ホーム › Security.Credentials › CredReadDomainCredentialsA

CredReadDomainCredentialsA

関数

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

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

シグネチャ

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

BOOL CredReadDomainCredentialsA(
    CREDENTIAL_TARGET_INFORMATIONA* TargetInfo,
    DWORD Flags,
    DWORD* Count,
    CREDENTIALA*** Credential
);

パラメーター

名前	型	方向	説明
TargetInfo	CREDENTIAL_TARGET_INFORMATIONA*	in	対象サーバーを識別するターゲット情報。少なくとも 1 つの名前指定メンバーが NULL 以外である必要があります。NetbiosServerName、DnsServerName、NetbiosDomainName、DnsDomainName、DnsTreeName のいずれかです。
Flags	DWORD	in	関数の動作を制御するフラグです。以下のフラグが定義されています。 CRED_CACHE_TARGET_INFORMATION CredGetTargetInfo を使用した後続の読み取りのために、TargetInfo をキャッシュします。
Count	DWORD*	out	Credentials 配列で返される資格情報の数です。
Credential	CREDENTIALA***	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

公式ドキュメント

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

戻り値

この関数は、成功した場合は 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 ヘッダーは、UNICODE プリプロセッサ定数の定義に基づいて、この関数の ANSI 版または Unicode 版を自動的に選択するエイリアスとして CredReadDomainCredentials を定義します。エンコーディング非依存のエイリアスの使用を、エンコーディング非依存でないコードと混在させると、不一致が生じ、コンパイルエラーまたは実行時エラーを引き起こす可能性があります。詳細については、関数プロトタイプの規則を参照してください。

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

各言語での呼び出し定義

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

BOOL CredReadDomainCredentialsA(
    CREDENTIAL_TARGET_INFORMATIONA* TargetInfo,
    DWORD Flags,
    DWORD* Count,
    CREDENTIALA*** Credential
);

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

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

' TargetInfo : CREDENTIAL_TARGET_INFORMATIONA*
' Flags : DWORD
' Count : DWORD* out
' Credential : CREDENTIALA*** out
Declare PtrSafe Function CredReadDomainCredentialsA Lib "advapi32" ( _
    ByVal TargetInfo As LongPtr, _
    ByVal Flags As Long, _
    ByRef Count As Long, _
    ByVal Credential As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

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

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('ADVAPI32.dll')
CredReadDomainCredentialsA = Fiddle::Function.new(
  lib['CredReadDomainCredentialsA'],
  [
    Fiddle::TYPE_VOIDP,  # TargetInfo : CREDENTIAL_TARGET_INFORMATIONA*
    -Fiddle::TYPE_INT,  # Flags : DWORD
    Fiddle::TYPE_VOIDP,  # Count : DWORD* out
    Fiddle::TYPE_VOIDP,  # Credential : CREDENTIALA*** out
  ],
  Fiddle::TYPE_INT)

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

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

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

出力引数:

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