Win32 API 日本語リファレンス
ホームSecurity.Cryptography › CryptUpdateProtectedState

CryptUpdateProtectedState

関数
ユーザーSID変更後にDPAPI保護状態を更新する。
DLLCRYPT32.dll呼出規約winapiSetLastErrorあり対応OSWindows Vista 以降

シグネチャ

// CRYPT32.dll
#include <windows.h>

BOOL CryptUpdateProtectedState(
    PSID pOldSid,   // optional
    LPCWSTR pwszOldPassword,   // optional
    DWORD dwFlags,
    DWORD* pdwSuccessCount,   // optional
    DWORD* pdwFailureCount   // optional
);

パラメーター

名前方向説明
pOldSidPSIDinoptional

ユーザーの以前の SID を格納する SID 構造体のアドレスです。この SID は古いマスターキーを特定するために使用されます。このパラメーターが NULL の場合、現在のユーザー SID のマスターキーが移行されます。

このパラメーターまたは pwszOldPassword パラメーターのいずれかを NULL にできますが、両方を NULL にすることはできません。

pwszOldPasswordLPCWSTRinoptional

SID が変更される前のユーザーのパスワードを格納する、null 終端の Unicode 文字列へのポインターです。このパスワードは古いマスターキーを復号化するために使用されます。このパラメーターが NULL の場合、現在のユーザーのパスワードが使用されます。

このパラメーターまたは pOldSid パラメーターのいずれかを NULL にできますが、両方を NULL にすることはできません。

dwFlagsDWORDin使用されません。0 を指定する必要があります。
pdwSuccessCountDWORD*outoptional正常に移行されたマスターキーの数を受け取る DWORD 変数のアドレスです。
pdwFailureCountDWORD*outoptional

復号化できなかったマスターキーの数を受け取る DWORD 変数のアドレスです。

1 つ以上のマスターキーを復号化できないことは、必ずしもエラーであるとは限りません。一部のユーザーは、長期間使用されておらず、長らく復号化できなかった状態のマスターキーを保持している場合があります。これは、たとえばローカルユーザーのパスワードが管理者によってリセットされた場合に発生することがあります。

戻り値の型: BOOL

公式ドキュメント

ユーザーのセキュリティ識別子 (SID) が変更された後、現在のユーザーのマスターキーを移行します。

戻り値

関数が成功すると、戻り値は TRUE です。

関数が失敗すると、戻り値は FALSE です。拡張エラー情報を取得するには、 GetLastError を呼び出します。考えられるエラーコードには、次のものがあります。

戻り値 説明
ERROR_INVALID_PARAMETER
いずれかのパラメーターに有効でない値が含まれています。
ERROR_OUTOFMEMORY
メモリの割り当てに失敗しました。
ERROR_ENCRYPTION_FAILED
古いパスワードを暗号化できませんでした。

解説(Remarks)

この関数は、以前のパスワードを使用して、古いマスターキーディレクトリ内にあるユーザーのすべてのマスターキーを復号化し、ユーザーの現在のパスワードで暗号化したうえで、ユーザーの現在のマスターキーディレクトリに格納します。

この関数は、キーの移行先となるユーザーアカウントから呼び出す必要があります。

この関数が古いマスターキーの移行に成功した場合、その古いマスターキーは自動的に削除されます。 復号化できなかったマスターキーは削除されません。

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

各言語での呼び出し定義

// CRYPT32.dll
#include <windows.h>

