ホーム › Security.Cryptography › CertAddEncodedCertificateToStore

CertAddEncodedCertificateToStore

関数

エンコードされた証明書をストアに追加する。

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

シグネチャ

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

BOOL CertAddEncodedCertificateToStore(
    HCERTSTORE hCertStore,   // optional
    CERT_QUERY_ENCODING_TYPE dwCertEncodingType,
    const BYTE* pbCertEncoded,
    DWORD cbCertEncoded,
    DWORD dwAddDisposition,
    CERT_CONTEXT** ppCertContext   // optional
);

パラメーター

名前

型

方向

説明

hCertStore

HCERTSTORE

inoptional

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

dwCertEncodingType

CERT_QUERY_ENCODING_TYPE

使用するエンコードの種類を指定します。次の例のように、証明書エンコードの種類とメッセージエンコードの種類の両方をビットごとの OR 演算で組み合わせて指定することは常に許容されます。

X509_ASN_ENCODING | PKCS_7_ASN_ENCODING 現在定義されているエンコードの種類は次のとおりです。

pbCertEncoded

BYTE*

証明書ストアに追加する、エンコードされた証明書を格納したバッファーへのポインター。

cbCertEncoded

DWORD

pbCertEncoded バッファーのサイズ(バイト単位)。

dwAddDisposition

DWORD

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

値	意味
CERT_STORE_ADD_ALWAYS	関数は、一致する既存の証明書や一致する証明書へのリンクの有無を確認しません。常に新しい証明書がストアに追加されます。これにより、ストア内に重複が生じる可能性があります。
CERT_STORE_ADD_NEW	一致する証明書または一致する証明書へのリンクがストアに存在する場合、操作は失敗します。 GetLastError は CRYPT_E_EXISTS コードを返します。
CERT_STORE_ADD_REPLACE_EXISTING	一致する証明書または一致する証明書へのリンクがストアに存在する場合、既存の証明書またはリンクが削除され、新しい証明書が作成されてストアに追加されます。一致する証明書または一致する証明書へのリンクが存在しない場合は、新しい証明書が作成されてストアに追加されます。
CERT_STORE_ADD_REPLACE_EXISTING_INHERIT_PROPERTIES	一致する証明書がストアに存在する場合、新しいコンテキストを作成して追加する前に、その既存のコンテキストが削除されます。新しいコンテキストは既存の証明書からプロパティを継承します。
CERT_STORE_ADD_USE_EXISTING	一致する証明書または一致する証明書へのリンクが存在する場合、その既存の証明書またはリンクが使用され、新しい証明書のプロパティが追加されます。関数は失敗しませんが、新しいコンテキストは追加しません。ppCertContext が NULL でない場合、既存のコンテキストが複製されます。一致する証明書または一致する証明書へのリンクが存在しない場合は、新しい証明書が追加されます。

ppCertContext

CERT_CONTEXT**

outoptional

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

戻り値の型: BOOL

公式ドキュメント

エンコードされた証明書から証明書コンテキストを作成し、それを証明書ストアに追加します。

戻り値

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

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

戻り値	説明
CRYPT_E_EXISTS	このコードは、CERT_STORE_ADD_NEW が設定されていて証明書が既にストアに存在する場合、または CERT_STORE_ADD_NEWER が設定されていて、追加対象の証明書の NotBefore 日付以上の NotBefore 日付を持つ証明書がストアに存在する場合に返されます。
E_INVALIDARG	dwAddDisposition パラメーターに無効な処理方法の値が指定されたか、無効な証明書エンコードの種類が指定されました。現在、X509_ASN_ENCODING 型のみがサポートされています。

関数が失敗した場合、GetLastError は Abstract Syntax Notation One (ASN.1) のエンコード/デコードエラーを返します。これらのエラーの詳細については、 ASN.1 Encoding/Decoding Return Values を参照してください。

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

各言語での呼び出し定義

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

