ホーム › Security.Cryptography › CertAddEncodedCRLToStore

CertAddEncodedCRLToStore

関数

エンコードされたCRLをストアに追加する。

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

シグネチャ

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

BOOL CertAddEncodedCRLToStore(
    HCERTSTORE hCertStore,   // optional
    CERT_QUERY_ENCODING_TYPE dwCertEncodingType,
    const BYTE* pbCrlEncoded,
    DWORD cbCrlEncoded,
    DWORD dwAddDisposition,
    CRL_CONTEXT** ppCrlContext   // optional
);

パラメーター

名前

型

方向

説明

hCertStore

HCERTSTORE

inoptional

証明書ストアのハンドル。

dwCertEncodingType

CERT_QUERY_ENCODING_TYPE

使用するエンコードの種類を指定します。次の例のように、証明書のエンコードの種類とメッセージのエンコードの種類をビットごとの OR 演算で組み合わせて指定することは常に許容されます。

X509_ASN_ENCODING | PKCS_7_ASN_ENCODING 現在定義されているエンコードの種類は次のとおりです。

pbCrlEncoded

BYTE*

証明書ストアに追加する、エンコードされた CRL を格納したバッファーへのポインター。

cbCrlEncoded

DWORD

pbCrlEncoded バッファーのサイズ (バイト単位)。

dwAddDisposition

DWORD

一致する CRL、または一致する CRL へのリンクがストアに既に存在する場合に実行する処理を指定します。現在定義されている処理値とその用途は次のとおりです。

値	意味
CERT_STORE_ADD_ALWAYS	一致する既存の CRL や一致する CRL へのリンクの確認を行いません。新しい CRL は常にストアに追加されます。これによりストア内に重複が生じる可能性があります。
CERT_STORE_ADD_NEW	一致する CRL、または一致する CRL へのリンクが存在する場合、操作は失敗します。 GetLastError は CRYPT_E_EXISTS コードを返します。
CERT_STORE_ADD_NEWER	一致する CRL、または一致する CRL へのリンクが存在する場合、両 CRL の ThisUpdate 時刻が比較されます。既存の CRL の ThisUpdate 時刻が新しい CRL の ThisUpdate 時刻より前の場合、CERT_STORE_ADD_REPLACE_EXISTING と同様に古い CRL またはリンクが置き換えられます。既存の CRL の ThisUpdate 時刻が追加対象の CRL の ThisUpdate 時刻以降の場合、関数は失敗し、 GetLastError は CRYPT_E_EXISTS コードを返します。一致する CRL、または一致する CRL へのリンクがストア内に見つからない場合、新しい CRL がストアに追加されます。
CERT_STORE_ADD_NEWER_INHERIT_PROPERTIES	処理は CERT_STORE_ADD_NEWER と同じですが、古い CRL が置き換えられる場合、古い CRL のプロパティが置換後の CRL に取り込まれる点が異なります。
CERT_STORE_ADD_REPLACE_EXISTING	一致する CRL、または一致する CRL へのリンクが存在する場合、その既存の CRL またはリンクが削除され、新しい CRL が作成されてストアに追加されます。一致する CRL、または一致する CRL へのリンクが存在しない場合は、新たに追加されます。
CERT_STORE_ADD_REPLACE_EXISTING_INHERIT_PROPERTIES	一致する CRL がストア内に存在する場合、新しいコンテキストを作成して追加する前に、その既存のコンテキストが削除されます。新しいコンテキストは既存の CRL からプロパティを継承します。
CERT_STORE_ADD_USE_EXISTING	一致する CRL、または一致する CRL へのリンクが存在する場合、その既存の CRL が使用され、新しい CRL のプロパティが追加されます。関数は失敗しませんが、新しい CRL は追加されません。ppCertContext が NULL でない場合、既存のコンテキストが複製されます。一致する CRL、または一致する CRL へのリンクが存在しない場合、新しい CRL が追加されます。

ppCrlContext

CRL_CONTEXT**

outoptional

デコードされた CRL_CONTEXT 構造体へのポインターへのポインター。これは省略可能なパラメーターで、NULL を指定できます。NULL を指定すると、呼び出し元のアプリケーションが新しい CRL または既存の CRL のコピーを必要としないことを示します。コピーが作成された場合、そのコンテキストは CertFreeCRLContext を使用して解放する必要があります。

戻り値の型: BOOL

公式ドキュメント

エンコードされた CRL から証明書失効リスト (CRL) コンテキストを作成し、証明書ストアに追加します。

戻り値

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

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

戻り値	説明
CRYPT_E_EXISTS	CERT_STORE_ADD_NEW が設定されており、その CRL がストアに既に存在する場合、または CERT_STORE_ADD_NEWER が設定されており、追加対象の CRL の ThisUpdate 時刻以降の ThisUpdate 時刻を持つ CRL がストアに存在する場合。
E_INVALIDARG	dwAddDisposition パラメーターに無効な処理値が指定されたか、無効なエンコードの種類が指定されました。現在、エンコードの種類は X509_ASN_ENCODING のみがサポートされています。

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

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

各言語での呼び出し定義

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