BOOL CryptUpdateProtectedState(
    PSID pOldSid,   // optional
    LPCWSTR pwszOldPassword,   // optional
    DWORD dwFlags,
    DWORD* pdwSuccessCount,   // optional
    DWORD* pdwFailureCount   // optional
);
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("CRYPT32.dll", SetLastError = true, ExactSpelling = true)]
static extern bool CryptUpdateProtectedState(
    IntPtr pOldSid,   // PSID optional
    [MarshalAs(UnmanagedType.LPWStr)] string pwszOldPassword,   // LPCWSTR optional
    uint dwFlags,   // DWORD
    IntPtr pdwSuccessCount,   // DWORD* optional, out
    IntPtr pdwFailureCount   // DWORD* optional, out
);
<DllImport("CRYPT32.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function CryptUpdateProtectedState(
    pOldSid As IntPtr,   ' PSID optional
    <MarshalAs(UnmanagedType.LPWStr)> pwszOldPassword As String,   ' LPCWSTR optional
    dwFlags As UInteger,   ' DWORD
    pdwSuccessCount As IntPtr,   ' DWORD* optional, out
    pdwFailureCount As IntPtr   ' DWORD* optional, out
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function
' pOldSid : PSID optional
' pwszOldPassword : LPCWSTR optional
' dwFlags : DWORD
' pdwSuccessCount : DWORD* optional, out
' pdwFailureCount : DWORD* optional, out
Declare PtrSafe Function CryptUpdateProtectedState Lib "crypt32" ( _
    ByVal pOldSid As LongPtr, _
    ByVal pwszOldPassword As LongPtr, _
    ByVal dwFlags As Long, _
    ByVal pdwSuccessCount As LongPtr, _
    ByVal pdwFailureCount As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

CryptUpdateProtectedState = ctypes.windll.crypt32.CryptUpdateProtectedState
CryptUpdateProtectedState.restype = wintypes.BOOL
CryptUpdateProtectedState.argtypes = [
    wintypes.HANDLE,  # pOldSid : PSID optional
    wintypes.LPCWSTR,  # pwszOldPassword : LPCWSTR optional
    wintypes.DWORD,  # dwFlags : DWORD
    ctypes.POINTER(wintypes.DWORD),  # pdwSuccessCount : DWORD* optional, out
    ctypes.POINTER(wintypes.DWORD),  # pdwFailureCount : DWORD* optional, out
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('CRYPT32.dll')
CryptUpdateProtectedState = Fiddle::Function.new(
  lib['CryptUpdateProtectedState'],
  [
    Fiddle::TYPE_VOIDP,  # pOldSid : PSID optional
    Fiddle::TYPE_VOIDP,  # pwszOldPassword : LPCWSTR optional
    -Fiddle::TYPE_INT,  # dwFlags : DWORD
    Fiddle::TYPE_VOIDP,  # pdwSuccessCount : DWORD* optional, out
    Fiddle::TYPE_VOIDP,  # pdwFailureCount : DWORD* optional, out
  ],
  Fiddle::TYPE_INT)
#[link(name = "crypt32")]
extern "system" {
    fn CryptUpdateProtectedState(
        pOldSid: *mut core::ffi::c_void,  // PSID optional
        pwszOldPassword: *const u16,  // LPCWSTR optional
        dwFlags: u32,  // DWORD
        pdwSuccessCount: *mut u32,  // DWORD* optional, out
        pdwFailureCount: *mut u32  // DWORD* optional, out
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("CRYPT32.dll", SetLastError = true)]
public static extern bool CryptUpdateProtectedState(IntPtr pOldSid, [MarshalAs(UnmanagedType.LPWStr)] string pwszOldPassword, uint dwFlags, IntPtr pdwSuccessCount, IntPtr pdwFailureCount);
"@
$api = Add-Type -MemberDefinition $sig -Name 'CRYPT32_CryptUpdateProtectedState' -Namespace Win32 -PassThru
# $api::CryptUpdateProtectedState(pOldSid, pwszOldPassword, dwFlags, pdwSuccessCount, pdwFailureCount)
#uselib "CRYPT32.dll"
#func global CryptUpdateProtectedState "CryptUpdateProtectedState" sptr, sptr, sptr, sptr, sptr
; CryptUpdateProtectedState pOldSid, pwszOldPassword, dwFlags, varptr(pdwSuccessCount), varptr(pdwFailureCount)   ; 戻り値は stat
; pOldSid : PSID optional -> "sptr"
; pwszOldPassword : LPCWSTR optional -> "sptr"
; dwFlags : DWORD -> "sptr"
; pdwSuccessCount : DWORD* optional, out -> "sptr"
; pdwFailureCount : DWORD* optional, out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "CRYPT32.dll"
#cfunc global CryptUpdateProtectedState "CryptUpdateProtectedState" sptr, wstr, int, var, var
; res = CryptUpdateProtectedState(pOldSid, pwszOldPassword, dwFlags, pdwSuccessCount, pdwFailureCount)
; pOldSid : PSID optional -> "sptr"
; pwszOldPassword : LPCWSTR optional -> "wstr"
; dwFlags : DWORD -> "int"
; pdwSuccessCount : DWORD* optional, out -> "var"
; pdwFailureCount : DWORD* optional, out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; BOOL CryptUpdateProtectedState(PSID pOldSid, LPCWSTR pwszOldPassword, DWORD dwFlags, DWORD* pdwSuccessCount, DWORD* pdwFailureCount)
#uselib "CRYPT32.dll"
#cfunc global CryptUpdateProtectedState "CryptUpdateProtectedState" intptr, wstr, int, var, var
; res = CryptUpdateProtectedState(pOldSid, pwszOldPassword, dwFlags, pdwSuccessCount, pdwFailureCount)
; pOldSid : PSID optional -> "intptr"
; pwszOldPassword : LPCWSTR optional -> "wstr"
; dwFlags : DWORD -> "int"
; pdwSuccessCount : DWORD* optional, out -> "var"
; pdwFailureCount : DWORD* optional, out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	crypt32 = windows.NewLazySystemDLL("CRYPT32.dll")
	procCryptUpdateProtectedState = crypt32.NewProc("CryptUpdateProtectedState")
)

// pOldSid (PSID optional), pwszOldPassword (LPCWSTR optional), dwFlags (DWORD), pdwSuccessCount (DWORD* optional, out), pdwFailureCount (DWORD* optional, out)
r1, _, err := procCryptUpdateProtectedState.Call(
	uintptr(pOldSid),
	uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(pwszOldPassword))),
	uintptr(dwFlags),
	uintptr(pdwSuccessCount),
	uintptr(pdwFailureCount),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // BOOL
function CryptUpdateProtectedState(
  pOldSid: THandle;   // PSID optional
  pwszOldPassword: PWideChar;   // LPCWSTR optional
  dwFlags: DWORD;   // DWORD
  pdwSuccessCount: Pointer;   // DWORD* optional, out
  pdwFailureCount: Pointer   // DWORD* optional, out
): BOOL; stdcall;
  external 'CRYPT32.dll' name 'CryptUpdateProtectedState';
result := DllCall("CRYPT32\CryptUpdateProtectedState"
    , "Ptr", pOldSid   ; PSID optional
    , "WStr", pwszOldPassword   ; LPCWSTR optional
    , "UInt", dwFlags   ; DWORD
    , "Ptr", pdwSuccessCount   ; DWORD* optional, out
    , "Ptr", pdwFailureCount   ; DWORD* optional, out
    , "Int")   ; return: BOOL
●CryptUpdateProtectedState(pOldSid, pwszOldPassword, dwFlags, pdwSuccessCount, pdwFailureCount) = DLL("CRYPT32.dll", "bool CryptUpdateProtectedState(void*, char*, dword, void*, void*)")
# 呼び出し: CryptUpdateProtectedState(pOldSid, pwszOldPassword, dwFlags, pdwSuccessCount, pdwFailureCount)
# pOldSid : PSID optional -> "void*"
# pwszOldPassword : LPCWSTR optional -> "char*"
# dwFlags : DWORD -> "dword"
# pdwSuccessCount : DWORD* optional, out -> "void*"
# pdwFailureCount : DWORD* optional, out -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

extern "crypt32" fn CryptUpdateProtectedState(
    pOldSid: ?*anyopaque, // PSID optional
    pwszOldPassword: [*c]const u16, // LPCWSTR optional
    dwFlags: u32, // DWORD
    pdwSuccessCount: [*c]u32, // DWORD* optional, out
    pdwFailureCount: [*c]u32 // DWORD* optional, out
) callconv(std.os.windows.WINAPI) i32;
proc CryptUpdateProtectedState(
    pOldSid: pointer,  # PSID optional
    pwszOldPassword: WideCString,  # LPCWSTR optional
    dwFlags: uint32,  # DWORD
    pdwSuccessCount: ptr uint32,  # DWORD* optional, out
    pdwFailureCount: ptr uint32  # DWORD* optional, out
): int32 {.importc: "CryptUpdateProtectedState", stdcall, dynlib: "CRYPT32.dll".}
pragma(lib, "crypt32");
extern(Windows)
int CryptUpdateProtectedState(
    void* pOldSid,   // PSID optional
    const(wchar)* pwszOldPassword,   // LPCWSTR optional
    uint dwFlags,   // DWORD
    uint* pdwSuccessCount,   // DWORD* optional, out
    uint* pdwFailureCount   // DWORD* optional, out
);
ccall((:CryptUpdateProtectedState, "CRYPT32.dll"), stdcall, Int32,
      (Ptr{Cvoid}, Cwstring, UInt32, Ptr{UInt32}, Ptr{UInt32}),
      pOldSid, pwszOldPassword, dwFlags, pdwSuccessCount, pdwFailureCount)
# pOldSid : PSID optional -> Ptr{Cvoid}
# pwszOldPassword : LPCWSTR optional -> Cwstring
# dwFlags : DWORD -> UInt32
# pdwSuccessCount : DWORD* optional, out -> Ptr{UInt32}
# pdwFailureCount : DWORD* optional, out -> Ptr{UInt32}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
int32_t CryptUpdateProtectedState(
    void* pOldSid,
    const uint16_t* pwszOldPassword,
    uint32_t dwFlags,
    uint32_t* pdwSuccessCount,
    uint32_t* pdwFailureCount);
]]
local crypt32 = ffi.load("crypt32")
-- crypt32.CryptUpdateProtectedState(pOldSid, pwszOldPassword, dwFlags, pdwSuccessCount, pdwFailureCount)
-- pOldSid : PSID optional
-- pwszOldPassword : LPCWSTR optional
-- dwFlags : DWORD
-- pdwSuccessCount : DWORD* optional, out
-- pdwFailureCount : DWORD* optional, out
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('CRYPT32.dll');
const CryptUpdateProtectedState = lib.func('__stdcall', 'CryptUpdateProtectedState', 'int32_t', ['void *', 'str16', 'uint32_t', 'uint32_t *', 'uint32_t *']);
// CryptUpdateProtectedState(pOldSid, pwszOldPassword, dwFlags, pdwSuccessCount, pdwFailureCount)
// pOldSid : PSID optional -> 'void *'
// pwszOldPassword : LPCWSTR optional -> 'str16'
// dwFlags : DWORD -> 'uint32_t'
// pdwSuccessCount : DWORD* optional, out -> 'uint32_t *'
// pdwFailureCount : DWORD* optional, out -> 'uint32_t *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("CRYPT32.dll", {
  CryptUpdateProtectedState: { parameters: ["pointer", "buffer", "u32", "pointer", "pointer"], result: "i32" },
});
// lib.symbols.CryptUpdateProtectedState(pOldSid, pwszOldPassword, dwFlags, pdwSuccessCount, pdwFailureCount)
// pOldSid : PSID optional -> "pointer"
// pwszOldPassword : LPCWSTR optional -> "buffer"
// dwFlags : DWORD -> "u32"
// pdwSuccessCount : DWORD* optional, out -> "pointer"
// pdwFailureCount : DWORD* optional, out -> "pointer"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t CryptUpdateProtectedState(
    void* pOldSid,
    const uint16_t* pwszOldPassword,
    uint32_t dwFlags,
    uint32_t* pdwSuccessCount,
    uint32_t* pdwFailureCount);