BOOL CertAddEncodedCertificateToStore(
    HCERTSTORE hCertStore,   // optional
    CERT_QUERY_ENCODING_TYPE dwCertEncodingType,
    const BYTE* pbCertEncoded,
    DWORD cbCertEncoded,
    DWORD dwAddDisposition,
    CERT_CONTEXT** ppCertContext   // optional
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("CRYPT32.dll", SetLastError = true, ExactSpelling = true)]
static extern bool CertAddEncodedCertificateToStore(
    IntPtr hCertStore,   // HCERTSTORE optional
    uint dwCertEncodingType,   // CERT_QUERY_ENCODING_TYPE
    IntPtr pbCertEncoded,   // BYTE*
    uint cbCertEncoded,   // DWORD
    uint dwAddDisposition,   // DWORD
    IntPtr ppCertContext   // CERT_CONTEXT** optional, out
);

<DllImport("CRYPT32.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function CertAddEncodedCertificateToStore(
    hCertStore As IntPtr,   ' HCERTSTORE optional
    dwCertEncodingType As UInteger,   ' CERT_QUERY_ENCODING_TYPE
    pbCertEncoded As IntPtr,   ' BYTE*
    cbCertEncoded As UInteger,   ' DWORD
    dwAddDisposition As UInteger,   ' DWORD
    ppCertContext As IntPtr   ' CERT_CONTEXT** optional, out
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function

' hCertStore : HCERTSTORE optional
' dwCertEncodingType : CERT_QUERY_ENCODING_TYPE
' pbCertEncoded : BYTE*
' cbCertEncoded : DWORD
' dwAddDisposition : DWORD
' ppCertContext : CERT_CONTEXT** optional, out
Declare PtrSafe Function CertAddEncodedCertificateToStore Lib "crypt32" ( _
    ByVal hCertStore As LongPtr, _
    ByVal dwCertEncodingType As Long, _
    ByVal pbCertEncoded As LongPtr, _
    ByVal cbCertEncoded As Long, _
    ByVal dwAddDisposition As Long, _
    ByVal ppCertContext As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

CertAddEncodedCertificateToStore = ctypes.windll.crypt32.CertAddEncodedCertificateToStore
CertAddEncodedCertificateToStore.restype = wintypes.BOOL
CertAddEncodedCertificateToStore.argtypes = [
    wintypes.HANDLE,  # hCertStore : HCERTSTORE optional
    wintypes.DWORD,  # dwCertEncodingType : CERT_QUERY_ENCODING_TYPE
    ctypes.POINTER(ctypes.c_ubyte),  # pbCertEncoded : BYTE*
    wintypes.DWORD,  # cbCertEncoded : DWORD
    wintypes.DWORD,  # dwAddDisposition : DWORD
    ctypes.c_void_p,  # ppCertContext : 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')
CertAddEncodedCertificateToStore = Fiddle::Function.new(
  lib['CertAddEncodedCertificateToStore'],
  [
    Fiddle::TYPE_VOIDP,  # hCertStore : HCERTSTORE optional
    -Fiddle::TYPE_INT,  # dwCertEncodingType : CERT_QUERY_ENCODING_TYPE
    Fiddle::TYPE_VOIDP,  # pbCertEncoded : BYTE*
    -Fiddle::TYPE_INT,  # cbCertEncoded : DWORD
    -Fiddle::TYPE_INT,  # dwAddDisposition : DWORD
    Fiddle::TYPE_VOIDP,  # ppCertContext : CERT_CONTEXT** optional, out
  ],
  Fiddle::TYPE_INT)

#[link(name = "crypt32")]
extern "system" {
    fn CertAddEncodedCertificateToStore(
        hCertStore: *mut core::ffi::c_void,  // HCERTSTORE optional
        dwCertEncodingType: u32,  // CERT_QUERY_ENCODING_TYPE
        pbCertEncoded: *const u8,  // BYTE*
        cbCertEncoded: u32,  // DWORD
        dwAddDisposition: u32,  // DWORD
        ppCertContext: *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 CertAddEncodedCertificateToStore(IntPtr hCertStore, uint dwCertEncodingType, IntPtr pbCertEncoded, uint cbCertEncoded, uint dwAddDisposition, IntPtr ppCertContext);
"@
$api = Add-Type -MemberDefinition $sig -Name 'CRYPT32_CertAddEncodedCertificateToStore' -Namespace Win32 -PassThru
# $api::CertAddEncodedCertificateToStore(hCertStore, dwCertEncodingType, pbCertEncoded, cbCertEncoded, dwAddDisposition, ppCertContext)

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

出力引数:

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