ホーム › Security.Cryptography.Certificates › IX509AttributeClientId

IX509AttributeClientId

COMIDispatch (デュアル)

📘 Microsoft Learn (日本語) · English

✅ IDispatch を実装(デュアルインターフェース)。HSP では comobj 経由でメソッド名による遅延バインド呼び出しができます(vtableインデックス不要)。

IID728ab325-217d-11da-b2a4-000e7bbb2b09継承元IX509Attribute呼び出し名前(IDispatch) または vtbl自前メソッド開始 vtbl10

公式ドキュメント

証明書要求を生成したクライアントを識別するために使用できる属性を表します。

メソッド 6

vtbl = vtable インデックス(0始まり)。IDispatch 実装のため HSP ではメソッド名でも呼べます(上記)。低レベルの index 呼び出し用に vtbl も掲載。0〜2 は IUnknown。

vtbl 10 HRESULT InitializeEncode(RequestClientInfoClientId ClientId, LPWSTR strMachineDnsName, LPWSTR strUserSamName, LPWSTR strProcessName)

証明書要求を送信したユーザー、クライアントコンピューター、およびアプリケーションに関する情報から属性を初期化します。

ClientId	RequestClientInfoClientId	in	要求を作成したアプリケーションの種類を識別する RequestClientInfoClientId 列挙値です。例としては、自動登録(エンロール)サービス、コマンドライン要求ツール、カスタム要求アプリケーションなどがあります。
strMachineDnsName	LPWSTR	in	要求が作成されたコンピューターのドメインネームシステム(DNS)名を含む BSTR 変数です(例: `ComputerName.contoso.com`)。名前を指定しない場合、このメソッドは GetComputerNameEx 関数を呼び出します。名前が見つからない場合、このメソッドは失敗します。
strUserSamName	LPWSTR	in	ユーザーの Security Accounts Manager(SAM)名を DomainName\UserName の形式で含む BSTR 変数です。名前を指定しない場合、このメソッドは GetUserNameEx 関数を呼び出します。名前が見つからない場合、このメソッドは失敗します。
strProcessName	LPWSTR	in	証明書要求を作成したアプリケーションの名前を含む BSTR 変数です。名前を指定しない場合、このメソッドは GetCommandLine 関数を呼び出してコマンドラインを解析します。名前が見つからない場合、このメソッドは失敗します。

戻り値

関数が成功した場合、関数は S_OK を返します。

関数が失敗した場合、エラーを示す HRESULT 値を返します。一般的なエラーコードの一覧については、Common HRESULT Values を参照してください。

解説(Remarks)

この属性の object identifier(OID)は XCN_OID_REQUEST_CLIENT_INFO(1.3.6.1.4.1.311.21.20)です。詳細については、CERTENROLL_OBJECTID を参照してください。この属性は、Distinguished Encoding Rules(DER)を使用してエンコードされる Abstract Syntax Notation One(ASN.1)構造として作成されます。

IX509AttributeClientId オブジェクトを使用する前に、InitializeEncode または InitializeDecode のいずれかを呼び出す必要があります。この2つのメソッドは互いを補完し合います。InitializeEncode メソッドは生データからエンコード済みの ASN.1 構造を構築でき、InitializeDecode メソッドはエンコード済みの ASN.1 構造から生データを初期化できます。生データを取得するには、次のプロパティを呼び出すことができます。

vtbl 11 HRESULT InitializeDecode(EncodingType Encoding, LPWSTR strEncodedData)

属性値を含む Distinguished Encoding Rules(DER)エンコードされたバイト配列からオブジェクトを初期化します。(IX509AttributeClientId.InitializeDecode)

Encoding	EncodingType	in	入力文字列に適用される Unicode エンコードの種類を指定する EncodingType 列挙値です。
strEncodedData	LPWSTR	in	DER エンコードされた属性を含む BSTR 変数です。

戻り値

関数が成功した場合、関数は S_OK を返します。

関数が失敗した場合、エラーを示す HRESULT 値を返します。一般的なエラーコードの一覧については、Common HRESULT Values を参照してください。

解説(Remarks)

この属性の object identifier(OID)は XCN_OID_REQUEST_CLIENT_INFO(1.3.6.1.4.1.311.21.20)です。詳細については、CERTENROLL_OBJECTID を参照してください。

