Retarder la destruction des versions de secret

Cette page explique comment configurer la destruction différée des versions de secret, ou supprimer le délai de destruction, et restaurer les versions de secret programmées avant d'être détruites.

Lorsque vous détruisez une version de secret, le matériel du secret est immédiatement détruit et de façon permanente. En tant qu'administrateur Secret Manager, vous pouvez configurer la destruction différée des versions de secret afin qu'elles ne soient pas détruites immédiatement à la demande et qu'elles restent récupérables pendant une durée configurable.

Lorsque la destruction différée est activée sur le secret et que vous le détruisez , voici ce qui se produit:

  • La version est désactivée, ce qui empêche son utilisation.
  • Le système planifie la destruction définitive de la version à la fin de la période de délai.
  • À l'expiration du délai, la version du secret devient permanente et irrévocable détruit.

Avantages

Cette fonctionnalité offre les avantages suivants:

  • Un niveau de protection supplémentaire contre la destruction accidentelle ou malveillante du des secrets critiques. Tout utilisateur disposant du rôle Gestionnaire de versions de secret Secret Manager peut supprimer une version de secret. Cette action est irréversible. En configurant la destruction différée, vous pouvez : empêcher la destruction immédiate des versions de secret. Vous pouvez accorder aux utilisateurs l'accès minimal requis pour gérer le cycle de vie des versions de secrets, car vous pouvez surveiller et empêcher toute destruction accidentelle de données sensibles.

  • La destruction d'une version de secret déclenche une exception SECRET_VERSION_DESTROY_SCHEDULED Sujets Pub/Sub configurés sur le secret. En tant que Administrateur Secret Manager, vous pouvez annuler la destruction programmée et restaurez la version du secret activation ou la désactivation du secret .

Avant de commencer

  • Enable the Secret Manager API.

    Enable the API

  • Configurez l'authentification.

    Sélectionnez l'onglet correspondant à la façon dont vous prévoyez d'utiliser les exemples de cette page :

    Console

    Lorsque vous utilisez la console Google Cloud pour accéder aux services et aux API Google Cloud, vous n'avez pas besoin de configurer l'authentification.

    gcloud

    Vous pouvez utiliser les exemples gcloud CLI de cette page dans l'un des environnements de développement suivants :

    • Cloud Shell : pour utiliser un terminal en ligne avec gcloud CLI déjà configuré, activez Cloud Shell.

      En bas de cette page, une session Cloud Shell démarre et affiche une invite de ligne de commande. L'initialisation de la session peut prendre quelques secondes.

    • Shell local : pour utiliser gcloud CLI dans un environnement de développement local, installez et initialisez gcloud CLI.

    REST

    Pour utiliser les exemples d'API REST de cette page dans un environnement de développement local, vous devez utiliser les identifiants que vous fournissez à gcloud CLI.

      Install the Google Cloud CLI, then initialize it by running the following command:

      gcloud init

Rôles requis

Pour obtenir les autorisations dont vous avez besoin pour configurer la destruction différée des versions de secret, demandez à votre administrateur de vous accorder le Rôle IAM Administrateur Secret Manager (roles/secretmanager.admin) sur le secret. Pour en savoir plus sur l'attribution de rôles, consultez la page Gérer l'accès aux projets, aux dossiers et aux organisations.

Vous pouvez également obtenir les autorisations requises via des rôles personnalisés ou d'autres rôles prédéfinis.

Configurer une destruction différée

Vous pouvez activer la destruction différée d'une version de secret lorsque vous créez le secret ou lorsque vous le mettez à jour.

Console

  1. Dans la console Google Cloud, accédez à la page Secret Manager.

    Accéder à Secret Manager

  2. Suivez la procédure requise pour créer un secret.

  3. Accédez à la section Retarder la destruction des versions de secret.

  4. Cochez la case Définir la durée du délai de destruction.

  5. Dans le champ Durée du délai de destruction, saisissez la durée en jours. La valeur minimale que vous pouvez saisir est de 1 jour, et la valeur maximale est de 1 000 jours.

  6. Cliquez sur Créer un secret.

Pour activer cette fonctionnalité pour un secret existant, accédez à la page Modifier le secret. puis configurez le délai de destruction.

gcloud

