Fonction InitializeSecurityContext (Digest)

Article
06/01/2023

La fonction InitializeSecurityContext (Digest) initie le contexte de sécurité sortant côté client à partir d’un handle d’informations d’identification. La fonction est utilisée pour créer un contexte de sécurité entre l’application cliente et un homologue distant. InitializeSecurityContext (Digest) retourne un jeton que le client doit passer à l’homologue distant, que l’homologue à son tour envoie à l’implémentation de sécurité locale via l’appel AcceptSecurityContext (Digest). Le jeton généré doit être considéré comme opaque par tous les appelants.

En règle générale, la fonction InitializeSecurityContext (Digest) est appelée dans une boucle jusqu’à ce qu’un contexte de sécurité suffisant soit établi.

Syntaxe

SECURITY_STATUS SEC_Entry InitializeSecurityContext(
  _In_opt_    PCredHandle    phCredential,
  _In_opt_    PCtxtHandle    phContext,
  _In_opt_    SEC_CHAR       *pszTargetName,
  _In_        ULONG          fContextReq,
  _In_        ULONG          Reserved1,
  _In_        ULONG          TargetDataRep,
  _In_opt_    PSecBufferDesc pInput,
  _In_        ULONG          Reserved2,
  _Inout_opt_ PCtxtHandle    phNewContext,
  _Inout_opt_ PSecBufferDesc pOutput,
  _Out_       PULONG         pfContextAttr,
  _Out_opt_   PTimeStamp     ptsExpiry
);

Paramètres

phCredential[in, optional]

Handle des informations d’identification retournées par AcquireCredentialsHandle (Digest). Ce handle est utilisé pour générer le contexte de sécurité. La fonction InitializeSecurityContext (Digest) nécessite au moins des informations d’identification sortantes.

phContext[in, optional]

Pointeur vers une structure CtxtHandle . Lors du premier appel à InitializeSecurityContext (Digest), ce pointeur est NULL. Lors du deuxième appel, ce paramètre est un pointeur vers le handle vers le contexte partiellement formé retourné dans le paramètre phNewContext par le premier appel.

Avertissement

N’utilisez pas le même handle de contexte dans les appels simultanés à InitializeSecurityContext (Digest). L’implémentation de l’API dans les fournisseurs de services de sécurité n’est pas thread-safe.

pszTargetName[in, optional]

Pointeur vers une chaîne terminée par null qui identifie de manière unique l’URI de la ressource demandée. La chaîne doit être composée de caractères autorisés dans un URI et doit être représentée par le jeu de code US ASCII. L’encodage en pourcentage peut être utilisé pour représenter des caractères en dehors du jeu de codes US ASCII.

fContextReq[in]

Indicateurs de bits qui indiquent les demandes pour le contexte. Tous les packages ne peuvent pas prendre en charge toutes les exigences. Les indicateurs utilisés pour ce paramètre sont précédés d’ISC_REQ_, par exemple, ISC_REQ_DELEGATE. Ce paramètre peut être un ou plusieurs des indicateurs d’attributs suivants.

Valeur	Signification
ISC_REQ_ALLOCATE_MEMORY	Le package de sécurité alloue des mémoires tampons de sortie pour vous. Lorsque vous avez terminé d’utiliser les mémoires tampons de sortie, libérez-les en appelant la fonction FreeContextBuffer .
ISC_REQ_CONFIDENTIALITY	Chiffrez les messages à l’aide de la fonction EncryptMessage .
ISC_REQ_EXTENDED_ERROR	Lorsque des erreurs se produisent, la partie distante est avertie.
ISC_REQ_HTTP	Utilisez Digest pour HTTP. Omettez cet indicateur pour utiliser Digest comme mécanisme SASL.
ISC_REQ_INTEGRITY	Signez des messages et vérifiez les signatures à l’aide des fonctions EncryptMessage et MakeSignature .
ISC_REQ_MUTUAL_AUTH	La stratégie d’authentification mutuelle du service sera satisfaite. ATTENTION: Cela ne signifie pas nécessairement que l’authentification mutuelle est effectuée, mais seulement que la stratégie d’authentification du service est satisfaite. Pour vous assurer que l’authentification mutuelle est effectuée, appelez la fonction QueryContextAttributes (Digest).
ISC_REQ_REPLAY_DETECT	Détectez les messages relus qui ont été encodés à l’aide des fonctions EncryptMessage ou MakeSignature .
ISC_REQ_SEQUENCE_DETECT	Détecter les messages reçus hors séquence.
ISC_REQ_STREAM	Prise en charge d’une connexion orientée flux.

