ホーム › Security.Cryptography › CryptSetKeyIdentifierProperty

CryptSetKeyIdentifierProperty

関数

鍵識別子にプロパティを設定する。

DLLCRYPT32.dll呼出規約winapiSetLastErrorあり対応OSWindows XP 以降

シグネチャ

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

BOOL CryptSetKeyIdentifierProperty(
    const CRYPT_INTEGER_BLOB* pKeyIdentifier,
    DWORD dwPropId,
    DWORD dwFlags,
    LPCWSTR pwszComputerName,   // optional
    void* pvReserved,   // optional
    const void* pvData   // optional
);

パラメーター

名前

型

方向

説明

pKeyIdentifier

CRYPT_INTEGER_BLOB*

キー識別子を含む CRYPT_HASH_BLOB へのポインターです。

dwPropId

DWORD

設定するプロパティを識別します。dwPropId の値によって、pvData パラメーターの型と内容が決まります。任意の証明書プロパティ ID を使用できます。最も重要なのは CERT_KEY_PROV_INFO_PROP_ID プロパティです。

dwFlags

DWORD

次のフラグを設定できます。これらはビットごとの OR 演算で組み合わせることができます。

Value	Meaning
CRYPT_KEYID_MACHINE_FLAG	LocalMachine(pwszComputerName が NULL の場合)またはリモートコンピューター(pwszComputerName が NULL でない場合)のプロパティを設定します。詳細については、pwszComputerName を参照してください。
CRYPT_KEYID_DELETE_FLAG	キー識別子とそのすべてのプロパティが削除されます。
CRYPT_KEYID_SET_NEW_FLAG	新しいキー識別子プロパティを設定します。プロパティが既に存在する場合、処理は失敗し、最終エラーコードに CRYPT_E_EXISTS が設定されて FALSE が返されます。

pwszComputerName

LPCWSTR

inoptional

プロパティが設定されるキー識別子を持つリモートコンピューターの名前を含む null 終端文字列へのポインターです。CRYPT_KEYID_MACHINE_FLAG フラグが設定されている場合、キー識別子の一覧についてリモートコンピューターを検索します。リモートコンピューターではなくローカルコンピューターを設定する場合は、pwszComputerName を NULL に設定します。

pvReserved

void*

optional

将来の使用のために予約されており、NULL でなければなりません。

pvData

void*

inoptional

dwPropId が CERT_KEY_PROV_INFO_PROP_ID の場合、pvData はキー識別子のプロパティを含む CRYPT_KEY_PROV_INFO 構造体を指します。

dwPropId が CERT_KEY_PROV_INFO_PROP_ID でない場合、pvData はキー識別子のプロパティを含む CRYPT_DATA_BLOB 構造体を指します。

pvData を NULL に設定すると、プロパティが削除されます。

戻り値の型: BOOL

公式ドキュメント

CryptSetKeyIdentifierProperty 関数は、指定されたキー識別子のプロパティを設定します。この関数は、pwszComputerName で識別されるコンピューター上のプロパティを設定できます。

戻り値

関数が成功した場合、戻り値は 0 以外(TRUE)です。

関数が失敗した場合、戻り値は 0(FALSE)です。詳細なエラー情報を取得するには、 GetLastError を呼び出します。

Note CRYPT_KEYID_SET_NEW_FLAG が設定されていてプロパティが既に存在する場合、最終エラーコードに CRYPT_E_EXISTS が設定されて FALSE が返されます。

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

各言語での呼び出し定義

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

BOOL CryptSetKeyIdentifierProperty(
    const CRYPT_INTEGER_BLOB* pKeyIdentifier,
    DWORD dwPropId,
    DWORD dwFlags,
    LPCWSTR pwszComputerName,   // optional
    void* pvReserved,   // optional
    const void* pvData   // optional
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("CRYPT32.dll", SetLastError = true, ExactSpelling = true)]
static extern bool CryptSetKeyIdentifierProperty(
    IntPtr pKeyIdentifier,   // CRYPT_INTEGER_BLOB*
    uint dwPropId,   // DWORD
    uint dwFlags,   // DWORD
    [MarshalAs(UnmanagedType.LPWStr)] string pwszComputerName,   // LPCWSTR optional
    IntPtr pvReserved,   // void* optional
    IntPtr pvData   // void* optional
);

