Fonction EncryptMessage (Général)

La fonction EncryptMessage (Général) chiffre un message pour assurer la confidentialité. EncryptMessage (Général) permet à une application de choisir parmi les algorithmes de chiffrement pris en charge par le mécanisme choisi. La fonction EncryptMessage (Général) utilise le contexte de sécurité référencé par le handle de contexte. Certains packages n’ont pas de messages à chiffrer ou à déchiffrer, mais fournissent plutôt un hachage d’intégrité qui peut être vérifié.

Lorsque vous utilisez le fournisseur de support de sécurité Digest, cette fonction est disponible en tant que mécanisme SASL uniquement.

Lorsque vous utilisez le SSP Schannel, cette fonction chiffre les messages à l’aide d’une clé de session négociée avec la partie distante qui recevra le message. L’algorithme de chiffrement est déterminé par la [suite de chiffrement ](suites-in-schannel.md de chiffrement) utilisée.

Pour plus d’informations sur l’utilisation de cette fonction avec un fournisseur de services partagés spécifique, consultez les rubriques suivantes.

Syntaxe

SECURITY_STATUS SEC_Entry EncryptMessage(
  _In_    PCtxtHandle    phContext,
  _In_    ULONG          fQOP,
  _Inout_ PSecBufferDesc pMessage,
  _In_    ULONG          MessageSeqNo
);

Paramètres

phContext [in]

Handle du contexte de sécurité à utiliser pour chiffrer le message.

fQOP [in]

Indicateurs spécifiques au package qui indiquent la qualité de la protection. Un package de sécurité peut utiliser ce paramètre pour activer la sélection d’algorithmes de chiffrement.

Lors de l’utilisation du SSP Digest, ce paramètre doit être défini sur zéro.

Ce paramètre peut être l’un des indicateurs suivants.

pMessage [in, out]

Pointeur vers une structure SecBufferDesc . Lors de l’entrée, la structure fait référence à une ou plusieurs structures SecBuffer . L’un d’eux peut être de type SECBUFFER_DATA. Cette mémoire tampon contient le message à chiffrer. Le message est chiffré en place, en remplaçant le contenu d’origine de la structure.

La fonction ne traite pas les mémoires tampons avec l’attribut SECBUFFER_READONLY.

La longueur de la structure SecBuffer qui contient le message ne doit pas être supérieure à cbMaximumMessage, obtenue à partir de la fonction QueryContextAttributes (General) (SECPKG_ATTR_STREAM_SIZES).

Lorsque vous utilisez le SSP Digest, il doit y avoir une deuxième mémoire tampon de type SECBUFFER_PADDING ou SEC_BUFFER_DATA pour contenir des informations de signature . Pour obtenir la taille de la mémoire tampon de sortie, appelez la fonction QueryContextAttributes (Général) et spécifiez SECPKG_ATTR_SIZES. La fonction retourne une structure SecPkgContext_Sizes . La taille de la mémoire tampon de sortie est la somme des valeurs des membres cbMaxSignature et cbBlockSize .

Les applications qui n’utilisent pas SSL doivent fournir un secBuffer de type SECBUFFER_PADDING.

MessageSeqNo [in]

Numéro de séquence attribué à l’application de transport du message. Si l’application de transport ne conserve pas de numéros de séquence, ce paramètre doit être égal à zéro.

Lors de l’utilisation du SSP Digest, ce paramètre doit être défini sur zéro. Le SSP Digest gère la numérotation séquentielle en interne.

Lorsque vous utilisez le SSP Schannel, ce paramètre doit être défini sur zéro. Le SSP Schannel n’utilise pas de numéros de séquence.

Valeur de retour

Si la fonction réussit, la fonction retourne SEC_E_OK.

Si la fonction échoue, elle retourne l’un des codes d’erreur suivants.

Remarques

La fonction EncryptMessage (Général) chiffre un message en fonction du message et de la clé de session à partir d’un contexte de sécurité.

Si l’application de transport a créé le contexte de sécurité pour prendre en charge la détection de séquence et que l’appelant fournit un numéro de séquence, la fonction inclut ces informations avec le message chiffré. L’inclusion de ces informations protège contre la relecture, l’insertion et la suppression des messages. Le package de sécurité incorpore le numéro de séquence transmis à partir de l’application de transport.

Lorsque vous utilisez le SSP Digest, obtenez la taille de la mémoire tampon de sortie en appelant la fonction QueryContextAttributes (Général) et en spécifiant SECPKG_ATTR_SIZES. La fonction retourne une structure SecPkgContext_Sizes . La taille de la mémoire tampon de sortie est la somme des valeurs des membres cbMaxSignature et cbBlockSize .

Lorsqu’il est utilisé avec le SSP Schannel, le paramètre pMessage doit contenir une structure SecBufferDesc avec les mémoires tampons suivantes.

Lorsque vous utilisez le SSP Schannel, déterminez la taille maximale de chacune des mémoires tampons en appelant la fonction QueryContextAttributes (Général) et en spécifiant l’attribut SECPKG_ATTR_STREAM_SIZES. Cette fonction retourne une structure SecPkgContext_StreamSizes dont les membres contiennent les tailles maximales pour les mémoires tampons d’en-tête (membre cbHeader ), de message (membre cbMaximumMessage ) et de bande-annonce (membre cbTrailer ).

Pour des performances optimales, les structures pMessage doivent être allouées à partir de la mémoire contiguë.

Windows XP/2000 : Cette fonction était également connue sous le nom de SealMessage. Les applications doivent désormais utiliser EncryptMessage (Général) uniquement.

Spécifications

Voir aussi

• Fonctions SSPI
• AcceptSecurityContext (General)
• DecryptMessage (General)
• InitializeSecurityContext (General)
• QueryContextAttributes (General)
• secBuffer
• SecBufferDesc