ホーム › Security.Cryptography › CertSetStoreProperty

CertSetStoreProperty

関数

証明書ストアの指定プロパティを設定する。

DLLCRYPT32.dll呼出規約winapi対応OSWindows XP 以降

シグネチャ

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

BOOL CertSetStoreProperty(
    HCERTSTORE hCertStore,
    DWORD dwPropId,
    DWORD dwFlags,
    const void* pvData   // optional
);

パラメーター

名前	型	方向	説明
hCertStore	HCERTSTORE	in	証明書ストアのハンドル。
dwPropId	DWORD	in	一連のストアプロパティのいずれか 1 つを指定します。ユーザー定義プロパティの値は、現在定義済みのコンテキストプロパティ値の範囲外でなければなりません。現在、ユーザー定義の dwPropId 値は 4,096 から始まります。定義済みのストアプロパティとして、ストアのローカライズされた名前を表す CERT_STORE_LOCALIZED_NAME_PROP_ID が 1 つあります。
dwFlags	DWORD	in	将来の使用のために予約されており、ゼロでなければなりません。
pvData	void*	inoptional	pvData の型定義は dwPropId の値によって異なります。dwPropId が CERT_STORE_LOCALIZED_NAME_PROP_ID の場合、pvData は CRYPT_DATA_BLOB 構造体を指します。この構造体の pbData メンバーは、null で終わる Unicode 文字列へのポインターです。この構造体の cbData メンバーは、その文字列の長さを保持する DWORD 値です。ユーザー定義の dwPropId 値の場合、pvData はエンコードされた CRYPT_DATA_BLOB へのポインターです。選択したプロパティに既に値が存在する場合、古い値は置き換えられます。 pvData に NULL を設定してこの関数を呼び出すと、プロパティが削除されます。

戻り値の型: BOOL

公式ドキュメント

CertSetStoreProperty 関数は、ストアのプロパティを設定します。

戻り値

関数が成功した場合、戻り値は TRUE です。

関数が失敗した場合、戻り値は FALSE です。

解説(Remarks)

ストアプロパティ識別子は、ストア全体に適用されるプロパティです。これらは個々の証明書、CRL、または CTL コンテキストのプロパティではありません。現在、ストアプロパティは永続化されません。

例

次の例は、開いている証明書ストアのローカライズされた名前プロパティを設定する方法を示しています。

//--------------------------------------------------------------
// Declare and initialize variables.

HCERTSTORE hCertStore = NULL;       // Original certificate store
CRYPT_DATA_BLOB Property_Name_Blob; // BLOB to hold store property

//--------------------------------------------------------------
// Open the certificate store that will have its localized name
// property set. In this case, the CA system store is opened. 

if ( hCertStore = CertOpenStore(
    CERT_STORE_PROV_SYSTEM,
    0,
    NULL,
    CERT_SYSTEM_STORE_CURRENT_USER,
    L"CA"))
{
     printf("The CA store is open.\n");
}
else
{
     printf("The CA store could not be opened \n.");
     exit(1);
}

//--------------------------------------------------------------------
// Prepare a data structure to set a store property.
// Initialize the members of the CRYPT_DATA_BLOB.
Property_Name_Blob.pbData = (BYTE *) L"The Local CA Store";
Property_Name_Blob.cbData = 
       (wcslen((LPWSTR)Property_Name_Blob.pbData)+1) * sizeof(WCHAR);

//--------------------------------------------------------------------
// Set the store's localized name property.
if (CertSetStoreProperty(
    hCertStore,
    CERT_STORE_LOCALIZED_NAME_PROP_ID,
    0,
    &Property_Name_Blob))
{
     printf("The name of the store has been set. Continue. \n");
}
else
{
     printf("Setting the store's localized name failed.\n");
     exit(1);
}

// Close the store when done.
if (!CertCloseStore(
     hCertStore,
     0 ))
{
     printf("The CA store could not be closed \n.");
     exit(1);

}

この関数を使用する別の例については、Example C Program: Setting and Getting Certificate Store Properties を参照してください。

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

各言語での呼び出し定義

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

