ホーム › Security.Cryptography › CryptGetMessageCertificates

CryptGetMessageCertificates

関数

署名付きメッセージに含まれる証明書をストアとして取得する。

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

シグネチャ

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

HCERTSTORE CryptGetMessageCertificates(
    DWORD dwMsgAndCertEncodingType,
    HCRYPTPROV_LEGACY hCryptProv,   // optional
    DWORD dwFlags,
    const BYTE* pbSignedBlob,
    DWORD cbSignedBlob
);

パラメーター

名前	型	方向	説明
dwMsgAndCertEncodingType	DWORD	in	使用するエンコード型を指定します。次の例に示すように、ビットごとの OR 演算で証明書エンコード型とメッセージエンコード型の両方を指定することは、常に有効です。 X509_ASN_ENCODING \| PKCS_7_ASN_ENCODING 現在定義されているエンコード型は次のとおりです。 X509_ASN_ENCODING PKCS_7_ASN_ENCODING
hCryptProv	HCRYPTPROV_LEGACY	inoptional	このパラメーターは使用されないため、NULL を設定してください。 Windows Server 2003 および Windows XP: CertOpenStore に渡される CSP のハンドルです。詳細については、 CertOpenStore を参照してください。hCryptProv に特定の暗号化プロバイダーを渡す明確な理由がない限り、ゼロを渡して既定の RSA または DSS プロバイダーを取得させてください。このパラメーターのデータ型は HCRYPTPROV です。
dwFlags	DWORD	in	CertOpenStore に渡されるフラグです。詳細については、 CertOpenStore を参照してください。
pbSignedBlob	BYTE*	in	署名済みメッセージを格納するバッファー化された CRYPT_INTEGER_BLOB 構造体へのポインターです。
cbSignedBlob	DWORD	in	署名済みメッセージのサイズ(バイト単位)です。

戻り値の型: HCERTSTORE

公式ドキュメント

CryptGetMessageCertificates 関数は、メッセージの証明書と CRL を格納する、開かれた証明書ストアのハンドルを返します。この関数は、lpszStoreProvider パラメーターにプロバイダー型 CERT_STORE_PROV_PKCS7 を指定して CertOpenStore を呼び出します。

戻り値

メッセージの証明書と CRL を格納する証明書ストアを返します。エラーの場合は NULL が返されます。

次に、 GetLastError 関数によって最も一般的に返されるエラーコードを示します。

戻り値	説明
E_INVALIDARG	メッセージおよび証明書のエンコード型が無効です。現在サポートされているのは PKCS_7_ASN_ENCODING と X509_ASN_ENCODING のみです。

関数が失敗した場合、GetLastError は Abstract Syntax Notation One(ASN.1)のエンコード/デコードエラーを返すことがあります。これらのエラーの詳細については、 ASN.1 Encoding/Decoding Return Values を参照してください。

解説(Remarks)

エラーの原因を特定するには、 GetLastError を使用してください。

例

この関数を使用する例については、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>

HCERTSTORE CryptGetMessageCertificates(
    DWORD dwMsgAndCertEncodingType,
    HCRYPTPROV_LEGACY hCryptProv,   // optional
    DWORD dwFlags,
    const BYTE* pbSignedBlob,
    DWORD cbSignedBlob
);

[DllImport("CRYPT32.dll", SetLastError = true, ExactSpelling = true)]
static extern IntPtr CryptGetMessageCertificates(
    uint dwMsgAndCertEncodingType,   // DWORD
    UIntPtr hCryptProv,   // HCRYPTPROV_LEGACY optional
    uint dwFlags,   // DWORD
    IntPtr pbSignedBlob,   // BYTE*
    uint cbSignedBlob   // DWORD
);

<DllImport("CRYPT32.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function CryptGetMessageCertificates(
    dwMsgAndCertEncodingType As UInteger,   ' DWORD
    hCryptProv As UIntPtr,   ' HCRYPTPROV_LEGACY optional
    dwFlags As UInteger,   ' DWORD
    pbSignedBlob As IntPtr,   ' BYTE*
    cbSignedBlob As UInteger   ' DWORD
) As IntPtr
End Function

' dwMsgAndCertEncodingType : DWORD
' hCryptProv : HCRYPTPROV_LEGACY optional
' dwFlags : DWORD
' pbSignedBlob : BYTE*
' cbSignedBlob : DWORD
Declare PtrSafe Function CryptGetMessageCertificates Lib "crypt32" ( _
    ByVal dwMsgAndCertEncodingType As Long, _
    ByVal hCryptProv As LongPtr, _
    ByVal dwFlags As Long, _
    ByVal pbSignedBlob As LongPtr, _
    ByVal cbSignedBlob As Long) As LongPtr
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