BOOL CertAddEncodedCRLToStore(
    HCERTSTORE hCertStore,   // optional
    CERT_QUERY_ENCODING_TYPE dwCertEncodingType,
    const BYTE* pbCrlEncoded,
    DWORD cbCrlEncoded,
    DWORD dwAddDisposition,
    CRL_CONTEXT** ppCrlContext   // optional
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("CRYPT32.dll", SetLastError = true, ExactSpelling = true)]
static extern bool CertAddEncodedCRLToStore(
    IntPtr hCertStore,   // HCERTSTORE optional
    uint dwCertEncodingType,   // CERT_QUERY_ENCODING_TYPE
    IntPtr pbCrlEncoded,   // BYTE*
    uint cbCrlEncoded,   // DWORD
    uint dwAddDisposition,   // DWORD
    IntPtr ppCrlContext   // CRL_CONTEXT** optional, out
);

<DllImport("CRYPT32.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function CertAddEncodedCRLToStore(
    hCertStore As IntPtr,   ' HCERTSTORE optional
    dwCertEncodingType As UInteger,   ' CERT_QUERY_ENCODING_TYPE
    pbCrlEncoded As IntPtr,   ' BYTE*
    cbCrlEncoded As UInteger,   ' DWORD
    dwAddDisposition As UInteger,   ' DWORD
    ppCrlContext As IntPtr   ' CRL_CONTEXT** optional, out
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function

' hCertStore : HCERTSTORE optional
' dwCertEncodingType : CERT_QUERY_ENCODING_TYPE
' pbCrlEncoded : BYTE*
' cbCrlEncoded : DWORD
' dwAddDisposition : DWORD
' ppCrlContext : CRL_CONTEXT** optional, out
Declare PtrSafe Function CertAddEncodedCRLToStore Lib "crypt32" ( _
    ByVal hCertStore As LongPtr, _
    ByVal dwCertEncodingType As Long, _
    ByVal pbCrlEncoded As LongPtr, _
    ByVal cbCrlEncoded As Long, _
    ByVal dwAddDisposition As Long, _
    ByVal ppCrlContext As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

CertAddEncodedCRLToStore = ctypes.windll.crypt32.CertAddEncodedCRLToStore
CertAddEncodedCRLToStore.restype = wintypes.BOOL
CertAddEncodedCRLToStore.argtypes = [
    wintypes.HANDLE,  # hCertStore : HCERTSTORE optional
    wintypes.DWORD,  # dwCertEncodingType : CERT_QUERY_ENCODING_TYPE
    ctypes.POINTER(ctypes.c_ubyte),  # pbCrlEncoded : BYTE*
    wintypes.DWORD,  # cbCrlEncoded : DWORD
    wintypes.DWORD,  # dwAddDisposition : DWORD
    ctypes.c_void_p,  # ppCrlContext : CRL_CONTEXT** optional, out
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('CRYPT32.dll')
CertAddEncodedCRLToStore = Fiddle::Function.new(
  lib['CertAddEncodedCRLToStore'],
  [
    Fiddle::TYPE_VOIDP,  # hCertStore : HCERTSTORE optional
    -Fiddle::TYPE_INT,  # dwCertEncodingType : CERT_QUERY_ENCODING_TYPE
    Fiddle::TYPE_VOIDP,  # pbCrlEncoded : BYTE*
    -Fiddle::TYPE_INT,  # cbCrlEncoded : DWORD
    -Fiddle::TYPE_INT,  # dwAddDisposition : DWORD
    Fiddle::TYPE_VOIDP,  # ppCrlContext : CRL_CONTEXT** optional, out
  ],
  Fiddle::TYPE_INT)

#[link(name = "crypt32")]
extern "system" {
    fn CertAddEncodedCRLToStore(
        hCertStore: *mut core::ffi::c_void,  // HCERTSTORE optional
        dwCertEncodingType: u32,  // CERT_QUERY_ENCODING_TYPE
        pbCrlEncoded: *const u8,  // BYTE*
        cbCrlEncoded: u32,  // DWORD
        dwAddDisposition: u32,  // DWORD
        ppCrlContext: *mut *mut CRL_CONTEXT  // CRL_CONTEXT** 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 CertAddEncodedCRLToStore(IntPtr hCertStore, uint dwCertEncodingType, IntPtr pbCrlEncoded, uint cbCrlEncoded, uint dwAddDisposition, IntPtr ppCrlContext);
"@
$api = Add-Type -MemberDefinition $sig -Name 'CRYPT32_CertAddEncodedCRLToStore' -Namespace Win32 -PassThru
# $api::CertAddEncodedCRLToStore(hCertStore, dwCertEncodingType, pbCrlEncoded, cbCrlEncoded, dwAddDisposition, ppCrlContext)

#uselib "CRYPT32.dll"
#func global CertAddEncodedCRLToStore "CertAddEncodedCRLToStore" sptr, sptr, sptr, sptr, sptr, sptr
; CertAddEncodedCRLToStore hCertStore, dwCertEncodingType, varptr(pbCrlEncoded), cbCrlEncoded, dwAddDisposition, varptr(ppCrlContext)   ; 戻り値は stat
; hCertStore : HCERTSTORE optional -> "sptr"
; dwCertEncodingType : CERT_QUERY_ENCODING_TYPE -> "sptr"
; pbCrlEncoded : BYTE* -> "sptr"
; cbCrlEncoded : DWORD -> "sptr"
; dwAddDisposition : DWORD -> "sptr"
; ppCrlContext : CRL_CONTEXT** optional, out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

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