ホーム › Security.Cryptography › CertAddCRLContextToStore

CertAddCRLContextToStore

関数

CRLコンテキストをストアに追加する。

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

シグネチャ

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

BOOL CertAddCRLContextToStore(
    HCERTSTORE hCertStore,   // optional
    CRL_CONTEXT* pCrlContext,
    DWORD dwAddDisposition,
    CRL_CONTEXT** ppStoreContext   // optional
);

パラメーター

名前

型

方向

説明

hCertStore

HCERTSTORE

inoptional

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

pCrlContext

CRL_CONTEXT*

追加する CRL_CONTEXT 構造体へのポインター。

dwAddDisposition

DWORD

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

値	意味
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 が追加されます。

ppStoreContext

CRL_CONTEXT**

outoptional

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

戻り値の型: BOOL

公式ドキュメント

指定された証明書ストアに証明書失効リスト (CRL) コンテキストを追加します。

戻り値

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

関数が失敗した場合、戻り値は FALSE です。呼び出される関数 CertAddEncodedCRLToStore および CertSetCRLContextProperty からのエラーが、この関数に伝播されることがあります。

拡張エラー情報を取得するには、 GetLastError を呼び出します。発生し得るエラーコードの一部を次に示します。

戻り値コード	説明
CRYPT_E_EXISTS	このエラーは、CERT_STORE_ADD_NEW が設定されていて CRL が既にストアに存在する場合、または CERT_STORE_ADD_NEWER が設定されていて、追加する CRL の ThisUpdate 日付以上の ThisUpdate 日付を持つ CRL がストアに存在する場合に返されます。
E_INVALIDARG	dwAddDisposition パラメーターに、有効でない処理 (disposition) 値が指定されました。

解説(Remarks)

CRL コンテキストは CertDuplicateCRLContext を使用して複製されるのではなく、新しいコピーが作成されてストアに追加されます。エンコードされた CRL のコピーに加えて、この関数はコンテキストのプロパティもコピーします。

証明書ストアから CRL コンテキストを削除するには、CertDeleteCRLFromStore 関数を使用します。

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

各言語での呼び出し定義

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

BOOL CertAddCRLContextToStore(
    HCERTSTORE hCertStore,   // optional
    CRL_CONTEXT* pCrlContext,
    DWORD dwAddDisposition,
    CRL_CONTEXT** ppStoreContext   // optional
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("CRYPT32.dll", SetLastError = true, ExactSpelling = true)]
static extern bool CertAddCRLContextToStore(
    IntPtr hCertStore,   // HCERTSTORE optional
    IntPtr pCrlContext,   // CRL_CONTEXT*
    uint dwAddDisposition,   // DWORD
    IntPtr ppStoreContext   // CRL_CONTEXT** optional, out
);

<DllImport("CRYPT32.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function CertAddCRLContextToStore(
    hCertStore As IntPtr,   ' HCERTSTORE optional
    pCrlContext As IntPtr,   ' CRL_CONTEXT*
    dwAddDisposition As UInteger,   ' DWORD
    ppStoreContext As IntPtr   ' CRL_CONTEXT** optional, out
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function

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

import ctypes
from ctypes import wintypes

CertAddCRLContextToStore = ctypes.windll.crypt32.CertAddCRLContextToStore
CertAddCRLContextToStore.restype = wintypes.BOOL
CertAddCRLContextToStore.argtypes = [
    wintypes.HANDLE,  # hCertStore : HCERTSTORE optional
    ctypes.c_void_p,  # pCrlContext : CRL_CONTEXT*
    wintypes.DWORD,  # dwAddDisposition : DWORD
    ctypes.c_void_p,  # ppStoreContext : 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')
CertAddCRLContextToStore = Fiddle::Function.new(
  lib['CertAddCRLContextToStore'],
  [
    Fiddle::TYPE_VOIDP,  # hCertStore : HCERTSTORE optional
    Fiddle::TYPE_VOIDP,  # pCrlContext : CRL_CONTEXT*
    -Fiddle::TYPE_INT,  # dwAddDisposition : DWORD
    Fiddle::TYPE_VOIDP,  # ppStoreContext : CRL_CONTEXT** optional, out
  ],
  Fiddle::TYPE_INT)

#[link(name = "crypt32")]
extern "system" {
    fn CertAddCRLContextToStore(
        hCertStore: *mut core::ffi::c_void,  // HCERTSTORE optional
        pCrlContext: *mut CRL_CONTEXT,  // CRL_CONTEXT*
        dwAddDisposition: u32,  // DWORD
        ppStoreContext: *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 CertAddCRLContextToStore(IntPtr hCertStore, IntPtr pCrlContext, uint dwAddDisposition, IntPtr ppStoreContext);
"@
$api = Add-Type -MemberDefinition $sig -Name 'CRYPT32_CertAddCRLContextToStore' -Namespace Win32 -PassThru
# $api::CertAddCRLContextToStore(hCertStore, pCrlContext, dwAddDisposition, ppStoreContext)

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

出力引数:

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