Pour configurer la durée du délai de destruction du secret, utilisez la commande gcloud beta secrets create.

Avant d'utiliser les données de la commande ci-dessous, effectuez les remplacements suivants :

  • SECRET_ID : ID du secret ou identifiant complet du secret.
  • TTL_DURATION: durée du délai de destruction pour le des versions secrètes. Vous pouvez saisir la durée dans n'importe quel format (par exemple, en jours, en heures ou en secondes). La La durée minimale requise est de 1 jour, tandis que la durée maximale peut être définie sur 1 000 jours.

Exécutez la commande suivante :

Linux, macOS ou Cloud Shell

gcloud beta secrets create SECRET_ID --version-destroy-ttl=TTL_DURATION

Windows (PowerShell)

gcloud beta secrets create SECRET_ID --version-destroy-ttl=TTL_DURATION

Windows (cmd.exe)

gcloud beta secrets create SECRET_ID --version-destroy-ttl=TTL_DURATION

La réponse contient le secret que vous venez de créer.

REST

Avant d'utiliser les données de requête ci-dessous, effectuez les remplacements suivants :

  • PROJECT_ID : ID du projet Google Cloud dans lequel vous souhaitez créer le secret
  • SECRET_ID: ID du secret ou identifiant complet du secret.
  • TTL_DURATION: délai de destruction des versions du secret. Saisissez la durée en secondes. Notez que la durée minimale requise est de 1 jour, tandis que la durée maximale peut être définie sur 1 000 jours.

Méthode HTTP et URL :

POST https://secretmanager.googleapis.com/v1/projects/PROJECT_ID/secrets?secretId=SECRET_ID

Corps JSON de la requête :

{"replication": {"automatic": {}}, "version_destroy_ttl":"TTL_DURATION"}

Pour envoyer votre requête, choisissez l'une des options suivantes :

curl

Enregistrez le corps de la requête dans un fichier nommé request.json, puis exécutez la commande suivante :

curl -X POST \
-H "Authorization: Bearer $(gcloud auth print-access-token)" \
-H "Content-Type: application/json; charset=utf-8" \
-d @request.json \
"https://secretmanager.googleapis.com/v1/projects/PROJECT_ID/secrets?secretId=SECRET_ID"

PowerShell

Enregistrez le corps de la requête dans un fichier nommé request.json, puis exécutez la commande suivante :

$cred = gcloud auth print-access-token
$headers = @{ "Authorization" = "Bearer $cred" }

