ホーム › Security.Cryptography › CryptSetProviderExA

CryptSetProviderExA

関数

ユーザーまたはマシン単位で既定の暗号プロバイダーを設定する(ANSI版)。

DLLADVAPI32.dll文字セットANSI (-A)呼出規約winapiSetLastErrorあり対応OSWindows XP 以降

シグネチャ

// ADVAPI32.dll  (ANSI / -A)
#include <windows.h>

BOOL CryptSetProviderExA(
    LPCSTR pszProvName,
    DWORD dwProvType,
    DWORD* pdwReserved,   // optional
    DWORD dwFlags
);

パラメーター

名前

型

方向

説明

pszProvName

LPCSTR

新しい既定の CSP の名前。これはコンピューターにインストールされている CSP である必要があります。利用可能な暗号化プロバイダーの一覧については、 Cryptographic Provider Names を参照してください。

dwProvType

DWORD

pszProvName で指定した CSP のプロバイダータイプ。

pdwReserved

DWORD*

optional

このパラメーターは将来の使用のために予約されており、NULL である必要があります。

dwFlags

DWORD

次のフラグ値が定義されています。

値	意味
CRYPT_DELETE_DEFAULT 0x00000004	CRYPT_MACHINE_DEFAULT または CRYPT_USER_DEFAULT と組み合わせて使用し、既定を削除できます。
CRYPT_USER_DEFAULT 0x00000002	指定したタイプのユーザーコンテキストの既定の CSP を設定します。
CRYPT_MACHINE_DEFAULT 0x00000001	指定したタイプのコンピューターの既定の CSP を設定します。

戻り値の型: BOOL

公式ドキュメント

指定したプロバイダータイプの既定の暗号化サービスプロバイダー (CSP) を、ローカルコンピューターまたは現在のユーザーに対して指定します。(ANSI)

戻り値

関数が成功した場合、戻り値は 0 以外 (TRUE) です。

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

戻り値	説明
ERROR_INVALID_PARAMETER	いずれかのパラメーターに無効な値が含まれています。これは多くの場合、無効なポインターです。
ERROR_NOT_ENOUGH_MEMORY	オペレーティングシステムのメモリが不足しました。

解説(Remarks)

ほとんどのアプリケーションは、 CryptAcquireContext 関数を呼び出す際に CSP 名を指定しません。ただし、アプリケーションは CSP 名を指定することで、適切なセキュリティレベルの CSP を選択できます。CryptSetProviderEx の呼び出しは、その時点以降にすべてのアプリケーションが使用する指定したタイプの CSP を決定するため、CryptSetProviderEx はユーザーの同意なしに呼び出してはなりません。

メモ

wincrypt.h ヘッダーは、CryptSetProviderEx を、UNICODE プリプロセッサ定数の定義に基づいてこの関数の ANSI 版または Unicode 版を自動的に選択するエイリアスとして定義します。エンコーディング非依存のエイリアスの使用を、エンコーディング非依存ではないコードと混在させると、コンパイルエラーや実行時エラーを引き起こす不一致が生じる可能性があります。詳細については、Conventions for Function Prototypes を参照してください。

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

各言語での呼び出し定義

// ADVAPI32.dll  (ANSI / -A)
#include <windows.h>

BOOL CryptSetProviderExA(
    LPCSTR pszProvName,
    DWORD dwProvType,
    DWORD* pdwReserved,   // optional
    DWORD dwFlags
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("ADVAPI32.dll", CharSet = CharSet.Ansi, SetLastError = true, ExactSpelling = true)]
static extern bool CryptSetProviderExA(
    [MarshalAs(UnmanagedType.LPStr)] string pszProvName,   // LPCSTR
    uint dwProvType,   // DWORD
    IntPtr pdwReserved,   // DWORD* optional
    uint dwFlags   // DWORD
);

<DllImport("ADVAPI32.dll", CharSet:=CharSet.Ansi, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function CryptSetProviderExA(
    <MarshalAs(UnmanagedType.LPStr)> pszProvName As String,   ' LPCSTR
    dwProvType As UInteger,   ' DWORD
    pdwReserved As IntPtr,   ' DWORD* optional
    dwFlags As UInteger   ' DWORD
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function

' pszProvName : LPCSTR
' dwProvType : DWORD
' pdwReserved : DWORD* optional
' dwFlags : DWORD
Declare PtrSafe Function CryptSetProviderExA Lib "advapi32" ( _
    ByVal pszProvName As String, _
    ByVal dwProvType As Long, _
    ByVal pdwReserved As LongPtr, _
    ByVal dwFlags As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

CryptSetProviderExA = ctypes.windll.advapi32.CryptSetProviderExA
CryptSetProviderExA.restype = wintypes.BOOL
CryptSetProviderExA.argtypes = [
    wintypes.LPCSTR,  # pszProvName : LPCSTR
    wintypes.DWORD,  # dwProvType : DWORD
    ctypes.POINTER(wintypes.DWORD),  # pdwReserved : DWORD* optional
    wintypes.DWORD,  # dwFlags : DWORD
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('ADVAPI32.dll')
CryptSetProviderExA = Fiddle::Function.new(
  lib['CryptSetProviderExA'],
  [
    Fiddle::TYPE_VOIDP,  # pszProvName : LPCSTR
    -Fiddle::TYPE_INT,  # dwProvType : DWORD
    Fiddle::TYPE_VOIDP,  # pdwReserved : DWORD* optional
    -Fiddle::TYPE_INT,  # dwFlags : DWORD
  ],
  Fiddle::TYPE_INT)

#[link(name = "advapi32")]
extern "system" {
    fn CryptSetProviderExA(
        pszProvName: *const u8,  // LPCSTR
        dwProvType: u32,  // DWORD
        pdwReserved: *mut u32,  // DWORD* optional
        dwFlags: u32  // DWORD
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("ADVAPI32.dll", CharSet = CharSet.Ansi, SetLastError = true)]
public static extern bool CryptSetProviderExA([MarshalAs(UnmanagedType.LPStr)] string pszProvName, uint dwProvType, IntPtr pdwReserved, uint dwFlags);
"@
$api = Add-Type -MemberDefinition $sig -Name 'ADVAPI32_CryptSetProviderExA' -Namespace Win32 -PassThru
# $api::CryptSetProviderExA(pszProvName, dwProvType, pdwReserved, dwFlags)

#uselib "ADVAPI32.dll"
#func global CryptSetProviderExA "CryptSetProviderExA" sptr, sptr, sptr, sptr
; CryptSetProviderExA pszProvName, dwProvType, varptr(pdwReserved), dwFlags   ; 戻り値は stat
; pszProvName : LPCSTR -> "sptr"
; dwProvType : DWORD -> "sptr"
; pdwReserved : DWORD* optional -> "sptr"
; dwFlags : DWORD -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "ADVAPI32.dll"
#cfunc global CryptSetProviderExA "CryptSetProviderExA" str, int, var, int
; res = CryptSetProviderExA(pszProvName, dwProvType, pdwReserved, dwFlags)
; pszProvName : LPCSTR -> "str"
; dwProvType : DWORD -> "int"
; pdwReserved : DWORD* optional -> "var"
; dwFlags : DWORD -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "ADVAPI32.dll"
#cfunc global CryptSetProviderExA "CryptSetProviderExA" str, int, sptr, int
; res = CryptSetProviderExA(pszProvName, dwProvType, varptr(pdwReserved), dwFlags)
; pszProvName : LPCSTR -> "str"
; dwProvType : DWORD -> "int"
; pdwReserved : DWORD* optional -> "sptr"
; dwFlags : DWORD -> "int"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。