CryptSetKeyParam
関数シグネチャ
// ADVAPI32.dll
#include <windows.h>
BOOL CryptSetKeyParam(
UINT_PTR hKey,
CRYPT_KEY_PARAM_ID dwParam,
const BYTE* pbData,
DWORD dwFlags
);パラメーター
| 名前 | 型 | 方向 | 説明 | ||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| hKey | UINT_PTR | in | 値を設定する対象のキーへのハンドル。 | ||||||||||||||||||||||||||||||||||||||||||||||||
| dwParam | CRYPT_KEY_PARAM_ID | in | 以下の表に、使用できる定義済みの値を示します。 すべてのキー種別について、このパラメーターには次のいずれかの値を指定できます。
hKey パラメーターで Digital Signature Standard (DSS) キーが指定されている場合、dwParam 値には次のいずれかの値も設定できます。
hKey で Diffie-Hellman アルゴリズム または Digital Signature Algorithm (DSA) キーが指定されている場合、dwParam 値には次のいずれかの値も設定できます。
hKey パラメーターで ブロック暗号 の セッションキー が指定されている場合、dwParam 値には次のいずれかの値も設定できます。
hKey パラメーターで RSA キーが指定されている場合、dwParam パラメーター値には次の値を指定できます。
次の値は使用されないことに注意してください。 | ||||||||||||||||||||||||||||||||||||||||||||||||
| pbData | BYTE* | in | CryptSetKeyParam を呼び出す前に、設定する値で初期化されたバッファーへのポインター。このデータの形式は dwParam の値によって異なります。 | ||||||||||||||||||||||||||||||||||||||||||||||||
| dwFlags | DWORD | in | dwParam が KP_ALGID の場合にのみ使用されます。dwFlags パラメーターは、有効化されるキーに対するフラグ値を渡すために使用されます。dwFlags パラメーターには、キーサイズや、CryptGenKey で同じ種別のキーを生成するときに許可されるその他のフラグ値などを保持できます。許可されるフラグ値については、 CryptGenKey を参照してください。 |
戻り値の型: BOOL
公式ドキュメント
セッションキーの操作に関するさまざまな側面をカスタマイズします。
戻り値
関数が成功した場合、戻り値は 0 以外 (TRUE) です。
関数が失敗した場合、戻り値は 0 (FALSE) です。拡張エラー情報を取得するには、 GetLastError を呼び出してください。
"NTE" で始まるエラーコードは、使用している特定の CSP によって生成されます。考えられるエラーコードの一部を次に示します。
| 戻り値 | 説明 |
|---|---|
| CSP コンテキストが現在、別の プロセス によって使用されています。 | |
| いずれかのパラメーターが無効なハンドルを指定しています。 | |
| いずれかのパラメーターに無効な値が含まれています。これは多くの場合、無効なポインターです。 | |
| dwFlags パラメーターが 0 以外であるか、pbData バッファーに無効な値が含まれています。 | |
| dwParam パラメーターが不明なパラメーターを指定しています。 | |
| hKey キーの作成時に指定された CSP コンテキストが見つかりません。 | |
| 関数が予期しない方法で失敗しました。 | |
| 一部の CSP では、P、Q、G の値がハードコードされています。この場合、dwParam の値として KP_P、KP_Q、KP_G を使用すると、このエラーが発生します。 |
解説(Remarks)
PREGEN 状態の Diffie-Hellman または DSS キーに KP_Q、KP_P、KP_X パラメーターを設定する場合、キー長は、そのキーを CryptGenKey で作成したときに dwFlags パラメーターの上位 16 ビットを使用して設定された キー長 と互換性がある必要があります。CryptGenKey でキー長が設定されていなかった場合は、既定のキー長が使用されます。既定以外のキー長を使用して P、Q、X を設定すると、エラーが発生します。
例
この関数を使用する例については、Example C Program: Duplicating a Session Key を参照してください。 この関数を使用するその他のコードについては、 Example C Program: Setting and Getting Session Key Parameters を参照してください。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)
各言語での呼び出し定義
// ADVAPI32.dll
#include <windows.h>
BOOL CryptSetKeyParam(
UINT_PTR hKey,
CRYPT_KEY_PARAM_ID dwParam,
const BYTE* pbData,
DWORD dwFlags
);[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("ADVAPI32.dll", SetLastError = true, ExactSpelling = true)]
static extern bool CryptSetKeyParam(
UIntPtr hKey, // UINT_PTR
uint dwParam, // CRYPT_KEY_PARAM_ID
IntPtr pbData, // BYTE*
uint dwFlags // DWORD
);<DllImport("ADVAPI32.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function CryptSetKeyParam(
hKey As UIntPtr, ' UINT_PTR
dwParam As UInteger, ' CRYPT_KEY_PARAM_ID
pbData As IntPtr, ' BYTE*
dwFlags As UInteger ' DWORD
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function' hKey : UINT_PTR
' dwParam : CRYPT_KEY_PARAM_ID
' pbData : BYTE*
' dwFlags : DWORD
Declare PtrSafe Function CryptSetKeyParam Lib "advapi32" ( _
ByVal hKey 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
CryptSetKeyParam = ctypes.windll.advapi32.CryptSetKeyParam
CryptSetKeyParam.restype = wintypes.BOOL
CryptSetKeyParam.argtypes = [
ctypes.c_size_t, # hKey : UINT_PTR
wintypes.DWORD, # dwParam : CRYPT_KEY_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')
CryptSetKeyParam = Fiddle::Function.new(
lib['CryptSetKeyParam'],
[
Fiddle::TYPE_UINTPTR_T, # hKey : UINT_PTR
-Fiddle::TYPE_INT, # dwParam : CRYPT_KEY_PARAM_ID
Fiddle::TYPE_VOIDP, # pbData : BYTE*
-Fiddle::TYPE_INT, # dwFlags : DWORD
],
Fiddle::TYPE_INT)#[link(name = "advapi32")]
extern "system" {
fn CryptSetKeyParam(
hKey: usize, // UINT_PTR
dwParam: u32, // CRYPT_KEY_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 CryptSetKeyParam(UIntPtr hKey, uint dwParam, IntPtr pbData, uint dwFlags);
"@
$api = Add-Type -MemberDefinition $sig -Name 'ADVAPI32_CryptSetKeyParam' -Namespace Win32 -PassThru
# $api::CryptSetKeyParam(hKey, dwParam, pbData, dwFlags)#uselib "ADVAPI32.dll"
#func global CryptSetKeyParam "CryptSetKeyParam" sptr, sptr, sptr, sptr
; CryptSetKeyParam hKey, dwParam, varptr(pbData), dwFlags ; 戻り値は stat
; hKey : UINT_PTR -> "sptr"
; dwParam : CRYPT_KEY_PARAM_ID -> "sptr"
; pbData : BYTE* -> "sptr"
; dwFlags : DWORD -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。#uselib "ADVAPI32.dll" #cfunc global CryptSetKeyParam "CryptSetKeyParam" sptr, int, var, int ; res = CryptSetKeyParam(hKey, dwParam, pbData, dwFlags) ; hKey : UINT_PTR -> "sptr" ; dwParam : CRYPT_KEY_PARAM_ID -> "int" ; pbData : BYTE* -> "var" ; dwFlags : DWORD -> "int" ; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "ADVAPI32.dll" #cfunc global CryptSetKeyParam "CryptSetKeyParam" sptr, int, sptr, int ; res = CryptSetKeyParam(hKey, dwParam, varptr(pbData), dwFlags) ; hKey : UINT_PTR -> "sptr" ; dwParam : CRYPT_KEY_PARAM_ID -> "int" ; pbData : BYTE* -> "sptr" ; dwFlags : DWORD -> "int" ; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。
; BOOL CryptSetKeyParam(UINT_PTR hKey, CRYPT_KEY_PARAM_ID dwParam, BYTE* pbData, DWORD dwFlags) #uselib "ADVAPI32.dll" #cfunc global CryptSetKeyParam "CryptSetKeyParam" intptr, int, var, int ; res = CryptSetKeyParam(hKey, dwParam, pbData, dwFlags) ; hKey : UINT_PTR -> "intptr" ; dwParam : CRYPT_KEY_PARAM_ID -> "int" ; pbData : BYTE* -> "var" ; dwFlags : DWORD -> "int" ; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。; BOOL CryptSetKeyParam(UINT_PTR hKey, CRYPT_KEY_PARAM_ID dwParam, BYTE* pbData, DWORD dwFlags) #uselib "ADVAPI32.dll" #cfunc global CryptSetKeyParam "CryptSetKeyParam" intptr, int, intptr, int ; res = CryptSetKeyParam(hKey, dwParam, varptr(pbData), dwFlags) ; hKey : UINT_PTR -> "intptr" ; dwParam : CRYPT_KEY_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")
procCryptSetKeyParam = advapi32.NewProc("CryptSetKeyParam")
)
// hKey (UINT_PTR), dwParam (CRYPT_KEY_PARAM_ID), pbData (BYTE*), dwFlags (DWORD)
r1, _, err := procCryptSetKeyParam.Call(
uintptr(hKey),
uintptr(dwParam),
uintptr(pbData),
uintptr(dwFlags),
)
_ = err // syscall.Errno (valid when the call sets last-error)
_ = r1 // BOOLfunction CryptSetKeyParam(
hKey: NativeUInt; // UINT_PTR
dwParam: DWORD; // CRYPT_KEY_PARAM_ID
pbData: Pointer; // BYTE*
dwFlags: DWORD // DWORD
): BOOL; stdcall;
external 'ADVAPI32.dll' name 'CryptSetKeyParam';result := DllCall("ADVAPI32\CryptSetKeyParam"
, "UPtr", hKey ; UINT_PTR
, "UInt", dwParam ; CRYPT_KEY_PARAM_ID
, "Ptr", pbData ; BYTE*
, "UInt", dwFlags ; DWORD
, "Int") ; return: BOOL●CryptSetKeyParam(hKey, dwParam, pbData, dwFlags) = DLL("ADVAPI32.dll", "bool CryptSetKeyParam(int, dword, void*, dword)")
# 呼び出し: CryptSetKeyParam(hKey, dwParam, pbData, dwFlags)
# hKey : UINT_PTR -> "int"
# dwParam : CRYPT_KEY_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 CryptSetKeyParam(
hKey: usize, // UINT_PTR
dwParam: u32, // CRYPT_KEY_PARAM_ID
pbData: [*c]u8, // BYTE*
dwFlags: u32 // DWORD
) callconv(std.os.windows.WINAPI) i32;proc CryptSetKeyParam(
hKey: uint, # UINT_PTR
dwParam: uint32, # CRYPT_KEY_PARAM_ID
pbData: ptr uint8, # BYTE*
dwFlags: uint32 # DWORD
): int32 {.importc: "CryptSetKeyParam", stdcall, dynlib: "ADVAPI32.dll".}pragma(lib, "advapi32");
extern(Windows)
int CryptSetKeyParam(
size_t hKey, // UINT_PTR
uint dwParam, // CRYPT_KEY_PARAM_ID
ubyte* pbData, // BYTE*
uint dwFlags // DWORD
);ccall((:CryptSetKeyParam, "ADVAPI32.dll"), stdcall, Int32,
(Csize_t, UInt32, Ptr{UInt8}, UInt32),
hKey, dwParam, pbData, dwFlags)
# hKey : UINT_PTR -> Csize_t
# dwParam : CRYPT_KEY_PARAM_ID -> UInt32
# pbData : BYTE* -> Ptr{UInt8}
# dwFlags : DWORD -> UInt32
# stdcall は 32bit のみ意味を持つ(x64 では無視)。local ffi = require("ffi")
ffi.cdef[[
int32_t CryptSetKeyParam(
uintptr_t hKey,
uint32_t dwParam,
uint8_t* pbData,
uint32_t dwFlags);
]]
local advapi32 = ffi.load("advapi32")
-- advapi32.CryptSetKeyParam(hKey, dwParam, pbData, dwFlags)
-- hKey : UINT_PTR
-- dwParam : CRYPT_KEY_PARAM_ID
-- pbData : BYTE*
-- dwFlags : DWORD
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。const koffi = require('koffi');
const lib = koffi.load('ADVAPI32.dll');
const CryptSetKeyParam = lib.func('__stdcall', 'CryptSetKeyParam', 'int32_t', ['uintptr_t', 'uint32_t', 'uint8_t *', 'uint32_t']);
// CryptSetKeyParam(hKey, dwParam, pbData, dwFlags)
// hKey : UINT_PTR -> 'uintptr_t'
// dwParam : CRYPT_KEY_PARAM_ID -> 'uint32_t'
// pbData : BYTE* -> 'uint8_t *'
// dwFlags : DWORD -> 'uint32_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。const lib = Deno.dlopen("ADVAPI32.dll", {
CryptSetKeyParam: { parameters: ["usize", "u32", "pointer", "u32"], result: "i32" },
});
// lib.symbols.CryptSetKeyParam(hKey, dwParam, pbData, dwFlags)
// hKey : UINT_PTR -> "usize"
// dwParam : CRYPT_KEY_PARAM_ID -> "u32"
// pbData : BYTE* -> "pointer"
// dwFlags : DWORD -> "u32"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。<?php
$ffi = FFI::cdef(<<<C
int32_t CryptSetKeyParam(
size_t hKey,
uint32_t dwParam,
uint8_t* pbData,
uint32_t dwFlags);
C, "ADVAPI32.dll");
// $ffi->CryptSetKeyParam(hKey, dwParam, pbData, dwFlags);
// hKey : UINT_PTR
// dwParam : CRYPT_KEY_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 CryptSetKeyParam(
long hKey, // UINT_PTR
int dwParam, // CRYPT_KEY_PARAM_ID
byte[] pbData, // BYTE*
int dwFlags // DWORD
);
}@[Link("advapi32")]
lib LibADVAPI32
fun CryptSetKeyParam = CryptSetKeyParam(
hKey : LibC::SizeT, # UINT_PTR
dwParam : UInt32, # CRYPT_KEY_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 CryptSetKeyParamNative = Int32 Function(UintPtr, Uint32, Pointer<Uint8>, Uint32);
typedef CryptSetKeyParamDart = int Function(int, int, Pointer<Uint8>, int);
final CryptSetKeyParam = DynamicLibrary.open('ADVAPI32.dll')
.lookupFunction<CryptSetKeyParamNative, CryptSetKeyParamDart>('CryptSetKeyParam');
// hKey : UINT_PTR -> UintPtr
// dwParam : CRYPT_KEY_PARAM_ID -> Uint32
// pbData : BYTE* -> Pointer<Uint8>
// dwFlags : DWORD -> Uint32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。{$mode objfpc}{$H+}
function CryptSetKeyParam(
hKey: NativeUInt; // UINT_PTR
dwParam: DWORD; // CRYPT_KEY_PARAM_ID
pbData: Pointer; // BYTE*
dwFlags: DWORD // DWORD
): BOOL; stdcall;
external 'ADVAPI32.dll' name 'CryptSetKeyParam';import Foreign
import Foreign.C.Types
import Foreign.C.String
foreign import stdcall safe "CryptSetKeyParam"
c_CryptSetKeyParam :: CUIntPtr -> Word32 -> Ptr Word8 -> Word32 -> IO CInt
-- hKey : UINT_PTR -> CUIntPtr
-- dwParam : CRYPT_KEY_PARAM_ID -> Word32
-- pbData : BYTE* -> Ptr Word8
-- dwFlags : DWORD -> Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。open Ctypes
open Foreign
let cryptsetkeyparam =
foreign "CryptSetKeyParam"
(size_t @-> uint32_t @-> (ptr uint8_t) @-> uint32_t @-> returning int32_t)
(* hKey : UINT_PTR -> size_t *)
(* dwParam : CRYPT_KEY_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 ("CryptSetKeyParam" crypt-set-key-param :convention :stdcall) :int32
(h-key :uint64) ; UINT_PTR
(dw-param :uint32) ; CRYPT_KEY_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 $CryptSetKeyParam = Win32::API::More->new('ADVAPI32',
'BOOL CryptSetKeyParam(WPARAM hKey, DWORD dwParam, LPVOID pbData, DWORD dwFlags)');
# my $ret = $CryptSetKeyParam->Call($hKey, $dwParam, $pbData, $dwFlags);
# hKey : UINT_PTR -> WPARAM
# dwParam : CRYPT_KEY_PARAM_ID -> DWORD
# pbData : BYTE* -> LPVOID
# dwFlags : DWORD -> DWORD
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。関連項目
- f CryptGenKey — 指定アルゴリズムの暗号鍵またはキーペアを生成する。
- f CryptGetKeyParam — 暗号鍵オブジェクトのパラメータを取得する。
- f CryptImportKey — キーBLOBから暗号鍵をプロバイダーへインポートする。