Les attributs demandés peuvent ne pas être pris en charge par le client. Pour plus d’informations, consultez le paramètre pfContextAttr .

Pour obtenir d’autres descriptions des différents attributs, consultez Configuration requise du contexte.

Réservé1[in]

Ce paramètre est réservé et doit être défini sur zéro.

TargetDataRep[in]

Ce paramètre n’est pas utilisé avec Digest. Définissez-le sur zéro.

pInput[in, optional]

Pointeur vers une structure SecBufferDesc qui contient des pointeurs vers les mémoires tampons fournies en entrée dans le package. Sauf si le contexte client a été initié par le serveur, la valeur de ce paramètre doit être NULL lors du premier appel à la fonction. Lors des appels ultérieurs à la fonction ou lorsque le contexte client a été lancé par le serveur, la valeur de ce paramètre est un pointeur vers une mémoire tampon allouée avec suffisamment de mémoire pour contenir le jeton retourné par l’ordinateur distant.

Pour plus d’informations sur la configuration de la mémoire tampon, consultez Mémoires tampons d’entrée pour la réponse au défi Digest.

Réservé2[in]

Ce paramètre est réservé et doit être défini sur zéro.

phNewContext[in, out, optional]

Pointeur vers une structure CtxtHandle . Lors du premier appel à InitializeSecurityContext (Digest), ce pointeur reçoit le nouveau handle de contexte. Lors du deuxième appel, phNewContext peut être identique au handle spécifié dans le paramètre phContext . phNewContext ne doit jamais être NULL.

pOutput[in, out, optional]

Pointeur vers une structure SecBufferDesc qui contient des pointeurs vers la structure SecBuffer qui reçoit les données de sortie. Si une mémoire tampon a été tapée comme SEC_READWRITE dans l’entrée, elle sera là sur la sortie. Le système alloue une mémoire tampon pour le jeton de sécurité si nécessaire (via ISC_REQ_ALLOCATE_MEMORY) et renseigne l’adresse dans le descripteur de mémoire tampon pour le jeton de sécurité.

Ce paramètre reçoit la réponse de défi qui doit être envoyée au serveur.

pfContextAttr[out]

Pointeur vers une variable pour recevoir un ensemble d’indicateurs de bits qui indiquent les attributs du contexte établi. Pour obtenir une description des différents attributs, consultez Configuration requise du contexte.

Les indicateurs utilisés pour ce paramètre sont précédés de ISC_RET, comme ISC_RET_DELEGATE. Pour obtenir la liste des valeurs valides, consultez le paramètre fContextReq .

Ne case activée pas pour les attributs liés à la sécurité tant que l’appel de fonction final n’est pas retourné. Les indicateurs d’attribut qui ne sont pas liés à la sécurité, tels que l’indicateur ASC_RET_ALLOCATED_MEMORY, peuvent être vérifiés avant le retour final.

Notes

Des attributs de contexte particuliers peuvent changer pendant la négociation avec un homologue distant.

ptsExpiry[out, optional]

Pointeur vers une structure TimeStamp qui reçoit l’heure d’expiration du contexte.

Il n’y a pas de délai d’expiration pour les informations d’identification ou contextes de sécuritéSSP Microsoft Digest.

Valeur retournée

Si la fonction réussit, la fonction retourne l’un des codes de réussite suivants.