Invoke-WebRequest `
-Method POST `
-Headers $headers `
-ContentType: "application/json; charset=utf-8" `
-InFile request.json `
-Uri "https://secretmanager.googleapis.com/v1/projects/PROJECT_ID/secrets?secretId=SECRET_ID" | Select-Object -Expand Content

Vous devriez recevoir une réponse JSON de ce type :

{
  "name":"projects/PROJECT_ID/secrets/SECRET_ID",
  "replication":{
     "automatic":{

     }
  },
  "createTime":"2023-10-16T17:10:16.345401Z",
  "etag":"\"1607d90ee3d84c\"",
  "versionDestroyTtl":"TTL_DURATION"
}

La destruction différée ne s'applique pas dans les scénarios suivants :

  • Lorsqu'un secret est supprimé, tout le matériel secret et les versions de secret associées sont immédiatement supprimés.
  • Lorsqu'une date d'expiration est définie sur le secret et que celui-ci expire, toutes les les versions de secret sont détruites immédiatement, même si la destruction différée est activée sur le secret.

Modifier la durée du délai de destruction

Console

  1. Dans la console Google Cloud, accédez à la page Secret Manager.

    Accéder à Secret Manager

  2. Modifiez votre secret en utilisant l'une des options suivantes:

    • Cliquez sur Autres actions associé au secret que vous souhaitez modifier, puis sélectionnez Modifier dans le menu.
    • Cliquez sur le nom du secret pour accéder à la page Informations sur le secret. Le Sur la page Détails du secret, cliquez sur Modifier le secret.
  3. Accédez à la section Retarder la destruction des versions de secret.

  4. Dans le champ Durée du délai de destruction, saisissez la durée mise à jour.

  5. Cliquez sur Mettre à jour le secret.

gcloud

Pour mettre à jour le délai de destruction, utilisez le gcloud beta secrets update.

Avant d'utiliser les données de la commande ci-dessous, effectuez les remplacements suivants :

  • SECRET_ID: ID du secret ou identifiant complet du secret
  • TTL_DURATION: délai de destruction des versions du secret

Exécutez la commande suivante :

Linux, macOS ou Cloud Shell

gcloud beta secrets update SECRET_ID --version-destroy-ttl=TTL_DURATION

Windows (PowerShell)

gcloud beta secrets update SECRET_ID --version-destroy-ttl=TTL_DURATION

Windows (cmd.exe)

gcloud beta secrets update SECRET_ID --version-destroy-ttl=TTL_DURATION

La réponse contient le secret mis à jour.

REST

Avant d'utiliser les données de requête ci-dessous, effectuez les remplacements suivants :

  • PROJECT_ID : ID de projet Google Cloud
  • SECRET_ID : ID du secret ou identifiant complet du secret
  • TTL_DURATION: délai de destruction des versions du secret

Méthode HTTP et URL :

PATCH https://secretmanager.googleapis.com/v1/projects/PROJECT_ID/secrets/SECRET_ID?updateMask=version_destroy_ttl

Corps JSON de la requête :

{
  "version_destroy_ttl":"TTL_DURATION"
}

Pour envoyer votre requête, choisissez l'une des options suivantes :

curl

Enregistrez le corps de la requête dans un fichier nommé request.json, puis exécutez la commande suivante :

curl -X PATCH \
-H "Authorization: Bearer $(gcloud auth print-access-token)" \
-H "Content-Type: application/json; charset=utf-8" \
-d @request.json \
"https://secretmanager.googleapis.com/v1/projects/PROJECT_ID/secrets/SECRET_ID?updateMask=version_destroy_ttl"

PowerShell

Enregistrez le corps de la requête dans un fichier nommé request.json, puis exécutez la commande suivante :

$cred = gcloud auth print-access-token
$headers = @{ "Authorization" = "Bearer $cred" }

Invoke-WebRequest `
-Method PATCH `
-Headers $headers `
-ContentType: "application/json; charset=utf-8" `
-InFile request.json `
-Uri "https://secretmanager.googleapis.com/v1/projects/PROJECT_ID/secrets/SECRET_ID?updateMask=version_destroy_ttl" | Select-Object -Expand Content

Vous devriez recevoir une réponse JSON de ce type :

{
  "name":"projects/PROJECT_ID/secrets/SECRET_ID",
  "replication":{
     "automatic":{

     }
  },
  "createTime":"2023-10-16T17:10:16.345401Z",
  "etag":"\"1607d90ee3d84c\"",
  "versionDestroyTtl":"TTL_DURATION"
}

Les versions de secret concernées par la durée de la destruction différée dépendent des éléments suivants :

  • Lorsque la destruction différée est définie pour la première fois sur le secret, ce délai affecte toutes les versions actives (activées et désactivées) secret.
  • Lorsque le délai de destruction est modifié ou supprimé, les modifications uniquement sur les nouvelles versions de secret sur lesquelles l'action de destruction est tentée. Le secret les versions dont la destruction est déjà programmée continueront d'être détruites à l'heure de destruction programmée.

Désactiver la destruction différée

Console

  1. Dans la console Google Cloud, accédez à la page Secret Manager.

    Accéder à Secret Manager

  2. Modifiez votre secret en utilisant l'une des options suivantes:

    • Cliquez sur Autres actions associé au secret que vous souhaitez modifier, puis sélectionnez Modifier dans le menu.
    • Cliquez sur le nom du secret pour accéder à la page Informations sur le secret. Le Sur la page Détails du secret, cliquez sur Modifier le secret.
  3. Accédez à la section Retarder la destruction des versions de secret.

  4. Décochez la case Définir la durée du délai de destruction.

  5. Cliquez sur Mettre à jour le secret.

gcloud

Pour supprimer la durée du délai de destruction, utilisez la commande gcloud beta secrets update.

Avant d'utiliser les données de la commande ci-dessous, effectuez les remplacements suivants :

  • SECRET_ID: ID du secret ou identifiant complet du secret

Exécutez la commande suivante :

