ホーム › Security.Credentials › CredPackAuthenticationBufferA

CredPackAuthenticationBufferA

関数

ユーザー名とパスワードを認証バッファにパックする。

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

シグネチャ

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

BOOL CredPackAuthenticationBufferA(
    CRED_PACK_FLAGS dwFlags,
    LPSTR pszUserName,
    LPSTR pszPassword,
    BYTE* pPackedCredentials,   // optional
    DWORD* pcbPackedCredentials
);

パラメーター

名前

型

方向

説明

dwFlags

CRED_PACK_FLAGS

資格情報をどのようにパックするかを指定します。次のフラグの組み合わせを指定できます。

値	意味
CRED_PACK_PROTECTED_CREDENTIALS	呼び出し元のログオンセッション内のプロセスのみが復号できるように資格情報を暗号化します。
CRED_PACK_WOW_BUFFER	WOW バッファー内で資格情報を暗号化します。
CRED_PACK_GENERIC_CREDENTIALS	CRED_GENERIC バッファー内で資格情報を暗号化します。
CRED_PACK_ID_PROVIDER_CREDENTIALS	オンライン ID の資格情報を SEC_WINNT_AUTH_IDENTITY_EX2 構造体に暗号化します。CRED_PACK_GENERIC_CREDENTIALS と CRED_PACK_ID_PROVIDER_CREDENTIALS のいずれも設定されていない場合は、KERB_INTERACTIVE_LOGON バッファー内で資格情報を暗号化します。 Windows 7、Windows Server 2008 R2、Windows Vista、Windows Server 2008: この値はサポートされていません。

pszUserName

LPSTR

変換するユーザー名を指定する null 終端文字列へのポインターです。ドメインユーザーの場合、文字列は次の形式である必要があります。

DomainName\UserName

オンライン ID の場合、資格情報がプレーンテキストのパスワードであれば、ユーザー名の形式は ProviderName\UserName です。資格情報が SEC_WINNT_AUTH_IDENTITY_EX2 構造体の場合、ユーザー名は SspiEncodeAuthIdentityAsStrings 関数の呼び出しによって出力される UserName パラメーターであるエンコードされた文字列です。

スマートカードまたは証明書の資格情報の場合、ユーザー名は CertCredential オプションを指定した CredMarshalCredential 関数の呼び出しによって出力されるエンコードされた文字列です。

Windows Server 2008 R2、Windows 7、Windows Server 2008、Windows Vista: オンライン ID はサポートされていません。

pszPassword

LPSTR

変換するパスワードを指定する null 終端文字列へのポインターです。

SEC_WINNT_AUTH_IDENTITY_EX2 資格情報の場合、パスワードは SspiEncodeAuthIdentityAsStrings 関数の呼び出しの ppszPackedCredentialsString 出力に含まれるエンコードされた文字列です。

スマートカードの資格情報の場合、これはスマートカードの PIN です。

Windows Server 2008 R2、Windows 7、Windows Server 2008、Windows Vista: オンライン ID はサポートされていません。

pPackedCredentials

BYTE*

outoptional

出力時にパックされた認証バッファーを受け取るバイト配列へのポインターです。このパラメーターを NULL にすると、必要なバッファーサイズを pcbPackedCredentials パラメーターで受け取ることができます。

pcbPackedCredentials

DWORD*

inout

pPackedCredentials バッファーのサイズ(バイト単位)を指定する DWORD 値へのポインターです。出力時、バッファーのサイズが十分でない場合は、pPackedCredentials バッファーに必要なサイズ(バイト単位)を指定します。

戻り値の型: BOOL

公式ドキュメント

文字列形式のユーザー名とパスワードを認証バッファーに変換します。(ANSI)

戻り値

関数が成功した場合は TRUE、それ以外の場合は FALSE を返します。

拡張エラー情報を取得するには、 GetLastError 関数を呼び出します。この関数は次のエラーコードを返すことがあります。

戻り値	説明
ERROR_INSUFFICIENT_BUFFER	pPackedCredentials によって提供されたバッファーが小さすぎます。

解説(Remarks)

メモ

wincred.h ヘッダーは、UNICODE プリプロセッサ定数の定義に基づいて、この関数の ANSI バージョンまたは Unicode バージョンを自動的に選択するエイリアスとして CredPackAuthenticationBuffer を定義します。エンコードに依存しないエイリアスと、エンコードに依存しないわけではないコードを混在させて使用すると、不一致が生じ、コンパイルエラーまたは実行時エラーを引き起こす可能性があります。詳細については、関数プロトタイプの規則を参照してください。

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

各言語での呼び出し定義

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

BOOL CredPackAuthenticationBufferA(
    CRED_PACK_FLAGS dwFlags,
    LPSTR pszUserName,
    LPSTR pszPassword,
    BYTE* pPackedCredentials,   // optional
    DWORD* pcbPackedCredentials
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("credui.dll", CharSet = CharSet.Ansi, SetLastError = true, ExactSpelling = true)]
static extern bool CredPackAuthenticationBufferA(
    uint dwFlags,   // CRED_PACK_FLAGS
    [MarshalAs(UnmanagedType.LPStr)] string pszUserName,   // LPSTR
    [MarshalAs(UnmanagedType.LPStr)] string pszPassword,   // LPSTR
    IntPtr pPackedCredentials,   // BYTE* optional, out
    ref uint pcbPackedCredentials   // DWORD* in/out
);

