ホーム › Security.Cryptography › CertAddCTLLinkToStore

CertAddCTLLinkToStore

関数

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

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

シグネチャ

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

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

パラメーター

名前

型

方向

説明

hCertStore

HCERTSTORE

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

pCtlContext

CTL_CONTEXT*

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

dwAddDisposition

DWORD

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

値	意味
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

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

戻り値の型: BOOL

公式ドキュメント

CertAddCTLLinkToStore 関数は、別のストアにある証明書信頼リスト (CTL) コンテキストへのリンクを、あるストアに追加します。CTL コンテキストの複製を作成して追加するのではなく、この関数は元の CTL コンテキストへのリンクを追加します。

戻り値

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

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

戻り値コード	説明
CRYPT_E_EXISTS	dwAddDisposition が CERT_STORE_ADD_NEW の場合に、CTL がストアに既に存在しています。
E_INVALIDARG	dwAddDisposition パラメーターで指定された追加処理 (add disposition) が無効です。

解説(Remarks)

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

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

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

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

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

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

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

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

出力引数:

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