ホーム › Security.Cryptography › CertAddEncodedCTLToStore

CertAddEncodedCTLToStore

関数

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

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

シグネチャ

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

BOOL CertAddEncodedCTLToStore(
    HCERTSTORE hCertStore,   // optional
    CERT_QUERY_ENCODING_TYPE dwMsgAndCertEncodingType,
    const BYTE* pbCtlEncoded,
    DWORD cbCtlEncoded,
    DWORD dwAddDisposition,
    CTL_CONTEXT** ppCtlContext   // optional
);

パラメーター

名前

型

方向

説明

hCertStore

HCERTSTORE

inoptional

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

dwMsgAndCertEncodingType

CERT_QUERY_ENCODING_TYPE

使用するエンコードの種類を指定します。証明書とメッセージのエンコードの種類は、次の例のようにビット単位の OR 演算で組み合わせて両方を指定する必要があります。

X509_ASN_ENCODING | PKCS_7_ASN_ENCODING

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

pbCtlEncoded

BYTE*

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

cbCtlEncoded

DWORD

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

dwAddDisposition

DWORD

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

値	意味
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 が追加されます。

ppCtlContext

CTL_CONTEXT**

outoptional

デコードされた CTL_CONTEXT 構造体へのポインターへのポインター。NULL を指定でき、その場合は呼び出し元のアプリケーションが追加された CTL または既存の CTL のコピーを必要としないことを示します。コピーが作成された場合は、 CertFreeCTLContext を使用して解放する必要があります。

戻り値の型: BOOL

公式ドキュメント

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

戻り値

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

関数が失敗した場合、戻り値は FALSE です。拡張エラー情報を取得するには、 GetLastError を呼び出します。

発生し得るエラーコードの一部を次に示します。

戻り値	説明
CRYPT_E_EXISTS	CERT_STORE_ADD_NEW が設定されており、CTL が既にストアに存在する場合。または、CERT_STORE_ADD_NEWER が設定されており、追加対象の CTL の ThisUpdate 時刻以上の ThisUpdate 時刻を持つ CTL がストアに存在する場合。
E_INVALIDARG	dwAddDisposition パラメーターに無効な処理方法の値が指定されたか、無効なエンコードの種類が指定されました。現在サポートされているエンコードの種類は X509_ASN_ENCODING と PKCS_7_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 CertAddEncodedCTLToStore(
    HCERTSTORE hCertStore,   // optional
    CERT_QUERY_ENCODING_TYPE dwMsgAndCertEncodingType,
    const BYTE* pbCtlEncoded,
    DWORD cbCtlEncoded,
    DWORD dwAddDisposition,
    CTL_CONTEXT** ppCtlContext   // optional
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("CRYPT32.dll", SetLastError = true, ExactSpelling = true)]
static extern bool CertAddEncodedCTLToStore(
    IntPtr hCertStore,   // HCERTSTORE optional
    uint dwMsgAndCertEncodingType,   // CERT_QUERY_ENCODING_TYPE
    IntPtr pbCtlEncoded,   // BYTE*
    uint cbCtlEncoded,   // DWORD
    uint dwAddDisposition,   // DWORD
    IntPtr ppCtlContext   // CTL_CONTEXT** optional, out
);

<DllImport("CRYPT32.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function CertAddEncodedCTLToStore(
    hCertStore As IntPtr,   ' HCERTSTORE optional
    dwMsgAndCertEncodingType As UInteger,   ' CERT_QUERY_ENCODING_TYPE
    pbCtlEncoded As IntPtr,   ' BYTE*
    cbCtlEncoded As UInteger,   ' DWORD
    dwAddDisposition As UInteger,   ' DWORD
    ppCtlContext As IntPtr   ' CTL_CONTEXT** optional, out
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function

' hCertStore : HCERTSTORE optional
' dwMsgAndCertEncodingType : CERT_QUERY_ENCODING_TYPE
' pbCtlEncoded : BYTE*
' cbCtlEncoded : DWORD
' dwAddDisposition : DWORD
' ppCtlContext : CTL_CONTEXT** optional, out
Declare PtrSafe Function CertAddEncodedCTLToStore Lib "crypt32" ( _
    ByVal hCertStore As LongPtr, _
    ByVal dwMsgAndCertEncodingType As Long, _
    ByVal pbCtlEncoded As LongPtr, _
    ByVal cbCtlEncoded As Long, _
    ByVal dwAddDisposition As Long, _
    ByVal ppCtlContext As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

CertAddEncodedCTLToStore = ctypes.windll.crypt32.CertAddEncodedCTLToStore
CertAddEncodedCTLToStore.restype = wintypes.BOOL
CertAddEncodedCTLToStore.argtypes = [
    wintypes.HANDLE,  # hCertStore : HCERTSTORE optional
    wintypes.DWORD,  # dwMsgAndCertEncodingType : CERT_QUERY_ENCODING_TYPE
    ctypes.POINTER(ctypes.c_ubyte),  # pbCtlEncoded : BYTE*
    wintypes.DWORD,  # cbCtlEncoded : DWORD
    wintypes.DWORD,  # dwAddDisposition : DWORD
    ctypes.c_void_p,  # ppCtlContext : 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')
CertAddEncodedCTLToStore = Fiddle::Function.new(
  lib['CertAddEncodedCTLToStore'],
  [
    Fiddle::TYPE_VOIDP,  # hCertStore : HCERTSTORE optional
    -Fiddle::TYPE_INT,  # dwMsgAndCertEncodingType : CERT_QUERY_ENCODING_TYPE
    Fiddle::TYPE_VOIDP,  # pbCtlEncoded : BYTE*
    -Fiddle::TYPE_INT,  # cbCtlEncoded : DWORD
    -Fiddle::TYPE_INT,  # dwAddDisposition : DWORD
    Fiddle::TYPE_VOIDP,  # ppCtlContext : CTL_CONTEXT** optional, out
  ],
  Fiddle::TYPE_INT)

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

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

出力引数:

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