<DllImport("credui.dll", CharSet:=CharSet.Ansi, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function CredPackAuthenticationBufferA(
    dwFlags As UInteger,   ' CRED_PACK_FLAGS
    <MarshalAs(UnmanagedType.LPStr)> pszUserName As String,   ' LPSTR
    <MarshalAs(UnmanagedType.LPStr)> pszPassword As String,   ' LPSTR
    pPackedCredentials As IntPtr,   ' BYTE* optional, out
    ByRef pcbPackedCredentials As UInteger   ' DWORD* in/out
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function

' dwFlags : CRED_PACK_FLAGS
' pszUserName : LPSTR
' pszPassword : LPSTR
' pPackedCredentials : BYTE* optional, out
' pcbPackedCredentials : DWORD* in/out
Declare PtrSafe Function CredPackAuthenticationBufferA Lib "credui" ( _
    ByVal dwFlags As Long, _
    ByVal pszUserName As String, _
    ByVal pszPassword As String, _
    ByVal pPackedCredentials As LongPtr, _
    ByRef pcbPackedCredentials As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

CredPackAuthenticationBufferA = ctypes.windll.credui.CredPackAuthenticationBufferA
CredPackAuthenticationBufferA.restype = wintypes.BOOL
CredPackAuthenticationBufferA.argtypes = [
    wintypes.DWORD,  # dwFlags : CRED_PACK_FLAGS
    wintypes.LPCSTR,  # pszUserName : LPSTR
    wintypes.LPCSTR,  # pszPassword : LPSTR
    ctypes.POINTER(ctypes.c_ubyte),  # pPackedCredentials : BYTE* optional, out
    ctypes.POINTER(wintypes.DWORD),  # pcbPackedCredentials : DWORD* in/out
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('credui.dll')
CredPackAuthenticationBufferA = Fiddle::Function.new(
  lib['CredPackAuthenticationBufferA'],
  [
    -Fiddle::TYPE_INT,  # dwFlags : CRED_PACK_FLAGS
    Fiddle::TYPE_VOIDP,  # pszUserName : LPSTR
    Fiddle::TYPE_VOIDP,  # pszPassword : LPSTR
    Fiddle::TYPE_VOIDP,  # pPackedCredentials : BYTE* optional, out
    Fiddle::TYPE_VOIDP,  # pcbPackedCredentials : DWORD* in/out
  ],
  Fiddle::TYPE_INT)

#[link(name = "credui")]
extern "system" {
    fn CredPackAuthenticationBufferA(
        dwFlags: u32,  // CRED_PACK_FLAGS
        pszUserName: *mut u8,  // LPSTR
        pszPassword: *mut u8,  // LPSTR
        pPackedCredentials: *mut u8,  // BYTE* optional, out
        pcbPackedCredentials: *mut u32  // DWORD* in/out
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("credui.dll", CharSet = CharSet.Ansi, SetLastError = true)]
public static extern bool CredPackAuthenticationBufferA(uint dwFlags, [MarshalAs(UnmanagedType.LPStr)] string pszUserName, [MarshalAs(UnmanagedType.LPStr)] string pszPassword, IntPtr pPackedCredentials, ref uint pcbPackedCredentials);
"@
$api = Add-Type -MemberDefinition $sig -Name 'credui_CredPackAuthenticationBufferA' -Namespace Win32 -PassThru
# $api::CredPackAuthenticationBufferA(dwFlags, pszUserName, pszPassword, pPackedCredentials, pcbPackedCredentials)

#uselib "credui.dll"
#func global CredPackAuthenticationBufferA "CredPackAuthenticationBufferA" sptr, sptr, sptr, sptr, sptr
; CredPackAuthenticationBufferA dwFlags, pszUserName, pszPassword, varptr(pPackedCredentials), varptr(pcbPackedCredentials)   ; 戻り値は stat
; dwFlags : CRED_PACK_FLAGS -> "sptr"
; pszUserName : LPSTR -> "sptr"
; pszPassword : LPSTR -> "sptr"
; pPackedCredentials : BYTE* optional, out -> "sptr"
; pcbPackedCredentials : DWORD* in/out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "credui.dll"
#cfunc global CredPackAuthenticationBufferA "CredPackAuthenticationBufferA" int, str, str, var, var
; res = CredPackAuthenticationBufferA(dwFlags, pszUserName, pszPassword, pPackedCredentials, pcbPackedCredentials)
; dwFlags : CRED_PACK_FLAGS -> "int"
; pszUserName : LPSTR -> "str"
; pszPassword : LPSTR -> "str"
; pPackedCredentials : BYTE* optional, out -> "var"
; pcbPackedCredentials : DWORD* in/out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "credui.dll"
#cfunc global CredPackAuthenticationBufferA "CredPackAuthenticationBufferA" int, str, str, sptr, sptr
; res = CredPackAuthenticationBufferA(dwFlags, pszUserName, pszPassword, varptr(pPackedCredentials), varptr(pcbPackedCredentials))
; dwFlags : CRED_PACK_FLAGS -> "int"
; pszUserName : LPSTR -> "str"
; pszPassword : LPSTR -> "str"
; pPackedCredentials : BYTE* optional, out -> "sptr"
; pcbPackedCredentials : DWORD* in/out -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。