BCryptGenerateSymmetricKey, fonction (bcrypt.h)

La fonction BCryptGenerateSymmetricKey crée un objet clé à utiliser avec un algorithme de chiffrement de clé symétrique à partir d’une clé fournie.

Syntaxe

NTSTATUS BCryptGenerateSymmetricKey(
  [in, out]       BCRYPT_ALG_HANDLE hAlgorithm,
  [out]           BCRYPT_KEY_HANDLE *phKey,
  [out, optional] PUCHAR            pbKeyObject,
  [in]            ULONG             cbKeyObject,
  [in]            PUCHAR            pbSecret,
  [in]            ULONG             cbSecret,
  [in]            ULONG             dwFlags
);

Paramètres

[in, out] hAlgorithm

Handle d’un fournisseur d’algorithmes créé avec la fonction BCryptOpenAlgorithmProvider. L’algorithme spécifié lors de la création du fournisseur doit prendre en charge le chiffrement de clé symétrique.

[out] phKey

Pointeur vers un BCRYPT_KEY_HANDLE qui reçoit le handle de la clé. Ce handle est utilisé dans les fonctions suivantes qui nécessitent une clé, telle que BCryptEncrypt. Ce handle doit être libéré lorsqu’il n’est plus nécessaire en le transmettant à la fonction BCryptDestroyKey.

[out, optional] pbKeyObject

Pointeur vers une mémoire tampon qui reçoit l’objet clé. Le paramètre cbKeyObject contient la taille de cette mémoire tampon. La taille requise de cette mémoire tampon peut être obtenue en appelant la fonction BCryptGetProperty pour obtenir la propriété BCRYPT_OBJECT_LENGTH. Cela fournit la taille de l’objet clé pour l’algorithme spécifié.

Cette mémoire ne peut être libérée qu’après la destruction du handle de clé phKey .

Si la valeur de ce paramètre est NULL et que la valeur du paramètre cbKeyObject est égale à zéro, la mémoire de l’objet clé est allouée et libérée par cette fonction.Windows 7 : cette fonctionnalité de gestion de la mémoire est disponible à partir de Windows 7.

[in] cbKeyObject

Taille, en octets, de la mémoire tampon pbKeyObject .

Si la valeur de ce paramètre est égale à zéro et que la valeur du paramètre pbKeyObject est NULL, la mémoire de l’objet clé est allouée et libérée par cette fonction.Windows 7 : cette fonctionnalité de gestion de la mémoire est disponible à partir de Windows 7.

[in] pbSecret

Pointeur vers une mémoire tampon qui contient la clé à partir de laquelle créer l’objet clé. Le paramètre cbSecret contient la taille de cette mémoire tampon. Il s’agit normalement d’un hachage d’un mot de passe ou d’autres données reproductibles. Si les données transmises dépassent la taille de clé cible, les données sont tronquées et l’excès est ignoré.

[in] cbSecret

Taille, en octets, de la mémoire tampon pbSecret.

[in] dwFlags

Ensemble d’indicateurs qui modifient le comportement de cette fonction. Aucun indicateur n’est actuellement défini. Ce paramètre doit donc être égal à zéro.

Valeur de retour

Retourne un code d’état qui indique la réussite ou l’échec de la fonction.

Les codes de retour possibles incluent, mais ne sont pas limités à, les éléments suivants.

Remarques

Selon les modes de processeur pris en charge par un fournisseur, BCryptGenerateSymmetricKey peuvent être appelés en mode utilisateur ou en mode noyau. Les appelants en mode noyau peuvent s’exécuter à PASSIVE_LEVEL IRQL ou DISPATCH_LEVEL IRQL. Si le niveau IRQL actuel est DISPATCH_LEVEL, le handle fourni dans le paramètre hAlgorithm doit avoir été ouvert à l’aide de l’indicateur de BCRYPT_PROV_DISPATCH, et tous les pointeurs passés à la fonction BCryptGenerateSymmetricKey doivent faire référence à la mémoire non page (ou verrouillée).

Pour appeler cette fonction en mode noyau, utilisez Cng.lib, qui fait partie du Kit de développement de pilotes (DDK). Windows Server 2008 et Windows Vista : Pour appeler cette fonction en mode noyau, utilisez Ksecdd.lib.

Exigences

Voir aussi

BCryptDestroyKey