Code de retour	Description
SEC_E_OK	Le contexte de sécurité a été initialisé avec succès. Il n’est pas nécessaire d’effectuer un autre appel InitializeSecurityContext (Digest). Si la fonction retourne un jeton de sortie, c’est-à-dire si le SECBUFFER_TOKEN dans pOutput est d’une longueur différente de zéro, ce jeton doit être envoyé au serveur.
SEC_I_COMPLETE_AND_CONTINUE	Le client doit appeler CompleteAuthToken , puis passer la sortie au serveur. Le client attend ensuite un jeton retourné et le passe, dans un autre appel, à InitializeSecurityContext (Digest).
SEC_I_COMPLETE_NEEDED	Le client doit terminer la génération du message, puis appeler la fonction CompleteAuthToken .
SEC_I_CONTINUE_NEEDED	Le client doit envoyer le jeton de sortie au serveur et attendre un jeton de retour. Le jeton retourné est ensuite passé dans un autre appel à InitializeSecurityContext (Digest). Le jeton de sortie peut être vide.
SEC_I_INCOMPLETE_CREDENTIALS	Utilisez avec Schannel. Le serveur a demandé l’authentification du client, et les informations d’identification fournies n’incluent pas de certificat ou le certificat n’a pas été émis par une autorité de certification approuvée par le serveur. Pour plus d'informations, consultez la section Notes.

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

Code de retour	Description
SEC_E_INSUFFICIENT_MEMORY	La mémoire disponible est insuffisante pour effectuer l’action demandée.
SEC_E_INTERNAL_ERROR	Une erreur s’est produite qui n’a pas été mappée à un code d’erreur SSPI.
SEC_E_INVALID_HANDLE	Le handle passé à la fonction n’est pas valide.
SEC_E_INVALID_TOKEN	L’erreur est due à un jeton d’entrée mal formé, tel qu’un jeton endommagé en transit, un jeton de taille incorrecte ou un jeton passé dans la délégation contrainte incorrecte. La transmission d’un jeton au package incorrect peut se produire si le client et le serveur n’ont pas négocié la délégation contrainte appropriée.
SEC_E_LOGON_DENIED	Échec de l’ouverture de session.
SEC_E_NO_AUTHENTICATING_AUTHORITY	Aucune autorité n’a pu être contactée pour l’authentification. Le nom de domaine de la partie authentifiante peut être incorrect, le domaine peut être inaccessible ou une relation d’approbation a peut-être échoué.
SEC_E_NO_CREDENTIALS	Aucune information d’identification n’est disponible dans la délégation contrainte.
SEC_E_TARGET_UNKNOWN	La cible n’a pas été reconnue.
SEC_E_UNSUPPORTED_FUNCTION	Un indicateur d’attribut de contexte non valide (ISC_REQ_DELEGATE ou ISC_REQ_PROMPT_FOR_CREDS) a été spécifié dans le paramètre fContextReq .
SEC_E_WRONG_PRINCIPAL	Le principal qui a reçu la demande d’authentification n’est pas le même que celui passé dans le paramètre pszTargetName . Cela indique un échec de l’authentification mutuelle.

Remarques

L’appelant est chargé de déterminer si les attributs de contexte finaux sont suffisants. Si, par exemple, la confidentialité a été demandée, mais n’a pas pu être établie, certaines applications peuvent choisir d’arrêter la connexion immédiatement.

Si les attributs du contexte de sécurité ne sont pas suffisants, le client doit libérer le contexte partiellement créé en appelant la fonction DeleteSecurityContext .

La fonction InitializeSecurityContext (Digest) est utilisée par un client pour initialiser un contexte sortant.

Pour un contexte de sécurité à deux étapes, la séquence d’appels est la suivante :

Le client appelle la fonction avec phContext défini NULL sur et remplit le descripteur de mémoire tampon avec le message d’entrée.
Le package de sécurité examine les paramètres et construit un jeton opaque, le plaçant dans l’élément TOKEN dans le tableau de mémoires tampons. Si le paramètre fContextReq inclut l’indicateur ISC_REQ_ALLOCATE_MEMORY, le package de sécurité alloue la mémoire et retourne le pointeur dans l’élément TOKEN.
Le client envoie le jeton retourné dans la mémoire tampon pOutput au serveur cible. Le serveur transmet ensuite le jeton comme argument d’entrée dans un appel à la fonction AcceptSecurityContext (Digest).
AcceptSecurityContext (Digest) peut retourner un jeton que le serveur envoie au client pour un deuxième appel à InitializeSecurityContext (Digest) si le premier appel a retourné SEC_I_CONTINUE_NEEDED.

Pour les contextes de sécuritéà plusieurs étapes, tels que l’authentification mutuelle, la séquence d’appel est la suivante :