C, "CRYPT32.dll");
// $ffi->CryptUpdateProtectedState(pOldSid, pwszOldPassword, dwFlags, pdwSuccessCount, pdwFailureCount);
// pOldSid : PSID optional
// pwszOldPassword : LPCWSTR optional
// dwFlags : DWORD
// pdwSuccessCount : DWORD* optional, out
// pdwFailureCount : DWORD* optional, out
// 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
// WINAPI(stdcall): x64 では呼出規約が統一されるため問題なし。x86 では __stdcall 対応のラッパが必要な場合あり。
import com.sun.jna.*;
import com.sun.jna.ptr.*;
import com.sun.jna.win32.StdCallLibrary;
import com.sun.jna.win32.W32APIOptions;

public interface Crypt32 extends StdCallLibrary {
    Crypt32 INSTANCE = Native.load("crypt32", Crypt32.class);
    boolean CryptUpdateProtectedState(
        Pointer pOldSid,   // PSID optional
        WString pwszOldPassword,   // LPCWSTR optional
        int dwFlags,   // DWORD
        IntByReference pdwSuccessCount,   // DWORD* optional, out
        IntByReference pdwFailureCount   // DWORD* optional, out
    );
}
@[Link("crypt32")]
lib LibCRYPT32
  fun CryptUpdateProtectedState = CryptUpdateProtectedState(
    pOldSid : Void*,   # PSID optional
    pwszOldPassword : UInt16*,   # LPCWSTR optional
    dwFlags : UInt32,   # DWORD
    pdwSuccessCount : UInt32*,   # DWORD* optional, out
    pdwFailureCount : UInt32*   # DWORD* optional, out
  ) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef CryptUpdateProtectedStateNative = Int32 Function(Pointer<Void>, Pointer<Utf16>, Uint32, Pointer<Uint32>, Pointer<Uint32>);