CryptGetMessageCertificates = ctypes.windll.crypt32.CryptGetMessageCertificates
CryptGetMessageCertificates.restype = ctypes.c_void_p
CryptGetMessageCertificates.argtypes = [
    wintypes.DWORD,  # dwMsgAndCertEncodingType : DWORD
    ctypes.c_size_t,  # hCryptProv : HCRYPTPROV_LEGACY optional
    wintypes.DWORD,  # dwFlags : DWORD
    ctypes.POINTER(ctypes.c_ubyte),  # pbSignedBlob : BYTE*
    wintypes.DWORD,  # cbSignedBlob : DWORD
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('CRYPT32.dll')
CryptGetMessageCertificates = Fiddle::Function.new(
  lib['CryptGetMessageCertificates'],
  [
    -Fiddle::TYPE_INT,  # dwMsgAndCertEncodingType : DWORD
    Fiddle::TYPE_UINTPTR_T,  # hCryptProv : HCRYPTPROV_LEGACY optional
    -Fiddle::TYPE_INT,  # dwFlags : DWORD
    Fiddle::TYPE_VOIDP,  # pbSignedBlob : BYTE*
    -Fiddle::TYPE_INT,  # cbSignedBlob : DWORD
  ],
  Fiddle::TYPE_VOIDP)

#[link(name = "crypt32")]
extern "system" {
    fn CryptGetMessageCertificates(
        dwMsgAndCertEncodingType: u32,  // DWORD
        hCryptProv: usize,  // HCRYPTPROV_LEGACY optional
        dwFlags: u32,  // DWORD
        pbSignedBlob: *const u8,  // BYTE*
        cbSignedBlob: u32  // DWORD
    ) -> *mut core::ffi::c_void;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("CRYPT32.dll", SetLastError = true)]
public static extern IntPtr CryptGetMessageCertificates(uint dwMsgAndCertEncodingType, UIntPtr hCryptProv, uint dwFlags, IntPtr pbSignedBlob, uint cbSignedBlob);
"@
$api = Add-Type -MemberDefinition $sig -Name 'CRYPT32_CryptGetMessageCertificates' -Namespace Win32 -PassThru
# $api::CryptGetMessageCertificates(dwMsgAndCertEncodingType, hCryptProv, dwFlags, pbSignedBlob, cbSignedBlob)

#uselib "CRYPT32.dll"
#func global CryptGetMessageCertificates "CryptGetMessageCertificates" sptr, sptr, sptr, sptr, sptr
; CryptGetMessageCertificates dwMsgAndCertEncodingType, hCryptProv, dwFlags, varptr(pbSignedBlob), cbSignedBlob   ; 戻り値は stat
; dwMsgAndCertEncodingType : DWORD -> "sptr"
; hCryptProv : HCRYPTPROV_LEGACY optional -> "sptr"
; dwFlags : DWORD -> "sptr"
; pbSignedBlob : BYTE* -> "sptr"
; cbSignedBlob : DWORD -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "CRYPT32.dll"
#cfunc global CryptGetMessageCertificates "CryptGetMessageCertificates" int, sptr, int, var, int
; res = CryptGetMessageCertificates(dwMsgAndCertEncodingType, hCryptProv, dwFlags, pbSignedBlob, cbSignedBlob)
; dwMsgAndCertEncodingType : DWORD -> "int"
; hCryptProv : HCRYPTPROV_LEGACY optional -> "sptr"
; dwFlags : DWORD -> "int"
; pbSignedBlob : BYTE* -> "var"
; cbSignedBlob : DWORD -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "CRYPT32.dll"
#cfunc global CryptGetMessageCertificates "CryptGetMessageCertificates" int, sptr, int, sptr, int
; res = CryptGetMessageCertificates(dwMsgAndCertEncodingType, hCryptProv, dwFlags, varptr(pbSignedBlob), cbSignedBlob)
; dwMsgAndCertEncodingType : DWORD -> "int"
; hCryptProv : HCRYPTPROV_LEGACY optional -> "sptr"
; dwFlags : DWORD -> "int"
; pbSignedBlob : BYTE* -> "sptr"
; cbSignedBlob : DWORD -> "int"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。