ホーム › System.Rpc › RpcBindingSetAuthInfoExA

RpcBindingSetAuthInfoExA

関数

RPCバインディングハンドルに認証・認可情報とセキュリティQOSを設定する(ANSI版)。

DLLRPCRT4.dll文字セットANSI (-A)呼出規約winapi対応OSWindows 2000 以降

シグネチャ

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

RPC_STATUS RpcBindingSetAuthInfoExA(
    void* Binding,
    LPSTR ServerPrincName,   // optional
    DWORD AuthnLevel,
    DWORD AuthnSvc,
    void* AuthIdentity,   // optional
    DWORD AuthzSvc,
    RPC_SECURITY_QOS* SecurityQos   // optional
);

パラメーター

名前	型	方向	説明
Binding	void*	in	認証情報と承認情報の設定先となるサーバーバインディングハンドル。
ServerPrincName	LPSTR	inoptional	Binding が参照するサーバーについて、想定されるプリンシパル名へのポインター。名前の内容とその構文は、使用する認証サービスによって定義されます。メモ SSP に指定できるターゲット名の一覧については、InitializeSecurityContext のドキュメントにあるコメントを参照してください。
AuthnLevel	DWORD	in	Binding を使用して行うリモートプロシージャコールに対して実行される認証のレベル。RPC がサポートする認証レベルの一覧については、 Authentication-Level Constants を参照してください。
AuthnSvc	DWORD	in	使用する認証サービス。 Binding を使用して行うリモートプロシージャコールの認証を無効にするには、RPC_C_AUTHN_NONE を指定します。 RPC_C_AUTHN_DEFAULT を指定した場合、RPC ランタイムライブラリは、Binding を使用して行うリモートプロシージャコールに RPC_C_AUTHN_WINNT 認証サービスを使用します。
AuthIdentity	void*	inoptional	選択した認証サービスおよび承認サービスに対応する、クライアントの認証資格情報と承認資格情報を格納する構造体のハンドル。 RPC_C_AUTHN_WINNT 認証サービスを使用する場合、AuthIdentity は SEC_WINNT_AUTH_IDENTITY 構造体 (Rpcdce.h で定義) へのポインターである必要があります。Kerberos および Negotiate 認証サービスも SEC_WINNT_AUTH_IDENTITY 構造体を使用します。現在のアドレス空間のセキュリティログインコンテキストを使用するには、null 値を指定します。匿名のログインコンテキストを使用するには、値 RPC_C_NO_CREDENTIALS を渡します。RPC_C_NO_CREDENTIALS が有効なのは、認証サービスとして RPC_C_AUTHN_GSS_SCHANNEL を選択した場合のみである点に注意してください。
AuthzSvc	DWORD	in	対象のインターフェイスについてサーバーが実装している承認サービス。承認データの有効性と信頼性は、他のアプリケーションデータと同様に、選択した認証サービスと認証レベルに依存します。RPC_C_AUTHN_WINNT 認証サービスを使用する場合、このパラメーターは無視されます。メモを参照してください。
SecurityQos	RPC_SECURITY_QOS*	inoptional	セキュリティのサービス品質を定義する RPC_SECURITY_QOS 構造体へのポインター。メモ RPC がサポートする認証サービスの一覧については、 Authentication-Service Constants を参照してください。

戻り値の型: RPC_STATUS

公式ドキュメント

RpcBindingSetAuthInfoEx 関数は、バインディングハンドルに認証、承認、およびセキュリティのサービス品質 (quality of service) の情報を設定します。(ANSI)

戻り値

値	意味
RPC_S_OK	呼び出しに成功しました。
RPC_S_INVALID_BINDING	バインディングハンドルが無効でした。
RPC_S_WRONG_KIND_OF_BINDING	この操作に対して不適切な種類のバインディングでした。
RPC_S_UNKNOWN_AUTHN_SERVICE	不明な認証サービスです。

メモ有効なエラーコードの一覧については、 RPC Return Values を参照してください。

解説(Remarks)

クライアントアプリケーションは、認証されたリモートプロシージャコールを行うためのサーバーバインディングハンドルを設定するために RpcBindingSetAuthInfoEx 関数を呼び出します。この関数は、バインディングハンドルにセキュリティのサービス品質情報を設定する機能を提供します。それ以外の点では RpcBindingSetAuthInfo と同一です。

クライアントが RpcBindingSetAuthInfoEx を呼び出さない限り、Binding 上のすべてのリモートプロシージャコールは認証されません。クライアントがこの関数を呼び出すことは必須ではありません。

