ホーム › Security.Cryptography › CertAddCertificateContextToStore

CertAddCertificateContextToStore

関数

証明書コンテキストをストアに追加する。

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

シグネチャ

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

BOOL CertAddCertificateContextToStore(
    HCERTSTORE hCertStore,   // optional
    const CERT_CONTEXT* pCertContext,
    DWORD dwAddDisposition,
    CERT_CONTEXT** ppStoreContext   // optional
);

パラメーター

名前

型

方向

説明

hCertStore

HCERTSTORE

inoptional

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

pCertContext

CERT_CONTEXT*

ストアに追加する CERT_CONTEXT 構造体へのポインター。

dwAddDisposition

DWORD

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

値	意味
CERT_STORE_ADD_ALWAYS	関数は、一致する既存の証明書や一致する証明書へのリンクを確認しません。新しい証明書は常にストアに追加されます。このため、ストア内に重複が生じる可能性があります。
CERT_STORE_ADD_NEW	一致する証明書、または一致する証明書へのリンクが存在する場合、操作は失敗します。 GetLastError は CRYPT_E_EXISTS コードを返します。
CERT_STORE_ADD_NEWER	一致する証明書、または一致する証明書へのリンクが存在し、既存コンテキストの NotBefore 時刻が、追加しようとしている新しいコンテキストの NotBefore 時刻以上である場合、操作は失敗し、GetLastError は CRYPT_E_EXISTS コードを返します。既存コンテキストの NotBefore 時刻が、追加しようとしている新しいコンテキストの NotBefore 時刻より前である場合、既存の証明書またはリンクが削除され、新しい証明書が作成されてストアに追加されます。一致する証明書または一致する証明書へのリンクが存在しない場合は、新しいリンクが追加されます。証明書失効リスト (CRL) または証明書信頼リスト (CTL) を比較する場合は、ThisUpdate 時刻が使用されます。
CERT_STORE_ADD_NEWER_INHERIT_PROPERTIES	一致する証明書、または一致する証明書へのリンクが存在し、既存コンテキストの NotBefore 時刻が、追加しようとしている新しいコンテキストの NotBefore 時刻以上である場合、操作は失敗し、GetLastError は CRYPT_E_EXISTS コードを返します。既存コンテキストの NotBefore 時刻が、追加しようとしている新しいコンテキストの NotBefore 時刻より前である場合、新しいコンテキストを作成して追加する前に、既存コンテキストが削除されます。新しく追加されたコンテキストは、既存の証明書からプロパティを継承します。 CRL または CTL を比較する場合は、ThisUpdate 時刻が使用されます。
CERT_STORE_ADD_REPLACE_EXISTING	一致する証明書へのリンクが存在する場合、その既存の証明書またはリンクが削除され、新しい証明書が作成されてストアに追加されます。一致する証明書または一致する証明書へのリンクが存在しない場合は、新しいリンクが追加されます。
CERT_STORE_ADD_REPLACE_EXISTING_INHERIT_PROPERTIES	一致する証明書がストアに存在する場合、既存コンテキストは置き換えられません。既存コンテキストは、新しい証明書からプロパティを継承します。
CERT_STORE_ADD_USE_EXISTING	一致する証明書、または一致する証明書へのリンクが存在する場合、その既存の証明書またはリンクが使用され、新しい証明書のプロパティが追加されます。関数は失敗しませんが、新しいコンテキストは追加されません。pCertContext が NULL でない場合、既存コンテキストが複製されます。一致する証明書、または一致する証明書へのリンクが存在しない場合は、新しい証明書が追加されます。

ppStoreContext

CERT_CONTEXT**

outoptional

ストアに追加された証明書から作成されるコピーへのポインターへのポインター。

ppStoreContext パラメーターは NULL にすることができ、これは呼び出し元のアプリケーションが追加された証明書のコピーを必要としないことを示します。コピーが作成された場合は、 CertFreeCertificateContext を使用して解放する必要があります。

戻り値の型: BOOL

公式ドキュメント

証明書コンテキストを証明書ストアに追加します。

戻り値

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

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

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

呼び出された関数 CertAddEncodedCertificateToStore および CertSetCertificateContextProperty からのエラーが、この関数に伝播される場合があります。

解説(Remarks)

証明書コンテキストは CertDuplicateCertificateContext を使用して複製されるわけではありません。代わりに、関数はコンテキストの新しいコピーを作成してストアに追加します。

エンコードされた証明書に加えて、CertDuplicateCertificateContext はコンテキストのプロパティもコピーします。ただし、CERT_KEY_PROV_HANDLE_PROP_ID および CERT_KEY_CONTEXT_PROP_ID プロパティは除きます。

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

注ストア内で証明書コンテキストの順序が保持されない場合があります。特定の証明書にアクセスするには、ストア内の証明書を反復処理する必要があります。

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

各言語での呼び出し定義

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

BOOL CertAddCertificateContextToStore(
    HCERTSTORE hCertStore,   // optional
    const CERT_CONTEXT* pCertContext,
    DWORD dwAddDisposition,
    CERT_CONTEXT** ppStoreContext   // optional
);

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

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

' hCertStore : HCERTSTORE optional
' pCertContext : CERT_CONTEXT*
' dwAddDisposition : DWORD
' ppStoreContext : CERT_CONTEXT** optional, out
Declare PtrSafe Function CertAddCertificateContextToStore Lib "crypt32" ( _
    ByVal hCertStore As LongPtr, _
    ByVal pCertContext 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

CertAddCertificateContextToStore = ctypes.windll.crypt32.CertAddCertificateContextToStore
CertAddCertificateContextToStore.restype = wintypes.BOOL
CertAddCertificateContextToStore.argtypes = [
    wintypes.HANDLE,  # hCertStore : HCERTSTORE optional
    ctypes.c_void_p,  # pCertContext : CERT_CONTEXT*
    wintypes.DWORD,  # dwAddDisposition : DWORD
    ctypes.c_void_p,  # ppStoreContext : CERT_CONTEXT** optional, out
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('CRYPT32.dll')
CertAddCertificateContextToStore = Fiddle::Function.new(
  lib['CertAddCertificateContextToStore'],
  [
    Fiddle::TYPE_VOIDP,  # hCertStore : HCERTSTORE optional
    Fiddle::TYPE_VOIDP,  # pCertContext : CERT_CONTEXT*
    -Fiddle::TYPE_INT,  # dwAddDisposition : DWORD
    Fiddle::TYPE_VOIDP,  # ppStoreContext : CERT_CONTEXT** optional, out
  ],
  Fiddle::TYPE_INT)

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

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

出力引数:

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