typedef CryptUpdateProtectedStateDart = int Function(Pointer<Void>, Pointer<Utf16>, int, Pointer<Uint32>, Pointer<Uint32>);
final CryptUpdateProtectedState = DynamicLibrary.open('CRYPT32.dll')
    .lookupFunction<CryptUpdateProtectedStateNative, CryptUpdateProtectedStateDart>('CryptUpdateProtectedState');
// pOldSid : PSID optional -> Pointer<Void>
// pwszOldPassword : LPCWSTR optional -> Pointer<Utf16>
// dwFlags : DWORD -> Uint32
// pdwSuccessCount : DWORD* optional, out -> Pointer<Uint32>
// pdwFailureCount : DWORD* optional, out -> Pointer<Uint32>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function CryptUpdateProtectedState(
  pOldSid: THandle;   // PSID optional
  pwszOldPassword: PWideChar;   // LPCWSTR optional
  dwFlags: DWORD;   // DWORD
  pdwSuccessCount: Pointer;   // DWORD* optional, out
  pdwFailureCount: Pointer   // DWORD* optional, out
): BOOL; stdcall;
  external 'CRYPT32.dll' name 'CryptUpdateProtectedState';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "CryptUpdateProtectedState"
  c_CryptUpdateProtectedState :: Ptr () -> CWString -> Word32 -> Ptr Word32 -> Ptr Word32 -> IO CInt
