ホーム › Networking.Ldap › ldap_start_tls_sA

ldap_start_tls_sA

関数

LDAP接続でTLSセッションを同期的に開始する(ANSI版)。

DLLWLDAP32.dll文字セットANSI (-A)呼出規約cdecl対応OSWindows Vista 以降

シグネチャ

// WLDAP32.dll  (ANSI / -A)
#include <windows.h>

DWORD ldap_start_tls_sA(
    LDAP* ExternalHandle,
    DWORD* ServerReturnValue,
    LDAPMessage** result,
    LDAPControlA** ServerControls,
    LDAPControlA** ClientControls
);

パラメーター

名前	型	方向	説明
ExternalHandle	LDAP*	inout	現在のセッションを表す LDAP 構造体へのポインターです。
ServerReturnValue	DWORD*	inout	省略可能です。サーバーのエラーコードが格納される可能性がある ULONG へのポインターです。戻り値として LDAP_OTHER が返された場合は、このパラメーターを確認してください。使用しない場合は NULL を渡します。
result	LDAPMessage**	inout	省略可能です。サーバーの参照(リファーラル)メッセージが格納される可能性がある LDAPMessage 構造体へのポインターのポインターです。使用しない場合は NULL を渡します。
ServerControls	LDAPControlA**	inout	省略可能です。サーバーコントロールを表す LDAPControl 構造体へのポインターの、NULL で終わる配列です。サーバーコントロールを指定しない場合は NULL を渡します。
ClientControls	LDAPControlA**	inout	省略可能です。クライアントコントロールを表す LDAPControl 構造体へのポインターの、NULL で終わる配列です。クライアントコントロールを指定しない場合は NULL を渡します。

戻り値の型: DWORD

公式ドキュメント

アクティブな LDAP セッションで TLS 暗号化の使用を開始するために使用します。(ANSI)

戻り値

関数の呼び出しに成功した場合は LDAP_SUCCESS が返されます。TLS/SSL セッションが既に進行中の場合、バインドが現在進行中の場合、または接続上に未処理の LDAP 要求がある場合は、LDAP_UNWILLING_TO_PERFORM が返されます。サーバーが拡張操作を拒否した場合は LDAP_OTHER が返されるので、ServerReturnValue パラメーターでサーバーのエラーコードを確認してください。

解説(Remarks)

ldap_start_tls_s 関数は、既存の LDAP セッションに対して TLS (SSL) 暗号化の使用を開始するために呼び出します。その接続では、TLS (SSL) 暗号化が既に有効になっていてはならず、署名 (signing) と封印 (sealing) のいずれも有効になっていてはなりません。また、その接続でバインドが現在進行中であってはならず、未処理の LDAP 要求が存在してもなりません。これらの条件が満たされない場合は、LDAP_UNWILLING_TO_PERFORM が返されます。条件が満たされている場合、この関数は TLS (SSL) を開始するための適切な拡張操作をサーバーに送信し、続いてサーバーとの間で暗号化のネゴシエーションを行います。サーバーが拡張操作を拒否した場合は LDAP_OTHER が返されるので、ServerReturnValue を確認してサーバーのエラーコードを取得してください。

この呼び出しに対して、サーバーが参照(リファーラル)を返す場合があります。セキュリティ上の理由から、その参照は自動的には追跡されません。参照メッセージへのポインターは result パラメーターで返されます。

ldap_start_tls_s を呼び出した後は、その接続で参照(リファーラル)の自動追跡と自動再接続が無効になります。これらは、ldap_stop_tls_s 操作が正常に完了した時点で、以前の設定に復元されます。

この関数の既定のタイムアウトは約 30 秒です。このタイムアウトは、Start TLS 拡張操作に対するサーバーからの応答を待機する間、および TLS (SSL) のネゴシエーション中に使用されます。

start-stop TLS 暗号化の詳細については、「Using Start-Stop TLS Encryption」を参照してください。

メモ

winldap.h ヘッダーは、UNICODE プリプロセッサ定数の定義に基づいて、この関数の ANSI 版または Unicode 版を自動的に選択するエイリアスとして ldap_start_tls_s を定義しています。エンコーディング中立のエイリアスの使用と、エンコーディング中立でないコードを混在させると、不一致が生じてコンパイルエラーや実行時エラーの原因となる場合があります。詳細については、「Conventions for Function Prototypes」を参照してください。

出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)

各言語での呼び出し定義

// WLDAP32.dll  (ANSI / -A)
#include <windows.h>

DWORD ldap_start_tls_sA(
    LDAP* ExternalHandle,
    DWORD* ServerReturnValue,
    LDAPMessage** result,
    LDAPControlA** ServerControls,
    LDAPControlA** ClientControls
);

[DllImport("WLDAP32.dll", CharSet = CharSet.Ansi, ExactSpelling = true, CallingConvention = CallingConvention.Cdecl)]
static extern uint ldap_start_tls_sA(
    IntPtr ExternalHandle,   // LDAP* in/out
    ref uint ServerReturnValue,   // DWORD* in/out
    IntPtr result,   // LDAPMessage** in/out
    IntPtr ServerControls,   // LDAPControlA** in/out
    IntPtr ClientControls   // LDAPControlA** in/out
);

