ホーム › Security.Cryptography › CryptGetUserKey

CryptGetUserKey

関数

プロバイダーの永続的なユーザー鍵ペアのハンドルを取得する。

DLLADVAPI32.dll呼出規約winapiSetLastErrorあり対応OSWindows XP 以降

シグネチャ

// ADVAPI32.dll
#include <windows.h>

BOOL CryptGetUserKey(
    UINT_PTR hProv,
    DWORD dwKeySpec,
    UINT_PTR* phUserKey
);

パラメーター

名前	型	方向	説明
hProv	UINT_PTR	in	CryptAcquireContext の呼び出しによって作成された暗号化サービスプロバイダー (CSP) の HCRYPTPROV ハンドル。
dwKeySpec	DWORD	in	キーコンテナーから使用する秘密鍵を識別します。AT_KEYEXCHANGE または AT_SIGNATURE を指定できます。さらに、一部のプロバイダーでは、この関数を通じてその他のユーザー固有のキーへのアクセスが許可される場合があります。詳細については、各プロバイダーのドキュメントを参照してください。
phUserKey	UINT_PTR*	out	取得したキーの HCRYPTKEY ハンドルへのポインター。キーの使用が終了したら、CryptDestroyKey 関数を呼び出してハンドルを削除してください。

名前

型

方向

説明

hProv

UINT_PTR

CryptAcquireContext の呼び出しによって作成された暗号化サービスプロバイダー (CSP) の HCRYPTPROV ハンドル。

dwKeySpec

DWORD

キーコンテナーから使用する秘密鍵を識別します。AT_KEYEXCHANGE または AT_SIGNATURE を指定できます。

さらに、一部のプロバイダーでは、この関数を通じてその他のユーザー固有のキーへのアクセスが許可される場合があります。詳細については、各プロバイダーのドキュメントを参照してください。

phUserKey

UINT_PTR*

out

取得したキーの HCRYPTKEY ハンドルへのポインター。キーの使用が終了したら、CryptDestroyKey 関数を呼び出してハンドルを削除してください。

戻り値の型: BOOL

公式ドキュメント

ユーザーが持つ 2 つの公開鍵/秘密鍵ペアのいずれか一方のハンドルを取得します。

戻り値

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

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

"NTE" で始まるエラーコードは、使用している特定の CSP によって生成されます。考えられるエラーコードの一部を次に示します。

戻り値コード	説明
ERROR_INVALID_HANDLE	いずれかのパラメーターに無効なハンドルが指定されています。
ERROR_INVALID_PARAMETER	いずれかのパラメーターに無効な値が含まれています。これは多くの場合、無効なポインターです。
NTE_BAD_KEY	dwKeySpec パラメーターに無効な値が含まれています。
NTE_BAD_UID	hProv パラメーターに有効なコンテキストハンドルが含まれていません。
NTE_NO_KEY	dwKeySpec パラメーターによって要求されたキーが存在しません。

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

各言語での呼び出し定義

// ADVAPI32.dll
#include <windows.h>

BOOL CryptGetUserKey(
    UINT_PTR hProv,
    DWORD dwKeySpec,
    UINT_PTR* phUserKey
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("ADVAPI32.dll", SetLastError = true, ExactSpelling = true)]
static extern bool CryptGetUserKey(
    UIntPtr hProv,   // UINT_PTR
    uint dwKeySpec,   // DWORD
    out UIntPtr phUserKey   // UINT_PTR* out
);

<DllImport("ADVAPI32.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function CryptGetUserKey(
    hProv As UIntPtr,   ' UINT_PTR
    dwKeySpec As UInteger,   ' DWORD
    <Out> ByRef phUserKey As UIntPtr   ' UINT_PTR* out
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function

' hProv : UINT_PTR
' dwKeySpec : DWORD
' phUserKey : UINT_PTR* out
Declare PtrSafe Function CryptGetUserKey Lib "advapi32" ( _
    ByVal hProv As LongPtr, _
    ByVal dwKeySpec As Long, _
    ByRef phUserKey As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

CryptGetUserKey = ctypes.windll.advapi32.CryptGetUserKey
CryptGetUserKey.restype = wintypes.BOOL
CryptGetUserKey.argtypes = [
    ctypes.c_size_t,  # hProv : UINT_PTR
    wintypes.DWORD,  # dwKeySpec : DWORD
    ctypes.POINTER(ctypes.c_size_t),  # phUserKey : UINT_PTR* out
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('ADVAPI32.dll')
CryptGetUserKey = Fiddle::Function.new(
  lib['CryptGetUserKey'],
  [
    Fiddle::TYPE_UINTPTR_T,  # hProv : UINT_PTR
    -Fiddle::TYPE_INT,  # dwKeySpec : DWORD
    Fiddle::TYPE_VOIDP,  # phUserKey : UINT_PTR* out
  ],
  Fiddle::TYPE_INT)

#[link(name = "advapi32")]
extern "system" {
    fn CryptGetUserKey(
        hProv: usize,  // UINT_PTR
        dwKeySpec: u32,  // DWORD
        phUserKey: *mut usize  // UINT_PTR* out
    ) -> 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 CryptGetUserKey(UIntPtr hProv, uint dwKeySpec, out UIntPtr phUserKey);
"@
$api = Add-Type -MemberDefinition $sig -Name 'ADVAPI32_CryptGetUserKey' -Namespace Win32 -PassThru
# $api::CryptGetUserKey(hProv, dwKeySpec, phUserKey)

#uselib "ADVAPI32.dll"
#func global CryptGetUserKey "CryptGetUserKey" sptr, sptr, sptr
; CryptGetUserKey hProv, dwKeySpec, varptr(phUserKey)   ; 戻り値は stat
; hProv : UINT_PTR -> "sptr"
; dwKeySpec : DWORD -> "sptr"
; phUserKey : UINT_PTR* out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

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