-- pOldSid : PSID optional -> Ptr ()
-- pwszOldPassword : LPCWSTR optional -> CWString
-- dwFlags : DWORD -> Word32
-- pdwSuccessCount : DWORD* optional, out -> Ptr Word32
-- pdwFailureCount : DWORD* optional, out -> Ptr Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let cryptupdateprotectedstate =
  foreign "CryptUpdateProtectedState"
    ((ptr void) @-> (ptr uint16_t) @-> uint32_t @-> (ptr uint32_t) @-> (ptr uint32_t) @-> returning int32_t)
(* pOldSid : PSID optional -> (ptr void) *)
(* pwszOldPassword : LPCWSTR optional -> (ptr uint16_t) *)
(* dwFlags : DWORD -> uint32_t *)
(* pdwSuccessCount : DWORD* optional, out -> (ptr uint32_t) *)
(* pdwFailureCount : DWORD* optional, out -> (ptr uint32_t) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library crypt32 (t "CRYPT32.dll"))
(cffi:use-foreign-library crypt32)

(cffi:defcfun ("CryptUpdateProtectedState" crypt-update-protected-state :convention :stdcall) :int32
  (p-old-sid :pointer)   ; PSID optional
  (pwsz-old-password (:string :encoding :utf-16le))   ; LPCWSTR optional
  (dw-flags :uint32)   ; DWORD
  (pdw-success-count :pointer)   ; DWORD* optional, out
  (pdw-failure-count :pointer))   ; DWORD* optional, out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $CryptUpdateProtectedState = Win32::API::More->new('CRYPT32',
    'BOOL CryptUpdateProtectedState(HANDLE pOldSid, LPCWSTR pwszOldPassword, DWORD dwFlags, LPVOID pdwSuccessCount, LPVOID pdwFailureCount)');
# my $ret = $CryptUpdateProtectedState->Call($pOldSid, $pwszOldPassword, $dwFlags, $pdwSuccessCount, $pdwFailureCount);
# pOldSid : PSID optional -> HANDLE
# pwszOldPassword : LPCWSTR optional -> LPCWSTR
# dwFlags : DWORD -> DWORD
# pdwSuccessCount : DWORD* optional, out -> LPVOID
# pdwFailureCount : DWORD* optional, out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。