ホーム › Security.Credentials › CredProtectA

CredProtectA

関数

資格情報文字列を暗号化して保護する。

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

シグネチャ

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

BOOL CredProtectA(
    BOOL fAsSelf,
    LPSTR pszCredentials,
    DWORD cchCredentials,
    LPSTR pszProtectedCredentials,
    DWORD* pcchMaxChars,
    CRED_PROTECTION_TYPE* ProtectionType   // optional
);

パラメーター

名前	型	方向	説明
fAsSelf	BOOL	in	資格情報を現在のプロセスのセキュリティコンテキストで暗号化することを指定するには TRUE を設定します。資格情報を呼び出し元スレッドのセキュリティコンテキストで暗号化することを指定するには FALSE を設定します。
pszCredentials	LPSTR	in	暗号化する資格情報を指定する文字列へのポインターです。この関数は cchCredentials パラメーターで指定された文字数を暗号化します。
cchCredentials	DWORD	in	pszCredentials バッファーのサイズ(文字数)です。
pszProtectedCredentials	LPSTR	out	出力時に、暗号化された資格情報を受け取る文字列へのポインターです。
pcchMaxChars	DWORD*	inout	pszProtectedCredentials バッファーのサイズ(文字数)です。出力時に、pszProtectedCredentials が暗号化された資格情報を受け取るのに十分なサイズでない場合、このパラメーターは pszProtectedCredentials バッファーに必要なサイズ(文字数)を指定します。
ProtectionType	CRED_PROTECTION_TYPE*	outoptional	出力時に、提供される保護の種類を指定する CRED_PROTECTION_TYPE 列挙型へのポインターです。

戻り値の型: BOOL

公式ドキュメント

指定された資格情報を、現在のセキュリティコンテキストのみが復号できるように暗号化します。(ANSI)

戻り値

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

拡張エラー情報を取得するには、 GetLastError 関数を呼び出してください。

解説(Remarks)

CredProtect 関数の出力は整合性が保護されていない点に注意してください。そのため、出力が変更された場合でも CredUnprotect 関数は更新されず、誤った結果を生成する可能性があります。

メモ

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

出典・ライセンス: 上記「公式ドキュメント」の内容は 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 CredProtectA(
    BOOL fAsSelf,
    LPSTR pszCredentials,
    DWORD cchCredentials,
    LPSTR pszProtectedCredentials,
    DWORD* pcchMaxChars,
    CRED_PROTECTION_TYPE* ProtectionType   // optional
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("ADVAPI32.dll", CharSet = CharSet.Ansi, SetLastError = true, ExactSpelling = true)]
static extern bool CredProtectA(
    bool fAsSelf,   // BOOL
    [MarshalAs(UnmanagedType.LPStr)] string pszCredentials,   // LPSTR
    uint cchCredentials,   // DWORD
    [MarshalAs(UnmanagedType.LPStr)] System.Text.StringBuilder pszProtectedCredentials,   // LPSTR out
    ref uint pcchMaxChars,   // DWORD* in/out
    IntPtr ProtectionType   // CRED_PROTECTION_TYPE* optional, out
);

