ホーム › Security.Cryptography › CertAddCRLLinkToStore

CertAddCRLLinkToStore

関数

別ストアのCRLへのリンクをストアに追加する。

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

シグネチャ

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

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

パラメーター

名前

型

方向

説明

hCertStore

HCERTSTORE

リンクの追加先となる証明書ストアのハンドルです。

pCrlContext

CRL_CONTEXT*

リンク対象となる CRL_CONTEXT 構造体へのポインターです。

dwAddDisposition

DWORD

一致する CRL、または一致する CRL へのリンクがストア内に存在する場合に取る動作を指定します。現在定義されている配置値とその用途は次のとおりです。

値	意味
CERT_STORE_ADD_ALWAYS	既存の一致する 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 の ThisUpdate 時刻が追加対象の CRL の ThisUpdate 時刻以上である場合、関数は失敗し、 GetLastError は CRYPT_E_EXISTS コードを返します。一致する CRL、または一致する CRL へのリンクがストア内に見つからない場合は、新しいリンクがストアに追加されます。
CERT_STORE_ADD_REPLACE_EXISTING	一致する CRL へのリンクが存在する場合、その既存のリンクは削除され、新しいリンクが作成されてストアに追加されます。一致する CRL、または一致する CRL へのリンクが存在しない場合は、新しいリンクが追加されます。
CERT_STORE_ADD_USE_EXISTING	一致する CRL、または一致する CRL へのリンクが存在する場合、その既存のリンクが使用されます。関数は失敗しませんが、新しいリンクは追加されません。一致する CRL、または CRL へのリンクが存在しない場合は、新しいリンクが追加されます。

ppStoreContext

CRL_CONTEXT**

outoptional

作成されたリンクのコピーへのポインターを格納するためのポインターです。リンクのコピーが不要であることを示すために、ppStoreContext パラメーターを NULL にできます。リンクのコピーが作成された場合、そのコピーは CertFreeCRLContext を使用して解放する必要があります。

戻り値の型: BOOL

公式ドキュメント

あるストア内に、別のストアにある証明書失効リスト(CRL)コンテキストへのリンクを追加します。

戻り値

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

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

戻りコード	説明
CRYPT_E_EXISTS	dwAddDisposition が CERT_STORE_ADD_NEW の場合に、CTL が既にストア内に存在します。
E_INVALIDARG	dwAddDisposition パラメーターに無効な配置値が指定されました。

解説(Remarks)

リンクは元の CRL コンテキストへのアクセスを提供するため、リンクされた CRL コンテキストで拡張プロパティを設定すると、CRL の元の場所およびその CRL への他のすべてのリンクにおいても、その拡張プロパティが変更されます。

コレクションとして開かれたストアにはリンクを追加できません。コレクションとして開かれたストアには、 CertOpenSystemStore で開かれたストア、または CERT_STORE_PROV_SYSTEM か CERT_STORE_PROV_COLLECTION を使用して CertOpenStore で開かれたすべてのストアが含まれます。詳細については、 CertAddStoreToCollection を参照してください。

リンクが使用されており、CERT_CLOSE_STORE_FORCE_FLAG を指定して CertCloseStore が呼び出される場合、元のコンテキストを含むストアを閉じる前に、リンクを使用するストアを閉じる必要があります。CERT_CLOSE_STORE_FORCE_FLAG を使用しない場合は、2 つのストアをどちらの順序でも閉じることができます。

証明書ストアから 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 CertAddCRLLinkToStore(
    HCERTSTORE hCertStore,
    CRL_CONTEXT* pCrlContext,
    DWORD dwAddDisposition,
    CRL_CONTEXT** ppStoreContext   // optional
);

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

<DllImport("CRYPT32.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function CertAddCRLLinkToStore(
    hCertStore As IntPtr,   ' HCERTSTORE
    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
' pCrlContext : CRL_CONTEXT*
' dwAddDisposition : DWORD
' ppStoreContext : CRL_CONTEXT** optional, out
Declare PtrSafe Function CertAddCRLLinkToStore 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

CertAddCRLLinkToStore = ctypes.windll.crypt32.CertAddCRLLinkToStore
CertAddCRLLinkToStore.restype = wintypes.BOOL
CertAddCRLLinkToStore.argtypes = [
    wintypes.HANDLE,  # hCertStore : HCERTSTORE
    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')
CertAddCRLLinkToStore = Fiddle::Function.new(
  lib['CertAddCRLLinkToStore'],
  [
    Fiddle::TYPE_VOIDP,  # hCertStore : HCERTSTORE
    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 CertAddCRLLinkToStore(
        hCertStore: *mut core::ffi::c_void,  // HCERTSTORE
        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 CertAddCRLLinkToStore(IntPtr hCertStore, IntPtr pCrlContext, uint dwAddDisposition, IntPtr ppStoreContext);
"@
$api = Add-Type -MemberDefinition $sig -Name 'CRYPT32_CertAddCRLLinkToStore' -Namespace Win32 -PassThru
# $api::CertAddCRLLinkToStore(hCertStore, pCrlContext, dwAddDisposition, ppStoreContext)

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

出力引数:

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