属性値を含む DER エンコードされた Abstract Syntax Notation One(ASN.1)オブジェクトがある場合に、このメソッドを使用できます。DER エンコードされたオブジェクトは Unicode エンコード文字列で指定する必要があります。詳細については、IBinaryConverter インターフェイスを参照してください。

InitializeEncode または InitializeDecode のいずれかを呼び出してからでないと、IX509AttributeClientId オブジェクトを使用できません。この2つのメソッドは互いを補完し合います。InitializeEncode メソッドは生データからエンコード済みの ASN.1 構造を構築でき、InitializeDecode メソッドはエンコード済みの ASN.1 構造から生データを初期化できます。生データを取得するには、次のプロパティを呼び出すことができます。

vtbl 12 HRESULT get_ClientId(RequestClientInfoClientId* pValue)

要求を生成したクライアントアプリケーションの種類を取得します。

pValue

RequestClientInfoClientId*

out

クライアントの種別を示す RequestClientInfoClientId 値を受け取る出力先である。

解説(Remarks)

ClientId 値を初期化するには、InitializeEncode メソッドまたは InitializeDecode メソッドを呼び出します。生データを取得するには、次のプロパティを呼び出すことができます。

vtbl 13 HRESULT get_MachineDnsName(LPWSTR* pValue)

要求を生成したコンピューターのドメインネームシステム(DNS)名を取得します。

pValue

LPWSTR*

out

クライアントコンピューターの DNS 名を受け取る出力先である。

解説(Remarks)

MachineDnsName 値を初期化するには、InitializeEncode メソッドまたは InitializeDecode メソッドを呼び出します。生データを取得するには、次のプロパティを呼び出すことができます。

vtbl 14 HRESULT get_UserSamName(LPWSTR* pValue)

ユーザーの Security Accounts Manager(SAM)名を取得します。

pValue

LPWSTR*

out

ユーザーの SAM アカウント名を受け取る出力先である。

解説(Remarks)

UserSamName 値を初期化するには、InitializeEncode メソッドまたは InitializeDecode メソッドを呼び出します。生データを取得するには、次のプロパティを呼び出すことができます。

vtbl 15 HRESULT get_ProcessName(LPWSTR* pValue)

要求を生成したアプリケーションの名前を取得します。

pValue

LPWSTR*

out

要求を発行したプロセス名を受け取る出力先である。

解説(Remarks)

ProcessName 値を初期化するには、InitializeEncode メソッドまたは InitializeDecode メソッドを呼び出します。生データを取得するには、次のプロパティを呼び出すことができます。

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

HSP用 COM定義

#usecom / #comfunc によるHSPのCOM呼び出し定義。数字は vtbl インデックス(0始まり)。クラスIDが無い場合 #usecom の末尾は "{}"、ある場合は "{CLSID}"。

出力引数:

#define global IID_IX509AttributeClientId "{728AB325-217D-11DA-B2A4-000E7BBB2B09}"
#usecom global IX509AttributeClientId IID_IX509AttributeClientId "{}"
#comfunc global IX509AttributeClientId_InitializeEncode    10 int,wstr,wstr,wstr
#comfunc global IX509AttributeClientId_InitializeDecode    11 int,wstr
#comfunc global IX509AttributeClientId_get_ClientId        12 var
#comfunc global IX509AttributeClientId_get_MachineDnsName  13 var
#comfunc global IX509AttributeClientId_get_UserSamName     14 var
#comfunc global IX509AttributeClientId_get_ProcessName     15 var
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数は var(変数直渡し)。varptr 方式にも切替可。
; ※IDispatch 実装。HSP では comobj 経由でメソッド名による呼び出しも可能(vtbl 不要)。#define global IID_IX509AttributeClientId "{728AB325-217D-11DA-B2A4-000E7BBB2B09}"
#usecom global IX509AttributeClientId IID_IX509AttributeClientId "{}"
#comfunc global IX509AttributeClientId_InitializeEncode    10 int,wstr,wstr,wstr
#comfunc global IX509AttributeClientId_InitializeDecode    11 int,wstr
#comfunc global IX509AttributeClientId_get_ClientId        12 sptr
#comfunc global IX509AttributeClientId_get_MachineDnsName  13 sptr
#comfunc global IX509AttributeClientId_get_UserSamName     14 sptr
#comfunc global IX509AttributeClientId_get_ProcessName     15 sptr
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。
; ※IDispatch 実装。HSP では comobj 経由でメソッド名による呼び出しも可能(vtbl 不要)。