ホーム › Security.Cryptography › CertGetStoreProperty

CertGetStoreProperty

関数

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

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

シグネチャ

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

BOOL CertGetStoreProperty(
    HCERTSTORE hCertStore,
    DWORD dwPropId,
    void* pvData,   // optional
    DWORD* pcbData
);

パラメーター

名前	型	方向	説明
hCertStore	HCERTSTORE	in	開いている証明書ストアのハンドルです。
dwPropId	DWORD	in	複数あるストアプロパティのいずれかを示します。定義済みのストアプロパティとして、ストアのローカライズされた名前を表す CERT_STORE_LOCALIZED_NAME_PROP_ID が 1 つあります。ユーザー定義のプロパティは、定義済みコンテキストプロパティの現在の値の範囲外でなければなりません。現在、ユーザー定義の dwPropId 値は 4,096 から始まります。
pvData	void*	outoptional	dwPropId によって決定されるデータを受け取るバッファーへのポインターです。CERT_STORE_LOCALIZED_NAME_PROP_ID の場合、これはストアのローカライズされた名前であり、pvData は null で終わる Unicode ワイド文字列を指します。その他の dwPropId の場合、pvData はバイト配列を指します。このパラメーターは、メモリ割り当てを目的としてこの情報のサイズを取得するために NULL を指定できます。詳細については、 Retrieving Data of Unknown Length を参照してください。
pcbData	DWORD*	inout	pvData バッファーのサイズ(バイト単位)を指定する DWORD 値へのポインターです。関数が戻るとき、この DWORD 値にはバッファーに格納されたバイト数が含まれます。

戻り値の型: BOOL

公式ドキュメント

ストアのプロパティを取得します。

戻り値

関数が成功すると、0 以外の値を返します。

関数が失敗すると、0 を返します。

ストアプロパティが見つかった場合、関数は 0 以外の値を返し、pvData はそのプロパティを指し、pcbData は文字列の長さを指します。ストアプロパティが見つからなかった場合、関数は 0 を返し、 GetLastError は CRYPT_E_NOT_FOUND を返します。

解説(Remarks)

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

ストアのローカライズされた名前を取得するには、CryptFindLocalizedName 関数を使用することもできます。

例

次の例は、ストアに対してローカル名プロパティを照会する方法を示しています。同様のコードを使用して、他のストアプロパティを取得できます。この関数を使用する完全な例については、Example C Program: Setting and Getting Certificate Store Properties を参照してください。

#include <windows.h>
#include <stdio.h>
#include <Wincrypt.h>


//--------------------------------------------------------------------
// 変数を宣言して初期化します。
void *pvData = NULL;
DWORD cbData = 0;

//--------------------------------------------------------------------
// 返されるストア名文字列の長さを取得するために、
// CertGetStoreProperty を 1 回目に呼び出します。
// hCertStore は、開いている証明書ストアを表す、
// 事前に割り当てられた HCERTSTORE 変数です。
if(CertGetStoreProperty(
    hCertStore,
    CERT_STORE_LOCALIZED_NAME_PROP_ID,
    NULL,     // 返される文字列の長さを確定するために
              // 1 回目の呼び出しでは NULL を指定
              // 
    &cbData))
{
     printf("The length of the property is %d. \n",cbData);
}
else
{
     printf("The length of the property was not calculated.\n");
     exit(1);
}

//--------------------------------------------------------------------
// cbData は割り当てる文字列の長さです。
// 文字列用の領域を割り当て、関数を 2 回目に
// 呼び出します。
if(pvData = malloc(cbData))
{
     printf("%d bytes of memory allocated.\n",cbData);
}
else
{
     printf("Memory was not allocated.\n");
     exit(1);
}

// ローカルストア名を pvData バッファーにコピーするために、
// CertGetStoreProperty を 2 回目に呼び出します。
if(CertGetStoreProperty(
    hCertStore,
    CERT_STORE_LOCALIZED_NAME_PROP_ID,
    pvData,
    &cbData))
{
     printf("The localized name is %S.\n",pvData);
}
else
{
     printf("CertGetStoreProperty failed.\n");
     exit(1);
}

// 終了時にメモリを解放します。
if (pvData)
    free(pvData);

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

各言語での呼び出し定義

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

BOOL CertGetStoreProperty(
    HCERTSTORE hCertStore,
    DWORD dwPropId,
    void* pvData,   // optional
    DWORD* pcbData
);

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

<DllImport("CRYPT32.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function CertGetStoreProperty(
    hCertStore As IntPtr,   ' HCERTSTORE
    dwPropId As UInteger,   ' DWORD
    pvData As IntPtr,   ' void* optional, out
    ByRef pcbData As UInteger   ' DWORD* in/out
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function

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

import ctypes
from ctypes import wintypes

CertGetStoreProperty = ctypes.windll.crypt32.CertGetStoreProperty
CertGetStoreProperty.restype = wintypes.BOOL
CertGetStoreProperty.argtypes = [
    wintypes.HANDLE,  # hCertStore : HCERTSTORE
    wintypes.DWORD,  # dwPropId : DWORD
    ctypes.POINTER(None),  # pvData : void* optional, out
    ctypes.POINTER(wintypes.DWORD),  # pcbData : DWORD* in/out
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))

require 'fiddle'
require 'fiddle/import'

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

#[link(name = "crypt32")]
extern "system" {
    fn CertGetStoreProperty(
        hCertStore: *mut core::ffi::c_void,  // HCERTSTORE
        dwPropId: u32,  // DWORD
        pvData: *mut (),  // void* optional, out
        pcbData: *mut u32  // DWORD* in/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 CertGetStoreProperty(IntPtr hCertStore, uint dwPropId, IntPtr pvData, ref uint pcbData);
"@
$api = Add-Type -MemberDefinition $sig -Name 'CRYPT32_CertGetStoreProperty' -Namespace Win32 -PassThru
# $api::CertGetStoreProperty(hCertStore, dwPropId, pvData, pcbData)

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

出力引数:

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