Linux, macOS ou Cloud Shell

gcloud beta secrets update SECRET_ID --remove-version-destroy-ttl

Windows (PowerShell)

gcloud beta secrets update SECRET_ID --remove-version-destroy-ttl

Windows (cmd.exe)

gcloud beta secrets update SECRET_ID --remove-version-destroy-ttl

La réponse contient le secret mis à jour.

REST

Avant d'utiliser les données de requête ci-dessous, effectuez les remplacements suivants :

  • PROJECT_ID : ID de projet Google Cloud
  • SECRET_ID : ID du secret ou identifiant complet du secret

Méthode HTTP et URL :

PATCH https://secretmanager.googleapis.com/v1/projects/PROJECT_ID/secrets/SECRET_ID?updateMask=version_destroy_ttl

Corps JSON de la requête :

{}

Pour envoyer votre requête, choisissez l'une des options suivantes :

curl

Enregistrez le corps de la requête dans un fichier nommé request.json, puis exécutez la commande suivante :

curl -X PATCH \
-H "Authorization: Bearer $(gcloud auth print-access-token)" \
-H "Content-Type: application/json; charset=utf-8" \
-d @request.json \
"https://secretmanager.googleapis.com/v1/projects/PROJECT_ID/secrets/SECRET_ID?updateMask=version_destroy_ttl"

PowerShell

Enregistrez le corps de la requête dans un fichier nommé request.json, puis exécutez la commande suivante :

$cred = gcloud auth print-access-token
$headers = @{ "Authorization" = "Bearer $cred" }

Invoke-WebRequest `
-Method PATCH `
-Headers $headers `
-ContentType: "application/json; charset=utf-8" `
-InFile request.json `
-Uri "https://secretmanager.googleapis.com/v1/projects/PROJECT_ID/secrets/SECRET_ID?updateMask=version_destroy_ttl" | Select-Object -Expand Content

Vous devriez recevoir une réponse JSON de ce type :

{
  "name":"projects/PROJECT_ID/secrets/SECRET_ID",
  "replication":{
     "automatic":{

     }
  },
  "createTime":"2023-10-16T17:10:16.345401Z",
  "etag":"\"1607d90ee3d84c\""
}

Tester la destruction différée des versions de secret

Console

  1. Dans la console Google Cloud, accédez à la page Secret Manager.

    Accéder à Secret Manager

  2. Cliquez sur le nom du secret. La page Informations détaillées sur le secret s'affiche.

  3. Dans le tableau Versions de la page Détails du secret, sélectionnez une version du secret.

  4. Dans la colonne Actions, cliquez sur Afficher plus, puis sur Supprimer.

  5. Dans la boîte de dialogue qui s'affiche, cliquez sur Programmer la destruction des versions sélectionnées.

gcloud

Pour détruire une version de secret, utilisez le gcloud beta secrets versions destroy.

Avant d'utiliser les données de la commande ci-dessous, effectuez les remplacements suivants :

  • SECRET_VERSION_ID : ID de la version ou identifiant complet de la version
  • SECRET_ID: ID du secret ou identifiant complet du secret

Exécutez la commande suivante :

Linux, macOS ou Cloud Shell

gcloud beta secrets versions destroy SECRET_VERSION_ID --secret=SECRET_ID

Windows (PowerShell)

gcloud beta secrets versions destroy SECRET_VERSION_ID --secret=SECRET_ID

Windows (cmd.exe)

gcloud beta secrets versions destroy SECRET_VERSION_ID --secret=SECRET_ID

La réponse contient la version détruite du secret.

REST

Avant d'utiliser les données de requête ci-dessous, effectuez les remplacements suivants :

  • PROJECT_ID : ID de projet Google Cloud
  • SECRET_ID: ID du secret ou identifiant complet du secret
  • VERSION_ID : ID de la version ou identifiant complet de la version

Méthode HTTP et URL :

POST https://secretmanager.googleapis.com/v1/projects/PROJECT_ID/secrets/SECRET_ID/versions/VERSION_ID/:destroy

Corps JSON de la requête :

{}

Pour envoyer votre requête, choisissez l'une des options suivantes :

curl

Enregistrez le corps de la requête dans un fichier nommé request.json, puis exécutez la commande suivante :

curl -X POST \
-H "Authorization: Bearer $(gcloud auth print-access-token)" \
-H "Content-Type: application/json; charset=utf-8" \
-d @request.json \
"https://secretmanager.googleapis.com/v1/projects/PROJECT_ID/secrets/SECRET_ID/versions/VERSION_ID/:destroy"

PowerShell

Enregistrez le corps de la requête dans un fichier nommé request.json, puis exécutez la commande suivante :

$cred = gcloud auth print-access-token
$headers = @{ "Authorization" = "Bearer $cred" }

Invoke-WebRequest `
-Method POST `
-Headers $headers `
-ContentType: "application/json; charset=utf-8" `
-InFile request.json `
-Uri "https://secretmanager.googleapis.com/v1/projects/PROJECT_ID/secrets/SECRET_ID/versions/VERSION_ID/:destroy" | Select-Object -Expand Content

