ホーム › Security.Cryptography › CertAddCertificateLinkToStore

CertAddCertificateLinkToStore

関数

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

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

シグネチャ

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

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

パラメーター

名前

型

方向

説明

hCertStore

HCERTSTORE

リンクを追加する証明書ストアへのハンドル。

pCertContext

CERT_CONTEXT*

リンク先となる CERT_CONTEXT 構造体へのポインター。

dwAddDisposition

DWORD

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

値	意味
CERT_STORE_ADD_ALWAYS	既存の一致する証明書、または一致する証明書へのリンクの有無をチェックしません。新しい証明書は常にストアに追加されます。このため、ストア内に重複が生じる可能性があります。
CERT_STORE_ADD_NEW	一致する証明書、または一致する証明書へのリンクが存在する場合、操作は失敗します。 GetLastError は CRYPT_E_EXISTS コードを返します。
CERT_STORE_ADD_REPLACE_EXISTING	一致する証明書へのリンクが存在する場合、その既存のリンクは削除され、新しいリンクが作成されてストアに追加されます。一致する証明書または一致する証明書へのリンクが存在しない場合は、リンクが 1 つ追加されます。
CERT_STORE_ADD_USE_EXISTING	一致する証明書、または一致する証明書へのリンクが存在する場合、既存の証明書が使用されます。関数は失敗しませんが、新しいリンクは追加されません。一致する証明書または一致する証明書へのリンクが存在しない場合は、新しいリンクが追加されます。

ppStoreContext

CERT_CONTEXT**

outoptional

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

戻り値の型: BOOL

公式ドキュメント

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

戻り値

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

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

戻り値	説明
CRYPT_E_EXISTS	dwAddDisposition パラメーターが CERT_STORE_ADD_NEW の場合に、その証明書が既にストアに存在しています。
E_INVALIDARG	dwAddDisposition パラメーターに無効な disposition 値が指定されました。

解説(Remarks)

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

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

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

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

例

この関数を使用する例については、例: 証明書ストア操作の C プログラムを参照してください。この関数を使用する追加のコードについては、例: コレクションおよびシブリング証明書ストア操作の C プログラムを参照してください。

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

各言語での呼び出し定義

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

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

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

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

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

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

出力引数:

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