<DllImport("CRYPT32.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function CryptSetKeyIdentifierProperty(
    pKeyIdentifier As IntPtr,   ' CRYPT_INTEGER_BLOB*
    dwPropId As UInteger,   ' DWORD
    dwFlags As UInteger,   ' DWORD
    <MarshalAs(UnmanagedType.LPWStr)> pwszComputerName As String,   ' LPCWSTR optional
    pvReserved As IntPtr,   ' void* optional
    pvData As IntPtr   ' void* optional
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function

' pKeyIdentifier : CRYPT_INTEGER_BLOB*
' dwPropId : DWORD
' dwFlags : DWORD
' pwszComputerName : LPCWSTR optional
' pvReserved : void* optional
' pvData : void* optional
Declare PtrSafe Function CryptSetKeyIdentifierProperty Lib "crypt32" ( _
    ByVal pKeyIdentifier As LongPtr, _
    ByVal dwPropId As Long, _
    ByVal dwFlags As Long, _
    ByVal pwszComputerName As LongPtr, _
    ByVal pvReserved As LongPtr, _
    ByVal pvData As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

CryptSetKeyIdentifierProperty = ctypes.windll.crypt32.CryptSetKeyIdentifierProperty
CryptSetKeyIdentifierProperty.restype = wintypes.BOOL
CryptSetKeyIdentifierProperty.argtypes = [
    ctypes.c_void_p,  # pKeyIdentifier : CRYPT_INTEGER_BLOB*
    wintypes.DWORD,  # dwPropId : DWORD
    wintypes.DWORD,  # dwFlags : DWORD
    wintypes.LPCWSTR,  # pwszComputerName : LPCWSTR optional
    ctypes.POINTER(None),  # pvReserved : void* optional
    ctypes.POINTER(None),  # pvData : void* optional
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('CRYPT32.dll')
CryptSetKeyIdentifierProperty = Fiddle::Function.new(
  lib['CryptSetKeyIdentifierProperty'],
  [
    Fiddle::TYPE_VOIDP,  # pKeyIdentifier : CRYPT_INTEGER_BLOB*
    -Fiddle::TYPE_INT,  # dwPropId : DWORD
    -Fiddle::TYPE_INT,  # dwFlags : DWORD
    Fiddle::TYPE_VOIDP,  # pwszComputerName : LPCWSTR optional
    Fiddle::TYPE_VOIDP,  # pvReserved : void* optional
    Fiddle::TYPE_VOIDP,  # pvData : void* optional
  ],
  Fiddle::TYPE_INT)

#[link(name = "crypt32")]
extern "system" {
    fn CryptSetKeyIdentifierProperty(
        pKeyIdentifier: *const CRYPT_INTEGER_BLOB,  // CRYPT_INTEGER_BLOB*
        dwPropId: u32,  // DWORD
        dwFlags: u32,  // DWORD
        pwszComputerName: *const u16,  // LPCWSTR optional
        pvReserved: *mut (),  // void* optional
        pvData: *const ()  // void* optional
    ) -> 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 CryptSetKeyIdentifierProperty(IntPtr pKeyIdentifier, uint dwPropId, uint dwFlags, [MarshalAs(UnmanagedType.LPWStr)] string pwszComputerName, IntPtr pvReserved, IntPtr pvData);
"@
$api = Add-Type -MemberDefinition $sig -Name 'CRYPT32_CryptSetKeyIdentifierProperty' -Namespace Win32 -PassThru
# $api::CryptSetKeyIdentifierProperty(pKeyIdentifier, dwPropId, dwFlags, pwszComputerName, pvReserved, pvData)

#uselib "CRYPT32.dll"
#func global CryptSetKeyIdentifierProperty "CryptSetKeyIdentifierProperty" sptr, sptr, sptr, sptr, sptr, sptr
; CryptSetKeyIdentifierProperty varptr(pKeyIdentifier), dwPropId, dwFlags, pwszComputerName, pvReserved, pvData   ; 戻り値は stat
; pKeyIdentifier : CRYPT_INTEGER_BLOB* -> "sptr"
; dwPropId : DWORD -> "sptr"
; dwFlags : DWORD -> "sptr"
; pwszComputerName : LPCWSTR optional -> "sptr"
; pvReserved : void* optional -> "sptr"
; pvData : void* optional -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "CRYPT32.dll"
#cfunc global CryptSetKeyIdentifierProperty "CryptSetKeyIdentifierProperty" var, int, int, wstr, sptr, sptr
; res = CryptSetKeyIdentifierProperty(pKeyIdentifier, dwPropId, dwFlags, pwszComputerName, pvReserved, pvData)
; pKeyIdentifier : CRYPT_INTEGER_BLOB* -> "var"
; dwPropId : DWORD -> "int"
; dwFlags : DWORD -> "int"
; pwszComputerName : LPCWSTR optional -> "wstr"
; pvReserved : void* optional -> "sptr"
; pvData : void* optional -> "sptr"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "CRYPT32.dll"
#cfunc global CryptSetKeyIdentifierProperty "CryptSetKeyIdentifierProperty" sptr, int, int, wstr, sptr, sptr
; res = CryptSetKeyIdentifierProperty(varptr(pKeyIdentifier), dwPropId, dwFlags, pwszComputerName, pvReserved, pvData)
; pKeyIdentifier : CRYPT_INTEGER_BLOB* -> "sptr"
; dwPropId : DWORD -> "int"
; dwFlags : DWORD -> "int"
; pwszComputerName : LPCWSTR optional -> "wstr"
; pvReserved : void* optional -> "sptr"
; pvData : void* optional -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。