Vous devriez recevoir une réponse JSON de ce type :

{
  "name":"projects/PROJECT_ID/secrets/SECRET_ID/versions/VERSION_ID",
  "createTime":"2023-10-16T17:21:55.920036Z",
  "state":"DISABLED",
  "replicationStatus":{
     "automatic":{

     }
  },
  "etag":"\"1607d8b2fc1cf4\"",
  "scheduledDestroyTime":"2023-10-16T17:26:57.459395960Z"
}

La version du secret est immédiatement désactivée et programmée pour être détruite à l'expiration du délai de destruction. Vous pouvez voir la date et l'heure exactes la version sera détruite conformément à la colonne Destruction programmée le dans la table Versions.

Restaurer les versions de secrets

Vous pouvez restaurer une version de secret dont la destruction est programmée en l'activant ou en la désactivant.

Activer une version de secret dont la destruction est programmée

Console

  1. Dans la console Google Cloud, accédez à la page Secret Manager.

    Accéder à Secret Manager

  2. Cliquez sur le nom du secret. La page Informations détaillées sur le secret s'affiche.

  3. Dans le tableau Versions de la page Détails du secret, sélectionnez une version du secret. dont la destruction est programmée.

  4. Dans la colonne Actions, cliquez sur Afficher plus. puis cliquez sur Activer.

  5. Dans la boîte de dialogue qui s'affiche, cliquez sur Activer les versions sélectionnées.

gcloud

Pour activer une version de secret dont la destruction est planifiée, utilisez la commande gcloud beta secrets versions enable.

Avant d'utiliser les données de la commande ci-dessous, effectuez les remplacements suivants :

  • SECRET_VERSION_ID : ID de la version ou identifiant complet de la version
  • SECRET_ID: ID du secret ou identifiant complet du secret

Exécutez la commande suivante :

Linux, macOS ou Cloud Shell

gcloud beta secrets versions enable SECRET_VERSION_ID --secret=SECRET_ID

Windows (PowerShell)

gcloud beta secrets versions enable SECRET_VERSION_ID --secret=SECRET_ID

Windows (cmd.exe)

gcloud beta secrets versions enable SECRET_VERSION_ID --secret=SECRET_ID

La réponse contient la version activée du secret.

REST

Avant d'utiliser les données de requête ci-dessous, effectuez les remplacements suivants :

  • PROJECT_ID : ID de projet Google Cloud
  • SECRET_ID: ID du secret ou identifiant complet du secret
  • VERSION_ID : ID de la version ou identifiant complet de la version

Méthode HTTP et URL :

POST https://secretmanager.googleapis.com/v1/projects/PROJECT_ID/secrets/SECRET_ID/versions/VERSION_ID/:enable

Corps JSON de la requête :

{}

Pour envoyer votre requête, choisissez l'une des options suivantes :

curl

Enregistrez le corps de la requête dans un fichier nommé request.json, puis exécutez la commande suivante :

curl -X POST \
-H "Authorization: Bearer $(gcloud auth print-access-token)" \
-H "Content-Type: application/json; charset=utf-8" \
-d @request.json \
"https://secretmanager.googleapis.com/v1/projects/PROJECT_ID/secrets/SECRET_ID/versions/VERSION_ID/:enable"

PowerShell

Enregistrez le corps de la requête dans un fichier nommé request.json, puis exécutez la commande suivante :

