SaslInitializeSecurityContextW 関数 (sspi.h)
SaslInitializeSecurityContext 関数は、セキュリティ サポート プロバイダー インターフェイスInitializeSecurityContext (General) 関数の標準呼び出しをラップし、サーバーからの SASL サーバー Cookie を処理します。
構文
SECURITY_STATUS SEC_ENTRY SaslInitializeSecurityContextW(
[in] PCredHandle phCredential,
[in] PCtxtHandle phContext,
[in] LPWSTR pszTargetName,
[in] unsigned long fContextReq,
[in] unsigned long Reserved1,
[in] unsigned long TargetDataRep,
[in] PSecBufferDesc pInput,
[in] unsigned long Reserved2,
[out] PCtxtHandle phNewContext,
[in, out] PSecBufferDesc pOutput,
[out] unsigned long *pfContextAttr,
[out, optional] PTimeStamp ptsExpiry
);
パラメーター
[in] phCredential
によって返される 資格情報の ハンドル。
セキュリティ コンテキストの構築に使用される AcquireCredentialsHandle 関数。 SaslInitializeSecurityContext 関数を使用するには、少なくとも OUTBOUND 資格情報が必要です。
[in] phContext
CtxtHandle 構造体へのポインター。 SaslInitializeSecurityContext 関数の最初の呼び出しでは、このポインターは NULL です。 2 番目の呼び出しでは、このパラメーターは、最初の呼び出しによって phNewContext パラメーターで返される部分的に形成されたコンテキストへのハンドルへのポインターです。
[in] pszTargetName
コンテキストのターゲットを示す Unicode または ANSI 文字列へのポインター。
[in] fContextReq
コンテキストの要件を示すビット フラグ。 このパラメーターに使用されるフラグの前には、ISC_REQ_が付いています。例: ISC_REQ_DELEGATE。 次の属性フラグの組み合わせを指定します。
さまざまな属性の詳細については、「 コンテキスト要件」を参照してください。
[in] Reserved1
予約値。は 0 である必要があります。
[in] TargetDataRep
ターゲットのバイト順序などのデータ表現を示します。 SECURITY_NATIVE_DREPまたはSECURITY_NETWORK_DREPを指定できます。
[in] pInput
パッケージへの入力として指定されたバッファーへのポインターを含む SecBufferDesc 構造体へのポインター。 ポインターは、関数の最初の呼び出しで NULL である必要があります。 以降の関数の呼び出しでは、リモート ピアによって返されるトークンを保持するのに十分なメモリが割り当てられたバッファーへのポインターです。
SASL には、サーバーから受け取ったチャレンジを含む SECBUFFER_TOKEN 型のバッファーが 1 つ必要です。
[in] Reserved2
予約値。は 0 である必要があります。
[out] phNewContext
CtxtHandle 構造体へのポインター。 SaslInitializeSecurityContext 関数の最初の呼び出しで、このポインターは新しいコンテキスト ハンドルを受け取ります。 2 番目の呼び出しでは、 phNewContext は phContext パラメーターで指定されたハンドルと同じにすることができます。
[in, out] pOutput
出力データを受信する SecBuffer 構造体へのポインターを含む SecBufferDesc 構造体へのポインター。 バッファーが入力にSEC_READWRITEとして入力された場合は、出力時にそのバッファーが存在します。 システムは、要求された場合 (ISC_REQ_ALLOCATE_MEMORYを介して) セキュリティ トークンのバッファーを割り当て、セキュリティ トークンのバッファー記述子のアドレスを入力します。
[out] pfContextAttr
確立されたコンテキストの属性を示すビット フラグのセットを受け取る変数へのポインター。 さまざまな属性の説明については、「 コンテキスト要件」を参照してください。
このパラメーターに使用されるフラグには、ISC_RET_DELEGATEなどのISC_RET_がプレフィックスとして付けられます。
有効な値の一覧については、 fContextReq パラメーターを参照してください。
最終的な関数呼び出しが正常に返されるまで、セキュリティ関連の属性をチェックしないでください。 セキュリティに関連しない属性フラグ (ASC_RET_ALLOCATED_MEMORY フラグなど) は、最終的な戻り値の前に確認できます。
[out, optional] ptsExpiry
コンテキストの有効期限を受け取る TimeStamp 構造体へのポインター。 セキュリティ パッケージでは、常にローカル時刻にこの値を返すようにお勧めします。 このパラメーターは省略可能であり、有効期間の短いクライアントには NULL を渡す必要があります。
戻り値
呼び出しが正常に完了すると、この関数はSEC_E_OKを返します。 次の表は、考えられるエラーの戻り値を示しています。
リターン コード | 説明 |
---|---|
|
認証処理は許可されていません。 |
|
要求を完了するのに十分なメモリがありません。 |
|
pOutput パラメーターにトークン バッファーが存在しないか、メッセージの暗号化を解除できませんでした。 |
注釈
注意
sspi.h ヘッダーは、SASlInitializeSecurityContext をエイリアスとして定義し、UNICODE プリプロセッサ定数の定義に基づいて、この関数の ANSI または Unicode バージョンを自動的に選択します。 エンコードに依存しないエイリアスをエンコードニュートラルでないコードと組み合わせて使用すると、コンパイルまたはランタイム エラーが発生する不一致が発生する可能性があります。 詳細については、「 関数プロトタイプの規則」を参照してください。
要件
要件 | 値 |
---|---|
サポートされている最小のクライアント | サポートなし |
サポートされている最小のサーバー | Windows Server 2003 (デスクトップ アプリのみ) |
対象プラットフォーム | Windows |
ヘッダー | sspi.h (Security.h を含む) |
Library | Secur32.lib |
[DLL] | Secur32.dll |