ホーム › Security.Cryptography › CryptGetDefaultProviderA

CryptGetDefaultProviderA

関数

指定タイプの既定暗号プロバイダー名を取得する(ANSI版)。

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

シグネチャ

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

BOOL CryptGetDefaultProviderA(
    DWORD dwProvType,
    DWORD* pdwReserved,   // optional
    DWORD dwFlags,
    LPSTR pszProvName,   // optional
    DWORD* pcbProvName
);

パラメーター

名前

型

方向

説明

dwProvType

DWORD

既定の CSP 名を検索する対象のプロバイダータイプです。

定義されているプロバイダータイプは次のとおりです。

pdwReserved

DWORD*

optional

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

dwFlags

DWORD

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

値	意味
CRYPT_USER_DEFAULT 0x00000002	指定したタイプのユーザーコンテキストの既定の CSP を返します。
CRYPT_MACHINE_DEFAULT 0x00000001	指定したタイプのコンピューターの既定の CSP を返します。

pszProvName

LPSTR

outoptional

既定の CSP の名前を受け取る、null 終端文字列バッファーへのポインターです。

メモリ割り当てを目的としてバッファーのサイズを求める場合、このパラメーターに NULL を指定できます。詳細については、 Retrieving Data of Unknown Length を参照してください。

pcbProvName

DWORD*

inout

pszProvName パラメーターが指すバッファーのサイズ (バイト単位) を指定する DWORD 値へのポインターです。関数が返るとき、この DWORD 値にはバッファーに格納された、または格納されるバイト数が設定されます。

注バッファーで返されるデータを処理する際、アプリケーションは返されたデータの実際のサイズを使用する必要があります。実際のサイズは、入力時に指定したバッファーのサイズよりわずかに小さい場合があります。(入力時には通常、想定される最大の出力データが収まるように十分大きなバッファーサイズを指定します。) 出力時には、このパラメーターが指す変数は、バッファーにコピーされたデータの実際のサイズを反映するように更新されます。

戻り値の型: BOOL

公式ドキュメント

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

戻り値

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

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

NTE を接頭辞とするエラーコードは、使用されている個々の CSP によって生成されます。発生し得るエラーコードには次のものがあります。

戻り値	説明
ERROR_INVALID_PARAMETER	いずれかのパラメーターに無効な値が含まれています。多くの場合、無効なポインターが原因です。
ERROR_MORE_DATA	名前を格納するバッファーが十分な大きさではありません。
ERROR_NOT_ENOUGH_MEMORY	オペレーティングシステムのメモリが不足しました。
NTE_BAD_FLAGS	dwFlags パラメーターに認識されない値が指定されています。

解説(Remarks)

この関数は、ローカルコンピューターまたは現在のユーザーについて、インストール済みのどの CSP が現在既定として設定されているかを判別します。この情報は多くの場合ユーザーに表示されます。

例

次の例では、PROV_RSA_FULL プロバイダータイプの既定の CSP の名前を取得します。この関数を使用する別の例については、Example C Program: Enumerating CSP Providers and Provider Types を参照してください。

#include <stdio.h>
#include <windows.h>
#include <Wincrypt.h>
#pragma comment(lib, "crypt32.lib")

void main()
{

    DWORD       cbProvName=0;
    LPTSTR      pbProvName=NULL;
    // Copyright (C) Microsoft.  All rights reserved.
    // Get the length of the RSA_FULL default provider name.
    if (!(CryptGetDefaultProvider(
         PROV_RSA_FULL, 
         NULL, 
         CRYPT_MACHINE_DEFAULT,
         NULL, 
         &cbProvName))) 
    { 
      printf("Error getting the length of the default "
          "provider name.\n");
      exit(1);
    }

    // Allocate local memory for the name of the default provider.
    if (!(pbProvName = (LPTSTR)LocalAlloc(LMEM_ZEROINIT, 
        cbProvName)))
    {
        printf("Error during memory allocation for "
            "provider name.\n");
        exit(1);
    }

    // Get the default provider name.
    if (CryptGetDefaultProvider(
        PROV_RSA_FULL, 
        NULL, 
        CRYPT_MACHINE_DEFAULT,
        pbProvName,
        &cbProvName)) 
    {
        printf("The default provider name is %s\n",pbProvName);
    }
    else
    {
        printf("Getting the name of the provider failed.\n");
        exit(1);
    }

    // Free resources when done.
    LocalFree(pbProvName);

}

