ホーム › Security.Credentials › CredReadDomainCredentialsW

CredReadDomainCredentialsW

関数

対象情報に一致するドメイン資格情報を読み取る。

DLLADVAPI32.dll文字セットUnicode (-W)呼出規約winapiSetLastErrorあり対応OSWindows XP 以降

シグネチャ

// ADVAPI32.dll  (Unicode / -W)
#include <windows.h>

BOOL CredReadDomainCredentialsW(
    CREDENTIAL_TARGET_INFORMATIONW* TargetInfo,
    DWORD Flags,
    DWORD* Count,
    CREDENTIALW*** Credential
);

パラメーター

名前	型	方向	説明
TargetInfo	CREDENTIAL_TARGET_INFORMATIONW*	in	対象サーバーを識別するターゲット情報。次の名前指定メンバーのうち、少なくとも 1 つは NULL 以外でなければなりません。NetbiosServerName、DnsServerName、NetbiosDomainName、DnsDomainName、または DnsTreeName。
Flags	DWORD	in	関数の動作を制御するフラグ。次のフラグが定義されています。 CRED_CACHE_TARGET_INFORMATION CredGetTargetInfo による後続の読み取りに備えて TargetInfo をキャッシュします。
Count	DWORD*	out	Credentials 配列で返される資格情報の数。
Credential	CREDENTIALW***	out	資格情報へのポインターの配列を指すポインター。TargetInfo に一致する、最も具体的な既存の資格情報が返されます。複数の種類の資格情報(例: CRED_TYPE_DOMAIN_PASSWORD と CRED_TYPE_DOMAIN_CERTIFICATE の資格情報)が存在する場合は、各種類につき 1 つずつ返されます。指定したターゲットへの接続が行われる場合、この最も具体的な資格情報が使用されます。 TargetInfo.CredTypes 配列で指定された種類の資格情報のみが返されます。返される Credentials 配列は、TargetInfo.CredTypes 配列と同じ順序でソートされます。すなわち、認証パッケージは、優先する資格情報の種類を TargetInfo.CredTypes 配列内のより前の位置に指定することで指定します。TargetInfo.CredTypeCount が 0 の場合、Credentials 配列は次のソート順で返されます。 CRED_TYPE_DOMAIN_CERTIFICATE CRED_TYPE_DOMAIN_PASSWORD 返されるバッファーは、単一の割り当てられたブロックです。バッファー内に含まれるポインターは、この単一の割り当てられたブロック内の位置を指すポインターです。返された単一のバッファーは、CredFree を呼び出して解放する必要があります。

戻り値の型: BOOL

公式ドキュメント

ユーザーの資格情報セットからドメイン資格情報を読み取ります。(Unicode)

戻り値

この関数は、成功した場合は TRUE を、失敗した場合は FALSE を返します。より具体的なステータスコードを取得するには、GetLastError 関数を呼び出すことができます。次のステータスコードが返される可能性があります。

ERROR_INVALID_PARAMETER
名前指定パラメーターがいずれも指定されていません。
ERROR_NOT_FOUND
指定された名前指定パラメーターに一致する資格情報がありません。
ERROR_NO_SUCH_LOGON_SESSION
ログオンセッションが存在しないか、このログオンセッションに関連付けられた資格情報セットがありません。ネットワークログオンセッションには、関連付けられた資格情報セットがありません。
ERROR_INVALID_FLAGS
Flags パラメーターに無効なフラグが指定されました。

解説(Remarks)

この関数は、名前指定パラメーターに一致する、最も具体的な資格情報を返します。たとえば、対象サーバー名に一致する資格情報と対象ドメイン名に一致する資格情報の両方が存在する場合、サーバー固有の資格情報のみが返されます。これは、実際に使用される資格情報です。

次の一覧は、複数が一致する場合にどの資格情報が返されるかの順序(最も具体的なものから最も具体的でないものへ)を示しています。

資格情報のターゲット名が <DfsRoot>\<DfsShare> の形式であり、TargetName と完全に一致する。
DnsServerName との完全一致。
NetBIOSServerName との完全一致。
TargetName との完全一致。
DnsServerName がワイルドカードサーバー資格情報に一致する。複数のワイルドカードサーバー資格情報が一致する場合は、TargetName がより長い資格情報が使用されます。すなわち、*.microsoft.com の資格情報ではなく、*.example.microsoft.com の資格情報が使用されます。
DnsDomainName が <DnsDomainName>\* の形式のワイルドカードドメイン資格情報と完全に一致する。
NetBIOSDomainName が <NetBIOSDomainName>\* の形式のワイルドカードドメイン資格情報と完全に一致する。
CRED_SESSION_WILDCARD_NAME という名前の資格情報。
"*" という名前の資格情報。

CredReadDomainCredentials は、ドメイン(CRED_TYPE_DOMAIN_PASSWORD または CRED_TYPE_DOMAIN_CERTIFICATE)資格情報の特性を処理する点で CredRead と異なります。ドメイン資格情報には、複数のターゲットメンバーが含まれます。

Credentials パラメーターで指定された CREDENTIAL 構造体の Type メンバーの値が CRED_TYPE_DOMAIN_EXTENDED の場合、ターゲット名に名前空間を指定する必要があります。この関数は、指定された種類の資格情報を 1 つだけ返すことができます。

この関数はこの種類の資格情報を複数返すことができますが、CRED_TYPE_DOMAIN_EXTENDED は、TargetInfo パラメーターで指定された CREDENTIAL_TARGET_INFORMATION 構造体の CredTypes メンバー内で他の種類と混在させることはできません。

メモ

