SymmetricKey Classe

Paquet:

com.microsoft.azure.keyvault.cryptography

• java.lang.Object
• • Closeable
  • • Ikey
    • • com.microsoft.azure.keyvault.cryptography.SymmetricKey

public class SymmetricKey implements IKey

Implémentation de clé symétrique simple

Récapitulatif du champ

Modificateur et type	Champ et description
final int	DefaultKeySize
final int	KeySize128
final int	KeySize192
final int	KeySize256
final int	KeySize384
final int	KeySize512

Récapitulatif du constructeur

Constructeur	Description
SymmetricKey()	Crée un SymmetricKey avec un identificateur de clé aléatoire et une clé aléatoire avec des bits DefaultKeySize.
SymmetricKey(String kid)	Crée un SymmetricKey avec l’identificateur de clé spécifié et une clé aléatoire avec les bits DefaultKeySize.
SymmetricKey(String kid, byte[] keyBytes)	Crée une symmetricKey avec l’identificateur de clé et le matériau de clé spécifiés.
SymmetricKey(String kid, byte[] keyBytes, Provider provider)	Crée une symmetricKey avec l’identificateur de clé et le matériel de clé spécifiés qui utilise le fournisseur spécifié.
SymmetricKey(String kid, int keySizeInBytes)	Crée une symmetricKey avec l’identificateur de clé spécifié et une clé aléatoire avec la taille spécifiée.
SymmetricKey(String kid, int keySizeInBytes, Provider provider)	Crée une symmetricKey avec l’identificateur de clé spécifié et une clé aléatoire avec la taille spécifiée qui utilise le fournisseur spécifié.

Résumé de la méthode

Modificateur et type	Méthode et description
void	close()
ListenableFuture<byte[]>	decryptAsync(final byte[] ciphertext, final byte[] iv, final byte[] authenticationData, final byte[] authenticationTag, final String algorithm) Déchiffre le texte de chiffrement spécifié. Notez que tous les algorithmes ne nécessitent pas ou ne prennent pas en charge tous les paramètres.
ListenableFuture<Triple<byte[], byte[], String>>	encryptAsync(final byte[] plaintext, final byte[] iv, final byte[] authenticationData, final String algorithm) Chiffre le texte brut spécifié. Notez que tous les algorithmes ne nécessitent pas ou ne prennent pas en charge tous les paramètres.
String	getDefaultEncryptionAlgorithm() L’algorithme de chiffrement par défaut pour cette clé, à l’aide des représentations des algorithmes de clé web Json, RFC7513.
String	getDefaultKeyWrapAlgorithm() Algorithme de wrap de clé par défaut pour cette clé, à l’aide des représentations des algorithmes de clé web Json, RFC7513.
String	getDefaultSignatureAlgorithm() L’algorithme de signature par défaut pour cette clé, à l’aide des représentations des algorithmes de clé web Json, RFC7513.
String	getKid() Identificateur de clé unique pour cette clé.
ListenableFuture<Pair<byte[], String>>	signAsync(final byte[] digest, final String algorithm) Signe le digest spécifié à l’aide de l’algorithme spécifié ou des clés DefaultSignatureAlgorithm si aucun algorithme n’est spécifié.
ListenableFuture<byte[]>	unwrapKeyAsync(final byte[] encryptedKey, final String algorithm) Désencapsule (déchiffre) le matériel de clé encrypé spécifié.
ListenableFuture<Boolean>	verifyAsync(final byte[] digest, final byte[] signature, final String algorithm) Vérifie la valeur de signature fournie à l’aide du digest et de l’algorithme fournis.
ListenableFuture<Pair<byte[], String>>	wrapKeyAsync(final byte[] key, final String algorithm) Encapsule (chiffre) le matériel de clé symétrique spécifié à l’aide de l’algorithme spécifié, ou les clés DefaultKeyWrapAlgorithm si aucune n’est spécifiée.

Détails du champ

DefaultKeySize

public static final int DefaultKeySize= KeySize256

KeySize128

public static final int KeySize128= 128>> 3