BOOL CertSetStoreProperty(
    HCERTSTORE hCertStore,
    DWORD dwPropId,
    DWORD dwFlags,
    const void* pvData   // optional
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("CRYPT32.dll", ExactSpelling = true)]
static extern bool CertSetStoreProperty(
    IntPtr hCertStore,   // HCERTSTORE
    uint dwPropId,   // DWORD
    uint dwFlags,   // DWORD
    IntPtr pvData   // void* optional
);

<DllImport("CRYPT32.dll", ExactSpelling:=True)>
Public Shared Function CertSetStoreProperty(
    hCertStore As IntPtr,   ' HCERTSTORE
    dwPropId As UInteger,   ' DWORD
    dwFlags As UInteger,   ' DWORD
    pvData As IntPtr   ' void* optional
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function

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

import ctypes
from ctypes import wintypes

CertSetStoreProperty = ctypes.windll.crypt32.CertSetStoreProperty
CertSetStoreProperty.restype = wintypes.BOOL
CertSetStoreProperty.argtypes = [
    wintypes.HANDLE,  # hCertStore : HCERTSTORE
    wintypes.DWORD,  # dwPropId : DWORD
    wintypes.DWORD,  # dwFlags : DWORD
    ctypes.POINTER(None),  # pvData : void* optional
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('CRYPT32.dll')
CertSetStoreProperty = Fiddle::Function.new(
  lib['CertSetStoreProperty'],
  [
    Fiddle::TYPE_VOIDP,  # hCertStore : HCERTSTORE
    -Fiddle::TYPE_INT,  # dwPropId : DWORD
    -Fiddle::TYPE_INT,  # dwFlags : DWORD
    Fiddle::TYPE_VOIDP,  # pvData : void* optional
  ],
  Fiddle::TYPE_INT)

#[link(name = "crypt32")]
extern "system" {
    fn CertSetStoreProperty(
        hCertStore: *mut core::ffi::c_void,  // HCERTSTORE
        dwPropId: u32,  // DWORD
        dwFlags: u32,  // DWORD
        pvData: *const ()  // void* optional
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("CRYPT32.dll")]
public static extern bool CertSetStoreProperty(IntPtr hCertStore, uint dwPropId, uint dwFlags, IntPtr pvData);
"@
$api = Add-Type -MemberDefinition $sig -Name 'CRYPT32_CertSetStoreProperty' -Namespace Win32 -PassThru
# $api::CertSetStoreProperty(hCertStore, dwPropId, dwFlags, pvData)

#uselib "CRYPT32.dll"
#func global CertSetStoreProperty "CertSetStoreProperty" sptr, sptr, sptr, sptr
; CertSetStoreProperty hCertStore, dwPropId, dwFlags, pvData   ; 戻り値は stat
; hCertStore : HCERTSTORE -> "sptr"
; dwPropId : DWORD -> "sptr"
; dwFlags : DWORD -> "sptr"
; pvData : void* optional -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

#uselib "CRYPT32.dll"
#cfunc global CertSetStoreProperty "CertSetStoreProperty" sptr, int, int, sptr
; res = CertSetStoreProperty(hCertStore, dwPropId, dwFlags, pvData)
; hCertStore : HCERTSTORE -> "sptr"
; dwPropId : DWORD -> "int"
; dwFlags : DWORD -> "int"
; pvData : void* optional -> "sptr"

; BOOL CertSetStoreProperty(HCERTSTORE hCertStore, DWORD dwPropId, DWORD dwFlags, void* pvData)
#uselib "CRYPT32.dll"
#cfunc global CertSetStoreProperty "CertSetStoreProperty" intptr, int, int, intptr
; res = CertSetStoreProperty(hCertStore, dwPropId, dwFlags, pvData)
; hCertStore : HCERTSTORE -> "intptr"
; dwPropId : DWORD -> "int"
; dwFlags : DWORD -> "int"
; pvData : void* optional -> "intptr"

import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	crypt32 = windows.NewLazySystemDLL("CRYPT32.dll")
	procCertSetStoreProperty = crypt32.NewProc("CertSetStoreProperty")
)

// hCertStore (HCERTSTORE), dwPropId (DWORD), dwFlags (DWORD), pvData (void* optional)
r1, _, err := procCertSetStoreProperty.Call(
	uintptr(hCertStore),
	uintptr(dwPropId),
	uintptr(dwFlags),
	uintptr(pvData),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // BOOL

function CertSetStoreProperty(
  hCertStore: THandle;   // HCERTSTORE
  dwPropId: DWORD;   // DWORD
  dwFlags: DWORD;   // DWORD
  pvData: Pointer   // void* optional
): BOOL; stdcall;
  external 'CRYPT32.dll' name 'CertSetStoreProperty';

result := DllCall("CRYPT32\CertSetStoreProperty"
    , "Ptr", hCertStore   ; HCERTSTORE
    , "UInt", dwPropId   ; DWORD
    , "UInt", dwFlags   ; DWORD
    , "Ptr", pvData   ; void* optional
    , "Int")   ; return: BOOL

●CertSetStoreProperty(hCertStore, dwPropId, dwFlags, pvData) = DLL("CRYPT32.dll", "bool CertSetStoreProperty(void*, dword, dword, void*)")
# 呼び出し: CertSetStoreProperty(hCertStore, dwPropId, dwFlags, pvData)
# hCertStore : HCERTSTORE -> "void*"
# dwPropId : DWORD -> "dword"
# dwFlags : DWORD -> "dword"
# pvData : void* optional -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。

const std = @import("std");

extern "crypt32" fn CertSetStoreProperty(
    hCertStore: ?*anyopaque, // HCERTSTORE
    dwPropId: u32, // DWORD
    dwFlags: u32, // DWORD
    pvData: ?*anyopaque // void* optional
) callconv(std.os.windows.WINAPI) i32;

proc CertSetStoreProperty(
    hCertStore: pointer,  # HCERTSTORE
    dwPropId: uint32,  # DWORD
    dwFlags: uint32,  # DWORD
    pvData: pointer  # void* optional
): int32 {.importc: "CertSetStoreProperty", stdcall, dynlib: "CRYPT32.dll".}

pragma(lib, "crypt32");
extern(Windows)
int CertSetStoreProperty(
    void* hCertStore,   // HCERTSTORE
    uint dwPropId,   // DWORD
    uint dwFlags,   // DWORD
    void* pvData   // void* optional
);

ccall((:CertSetStoreProperty, "CRYPT32.dll"), stdcall, Int32,
      (Ptr{Cvoid}, UInt32, UInt32, Ptr{Cvoid}),
      hCertStore, dwPropId, dwFlags, pvData)
# hCertStore : HCERTSTORE -> Ptr{Cvoid}
# dwPropId : DWORD -> UInt32
# dwFlags : DWORD -> UInt32
# pvData : void* optional -> Ptr{Cvoid}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。

local ffi = require("ffi")
ffi.cdef[[
int32_t CertSetStoreProperty(
    void* hCertStore,
    uint32_t dwPropId,
    uint32_t dwFlags,
    void* pvData);
]]
local crypt32 = ffi.load("crypt32")
-- crypt32.CertSetStoreProperty(hCertStore, dwPropId, dwFlags, pvData)
-- hCertStore : HCERTSTORE
-- dwPropId : DWORD
-- dwFlags : DWORD
-- pvData : void* optional
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。

const koffi = require('koffi');
const lib = koffi.load('CRYPT32.dll');
const CertSetStoreProperty = lib.func('__stdcall', 'CertSetStoreProperty', 'int32_t', ['void *', 'uint32_t', 'uint32_t', 'void *']);
// CertSetStoreProperty(hCertStore, dwPropId, dwFlags, pvData)
// hCertStore : HCERTSTORE -> 'void *'
// dwPropId : DWORD -> 'uint32_t'
// dwFlags : DWORD -> 'uint32_t'
// pvData : void* optional -> 'void *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。

const lib = Deno.dlopen("CRYPT32.dll", {
  CertSetStoreProperty: { parameters: ["pointer", "u32", "u32", "pointer"], result: "i32" },
});
// lib.symbols.CertSetStoreProperty(hCertStore, dwPropId, dwFlags, pvData)
// hCertStore : HCERTSTORE -> "pointer"
// dwPropId : DWORD -> "u32"
// dwFlags : DWORD -> "u32"
// pvData : void* optional -> "pointer"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。

<?php
$ffi = FFI::cdef(<<<C
int32_t CertSetStoreProperty(
    void* hCertStore,
    uint32_t dwPropId,
    uint32_t dwFlags,
    void* pvData);
C, "CRYPT32.dll");
// $ffi->CertSetStoreProperty(hCertStore, dwPropId, dwFlags, pvData);
// hCertStore : HCERTSTORE
// dwPropId : DWORD
// dwFlags : DWORD
// pvData : void* optional
// 構造体/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 CertSetStoreProperty(
        Pointer hCertStore,   // HCERTSTORE
        int dwPropId,   // DWORD
        int dwFlags,   // DWORD
        Pointer pvData   // void* optional
    );
}

@[Link("crypt32")]
lib LibCRYPT32
  fun CertSetStoreProperty = CertSetStoreProperty(
    hCertStore : Void*,   # HCERTSTORE
    dwPropId : UInt32,   # DWORD
    dwFlags : UInt32,   # DWORD
    pvData : Void*   # void* optional
  ) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。

import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef CertSetStorePropertyNative = Int32 Function(Pointer<Void>, Uint32, Uint32, Pointer<Void>);
typedef CertSetStorePropertyDart = int Function(Pointer<Void>, int, int, Pointer<Void>);
final CertSetStoreProperty = DynamicLibrary.open('CRYPT32.dll')
    .lookupFunction<CertSetStorePropertyNative, CertSetStorePropertyDart>('CertSetStoreProperty');
// hCertStore : HCERTSTORE -> Pointer<Void>
// dwPropId : DWORD -> Uint32
// dwFlags : DWORD -> Uint32
// pvData : void* optional -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。

{$mode objfpc}{$H+}
function CertSetStoreProperty(
  hCertStore: THandle;   // HCERTSTORE
  dwPropId: DWORD;   // DWORD
  dwFlags: DWORD;   // DWORD
  pvData: Pointer   // void* optional
): BOOL; stdcall;
  external 'CRYPT32.dll' name 'CertSetStoreProperty';

import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "CertSetStoreProperty"
  c_CertSetStoreProperty :: Ptr () -> Word32 -> Word32 -> Ptr () -> IO CInt
-- hCertStore : HCERTSTORE -> Ptr ()
-- dwPropId : DWORD -> Word32
-- dwFlags : DWORD -> Word32
-- pvData : void* optional -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。

open Ctypes
open Foreign

let certsetstoreproperty =
  foreign "CertSetStoreProperty"
    ((ptr void) @-> uint32_t @-> uint32_t @-> (ptr void) @-> returning int32_t)
(* hCertStore : HCERTSTORE -> (ptr void) *)
(* dwPropId : DWORD -> uint32_t *)
(* dwFlags : DWORD -> uint32_t *)
(* pvData : void* optional -> (ptr void) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)

(cffi:define-foreign-library crypt32 (t "CRYPT32.dll"))
(cffi:use-foreign-library crypt32)

(cffi:defcfun ("CertSetStoreProperty" cert-set-store-property :convention :stdcall) :int32
  (h-cert-store :pointer)   ; HCERTSTORE
  (dw-prop-id :uint32)   ; DWORD
  (dw-flags :uint32)   ; DWORD
  (pv-data :pointer))   ; void* optional
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。

use Win32::API;
my $CertSetStoreProperty = Win32::API::More->new('CRYPT32',
    'BOOL CertSetStoreProperty(HANDLE hCertStore, DWORD dwPropId, DWORD dwFlags, LPVOID pvData)');
# my $ret = $CertSetStoreProperty->Call($hCertStore, $dwPropId, $dwFlags, $pvData);
# hCertStore : HCERTSTORE -> HANDLE
# dwPropId : DWORD -> DWORD
# dwFlags : DWORD -> DWORD
# pvData : void* optional -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。