ホーム › Security.Credentials › CredProtectW

CredProtectW

関数

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

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

シグネチャ

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

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

パラメーター

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

戻り値の型: BOOL

公式ドキュメント

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

戻り値

関数が成功した場合は 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  (Unicode / -W)
#include <windows.h>

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

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

<DllImport("ADVAPI32.dll", CharSet:=CharSet.Unicode, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function CredProtectW(
    fAsSelf As Boolean,   ' BOOL
    <MarshalAs(UnmanagedType.LPWStr)> pszCredentials As String,   ' LPWSTR
    cchCredentials As UInteger,   ' DWORD
    <MarshalAs(UnmanagedType.LPWStr)> pszProtectedCredentials As System.Text.StringBuilder,   ' LPWSTR 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 : LPWSTR
' cchCredentials : DWORD
' pszProtectedCredentials : LPWSTR out
' pcchMaxChars : DWORD* in/out
' ProtectionType : CRED_PROTECTION_TYPE* optional, out
Declare PtrSafe Function CredProtectW Lib "advapi32" ( _
    ByVal fAsSelf As Long, _
    ByVal pszCredentials As LongPtr, _
    ByVal cchCredentials As Long, _
    ByVal pszProtectedCredentials As LongPtr, _
    ByRef pcchMaxChars As Long, _
    ByVal ProtectionType 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

CredProtectW = ctypes.windll.advapi32.CredProtectW
CredProtectW.restype = wintypes.BOOL
CredProtectW.argtypes = [
    wintypes.BOOL,  # fAsSelf : BOOL
    wintypes.LPCWSTR,  # pszCredentials : LPWSTR
    wintypes.DWORD,  # cchCredentials : DWORD
    wintypes.LPWSTR,  # pszProtectedCredentials : LPWSTR 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')
CredProtectW = Fiddle::Function.new(
  lib['CredProtectW'],
  [
    Fiddle::TYPE_INT,  # fAsSelf : BOOL
    Fiddle::TYPE_VOIDP,  # pszCredentials : LPWSTR
    -Fiddle::TYPE_INT,  # cchCredentials : DWORD
    Fiddle::TYPE_VOIDP,  # pszProtectedCredentials : LPWSTR out
    Fiddle::TYPE_VOIDP,  # pcchMaxChars : DWORD* in/out
    Fiddle::TYPE_VOIDP,  # ProtectionType : CRED_PROTECTION_TYPE* optional, out
  ],
  Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"

#[link(name = "advapi32")]
extern "system" {
    fn CredProtectW(
        fAsSelf: i32,  // BOOL
        pszCredentials: *mut u16,  // LPWSTR
        cchCredentials: u32,  // DWORD
        pszProtectedCredentials: *mut u16,  // LPWSTR 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.Unicode, SetLastError = true)]
public static extern bool CredProtectW(bool fAsSelf, [MarshalAs(UnmanagedType.LPWStr)] string pszCredentials, uint cchCredentials, [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder pszProtectedCredentials, ref uint pcchMaxChars, IntPtr ProtectionType);
"@
$api = Add-Type -MemberDefinition $sig -Name 'ADVAPI32_CredProtectW' -Namespace Win32 -PassThru
# $api::CredProtectW(fAsSelf, pszCredentials, cchCredentials, pszProtectedCredentials, pcchMaxChars, ProtectionType)

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

出力引数:

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