KeySize192

public static final int KeySize192= 192>> 3

KeySize256

public static final int KeySize256= 256>> 3

KeySize384

public static final int KeySize384= 384>> 3

KeySize512

public static final int KeySize512= 512>> 3

Détails du constructeur

SymmetricKey

public SymmetricKey()

Crée un SymmetricKey avec un identificateur de clé aléatoire et une clé aléatoire avec des bits DefaultKeySize.

SymmetricKey

public SymmetricKey(String kid)

Crée un SymmetricKey avec l’identificateur de clé spécifié et une clé aléatoire avec les bits DefaultKeySize.

Parameters:

kid - Identificateur de clé à utiliser.

SymmetricKey

public SymmetricKey(String kid, byte[] keyBytes)

Crée une symmetricKey avec l’identificateur de clé et le matériau de clé spécifiés.

Parameters:

kid - Identificateur de clé à utiliser.

keyBytes - Matériau clé à utiliser.

SymmetricKey

public SymmetricKey(String kid, byte[] keyBytes, Provider provider)

Crée une symmetricKey avec l’identificateur de clé et le matériel de clé spécifiés qui utilise le fournisseur spécifié.

Parameters:

kid - Identificateur de clé à utiliser.

keyBytes - Matériau clé à utiliser.

provider - Fournisseur à utiliser (facultatif, null pour la valeur par défaut)

SymmetricKey

public SymmetricKey(String kid, int keySizeInBytes)

Crée une symmetricKey avec l’identificateur de clé spécifié et une clé aléatoire avec la taille spécifiée.

Parameters:

kid - Identificateur de clé à utiliser.

keySizeInBytes - Taille de clé à utiliser en octets.

SymmetricKey

public SymmetricKey(String kid, int keySizeInBytes, Provider provider)

Crée une symmetricKey avec l’identificateur de clé spécifié et une clé aléatoire avec la taille spécifiée qui utilise le fournisseur spécifié.

Parameters:

kid - Identificateur de clé à utiliser.

keySizeInBytes - Taille de clé à utiliser en octets.

provider - Fournisseur à utiliser (facultatif, null pour la valeur par défaut)

Détails de la méthode

close

public void close()

decryptAsync

public ListenableFuture decryptAsync(final byte[] ciphertext, final byte[] iv, final byte[] authenticationData, final byte[] authenticationTag, final String algorithm)

Déchiffre le texte de chiffrement spécifié. Notez que tous les algorithmes ne nécessitent pas ou ne prennent pas en charge tous les paramètres.

Overrides:

SymmetricKey.decryptAsync(final byte[] ciphertext, final byte[] iv, final byte[] authenticationData, final byte[] authenticationTag, final String algorithm)

Parameters:

ciphertext - Texte de chiffrement à déchiffrer

iv - Vecteur d’initialisation (facultatif avec certains algorithmes)

authenticationData - Données d’authentification supplémentaires (facultatives avec certains algorithmes)

authenticationTag - Balise d’authentification de l’opération de chiffrement (facultative avec certains algorithmes)

algorithm - L’algorithme de chiffrement à utiliser doit être fourni

Returns:

ListenableFuture contenant le texte brut

Throws:

NoSuchAlgorithmException - l’algorithme n’est pas valide

encryptAsync

public ListenableFuture<>> encryptAsync(final byte[] plaintext, final byte[] iv, final byte[] authenticationData, final String algorithm)

Chiffre le texte brut spécifié. Notez que tous les algorithmes ne nécessitent pas ou ne prennent pas en charge tous les paramètres.

Overrides:

SymmetricKey.encryptAsync(final byte[] plaintext, final byte[] iv, final byte[] authenticationData, final String algorithm)

Parameters:

plaintext - Texte brut à chiffrer

iv - Vecteur d’initialisation (facultatif avec certains algorithmes)

authenticationData - Données d’authentification supplémentaires (facultatives avec certains algorithmes)

algorithm - L’algorithme de chiffrement à utiliser est défini par défaut sur les clés DefaultEncryptionAlgorithm

