Bring Your Own Key
- Répondre à des exigences personnalisées en matière de génération et de provenance des clés pour la clé racine d’environnement
- Répondre à des exigences précises d’installation ou de durée de vie des clés pour la clé racine d’environnement
- Conserver une copie de la clé racine fournie par le client dans leurs propres locaux.
-
Appelez le point de terminaison Create the new encryption key pour lancer le processus Bring Your Own Key et obtenir le
kid(identifiant de clé) de la clé racine fournie par le client, préactivée mais sans matériel cryptographique.Ce point de terminaison renvoie la valeurkid, qui correspond à l’identifiant unique de la clé. - Appelez le point de terminaison Create the public wrapping key pour créer et renvoyer une clé publique d’encapsulation.
- Dans votre environnement, générez votre propre matériel de clé cryptographique et encapsulez-le (chiffrez-le) avec la clé publique d’encapsulation afin de créer une clé de chiffrement encapsulée (la clé racine fournie par le client).
- Appelez le point de terminaison Import the encryption key pour importer votre clé racine fournie par le client dans Auth0.
Exigences relatives au matériel cryptographique
Auth0 sur le cloud AWS
- Longueur de la clé publique d’encapsulation : 3072 bits
- Algorithme : CKG_MGF1_SHA256
- Longueur de la clé AES temporaire pour CKM_AES_KEY_WRAP_PAD : 256 bits
- Type de clé racine fournie par le client : clé symétrique AES de 256 bits
Auth0 sur Azure
- Longueur de la clé d’encapsulation publique : 2048 bits
- Algorithme : CKG_MGF1_SHA-1
- Longueur de la clé AES temporaire pour CKM_AES_KEY_WRAP_PAD : 256 bits
- Type de clé racine fournie par le client : clé privée RSA de 2048 bits
- Encodage de la clé privée : PKCS #8 - ASN.1 DER
Autorisations
| Autorisations | Descriptions |
|---|---|
read:encryption_keys | Les utilisateurs peuvent rechercher et récupérer des clés dans le locataire Auth0. Cela comprend la lecture des points de terminaison /api/v2/keys/encryption et /api/v2/keys/encryption/{kid}. |
create:encryption_keys | Les utilisateurs peuvent créer leur propre clé racine fournie par le client ainsi que leur clé d’encapsulation publique au moyen des points de terminaison /api/v2/keys/encryption et /api/v2/keys/encryption/{kid}/wrapping-key. |
delete:encryption_keys | Les utilisateurs peuvent supprimer leur propre clé racine fournie par le client au moyen du point de terminaison /api/v2/keys/encryption/{kid}. |
update:encryption_keys | Les utilisateurs peuvent importer leur propre clé racine fournie par le client au moyen du point de terminaison /api/v2/keys/encryption/{kid}. |
Points de terminaison
- Utilisez le point de terminaison Get all encryption keys pour obtenir des renseignements sur la clé racine d’environnement actuellement en place ou la clé racine fournie par le client, ainsi que sur la clé maître du locataire.
- Utilisez le point de terminaison Get the encryption key by its key id pour obtenir des renseignements sur la clé spécifiée.
- Utilisez le point de terminaison Create the new encryption key pour créer un espace réservé préactivé pour une clé racine fournie par le client.
- Utilisez le point de terminaison Create the public wrapping key pour obtenir une clé d’encapsulation publique afin d’encapsuler votre matériel cryptographique.
- Utilisez le point de terminaison Import the encryption key pour importer le matériel d’une nouvelle clé racine fournie par le client.
- Utilisez le point de terminaison Delete the encryption key by its key id pour supprimer une clé racine fournie par le client existante et cesser d’utiliser Bring Your Own Keys. La clé racine d’environnement d’Auth0 est utilisée pour rechiffrer la hiérarchie des clés. Cette opération n’a pas d’incidence négative sur les données existantes ni sur les flux d’authentification.
Si la fonctionnalité Customer Managed Keys n’est pas activée dans votre locataire, l’appel de ce ou ces points de terminaison d’API renverra l’erreur :
This feature is not enabled for this tenant.