RpcBindingSetAuthInfoEx 関数は資格情報のスナップショットを取得します。そのため、AuthIdentity パラメーターに割り当てたメモリは、バインディングハンドルよりも先に解放できます。ただし、アプリケーションが RpcBindingSetAuthInfoEx を RPC_C_QOS_IDENTITY_DYNAMIC と共に使用し、かつ AuthIdentity に NULL 以外の値を指定する場合は例外です。

メモ同じバインディングハンドル上で RPC 呼び出しが進行中の間は、そのハンドルに対して RpcBindingSetAuthInfo 関数を呼び出してはいけません。呼び出した場合の結果は未定義です。

Microsoft RPC のバージョンによって要件が異なるため、Microsoft はバインディングハンドルが存在する間、アプリケーションが AuthIdentity パラメーターへのポインターを保持し続けることを推奨しています。そうすることでアプリケーションの移植性が高まります。

Windows Server 2003 with SP1 および Windows XP with SP2: Windows XP SP2 および Windows Server 2003 SP1 では、AuthIdentity パラメーターへのポインターをバインディングハンドルの有効期間中保持する必要はありません。このポインターを保持する必要があるのは、その後に RpcBindingInqAuthInfo または RpcBindingInqAuthInfoEx を呼び出す場合だけです。

メモ ncalrpc プロトコルシーケンスは RPC_C_AUTHN_WINNT のみをサポートしますが、相互認証はサポートしています。相互認証を行うには、SPN を指定し、SecurityQOS パラメーターを通じて相互認証を要求してください。

メモ

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

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

各言語での呼び出し定義

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

RPC_STATUS RpcBindingSetAuthInfoExA(
    void* Binding,
    LPSTR ServerPrincName,   // optional
    DWORD AuthnLevel,
    DWORD AuthnSvc,
    void* AuthIdentity,   // optional
    DWORD AuthzSvc,
    RPC_SECURITY_QOS* SecurityQos   // optional
);

[DllImport("RPCRT4.dll", CharSet = CharSet.Ansi, ExactSpelling = true)]
static extern int RpcBindingSetAuthInfoExA(
    IntPtr Binding,   // void*
    [MarshalAs(UnmanagedType.LPStr)] string ServerPrincName,   // LPSTR optional
    uint AuthnLevel,   // DWORD
    uint AuthnSvc,   // DWORD
    IntPtr AuthIdentity,   // void* optional
    uint AuthzSvc,   // DWORD
    IntPtr SecurityQos   // RPC_SECURITY_QOS* optional
);

<DllImport("RPCRT4.dll", CharSet:=CharSet.Ansi, ExactSpelling:=True)>
Public Shared Function RpcBindingSetAuthInfoExA(
    Binding As IntPtr,   ' void*
    <MarshalAs(UnmanagedType.LPStr)> ServerPrincName As String,   ' LPSTR optional
    AuthnLevel As UInteger,   ' DWORD
    AuthnSvc As UInteger,   ' DWORD
    AuthIdentity As IntPtr,   ' void* optional
    AuthzSvc As UInteger,   ' DWORD
    SecurityQos As IntPtr   ' RPC_SECURITY_QOS* optional
) As Integer
End Function