メモ

wincrypt.h ヘッダーは CryptGetDefaultProvider を、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 CryptGetDefaultProviderA(
    DWORD dwProvType,
    DWORD* pdwReserved,   // optional
    DWORD dwFlags,
    LPSTR pszProvName,   // optional
    DWORD* pcbProvName
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("ADVAPI32.dll", CharSet = CharSet.Ansi, SetLastError = true, ExactSpelling = true)]
static extern bool CryptGetDefaultProviderA(
    uint dwProvType,   // DWORD
    IntPtr pdwReserved,   // DWORD* optional
    uint dwFlags,   // DWORD
    [MarshalAs(UnmanagedType.LPStr)] System.Text.StringBuilder pszProvName,   // LPSTR optional, out
    ref uint pcbProvName   // DWORD* in/out
);

<DllImport("ADVAPI32.dll", CharSet:=CharSet.Ansi, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function CryptGetDefaultProviderA(
    dwProvType As UInteger,   ' DWORD
    pdwReserved As IntPtr,   ' DWORD* optional
    dwFlags As UInteger,   ' DWORD
    <MarshalAs(UnmanagedType.LPStr)> pszProvName As System.Text.StringBuilder,   ' LPSTR optional, out
    ByRef pcbProvName As UInteger   ' DWORD* in/out
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function

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

import ctypes
from ctypes import wintypes

CryptGetDefaultProviderA = ctypes.windll.advapi32.CryptGetDefaultProviderA
CryptGetDefaultProviderA.restype = wintypes.BOOL
CryptGetDefaultProviderA.argtypes = [
    wintypes.DWORD,  # dwProvType : DWORD
    ctypes.POINTER(wintypes.DWORD),  # pdwReserved : DWORD* optional
    wintypes.DWORD,  # dwFlags : DWORD
    wintypes.LPSTR,  # pszProvName : LPSTR optional, out
    ctypes.POINTER(wintypes.DWORD),  # pcbProvName : DWORD* in/out
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('ADVAPI32.dll')
CryptGetDefaultProviderA = Fiddle::Function.new(
  lib['CryptGetDefaultProviderA'],
  [
    -Fiddle::TYPE_INT,  # dwProvType : DWORD
    Fiddle::TYPE_VOIDP,  # pdwReserved : DWORD* optional
    -Fiddle::TYPE_INT,  # dwFlags : DWORD
    Fiddle::TYPE_VOIDP,  # pszProvName : LPSTR optional, out
    Fiddle::TYPE_VOIDP,  # pcbProvName : DWORD* in/out
  ],
  Fiddle::TYPE_INT)

#[link(name = "advapi32")]
extern "system" {
    fn CryptGetDefaultProviderA(
        dwProvType: u32,  // DWORD
        pdwReserved: *mut u32,  // DWORD* optional
        dwFlags: u32,  // DWORD
        pszProvName: *mut u8,  // LPSTR optional, out
        pcbProvName: *mut u32  // DWORD* in/out
    ) -> 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 CryptGetDefaultProviderA(uint dwProvType, IntPtr pdwReserved, uint dwFlags, [MarshalAs(UnmanagedType.LPStr)] System.Text.StringBuilder pszProvName, ref uint pcbProvName);
"@
$api = Add-Type -MemberDefinition $sig -Name 'ADVAPI32_CryptGetDefaultProviderA' -Namespace Win32 -PassThru
# $api::CryptGetDefaultProviderA(dwProvType, pdwReserved, dwFlags, pszProvName, pcbProvName)

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

出力引数:

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