Returns:

ListenableFuture contenant le texte de chiffrement, la balise d’authentification et l’algorithme utilisé

Throws:

NoSuchAlgorithmException - l’algorithme n’est pas valide

getDefaultEncryptionAlgorithm

public String getDefaultEncryptionAlgorithm()

L’algorithme de chiffrement par défaut pour cette clé, à l’aide des représentations des algorithmes de clé web Json, RFC7513.

Overrides:

SymmetricKey.getDefaultEncryptionAlgorithm()

Returns:

Algorithme de chiffrement par défaut pour cette clé.

getDefaultKeyWrapAlgorithm

public String getDefaultKeyWrapAlgorithm()

Algorithme de wrap de clé par défaut pour cette clé, à l’aide des représentations des algorithmes de clé web Json, RFC7513.

Overrides:

SymmetricKey.getDefaultKeyWrapAlgorithm()

Returns:

Algorithme de wrap de clé par défaut pour cette clé.

getDefaultSignatureAlgorithm

public String getDefaultSignatureAlgorithm()

L’algorithme de signature par défaut pour cette clé, à l’aide des représentations des algorithmes de clé web Json, RFC7513.

Overrides:

SymmetricKey.getDefaultSignatureAlgorithm()

Returns:

Algorithme de signature par défaut pour cette clé.

getKid

public String getKid()

Identificateur de clé unique pour cette clé.

Overrides:

SymmetricKey.getKid()

Returns:

Identificateur de clé

signAsync

public ListenableFuture<>> signAsync(final byte[] digest, final String algorithm)

Signe le digest spécifié à l’aide de l’algorithme spécifié ou des clés DefaultSignatureAlgorithm si aucun algorithme n’est spécifié.

Overrides:

SymmetricKey.signAsync(final byte[] digest, final String algorithm)

Parameters:

digest - Synthèse à signer

algorithm - Algorithme de signature à utiliser

Returns:

ListenableFuture contenant la signature et l’algorithme utilisé.

Throws:

NoSuchAlgorithmException - l’algorithme n’est pas valide

unwrapKeyAsync

public ListenableFuture unwrapKeyAsync(final byte[] encryptedKey, final String algorithm)

Désencapsule (déchiffre) le matériel de clé encrypé spécifié.

Overrides:

SymmetricKey.unwrapKeyAsync(final byte[] encryptedKey, final String algorithm)

Parameters:

encryptedKey - Clé chiffrée à déchiffrer

algorithm - L’algorithme à utiliser doit être fourni

Returns:

ListenableFuture contenant la clé non-encapsulée

Throws:

NoSuchAlgorithmException - l’algorithme n’est pas valide

verifyAsync

public ListenableFuture verifyAsync(final byte[] digest, final byte[] signature, final String algorithm)

Vérifie la valeur de signature fournie à l’aide du digest et de l’algorithme fournis.

Overrides:

SymmetricKey.verifyAsync(final byte[] digest, final byte[] signature, final String algorithm)

Parameters:

digest - Entrée digest

signature - Signature à vérifier

algorithm - L’algorithme à utiliser doit être fourni

Returns:

ListenableFuture contenant la signature et l’algorithme utilisé.

Throws:

NoSuchAlgorithmException - l’algorithme n’est pas valide

wrapKeyAsync

public ListenableFuture<>> wrapKeyAsync(final byte[] key, final String algorithm)

Encapsule (chiffre) le matériel de clé symétrique spécifié à l’aide de l’algorithme spécifié, ou les clés DefaultKeyWrapAlgorithm si aucune n’est spécifiée.

Overrides:

SymmetricKey.wrapKeyAsync(final byte[] key, final String algorithm)

Parameters:

key - Clé symétrique à encapsuler

algorithm - L’algorithme d’habillage à utiliser est défini par défaut sur les clés DefaultKeyWrapAlgorithm

Returns:

ListenableFuture contenant la clé chiffrée et l’algorithme utilisé

Throws:

NoSuchAlgorithmException - l’algorithme n’est pas valide