Remarque
L’accès à cette page nécessite une autorisation. Vous pouvez essayer de vous connecter ou de modifier des répertoires.
L’accès à cette page nécessite une autorisation. Vous pouvez essayer de modifier des répertoires.
Une étendue de secrets d’un espace de travail est une collection nommée de secrets dans un espace de travail. Les autorisations d’une étendue de secrets déterminent qui peut lire, écrire et gérer les secrets qu’elle contient. Les autorisations s’appliquent à l’ensemble de l’étendue, et non aux secrets individuels. Par conséquent, un utilisateur autorisé à lire un secret dans une étendue peut lire tous les secrets qu’elle contient. Pour comparer les scopes de secrets d’espace de travail avec ceux du catalogue Unity, voir Choisir où stocker un secret.
Pour utiliser une étendue de secrets d’espace de travail :
- Créez une étendue de secrets.
- Ajouter des secrets à l’étendue.
- Accorder des autorisations sur l’étendue.
- Faites référence aux secrets dans votre code, ou dans une propriété de configuration Spark ou une variable d’environnement. Voir Utiliser un secret dans une propriété de configuration ou une variable d’environnement Spark.
Warning
Les administrateurs d’espaces de travail, créateurs de secrets et utilisateurs ayant obtenu la permission peuvent accéder et lire les secrets d’Azure Databricks. Bien qu’Azure Databricks tente de caviarder les valeurs secrètes dans les sorties des notebooks, il n’est pas possible d’empêcher complètement ces utilisateurs de consulter les contenus secrets. Attribuez toujours des autorisations d’accès secret soigneusement pour protéger les informations sensibles.
Gérer les étendues des secrets
Azure Databricks recommande d’aligner les étendues secrètes sur des rôles ou des applications plutôt que sur des individus.
Il existe deux types d’étendue de secret :
- Azure Key Vault sauvegardé : vous pouvez référencer des secrets stockés dans un coffre de clés Azure à l’aide d’étendues de secrets sauvegardées par Azure Key Vault. Une étendue de secrets reposant sur Azure Key Vault est une interface en lecture seule du coffre de clés. Vous gérez ses secrets dans Azure.
- Databricks-backed : une étendue secrète sauvegardée par Databricks est stockée dans une base de données chiffrée détenue et gérée par Azure Databricks.
Important
Les portées de secrets adossées à Azure Key Vault ne prennent en charge que le modèle d’autorisations de la stratégie d’accès au coffre, et non le contrôle d’accès en fonction du rôle (RBAC) Azure. Les nouveaux Key Vault Azure utilisent Azure RBAC par défaut. Si votre coffre de clés utilise Azure RBAC, passez son modèle d’autorisation à la Vault access policy avant de créer une étendue de secrets adossée à Azure Key Vault.
Après avoir créé un espace de secrets, vous pouvez attribuer des autorisations pour accorder aux utilisateurs l'accès nécessaire pour lire, écrire et gérer les espaces de secrets.
Créer une étendue de secrets reposant sur Azure Key Vault
Créez un périmètre de secrets adossé à Azure Key Vault dans le portail Azure et l’interface utilisateur de l’espace de travail Azure Databricks. Vous pouvez aussi utiliser Databricks CLI.
Requirements
- Vous devez disposer d’une instance Azure Key Vault. Si vous n’avez pas d’instance de coffre de clés, suivez les instructions dans Créer un coffre de clés à l’aide du portail Azure.
- Vous devez disposer du rôle Contributeur, Contributeur ou Propriétaire de Key Vault sur l’instance Azure Key Vault que vous souhaitez utiliser pour sauvegarder la portée du secret.
Note
Créer une étendue de secrets soutenue par Azure Key Vault nécessite le rôle de Contributeur ou de Propriétaire sur le coffre de clés Azure, même si le service Azure Databricks a déjà obtenu l'accès au coffre de clés.
Si le key vault existe dans un autre locataire que l'espace de travail Azure Databricks, l'utilisateur Microsoft Entra ID qui crée le scope secret doit avoir la permission de créer des principaux de service dans le locataire du key vault. Sinon, l’erreur suivante s’affiche :
Unable to grant read/list permission to Databricks service principal to KeyVault 'https://xxxxx.vault.azure.net/': Status code 403, {"odata.error":{"code":"Authorization_RequestDenied","message":{"lang":"en","value":"Insufficient privileges to complete the operation."},"requestId":"XXXXX","date":"YYYY-MM-DDTHH:MM:SS"}}
Configurer votre instance de coffre de clés Azure pour Azure Databricks
Connectez-vous au portail Azure, trouvez et sélectionnez l’instance Azure key vault.
Sous Paramètres, cliquez sur l’onglet Configuration d’Access.
Définissez Modèle d’autorisation sur Stratégie d’accès au coffre. Les nouveaux coffres à clés utilisent par défaut le contrôle d’accès basé sur les rôles Azure, que les portées de secrets adossées à Azure Key Vault ne prennent pas en charge.
Note
La création d’une étendue de secrets adossée à Azure Key Vault accorde les permissions Get et List à l’ID d’application du service Azure Databricks à l’aide des stratégies d’accès au coffre.
Sous Paramètres, sélectionnez Mise en réseau.
Dans Pare-feu et réseaux virtuels, définissez Autoriser l’accès à partir de : à Autoriser l’accès public à partir de réseaux virtuels spécifiques et des adresses IP.
Sous Exception, cochez la case Autoriser les services Microsoft approuvés pour contourner ce pare-feu.
Note
Vous pouvez également définir Autoriser l’accès à partir de : sur Autoriser l’accès public à partir de tous les réseaux.
Créer une étendue de secrets reposant sur Azure Key Vault
Accédez à
https://<databricks-instance>#secrets/createScope. Remplacez<databricks-instance>par l'URL de l'espace de travail de votre déploiement Azure Databricks. Cette URL est sensible à la casse ! Par exemple,scopedanscreateScopedoit utiliserSen majuscule.
Entrez le nom de l’étendue de secrets. Les noms d’étendues de secrets ne respectent pas la casse.
Dans Gérer le principal, sélectionnez Créateur ou Tous les utilisateurs de l’espace de travail pour spécifier quels utilisateurs ont l'autorisation de gestion sur le domaine secret.
L'autorisation MANAGE permet aux utilisateurs de lire, d'écrire et d'accorder des autorisations sur le périmètre. Votre compte doit avoir le plan Premium pour choisir Creator.
Entrez le nom DNS (par exemple,
https://databrickskv.vault.azure.net/) et l'ID de ressource, par exemple :/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourcegroups/databricks-rg/providers/Microsoft.KeyVault/vaults/databricksKVCes propriétés sont disponibles dans l’onglet Paramètres > Propriétés d’un Azure Key Vault dans votre Portail Azure.
Cliquez sur Créer.
Utilisez la commande Databricks CLI
databricks secrets list-scopespour vérifier que l’étendue a bien été créée.
Créer une étendue de secrets reposant sur Databricks
Créez un scope secret avec la ligne de commande Databricks (version 0.205 et ultérieure) ou l’API Secrets.
Noms d’étendue de secret :
- doit être unique au sein d’un espace de travail ;
- Doit être constitué de caractères alphanumériques, tirets, soulignements
@et points, et ne peut pas dépasser 128 caractères. - Ne respectent pas la casse.
Les noms d’étendue de secret sont considérés comme non sensibles et sont lisibles par tous les utilisateurs de l’espace de travail.
Pour créer une étendue à l’aide de l’interface CLI Databricks :
databricks secrets create-scope <scope-name>
Par défaut, les étendues sont créées avec l’autorisation GÉRER pour l’utilisateur qui a créé l’étendue. Une fois que vous avez créé une étendue de secret sauvegardée par Databricks, vous pouvez y ajouter des secrets.
Lister les étendues de secrets
Pour dresser la liste des étendues existantes dans un espace de travail à l’aide de l’interface CLI :
databricks secrets list-scopes
Vous pouvez également répertorier les espaces secrets à l’aide de l’API Secrets.
Supprimer un périmètre de secret
La suppression d’une étendue de secrets entraîne la suppression de tous les secrets et ACL appliqués à l’étendue. Pour supprimer une étendue à l’aide de l’interface CLI, exécutez les opérations suivantes :
databricks secrets delete-scope <scope-name>
Vous pouvez également supprimer une étendue de secrets en tirant parti de l’API Secrets.
Gérer les secrets
Un secret est une paire clé-valeur qui stocke des éléments sensibles à l’aide d’un nom de clé unique dans une étendue secrète.
La méthode de création d'un secret dépend de l'utilisation d'une portée adossée à Azure Key Vault ou d'une portée adossée à Databricks.
Créer un secret dans une étendue Azure Key Vault
Pour créer un secret dans Azure Key Vault, vous utilisez l’API REST Portail Azure ou Azure Set Secret.
Créer un secret dans une étendue Databricks
Créez un secret avec la CLI Databricks (version 0.205 et ultérieure), le SDK Databricks pour Python dans un notebook, ou l’API Secrets. Les noms de secrets ne respectent pas la casse.
Interface CLI de Databricks
Lorsque vous créez un secret dans une étendue prise en charge par Databricks, vous pouvez spécifier la valeur secrète de l'une des trois manières suivantes :
- Spécifiez la valeur sous forme de chaîne avec l’indicateur
--string-value. - Entrez le secret lorsque vous y êtes invité de manière interactive (secrets à ligne unique).
- Passez le secret à l’aide d’une entrée standard (secrets multilignes).
Par exemple:
databricks secrets put-secret --json '{
"scope": "<scope-name>",
"key": "<key-name>",
"string_value": "<secret>"
}'
Si vous créez un secret sur plusieurs lignes, vous pouvez transmettre le secret à l’aide d’une entrée standard. Par exemple:
(cat << EOF
this
is
a
multi
line
secret
EOF
) | databricks secrets put-secret <scope-name> <key-name>
Kit de développement logiciel (SDK) Databricks pour Python
from databricks.sdk import WorkspaceClient
w = WorkspaceClient()
w.secrets.put_secret("<secret_scope>","<key-name>",string_value ="<secret>")
Lire un secret
Lisez un secret avec Databricks CLI (version 0.205 et ultérieure), ou dans un notebook avec l’utilitaire Secrets (dbutils.secrets).
Interface CLI de Databricks
Pour lire la valeur d’un secret à l’aide de l’interface de ligne de commande Databricks, vous devez décoder la valeur encodée en base64. Vous pouvez utiliser jq pour extraire la valeur et base64 --decode le décoder :
databricks secrets get-secret <scope-name> <key-name> | jq -r .value | base64 --decode
Utilitaire secrets (dbutils.secrets)
password = dbutils.secrets.get(scope = "<scope-name>", key = "<key-name>")
Lister les secrets
Pour répertorier les secrets dans un domaine donné :
databricks secrets list-secrets <scope-name>
La réponse montre des métadonnées sur les secrets, comme leurs noms clés. Pour lister ces métadonnées dans un notebook ou un job, utilisez l’utilitaire Secrets (dbutils.secrets). Par exemple:
dbutils.secrets.list('my-scope')
supprimer un secret
Pour supprimer un secret d’une étendue avec l’interface de ligne de commande Databricks :
databricks secrets delete-secret <scope-name> <key-name>
Vous pouvez également utiliser l’API Secrets.
Pour supprimer un secret d'une portée soutenue par Azure Key Vault, utilisez l'API REST Azure SetSecret ou l'interface utilisateur du portail Azure.
Gérer les autorisations d’étendue de secret
Par défaut, l’utilisateur qui crée un scope secret a la MANAGE permission dessus, ce qui lui permet de lire les secrets dans le scope, d’écrire des secrets dessus et de gérer ses permissions.
Note
Les listes de contrôle d’accès de secret se trouvent au niveau de l’étendue. Si vous utilisez des étendues reposant sur Azure Key Vault, les utilisateurs auxquels l’accès est accordé ont accès à tous les secrets dans le Key Vault Azure. Pour restreindre l’accès, utilisez des instances distinctes de coffre de clés Azure.
Gérez les autorisations du périmètre des secrets avec la CLI Databricks (version 0.205 et ultérieure) ou l’API Secrets. Pour en savoir plus sur les niveaux d’autorisation des secrets, consultez Listes de contrôle d’accès des secrets.
Accorder des autorisations d'utilisateur sur un périmètre secret
Note
Pour accorder des autorisations sur une étendue de secrets, vous devez disposer du plan Premium.
Pour accorder des autorisations utilisateur sur une étendue secrète à l’aide de l’interface CLI Databricks :
databricks secrets put-acl <scope-name> <principal> <permission>
Le fait de faire une demande pour un principal qui a déjà une autorisation appliquée remplace le niveau d’autorisation existant.
Le champ principal spécifie un principal Azure Databricks existant. Un utilisateur est spécifié à l’aide de son adresse e-mail, un principal de service à l’aide de sa valeur applicationId et un groupe à l’aide de son nom de groupe. Pour plus d’informations, consultez Principal.
Par exemple, pour permettre à un groupe tel que datascience de lire les secrets dans une étendue, accordez-lui READ :
databricks secrets put-acl <scope-name> <group> READ
Afficher les autorisations d’étendue de secret
Pour afficher toutes les autorisations d’étendue de secret pour une étendue secrète donnée :
databricks secrets list-acls <scope-name>
Pour obtenir les autorisations d’étendue de secret appliquées à un principal pour une étendue secrète donnée :
databricks secrets get-acl <scope-name> <principal>
Si aucune liste de contrôle d’accès n’existe pour le principal et l’étendue donnés, cette requête échoue.
Supprimer une autorisation d’étendue secrète
Pour supprimer une autorisation d’étendue secrète appliquée à un principal pour une étendue secrète donnée :
databricks secrets delete-acl <scope-name> <principal>
Rédaction des secrets
Stocker les identifiants sous forme de secrets Azure Databricks aide à les protéger lorsque vous exécutez des notebooks et des jobs. Cependant, vous pouvez toujours imprimer accidentellement un secret dans des tampons de sortie standards ou afficher la valeur lors de l’affectation d’une variable.
Pour éviter cela, Azure Databricks tente de caviarder les valeurs secrètes qui sont lues à l’aide de dbutils.secrets.get() et référencées dans une propriété de configuration Spark. Lorsqu’elles sont affichées, les valeurs secrètes sont remplacées par [REDACTED].
Par exemple, si vous attribuez une valeur secrète à une variable à l’aide de dbutils.secrets.get() et que vous imprimez ensuite cette variable, celle-ci est remplacée par [REDACTED].
Warning
Le caviardage s’applique uniquement aux valeurs secrètes littérales. La fonctionnalité d’expurgation des secrets n’empêche pas les transformations délibérées et arbitraires d’un secret codé. Pour contrôler les secrets, utilisez des listes de contrôle d’accès pour limiter les permissions d’exécution des commandes. Cela empêche l’accès non autorisé aux contextes de bloc-notes partagés.
Rédaction de données sensibles dans SQL
Azure Databricks tente de masquer toutes les commandes du langage de requête de données (DQL) SQL qui appellent la fonction `secret`, y compris dans les vues et les fonctions définies par l’utilisateur référencées. Lorsque la secret fonction est utilisée, la sortie est remplacée par [REDACTED] le cas échéant. Comme la rédaction du bloc-notes, cela s’applique uniquement aux valeurs littérales, pas aux secrets transformés ou indirectement référencés.
Pour les commandes du langage de manipulation de données SQL (DML), Azure Databricks permet des recherches de secrets si le secret est considéré comme sûr. Par exemple, un secret est sûr lorsqu’il est enveloppé dans une fonction cryptographique telle que sha() ou aes_encrypt(), qui empêchent les valeurs brutes d’être stockées sans chiffrement.
Validation des secrets dans SQL
Azure Databricks applique également la validation pour bloquer les commandes DML SQL qui peuvent entraîner l’enregistrement de secrets non chiffrés dans des tables. L’analyseur de requête tente d’identifier et d’empêcher ces scénarios, ce qui permet d’éviter le stockage accidentel d’informations sensibles en texte clair.
Ressources supplémentaires
| Ressource | Description |
|---|---|
| Gestion des secrets | Comparez les scopes de secrets de l’espace de travail avec ceux du catalogue Unity, et voyez où vous pouvez utiliser chacun d’eux. |
| Utiliser un secret dans une propriété de configuration Spark ou une variable d’environnement | Référencer des secrets dans les propriétés de configuration Spark et les variables d’environnement. |