ホーム › Security.Cryptography › CertAddEncodedCertificateToSystemStoreW

CertAddEncodedCertificateToSystemStoreW

関数

エンコード済み証明書をUnicode名のシステムストアに追加する。

DLLCRYPT32.dll文字セットUnicode (-W)呼出規約winapiSetLastErrorあり対応OSWindows XP 以降

シグネチャ

// CRYPT32.dll  (Unicode / -W)
#include <windows.h>

BOOL CertAddEncodedCertificateToSystemStoreW(
    LPCWSTR szCertStoreName,
    const BYTE* pbCertEncoded,
    DWORD cbCertEncoded
);

パラメーター

名前	型	方向	説明
szCertStoreName	LPCWSTR	in	エンコードされた証明書を追加するシステムストアの名前を含む、null で終端された文字列です。
pbCertEncoded	BYTE*	in	追加するエンコード済み証明書を格納するバッファへのポインターです。
cbCertEncoded	DWORD	in	pbCertEncoded バッファのサイズ(バイト単位)です。

戻り値の型: BOOL

公式ドキュメント

指定されたシステムストアを開き、エンコードされた証明書をそこに追加します。(Unicode)

戻り値

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

関数が失敗した場合、戻り値は FALSE です。CertAddEncodedCertificateToSystemStore は、エラー処理について次の「解説」に記載された関数に依存します。それぞれのエラー処理の動作については、各関数のトピックを参照してください。拡張エラー情報を取得するには、GetLastError を呼び出します。

解説(Remarks)

内部的には、CertAddEncodedCertificateToSystemStore は次のパラメーターで CertOpenSystemStore と CertAddEncodedCertificateToStore を呼び出します。

CertOpenSystemStore のパラメーター	値
szSubsystemProtocol	szCertStoreName

CertAddEncodedCertificateToSystemStore は、指定されたシステムストアのハンドルを取得した場合、戻る前に CertCloseStore を呼び出してそのハンドルを閉じます。

CertAddEncodedCertificateToStore のパラメーター	値
dwCertEncodingType	X509_ASN_ENCODING
dwAddDisposition	CERT_STORE_ADD_USE_EXISTING
ppCertContext	NULL

メモ

wincrypt.h ヘッダーは、CertAddEncodedCertificateToSystemStore を、UNICODE プリプロセッサ定数の定義に基づいてこの関数の ANSI 版または Unicode 版を自動的に選択するエイリアスとして定義しています。エンコーディング中立のエイリアスの使用を、エンコーディング中立でないコードと混在させると、不一致が生じ、コンパイルエラーや実行時エラーの原因となることがあります。詳細については、関数プロトタイプの規則を参照してください。

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

各言語での呼び出し定義

// CRYPT32.dll  (Unicode / -W)
#include <windows.h>

BOOL CertAddEncodedCertificateToSystemStoreW(
    LPCWSTR szCertStoreName,
    const BYTE* pbCertEncoded,
    DWORD cbCertEncoded
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("CRYPT32.dll", CharSet = CharSet.Unicode, SetLastError = true, ExactSpelling = true)]
static extern bool CertAddEncodedCertificateToSystemStoreW(
    [MarshalAs(UnmanagedType.LPWStr)] string szCertStoreName,   // LPCWSTR
    IntPtr pbCertEncoded,   // BYTE*
    uint cbCertEncoded   // DWORD
);

<DllImport("CRYPT32.dll", CharSet:=CharSet.Unicode, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function CertAddEncodedCertificateToSystemStoreW(
    <MarshalAs(UnmanagedType.LPWStr)> szCertStoreName As String,   ' LPCWSTR
    pbCertEncoded As IntPtr,   ' BYTE*
    cbCertEncoded As UInteger   ' DWORD
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function

' szCertStoreName : LPCWSTR
' pbCertEncoded : BYTE*
' cbCertEncoded : DWORD
Declare PtrSafe Function CertAddEncodedCertificateToSystemStoreW Lib "crypt32" ( _
    ByVal szCertStoreName As LongPtr, _
    ByVal pbCertEncoded As LongPtr, _
    ByVal cbCertEncoded As Long) As Long
' Unicode(W): 文字列は ByVal As LongPtr とし StrPtr(unicodeStr) を渡す
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

CertAddEncodedCertificateToSystemStoreW = ctypes.windll.crypt32.CertAddEncodedCertificateToSystemStoreW
CertAddEncodedCertificateToSystemStoreW.restype = wintypes.BOOL
CertAddEncodedCertificateToSystemStoreW.argtypes = [
    wintypes.LPCWSTR,  # szCertStoreName : LPCWSTR
    ctypes.POINTER(ctypes.c_ubyte),  # pbCertEncoded : BYTE*
    wintypes.DWORD,  # cbCertEncoded : DWORD
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('CRYPT32.dll')
CertAddEncodedCertificateToSystemStoreW = Fiddle::Function.new(
  lib['CertAddEncodedCertificateToSystemStoreW'],
  [
    Fiddle::TYPE_VOIDP,  # szCertStoreName : LPCWSTR
    Fiddle::TYPE_VOIDP,  # pbCertEncoded : BYTE*
    -Fiddle::TYPE_INT,  # cbCertEncoded : DWORD
  ],
  Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"

#[link(name = "crypt32")]
extern "system" {
    fn CertAddEncodedCertificateToSystemStoreW(
        szCertStoreName: *const u16,  // LPCWSTR
        pbCertEncoded: *const u8,  // BYTE*
        cbCertEncoded: u32  // DWORD
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("CRYPT32.dll", CharSet = CharSet.Unicode, SetLastError = true)]
public static extern bool CertAddEncodedCertificateToSystemStoreW([MarshalAs(UnmanagedType.LPWStr)] string szCertStoreName, IntPtr pbCertEncoded, uint cbCertEncoded);
"@
$api = Add-Type -MemberDefinition $sig -Name 'CRYPT32_CertAddEncodedCertificateToSystemStoreW' -Namespace Win32 -PassThru
# $api::CertAddEncodedCertificateToSystemStoreW(szCertStoreName, pbCertEncoded, cbCertEncoded)

#uselib "CRYPT32.dll"
#func global CertAddEncodedCertificateToSystemStoreW "CertAddEncodedCertificateToSystemStoreW" wptr, wptr, wptr
; CertAddEncodedCertificateToSystemStoreW szCertStoreName, varptr(pbCertEncoded), cbCertEncoded   ; 戻り値は stat
; szCertStoreName : LPCWSTR -> "wptr"
; pbCertEncoded : BYTE* -> "wptr"
; cbCertEncoded : DWORD -> "wptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

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