ホーム › Security.Cryptography › CertAddCTLContextToStore

CertAddCTLContextToStore

関数

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

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

シグネチャ

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

BOOL CertAddCTLContextToStore(
    HCERTSTORE hCertStore,   // optional
    CTL_CONTEXT* pCtlContext,
    DWORD dwAddDisposition,
    CTL_CONTEXT** ppStoreContext   // optional
);

パラメーター

名前

型

方向

説明

hCertStore

HCERTSTORE

inoptional

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

pCtlContext

CTL_CONTEXT*

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

dwAddDisposition

DWORD

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

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

ppStoreContext

CTL_CONTEXT**

outoptional

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

戻り値の型: BOOL

公式ドキュメント

証明書信頼リスト (CTL) コンテキストを証明書ストアに追加します。

戻り値

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

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

拡張エラー情報を取得するには、 GetLastError を呼び出します。考えられるエラーコードの一部を以下に示します。

Return code	Description
CRYPT_E_EXISTS	このエラーは、CERT_STORE_ADD_NEW が設定されていて CTL がストアに存在する場合、または CERT_STORE_ADD_NEWER が設定されていて、追加する CTL の ThisUpdate の日付以上の ThisUpdate の日付を持つ CTL がストアに存在する場合に返されます。
E_INVALIDARG	dwAddDisposition パラメーターに無効な add disposition が指定されました。

解説(Remarks)

CTL コンテキストは CertDuplicateCTLContext を使用して複製されるのではありません。代わりに、新しいコピーが作成されてストアに追加されます。エンコードされた CTL に加えて、コンテキストのプロパティもコピーされます。

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

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

各言語での呼び出し定義

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

BOOL CertAddCTLContextToStore(
    HCERTSTORE hCertStore,   // optional
    CTL_CONTEXT* pCtlContext,
    DWORD dwAddDisposition,
    CTL_CONTEXT** ppStoreContext   // optional
);

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

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

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

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

require 'fiddle'
require 'fiddle/import'

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

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

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

出力引数:

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