<DllImport("WLDAP32.dll", CharSet:=CharSet.Ansi, ExactSpelling:=True, CallingConvention:=CallingConvention.Cdecl)>
Public Shared Function ldap_start_tls_sA(
    ExternalHandle As IntPtr,   ' LDAP* in/out
    ByRef ServerReturnValue As UInteger,   ' DWORD* in/out
    result As IntPtr,   ' LDAPMessage** in/out
    ServerControls As IntPtr,   ' LDAPControlA** in/out
    ClientControls As IntPtr   ' LDAPControlA** in/out
) As UInteger
End Function

' ExternalHandle : LDAP* in/out
' ServerReturnValue : DWORD* in/out
' result : LDAPMessage** in/out
' ServerControls : LDAPControlA** in/out
' ClientControls : LDAPControlA** in/out
Declare PtrSafe Function ldap_start_tls_sA Lib "wldap32" ( _
    ByVal ExternalHandle As LongPtr, _
    ByRef ServerReturnValue As Long, _
    ByVal result As LongPtr, _
    ByVal ServerControls As LongPtr, _
    ByVal ClientControls As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

ldap_start_tls_sA = ctypes.cdll.wldap32.ldap_start_tls_sA
ldap_start_tls_sA.restype = wintypes.DWORD
ldap_start_tls_sA.argtypes = [
    ctypes.c_void_p,  # ExternalHandle : LDAP* in/out
    ctypes.POINTER(wintypes.DWORD),  # ServerReturnValue : DWORD* in/out
    ctypes.c_void_p,  # result : LDAPMessage** in/out
    ctypes.c_void_p,  # ServerControls : LDAPControlA** in/out
    ctypes.c_void_p,  # ClientControls : LDAPControlA** in/out
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('WLDAP32.dll')
ldap_start_tls_sA = Fiddle::Function.new(
  lib['ldap_start_tls_sA'],
  [
    Fiddle::TYPE_VOIDP,  # ExternalHandle : LDAP* in/out
    Fiddle::TYPE_VOIDP,  # ServerReturnValue : DWORD* in/out
    Fiddle::TYPE_VOIDP,  # result : LDAPMessage** in/out
    Fiddle::TYPE_VOIDP,  # ServerControls : LDAPControlA** in/out
    Fiddle::TYPE_VOIDP,  # ClientControls : LDAPControlA** in/out
  ],
  -Fiddle::TYPE_INT, Fiddle::Function::CDECL)

#[link(name = "wldap32")]
extern "C" {
    fn ldap_start_tls_sA(
        ExternalHandle: *mut LDAP,  // LDAP* in/out
        ServerReturnValue: *mut u32,  // DWORD* in/out
        result: *mut *mut LDAPMessage,  // LDAPMessage** in/out
        ServerControls: *mut *mut LDAPControlA,  // LDAPControlA** in/out
        ClientControls: *mut *mut LDAPControlA  // LDAPControlA** in/out
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("WLDAP32.dll", CharSet = CharSet.Ansi, CallingConvention = CallingConvention.Cdecl)]
public static extern uint ldap_start_tls_sA(IntPtr ExternalHandle, ref uint ServerReturnValue, IntPtr result, IntPtr ServerControls, IntPtr ClientControls);
"@
$api = Add-Type -MemberDefinition $sig -Name 'WLDAP32_ldap_start_tls_sA' -Namespace Win32 -PassThru
# $api::ldap_start_tls_sA(ExternalHandle, ServerReturnValue, result, ServerControls, ClientControls)

#uselib "WLDAP32.dll"
#func global ldap_start_tls_sA "ldap_start_tls_sA" sptr, sptr, sptr, sptr, sptr
; ldap_start_tls_sA varptr(ExternalHandle), varptr(ServerReturnValue), varptr(result), varptr(ServerControls), varptr(ClientControls)   ; 戻り値は stat
; ExternalHandle : LDAP* in/out -> "sptr"
; ServerReturnValue : DWORD* in/out -> "sptr"
; result : LDAPMessage** in/out -> "sptr"
; ServerControls : LDAPControlA** in/out -> "sptr"
; ClientControls : LDAPControlA** in/out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "WLDAP32.dll"
#cfunc global ldap_start_tls_sA "ldap_start_tls_sA" var, var, var, var, var
; res = ldap_start_tls_sA(ExternalHandle, ServerReturnValue, result, ServerControls, ClientControls)
; ExternalHandle : LDAP* in/out -> "var"
; ServerReturnValue : DWORD* in/out -> "var"
; result : LDAPMessage** in/out -> "var"
; ServerControls : LDAPControlA** in/out -> "var"
; ClientControls : LDAPControlA** in/out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "WLDAP32.dll"
#cfunc global ldap_start_tls_sA "ldap_start_tls_sA" sptr, sptr, sptr, sptr, sptr
; res = ldap_start_tls_sA(varptr(ExternalHandle), varptr(ServerReturnValue), varptr(result), varptr(ServerControls), varptr(ClientControls))
; ExternalHandle : LDAP* in/out -> "sptr"
; ServerReturnValue : DWORD* in/out -> "sptr"
; result : LDAPMessage** in/out -> "sptr"
; ServerControls : LDAPControlA** in/out -> "sptr"
; ClientControls : LDAPControlA** in/out -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。