wincred.h ヘッダーは、CredReadDomainCredentials を、UNICODE プリプロセッサ定数の定義に基づいてこの関数の ANSI 版または Unicode 版を自動的に選択するエイリアスとして定義します。エンコード非依存のエイリアスの使用を、エンコード非依存ではないコードと混在させると、コンパイルエラーや実行時エラーを引き起こす不一致が発生する可能性があります。詳細については、「Conventions for Function Prototypes」を参照してください。

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

各言語での呼び出し定義

// ADVAPI32.dll  (Unicode / -W)
#include <windows.h>

BOOL CredReadDomainCredentialsW(
    CREDENTIAL_TARGET_INFORMATIONW* TargetInfo,
    DWORD Flags,
    DWORD* Count,
    CREDENTIALW*** Credential
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("ADVAPI32.dll", CharSet = CharSet.Unicode, SetLastError = true, ExactSpelling = true)]
static extern bool CredReadDomainCredentialsW(
    IntPtr TargetInfo,   // CREDENTIAL_TARGET_INFORMATIONW*
    uint Flags,   // DWORD
    out uint Count,   // DWORD* out
    IntPtr Credential   // CREDENTIALW*** out
);

<DllImport("ADVAPI32.dll", CharSet:=CharSet.Unicode, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function CredReadDomainCredentialsW(
    TargetInfo As IntPtr,   ' CREDENTIAL_TARGET_INFORMATIONW*
    Flags As UInteger,   ' DWORD
    <Out> ByRef Count As UInteger,   ' DWORD* out
    Credential As IntPtr   ' CREDENTIALW*** out
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function

' TargetInfo : CREDENTIAL_TARGET_INFORMATIONW*
' Flags : DWORD
' Count : DWORD* out
' Credential : CREDENTIALW*** out
Declare PtrSafe Function CredReadDomainCredentialsW Lib "advapi32" ( _
    ByVal TargetInfo As LongPtr, _
    ByVal Flags As Long, _
    ByRef Count As Long, _
    ByVal Credential As LongPtr) As Long
' Unicode(W): 文字列は ByVal As LongPtr とし StrPtr(unicodeStr) を渡す
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

CredReadDomainCredentialsW = ctypes.windll.advapi32.CredReadDomainCredentialsW
CredReadDomainCredentialsW.restype = wintypes.BOOL
CredReadDomainCredentialsW.argtypes = [
    ctypes.c_void_p,  # TargetInfo : CREDENTIAL_TARGET_INFORMATIONW*
    wintypes.DWORD,  # Flags : DWORD
    ctypes.POINTER(wintypes.DWORD),  # Count : DWORD* out
    ctypes.c_void_p,  # Credential : CREDENTIALW*** out
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('ADVAPI32.dll')
CredReadDomainCredentialsW = Fiddle::Function.new(
  lib['CredReadDomainCredentialsW'],
  [
    Fiddle::TYPE_VOIDP,  # TargetInfo : CREDENTIAL_TARGET_INFORMATIONW*
    -Fiddle::TYPE_INT,  # Flags : DWORD
    Fiddle::TYPE_VOIDP,  # Count : DWORD* out
    Fiddle::TYPE_VOIDP,  # Credential : CREDENTIALW*** out
  ],
  Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"

#[link(name = "advapi32")]
extern "system" {
    fn CredReadDomainCredentialsW(
        TargetInfo: *mut CREDENTIAL_TARGET_INFORMATIONW,  // CREDENTIAL_TARGET_INFORMATIONW*
        Flags: u32,  // DWORD
        Count: *mut u32,  // DWORD* out
        Credential: *mut *mut *mut CREDENTIALW  // CREDENTIALW*** out
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("ADVAPI32.dll", CharSet = CharSet.Unicode, SetLastError = true)]
public static extern bool CredReadDomainCredentialsW(IntPtr TargetInfo, uint Flags, out uint Count, IntPtr Credential);
"@
$api = Add-Type -MemberDefinition $sig -Name 'ADVAPI32_CredReadDomainCredentialsW' -Namespace Win32 -PassThru
# $api::CredReadDomainCredentialsW(TargetInfo, Flags, Count, Credential)

#uselib "ADVAPI32.dll"
#func global CredReadDomainCredentialsW "CredReadDomainCredentialsW" wptr, wptr, wptr, wptr
; CredReadDomainCredentialsW varptr(TargetInfo), Flags, varptr(Count), varptr(Credential)   ; 戻り値は stat
; TargetInfo : CREDENTIAL_TARGET_INFORMATIONW* -> "wptr"
; Flags : DWORD -> "wptr"
; Count : DWORD* out -> "wptr"
; Credential : CREDENTIALW*** out -> "wptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "ADVAPI32.dll"
#cfunc global CredReadDomainCredentialsW "CredReadDomainCredentialsW" var, int, var, var
; res = CredReadDomainCredentialsW(TargetInfo, Flags, Count, Credential)
; TargetInfo : CREDENTIAL_TARGET_INFORMATIONW* -> "var"
; Flags : DWORD -> "int"
; Count : DWORD* out -> "var"
; Credential : CREDENTIALW*** out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "ADVAPI32.dll"
#cfunc global CredReadDomainCredentialsW "CredReadDomainCredentialsW" sptr, int, sptr, sptr
; res = CredReadDomainCredentialsW(varptr(TargetInfo), Flags, varptr(Count), varptr(Credential))
; TargetInfo : CREDENTIAL_TARGET_INFORMATIONW* -> "sptr"
; Flags : DWORD -> "int"
; Count : DWORD* out -> "sptr"
; Credential : CREDENTIALW*** out -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。