<DllImport("ADVAPI32.dll", CharSet:=CharSet.Ansi, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function CredProtectA(
    fAsSelf As Boolean,   ' BOOL
    <MarshalAs(UnmanagedType.LPStr)> pszCredentials As String,   ' LPSTR
    cchCredentials As UInteger,   ' DWORD
    <MarshalAs(UnmanagedType.LPStr)> pszProtectedCredentials As System.Text.StringBuilder,   ' LPSTR out
    ByRef pcchMaxChars As UInteger,   ' DWORD* in/out
    ProtectionType As IntPtr   ' CRED_PROTECTION_TYPE* optional, out
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function

' fAsSelf : BOOL
' pszCredentials : LPSTR
' cchCredentials : DWORD
' pszProtectedCredentials : LPSTR out
' pcchMaxChars : DWORD* in/out
' ProtectionType : CRED_PROTECTION_TYPE* optional, out
Declare PtrSafe Function CredProtectA Lib "advapi32" ( _
    ByVal fAsSelf As Long, _
    ByVal pszCredentials As String, _
    ByVal cchCredentials As Long, _
    ByVal pszProtectedCredentials As String, _
    ByRef pcchMaxChars As Long, _
    ByVal ProtectionType As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

CredProtectA = ctypes.windll.advapi32.CredProtectA
CredProtectA.restype = wintypes.BOOL
CredProtectA.argtypes = [
    wintypes.BOOL,  # fAsSelf : BOOL
    wintypes.LPCSTR,  # pszCredentials : LPSTR
    wintypes.DWORD,  # cchCredentials : DWORD
    wintypes.LPSTR,  # pszProtectedCredentials : LPSTR out
    ctypes.POINTER(wintypes.DWORD),  # pcchMaxChars : DWORD* in/out
    ctypes.c_void_p,  # ProtectionType : CRED_PROTECTION_TYPE* optional, out
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('ADVAPI32.dll')
CredProtectA = Fiddle::Function.new(
  lib['CredProtectA'],
  [
    Fiddle::TYPE_INT,  # fAsSelf : BOOL
    Fiddle::TYPE_VOIDP,  # pszCredentials : LPSTR
    -Fiddle::TYPE_INT,  # cchCredentials : DWORD
    Fiddle::TYPE_VOIDP,  # pszProtectedCredentials : LPSTR out
    Fiddle::TYPE_VOIDP,  # pcchMaxChars : DWORD* in/out
    Fiddle::TYPE_VOIDP,  # ProtectionType : CRED_PROTECTION_TYPE* optional, out
  ],
  Fiddle::TYPE_INT)

#[link(name = "advapi32")]
extern "system" {
    fn CredProtectA(
        fAsSelf: i32,  // BOOL
        pszCredentials: *mut u8,  // LPSTR
        cchCredentials: u32,  // DWORD
        pszProtectedCredentials: *mut u8,  // LPSTR out
        pcchMaxChars: *mut u32,  // DWORD* in/out
        ProtectionType: *mut i32  // CRED_PROTECTION_TYPE* optional, 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 CredProtectA(bool fAsSelf, [MarshalAs(UnmanagedType.LPStr)] string pszCredentials, uint cchCredentials, [MarshalAs(UnmanagedType.LPStr)] System.Text.StringBuilder pszProtectedCredentials, ref uint pcchMaxChars, IntPtr ProtectionType);
"@
$api = Add-Type -MemberDefinition $sig -Name 'ADVAPI32_CredProtectA' -Namespace Win32 -PassThru
# $api::CredProtectA(fAsSelf, pszCredentials, cchCredentials, pszProtectedCredentials, pcchMaxChars, ProtectionType)

#uselib "ADVAPI32.dll"
#func global CredProtectA "CredProtectA" sptr, sptr, sptr, sptr, sptr, sptr
; CredProtectA fAsSelf, pszCredentials, cchCredentials, varptr(pszProtectedCredentials), varptr(pcchMaxChars), varptr(ProtectionType)   ; 戻り値は stat
; fAsSelf : BOOL -> "sptr"
; pszCredentials : LPSTR -> "sptr"
; cchCredentials : DWORD -> "sptr"
; pszProtectedCredentials : LPSTR out -> "sptr"
; pcchMaxChars : DWORD* in/out -> "sptr"
; ProtectionType : CRED_PROTECTION_TYPE* optional, out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "ADVAPI32.dll"
#cfunc global CredProtectA "CredProtectA" int, str, int, var, var, var
; res = CredProtectA(fAsSelf, pszCredentials, cchCredentials, pszProtectedCredentials, pcchMaxChars, ProtectionType)
; fAsSelf : BOOL -> "int"
; pszCredentials : LPSTR -> "str"
; cchCredentials : DWORD -> "int"
; pszProtectedCredentials : LPSTR out -> "var"
; pcchMaxChars : DWORD* in/out -> "var"
; ProtectionType : CRED_PROTECTION_TYPE* optional, out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "ADVAPI32.dll"
#cfunc global CredProtectA "CredProtectA" int, str, int, sptr, sptr, sptr
; res = CredProtectA(fAsSelf, pszCredentials, cchCredentials, varptr(pszProtectedCredentials), varptr(pcchMaxChars), varptr(ProtectionType))
; fAsSelf : BOOL -> "int"
; pszCredentials : LPSTR -> "str"
; cchCredentials : DWORD -> "int"
; pszProtectedCredentials : LPSTR out -> "sptr"
; pcchMaxChars : DWORD* in/out -> "sptr"
; ProtectionType : CRED_PROTECTION_TYPE* optional, out -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。