' Binding : void*
' ServerPrincName : LPSTR optional
' AuthnLevel : DWORD
' AuthnSvc : DWORD
' AuthIdentity : void* optional
' AuthzSvc : DWORD
' SecurityQos : RPC_SECURITY_QOS* optional
Declare PtrSafe Function RpcBindingSetAuthInfoExA Lib "rpcrt4" ( _
    ByVal Binding As LongPtr, _
    ByVal ServerPrincName As String, _
    ByVal AuthnLevel As Long, _
    ByVal AuthnSvc As Long, _
    ByVal AuthIdentity As LongPtr, _
    ByVal AuthzSvc As Long, _
    ByVal SecurityQos As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

RpcBindingSetAuthInfoExA = ctypes.windll.rpcrt4.RpcBindingSetAuthInfoExA
RpcBindingSetAuthInfoExA.restype = ctypes.c_int
RpcBindingSetAuthInfoExA.argtypes = [
    ctypes.POINTER(None),  # Binding : void*
    wintypes.LPCSTR,  # ServerPrincName : LPSTR optional
    wintypes.DWORD,  # AuthnLevel : DWORD
    wintypes.DWORD,  # AuthnSvc : DWORD
    ctypes.POINTER(None),  # AuthIdentity : void* optional
    wintypes.DWORD,  # AuthzSvc : DWORD
    ctypes.c_void_p,  # SecurityQos : RPC_SECURITY_QOS* optional
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('RPCRT4.dll')
RpcBindingSetAuthInfoExA = Fiddle::Function.new(
  lib['RpcBindingSetAuthInfoExA'],
  [
    Fiddle::TYPE_VOIDP,  # Binding : void*
    Fiddle::TYPE_VOIDP,  # ServerPrincName : LPSTR optional
    -Fiddle::TYPE_INT,  # AuthnLevel : DWORD
    -Fiddle::TYPE_INT,  # AuthnSvc : DWORD
    Fiddle::TYPE_VOIDP,  # AuthIdentity : void* optional
    -Fiddle::TYPE_INT,  # AuthzSvc : DWORD
    Fiddle::TYPE_VOIDP,  # SecurityQos : RPC_SECURITY_QOS* optional
  ],
  Fiddle::TYPE_INT)

#[link(name = "rpcrt4")]
extern "system" {
    fn RpcBindingSetAuthInfoExA(
        Binding: *mut (),  // void*
        ServerPrincName: *mut u8,  // LPSTR optional
        AuthnLevel: u32,  // DWORD
        AuthnSvc: u32,  // DWORD
        AuthIdentity: *mut (),  // void* optional
        AuthzSvc: u32,  // DWORD
        SecurityQos: *mut RPC_SECURITY_QOS  // RPC_SECURITY_QOS* optional
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("RPCRT4.dll", CharSet = CharSet.Ansi)]
public static extern int RpcBindingSetAuthInfoExA(IntPtr Binding, [MarshalAs(UnmanagedType.LPStr)] string ServerPrincName, uint AuthnLevel, uint AuthnSvc, IntPtr AuthIdentity, uint AuthzSvc, IntPtr SecurityQos);
"@
$api = Add-Type -MemberDefinition $sig -Name 'RPCRT4_RpcBindingSetAuthInfoExA' -Namespace Win32 -PassThru
# $api::RpcBindingSetAuthInfoExA(Binding, ServerPrincName, AuthnLevel, AuthnSvc, AuthIdentity, AuthzSvc, SecurityQos)

#uselib "RPCRT4.dll"
#func global RpcBindingSetAuthInfoExA "RpcBindingSetAuthInfoExA" sptr, sptr, sptr, sptr, sptr, sptr, sptr
; RpcBindingSetAuthInfoExA Binding, ServerPrincName, AuthnLevel, AuthnSvc, AuthIdentity, AuthzSvc, varptr(SecurityQos)   ; 戻り値は stat
; Binding : void* -> "sptr"
; ServerPrincName : LPSTR optional -> "sptr"
; AuthnLevel : DWORD -> "sptr"
; AuthnSvc : DWORD -> "sptr"
; AuthIdentity : void* optional -> "sptr"
; AuthzSvc : DWORD -> "sptr"
; SecurityQos : RPC_SECURITY_QOS* optional -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "RPCRT4.dll"
#cfunc global RpcBindingSetAuthInfoExA "RpcBindingSetAuthInfoExA" sptr, str, int, int, sptr, int, var
; res = RpcBindingSetAuthInfoExA(Binding, ServerPrincName, AuthnLevel, AuthnSvc, AuthIdentity, AuthzSvc, SecurityQos)
; Binding : void* -> "sptr"
; ServerPrincName : LPSTR optional -> "str"
; AuthnLevel : DWORD -> "int"
; AuthnSvc : DWORD -> "int"
; AuthIdentity : void* optional -> "sptr"
; AuthzSvc : DWORD -> "int"
; SecurityQos : RPC_SECURITY_QOS* optional -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "RPCRT4.dll"
#cfunc global RpcBindingSetAuthInfoExA "RpcBindingSetAuthInfoExA" sptr, str, int, int, sptr, int, sptr
; res = RpcBindingSetAuthInfoExA(Binding, ServerPrincName, AuthnLevel, AuthnSvc, AuthIdentity, AuthzSvc, varptr(SecurityQos))
; Binding : void* -> "sptr"
; ServerPrincName : LPSTR optional -> "str"
; AuthnLevel : DWORD -> "int"
; AuthnSvc : DWORD -> "int"
; AuthIdentity : void* optional -> "sptr"
; AuthzSvc : DWORD -> "int"
; SecurityQos : RPC_SECURITY_QOS* optional -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。