$cred = gcloud auth print-access-token
$headers = @{ "Authorization" = "Bearer $cred" }

Invoke-WebRequest `
-Method POST `
-Headers $headers `
-ContentType: "application/json; charset=utf-8" `
-InFile request.json `
-Uri "https://secretmanager.googleapis.com/v1/projects/PROJECT_ID/secrets/SECRET_ID/versions/VERSION_ID/:enable" | Select-Object -Expand Content

Vous devriez recevoir une réponse JSON de ce type :

{
  "name":"projects/PROJECT_ID/secrets/SECRET_ID/versions/VERSION_ID",
  "createTime":"2023-10-16T17:21:55.920036Z",
  "state":"ENABLED",
  "replicationStatus":{
     "automatic":{

     }
  },
  "etag":"\"1607d8b3e8e1bc\""
}

Désactiver une version de secret dont la destruction est programmée

Console

  1. Dans la console Google Cloud, accédez à la page Secret Manager.

    Accéder à Secret Manager

  2. Cliquez sur le nom du secret. La page Informations détaillées sur le secret s'affiche.

  3. Dans le tableau Versions de la page Détails du secret, sélectionnez une version du secret. dont la destruction est programmée.

  4. Dans la colonne Actions, cliquez sur Afficher plus, puis sur Désactiver.

  5. Dans la boîte de dialogue qui s'affiche, cliquez sur Désactiver les versions sélectionnées.

gcloud

Pour désactiver une version de secret dont la destruction est planifiée, utilisez la commande gcloud beta secrets versions disable.

Avant d'utiliser les données de la commande ci-dessous, effectuez les remplacements suivants :

  • SECRET_VERSION_ID : ID de la version ou identifiant complet de la version
  • SECRET_ID: ID du secret ou identifiant complet du secret

Exécutez la commande suivante :

Linux, macOS ou Cloud Shell

gcloud beta secrets versions disable SECRET_VERSION_ID --secret=SECRET_ID

Windows (PowerShell)

gcloud beta secrets versions disable SECRET_VERSION_ID --secret=SECRET_ID

Windows (cmd.exe)

gcloud beta secrets versions disable SECRET_VERSION_ID --secret=SECRET_ID

La réponse contient la version désactivée du secret.

REST

Avant d'utiliser les données de requête ci-dessous, effectuez les remplacements suivants :

  • PROJECT_ID : ID de projet Google Cloud
  • SECRET_ID: ID du secret ou identifiant complet du secret
  • VERSION_ID : ID de la version ou identifiant complet de la version

Méthode HTTP et URL :

POST https://secretmanager.googleapis.com/v1/projects/PROJECT_ID/secrets/SECRET_ID/versions/VERSION_ID/:disable

Corps JSON de la requête :

{}

Pour envoyer votre requête, choisissez l'une des options suivantes :

curl

Enregistrez le corps de la requête dans un fichier nommé request.json, puis exécutez la commande suivante :

curl -X POST \
-H "Authorization: Bearer $(gcloud auth print-access-token)" \
-H "Content-Type: application/json; charset=utf-8" \
-d @request.json \
"https://secretmanager.googleapis.com/v1/projects/PROJECT_ID/secrets/SECRET_ID/versions/VERSION_ID/:disable"

PowerShell

Enregistrez le corps de la requête dans un fichier nommé request.json, puis exécutez la commande suivante :

$cred = gcloud auth print-access-token
$headers = @{ "Authorization" = "Bearer $cred" }

Invoke-WebRequest `
-Method POST `
-Headers $headers `
-ContentType: "application/json; charset=utf-8" `
-InFile request.json `
-Uri "https://secretmanager.googleapis.com/v1/projects/PROJECT_ID/secrets/SECRET_ID/versions/VERSION_ID/:disable" | Select-Object -Expand Content

Vous devriez recevoir une réponse JSON de ce type :

{
  "name":"projects/PROJECT_ID/secrets/SECRET_ID/versions/VERSION_ID",
  "createTime":"2023-10-16T17:21:55.920036Z",
  "state":"DISABLED",
  "replicationStatus":{
     "automatic":{

     }
  },
  "etag":"\"1607d8b3e8e1bc\""
}

Étape suivante