CryptSetProvParam
関数シグネチャ
// ADVAPI32.dll
#include <windows.h>
BOOL CryptSetProvParam(
UINT_PTR hProv,
CRYPT_SET_PROV_PARAM_ID dwParam,
const BYTE* pbData,
DWORD dwFlags
);パラメーター
| 名前 | 型 | 方向 | 説明 | ||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| hProv | UINT_PTR | in | 値を設定する対象の CSP のハンドル。このハンドルは、あらかじめ CryptAcquireContext 関数を使用して作成されている必要があります。 | ||||||||||||||||||||||||||||||||||||||
| dwParam | CRYPT_SET_PROV_PARAM_ID | in | 設定するパラメーターを指定します。次のいずれかの値を指定できます。
| ||||||||||||||||||||||||||||||||||||||
| pbData | BYTE* | in | プロバイダーパラメーターとして設定する値を格納したデータバッファーへのポインター。このデータの形式は dwParam の値によって異なります。dwParam に PP_USE_HARDWARE_RNG が含まれている場合、このパラメーターは NULL である必要があります。 | ||||||||||||||||||||||||||||||||||||||
| dwFlags | DWORD | in | dwParam に PP_KEYSET_SEC_DESCR が含まれている場合、dwFlags には Platform SDK で定義されている該当する SECURITY_INFORMATION ビットフラグが含まれます。キーコンテナーのセキュリティは、 SetFileSecurity および GetFileSecurity を使用して処理されます。 これらのビットフラグは、ビットごとの OR 演算を使用して組み合わせることができます。詳細については、 CryptGetProvParam を参照してください。 dwParam が PP_USE_HARDWARE_RNG または PP_DELETEKEY の場合、dwFlags はゼロに設定する必要があります。 |
戻り値の型: BOOL
公式ドキュメント
暗号化サービスプロバイダー (CSP) の動作をカスタマイズします。この関数は一般に、CSP に関連付けられたキーコンテナーにセキュリティ記述子を設定し、そのキーコンテナー内の秘密キーへのアクセスを制御するために使用されます。
戻り値
関数が成功した場合、戻り値は 0 以外 (TRUE) です。
関数が失敗した場合、戻り値は 0 (FALSE) です。拡張エラー情報を取得するには、 GetLastError を呼び出します。
"NTE" で始まるエラーコードは、使用している特定の CSP によって生成されます。エラーコードには次のものが含まれます。
| 戻り値 | 説明 |
|---|---|
| CSP コンテキストは現在、別の プロセス によって使用されています。 | |
| いずれかのパラメーターが有効でないハンドルを指定しています。 | |
| いずれかのパラメーターが有効でない値を含んでいます。これは多くの場合、有効でないポインターです。 | |
| dwFlags パラメーターが 0 以外であるか、pbData バッファーが有効でない値を含んでいます。 | |
| dwParam パラメーターが不明なパラメーターを指定しています。 | |
| hKey キーの作成時に指定された CSP コンテキストが見つかりません。 | |
| 関数が予期しない方法で失敗しました。 |
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)
各言語での呼び出し定義
// ADVAPI32.dll
#include <windows.h>
BOOL CryptSetProvParam(
UINT_PTR hProv,
CRYPT_SET_PROV_PARAM_ID dwParam,
const BYTE* pbData,
DWORD dwFlags
);[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("ADVAPI32.dll", SetLastError = true, ExactSpelling = true)]
static extern bool CryptSetProvParam(
UIntPtr hProv, // UINT_PTR
uint dwParam, // CRYPT_SET_PROV_PARAM_ID
IntPtr pbData, // BYTE*
uint dwFlags // DWORD
);<DllImport("ADVAPI32.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function CryptSetProvParam(
hProv As UIntPtr, ' UINT_PTR
dwParam As UInteger, ' CRYPT_SET_PROV_PARAM_ID
pbData As IntPtr, ' BYTE*
dwFlags As UInteger ' DWORD
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function' hProv : UINT_PTR
' dwParam : CRYPT_SET_PROV_PARAM_ID
' pbData : BYTE*
' dwFlags : DWORD
Declare PtrSafe Function CryptSetProvParam Lib "advapi32" ( _
ByVal hProv As LongPtr, _
ByVal dwParam As Long, _
ByVal pbData 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
CryptSetProvParam = ctypes.windll.advapi32.CryptSetProvParam
CryptSetProvParam.restype = wintypes.BOOL
CryptSetProvParam.argtypes = [
ctypes.c_size_t, # hProv : UINT_PTR
wintypes.DWORD, # dwParam : CRYPT_SET_PROV_PARAM_ID
ctypes.POINTER(ctypes.c_ubyte), # pbData : BYTE*
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')
CryptSetProvParam = Fiddle::Function.new(
lib['CryptSetProvParam'],
[
Fiddle::TYPE_UINTPTR_T, # hProv : UINT_PTR
-Fiddle::TYPE_INT, # dwParam : CRYPT_SET_PROV_PARAM_ID
Fiddle::TYPE_VOIDP, # pbData : BYTE*
-Fiddle::TYPE_INT, # dwFlags : DWORD
],
Fiddle::TYPE_INT)#[link(name = "advapi32")]
extern "system" {
fn CryptSetProvParam(
hProv: usize, // UINT_PTR
dwParam: u32, // CRYPT_SET_PROV_PARAM_ID
pbData: *const u8, // BYTE*
dwFlags: u32 // DWORD
) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("ADVAPI32.dll", SetLastError = true)]
public static extern bool CryptSetProvParam(UIntPtr hProv, uint dwParam, IntPtr pbData, uint dwFlags);
"@
$api = Add-Type -MemberDefinition $sig -Name 'ADVAPI32_CryptSetProvParam' -Namespace Win32 -PassThru
# $api::CryptSetProvParam(hProv, dwParam, pbData, dwFlags)#uselib "ADVAPI32.dll"
#func global CryptSetProvParam "CryptSetProvParam" sptr, sptr, sptr, sptr
; CryptSetProvParam hProv, dwParam, varptr(pbData), dwFlags ; 戻り値は stat
; hProv : UINT_PTR -> "sptr"
; dwParam : CRYPT_SET_PROV_PARAM_ID -> "sptr"
; pbData : BYTE* -> "sptr"
; dwFlags : DWORD -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。#uselib "ADVAPI32.dll" #cfunc global CryptSetProvParam "CryptSetProvParam" sptr, int, var, int ; res = CryptSetProvParam(hProv, dwParam, pbData, dwFlags) ; hProv : UINT_PTR -> "sptr" ; dwParam : CRYPT_SET_PROV_PARAM_ID -> "int" ; pbData : BYTE* -> "var" ; dwFlags : DWORD -> "int" ; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "ADVAPI32.dll" #cfunc global CryptSetProvParam "CryptSetProvParam" sptr, int, sptr, int ; res = CryptSetProvParam(hProv, dwParam, varptr(pbData), dwFlags) ; hProv : UINT_PTR -> "sptr" ; dwParam : CRYPT_SET_PROV_PARAM_ID -> "int" ; pbData : BYTE* -> "sptr" ; dwFlags : DWORD -> "int" ; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。
; BOOL CryptSetProvParam(UINT_PTR hProv, CRYPT_SET_PROV_PARAM_ID dwParam, BYTE* pbData, DWORD dwFlags) #uselib "ADVAPI32.dll" #cfunc global CryptSetProvParam "CryptSetProvParam" intptr, int, var, int ; res = CryptSetProvParam(hProv, dwParam, pbData, dwFlags) ; hProv : UINT_PTR -> "intptr" ; dwParam : CRYPT_SET_PROV_PARAM_ID -> "int" ; pbData : BYTE* -> "var" ; dwFlags : DWORD -> "int" ; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。; BOOL CryptSetProvParam(UINT_PTR hProv, CRYPT_SET_PROV_PARAM_ID dwParam, BYTE* pbData, DWORD dwFlags) #uselib "ADVAPI32.dll" #cfunc global CryptSetProvParam "CryptSetProvParam" intptr, int, intptr, int ; res = CryptSetProvParam(hProv, dwParam, varptr(pbData), dwFlags) ; hProv : UINT_PTR -> "intptr" ; dwParam : CRYPT_SET_PROV_PARAM_ID -> "int" ; pbData : BYTE* -> "intptr" ; dwFlags : DWORD -> "int" ; ※出力/バッファ引数はポインタ方式(token=intptr / 呼び出しは varptr(変数))。
import (
"golang.org/x/sys/windows"
"unsafe"
)
var (
advapi32 = windows.NewLazySystemDLL("ADVAPI32.dll")
procCryptSetProvParam = advapi32.NewProc("CryptSetProvParam")
)
// hProv (UINT_PTR), dwParam (CRYPT_SET_PROV_PARAM_ID), pbData (BYTE*), dwFlags (DWORD)
r1, _, err := procCryptSetProvParam.Call(
uintptr(hProv),
uintptr(dwParam),
uintptr(pbData),
uintptr(dwFlags),
)
_ = err // syscall.Errno (valid when the call sets last-error)
_ = r1 // BOOLfunction CryptSetProvParam(
hProv: NativeUInt; // UINT_PTR
dwParam: DWORD; // CRYPT_SET_PROV_PARAM_ID
pbData: Pointer; // BYTE*
dwFlags: DWORD // DWORD
): BOOL; stdcall;
external 'ADVAPI32.dll' name 'CryptSetProvParam';result := DllCall("ADVAPI32\CryptSetProvParam"
, "UPtr", hProv ; UINT_PTR
, "UInt", dwParam ; CRYPT_SET_PROV_PARAM_ID
, "Ptr", pbData ; BYTE*
, "UInt", dwFlags ; DWORD
, "Int") ; return: BOOL●CryptSetProvParam(hProv, dwParam, pbData, dwFlags) = DLL("ADVAPI32.dll", "bool CryptSetProvParam(int, dword, void*, dword)")
# 呼び出し: CryptSetProvParam(hProv, dwParam, pbData, dwFlags)
# hProv : UINT_PTR -> "int"
# dwParam : CRYPT_SET_PROV_PARAM_ID -> "dword"
# pbData : BYTE* -> "void*"
# dwFlags : DWORD -> "dword"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。const std = @import("std");
extern "advapi32" fn CryptSetProvParam(
hProv: usize, // UINT_PTR
dwParam: u32, // CRYPT_SET_PROV_PARAM_ID
pbData: [*c]u8, // BYTE*
dwFlags: u32 // DWORD
) callconv(std.os.windows.WINAPI) i32;proc CryptSetProvParam(
hProv: uint, # UINT_PTR
dwParam: uint32, # CRYPT_SET_PROV_PARAM_ID
pbData: ptr uint8, # BYTE*
dwFlags: uint32 # DWORD
): int32 {.importc: "CryptSetProvParam", stdcall, dynlib: "ADVAPI32.dll".}pragma(lib, "advapi32");
extern(Windows)
int CryptSetProvParam(
size_t hProv, // UINT_PTR
uint dwParam, // CRYPT_SET_PROV_PARAM_ID
ubyte* pbData, // BYTE*
uint dwFlags // DWORD
);ccall((:CryptSetProvParam, "ADVAPI32.dll"), stdcall, Int32,
(Csize_t, UInt32, Ptr{UInt8}, UInt32),
hProv, dwParam, pbData, dwFlags)
# hProv : UINT_PTR -> Csize_t
# dwParam : CRYPT_SET_PROV_PARAM_ID -> UInt32
# pbData : BYTE* -> Ptr{UInt8}
# dwFlags : DWORD -> UInt32
# stdcall は 32bit のみ意味を持つ(x64 では無視)。local ffi = require("ffi")
ffi.cdef[[
int32_t CryptSetProvParam(
uintptr_t hProv,
uint32_t dwParam,
uint8_t* pbData,
uint32_t dwFlags);
]]
local advapi32 = ffi.load("advapi32")
-- advapi32.CryptSetProvParam(hProv, dwParam, pbData, dwFlags)
-- hProv : UINT_PTR
-- dwParam : CRYPT_SET_PROV_PARAM_ID
-- pbData : BYTE*
-- dwFlags : DWORD
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。const koffi = require('koffi');
const lib = koffi.load('ADVAPI32.dll');
const CryptSetProvParam = lib.func('__stdcall', 'CryptSetProvParam', 'int32_t', ['uintptr_t', 'uint32_t', 'uint8_t *', 'uint32_t']);
// CryptSetProvParam(hProv, dwParam, pbData, dwFlags)
// hProv : UINT_PTR -> 'uintptr_t'
// dwParam : CRYPT_SET_PROV_PARAM_ID -> 'uint32_t'
// pbData : BYTE* -> 'uint8_t *'
// dwFlags : DWORD -> 'uint32_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。const lib = Deno.dlopen("ADVAPI32.dll", {
CryptSetProvParam: { parameters: ["usize", "u32", "pointer", "u32"], result: "i32" },
});
// lib.symbols.CryptSetProvParam(hProv, dwParam, pbData, dwFlags)
// hProv : UINT_PTR -> "usize"
// dwParam : CRYPT_SET_PROV_PARAM_ID -> "u32"
// pbData : BYTE* -> "pointer"
// dwFlags : DWORD -> "u32"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。<?php
$ffi = FFI::cdef(<<<C
int32_t CryptSetProvParam(
size_t hProv,
uint32_t dwParam,
uint8_t* pbData,
uint32_t dwFlags);
C, "ADVAPI32.dll");
// $ffi->CryptSetProvParam(hProv, dwParam, pbData, dwFlags);
// hProv : UINT_PTR
// dwParam : CRYPT_SET_PROV_PARAM_ID
// pbData : BYTE*
// dwFlags : DWORD
// 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
// WINAPI(stdcall): x64 では呼出規約が統一されるため問題なし。x86 では __stdcall 対応のラッパが必要な場合あり。import com.sun.jna.*;
import com.sun.jna.ptr.*;
import com.sun.jna.win32.StdCallLibrary;
import com.sun.jna.win32.W32APIOptions;
public interface Advapi32 extends StdCallLibrary {
Advapi32 INSTANCE = Native.load("advapi32", Advapi32.class);
boolean CryptSetProvParam(
long hProv, // UINT_PTR
int dwParam, // CRYPT_SET_PROV_PARAM_ID
byte[] pbData, // BYTE*
int dwFlags // DWORD
);
}@[Link("advapi32")]
lib LibADVAPI32
fun CryptSetProvParam = CryptSetProvParam(
hProv : LibC::SizeT, # UINT_PTR
dwParam : UInt32, # CRYPT_SET_PROV_PARAM_ID
pbData : UInt8*, # BYTE*
dwFlags : UInt32 # DWORD
) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。import 'dart:ffi';
import 'package:ffi/ffi.dart';
typedef CryptSetProvParamNative = Int32 Function(UintPtr, Uint32, Pointer<Uint8>, Uint32);
typedef CryptSetProvParamDart = int Function(int, int, Pointer<Uint8>, int);
final CryptSetProvParam = DynamicLibrary.open('ADVAPI32.dll')
.lookupFunction<CryptSetProvParamNative, CryptSetProvParamDart>('CryptSetProvParam');
// hProv : UINT_PTR -> UintPtr
// dwParam : CRYPT_SET_PROV_PARAM_ID -> Uint32
// pbData : BYTE* -> Pointer<Uint8>
// dwFlags : DWORD -> Uint32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。{$mode objfpc}{$H+}
function CryptSetProvParam(
hProv: NativeUInt; // UINT_PTR
dwParam: DWORD; // CRYPT_SET_PROV_PARAM_ID
pbData: Pointer; // BYTE*
dwFlags: DWORD // DWORD
): BOOL; stdcall;
external 'ADVAPI32.dll' name 'CryptSetProvParam';import Foreign
import Foreign.C.Types
import Foreign.C.String
foreign import stdcall safe "CryptSetProvParam"
c_CryptSetProvParam :: CUIntPtr -> Word32 -> Ptr Word8 -> Word32 -> IO CInt
-- hProv : UINT_PTR -> CUIntPtr
-- dwParam : CRYPT_SET_PROV_PARAM_ID -> Word32
-- pbData : BYTE* -> Ptr Word8
-- dwFlags : DWORD -> Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。open Ctypes
open Foreign
let cryptsetprovparam =
foreign "CryptSetProvParam"
(size_t @-> uint32_t @-> (ptr uint8_t) @-> uint32_t @-> returning int32_t)
(* hProv : UINT_PTR -> size_t *)
(* dwParam : CRYPT_SET_PROV_PARAM_ID -> uint32_t *)
(* pbData : BYTE* -> (ptr uint8_t) *)
(* dwFlags : DWORD -> uint32_t *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)(cffi:define-foreign-library advapi32 (t "ADVAPI32.dll"))
(cffi:use-foreign-library advapi32)
(cffi:defcfun ("CryptSetProvParam" crypt-set-prov-param :convention :stdcall) :int32
(h-prov :uint64) ; UINT_PTR
(dw-param :uint32) ; CRYPT_SET_PROV_PARAM_ID
(pb-data :pointer) ; BYTE*
(dw-flags :uint32)) ; DWORD
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。use Win32::API;
my $CryptSetProvParam = Win32::API::More->new('ADVAPI32',
'BOOL CryptSetProvParam(WPARAM hProv, DWORD dwParam, LPVOID pbData, DWORD dwFlags)');
# my $ret = $CryptSetProvParam->Call($hProv, $dwParam, $pbData, $dwFlags);
# hProv : UINT_PTR -> WPARAM
# dwParam : CRYPT_SET_PROV_PARAM_ID -> DWORD
# pbData : BYTE* -> LPVOID
# dwFlags : DWORD -> DWORD
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。関連項目
- f CryptAcquireContextW — 暗号化サービスプロバイダーのコンテキストハンドルを取得する(Unicode版)。
- f CryptGetProvParam — 暗号化サービスプロバイダーのパラメータを取得する。
- f CryptSetKeyParam — 暗号鍵オブジェクトのパラメータを設定する。