Le client appelle la fonction comme décrit précédemment, mais le package retourne le code de réussite SEC_I_CONTINUE_NEEDED.
Le client envoie le jeton de sortie au serveur et attend la réponse du serveur.
À la réception de la réponse du serveur, le client appelle à nouveau InitializeSecurityContext (Digest), avec phContext défini sur le handle qui a été retourné à partir du dernier appel. Le jeton reçu du serveur est fourni dans le paramètre pInput .
N’utilisez pas la valeur phContext dans les appels simultanés à InitializeSecurityContext (Digest). L’implémentation dans les fournisseurs de sécurité n’est pas thread-safe.

Si le serveur a répondu avec succès, le package de sécurité retourne SEC_E_OK et une session sécurisée est établie.

Si la fonction retourne l’une des réponses d’erreur, la réponse du serveur n’est pas acceptée et la session n’est pas établie.

Si la fonction retourne SEC_I_CONTINUE_NEEDED, SEC_I_COMPLETE_NEEDED ou SEC_I_COMPLETE_AND_CONTINUE, les étapes 2 et 3 sont répétées.

Pour initialiser un contexte de sécurité, plusieurs appels à cette fonction peuvent être nécessaires, en fonction du mécanisme d’authentification sous-jacent ainsi que des choix spécifiés dans le paramètre fContextReq .

Les paramètres fContextReq et pfContextAttributes sont des masques de bits qui représentent différents attributs de contexte. Pour obtenir une description des différents attributs, consultez Configuration requise du contexte. Le paramètre pfContextAttributes est valide sur tout retour réussi, mais uniquement sur le retour final réussi si vous devez examiner les indicateurs relatifs aux aspects de sécurité du contexte. Les retours intermédiaires peuvent définir, par exemple, l’indicateur ISC_RET_ALLOCATED_MEMORY.

Si l’indicateur ISC_REQ_USE_SUPPLIED_CREDS est défini, le package de sécurité doit rechercher un type de mémoire tampon SECBUFFER_PKG_PARAMS dans la mémoire tampon d’entrée pInput . Il ne s’agit pas d’une solution générique, mais elle permet une association forte du package de sécurité et de l’application le cas échéant.

Si ISC_REQ_ALLOCATE_MEMORY a été spécifié, l’appelant doit libérer la mémoire en appelant la fonction FreeContextBuffer .

Par exemple, le jeton d’entrée peut être le défi d’un gestionnaire lan. Dans ce cas, le jeton de sortie est la réponse chiffrée par NTLM au défi.

L’action du client dépend du code de retour de cette fonction. Si le code de retour est SEC_E_OK, il n’y aura pas de deuxième appel InitializeSecurityContext (Digest) et aucune réponse du serveur n’est attendue. Si le code de retour est SEC_I_CONTINUE_NEEDED, le client attend un jeton en réponse du serveur et le transmet dans un deuxième appel à InitializeSecurityContext (Digest). Le code de retour SEC_I_COMPLETE_NEEDED indique que le client doit terminer la génération du message et appeler la fonction CompleteAuthToken . Le code SEC_I_COMPLETE_AND_CONTINUE incorpore ces deux actions.

Si InitializeSecurityContext (Digest) retourne la réussite du premier (ou du seul) appel, l’appelant doit finalement appeler la fonction DeleteSecurityContext sur le handle retourné, même si l’appel échoue sur une étape ultérieure de l’échange d’authentification.

Le client peut appeler InitializeSecurityContext (Digest) une fois qu’il s’est terminé avec succès. Cela indique au package de sécurité qu’une réauthentification est souhaitée.

Les appelants en mode noyau présentent les différences suivantes : le nom cible est une chaîne Unicode qui doit être allouée en mémoire virtuelle à l’aide de VirtualAlloc ; il ne doit pas être alloué à partir du pool. Les mémoires tampons passées et fournies dans pInput et pOutput doivent être en mémoire virtuelle, et non dans le pool.

Configuration requise

Condition requise	Valeur
Client minimal pris en charge	Windows XP [applications de bureau uniquement]
Serveur minimal pris en charge	Windows Server 2003 [applications de bureau uniquement]
En-tête	Sspi.h (include Security.h)
Bibliothèque	Secur32.lib
DLL	Secur32.dll