ホーム › Security.Cryptography › CryptDuplicateKey

CryptDuplicateKey

関数

暗号鍵ハンドルを複製して状態をコピーする。

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

シグネチャ

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

BOOL CryptDuplicateKey(
    UINT_PTR hKey,
    DWORD* pdwReserved,   // optional
    DWORD dwFlags,
    UINT_PTR* phKey
);

パラメーター

名前	型	方向	説明
hKey	UINT_PTR	in	複製するキーのハンドルです。
pdwReserved	DWORD*	optional	将来の使用のために予約されており、NULL でなければなりません。
dwFlags	DWORD	in	将来の使用のために予約されており、ゼロでなければなりません。
phKey	UINT_PTR*	out	複製されたキーのハンドルのアドレスです。キーの使用が終わったら、CryptDestroyKey 関数を呼び出してハンドルを解放してください。

戻り値の型: BOOL

公式ドキュメント

キーおよびキーの状態の正確なコピーを作成します。

戻り値

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

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

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

戻り値	説明
ERROR_CALL_NOT_IMPLEMENTED	これは新しい関数であるため、既存の CSP では実装されていない場合があります。CSP がこの関数をサポートしていない場合に、このエラーが返されます。
ERROR_INVALID_PARAMETER	いずれかのパラメーターに無効な値が含まれています。多くの場合、これは無効なポインターです。
NTE_BAD_KEY	元のキーのハンドルが無効です。

解説(Remarks)

CryptDuplicateKey は、キーのコピーと、そのキーの正確な状態を作成します。この関数が使用されるシナリオの 1 つとして、アプリケーションが同じキーを使用しつつ異なるソルト値で 2 つの個別のメッセージを暗号化する必要がある場合があります。まず元のキーを生成し、次に CryptDuplicateKey 関数を使用して複製キーを作成します。その後、 CryptSetKeyParam 関数を個別に呼び出して、元のキーと複製キーに異なるソルト値を設定します。

CryptDuplicateKey を使用して作成されたキーを破棄するには、CryptDestroyKey を呼び出す必要があります。元のキーを破棄しても、複製キーは破棄されません。複製キーが作成された後は、それは元のキーとは独立しています。2 つのキー間で状態が共有されることはありません。

例

次の例は、既存のセッションキーの複製であるセッションキーの作成を示しています。この例の完全なコンテキストを含む例については、C プログラムの例: セッションキーの複製を参照してください。

//--------------------------------------------------------------------
// Declare and initialize variables.

HCRYPTKEY    hDuplicateKey;

// Duplicate the key. hOriginalKey is a previously 
// assigned HCRYPTKEY variable.

if (CryptDuplicateKey(
     hOriginalKey, 
     NULL, 
     0, 
     &hDuplicateKey))
{
   printf("The session key has been duplicated. \n");
}
else
{
   printf("Error using CryptDuplicateKey.\n");
   exit(1);
}

// Insert code that uses the duplicate key here.

// When you have finished using the key, the handle must be released.

if (CryptDestroyKey(hDuplicateKey))
{
  printf("The handle has been released.\n");
}
else
{
  printf("The handle could not be released.\n");
}

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

各言語での呼び出し定義

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

BOOL CryptDuplicateKey(
    UINT_PTR hKey,
    DWORD* pdwReserved,   // optional
    DWORD dwFlags,
    UINT_PTR* phKey
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("ADVAPI32.dll", SetLastError = true, ExactSpelling = true)]
static extern bool CryptDuplicateKey(
    UIntPtr hKey,   // UINT_PTR
    IntPtr pdwReserved,   // DWORD* optional
    uint dwFlags,   // DWORD
    out UIntPtr phKey   // UINT_PTR* out
);

<DllImport("ADVAPI32.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function CryptDuplicateKey(
    hKey As UIntPtr,   ' UINT_PTR
    pdwReserved As IntPtr,   ' DWORD* optional
    dwFlags As UInteger,   ' DWORD
    <Out> ByRef phKey As UIntPtr   ' UINT_PTR* out
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function

' hKey : UINT_PTR
' pdwReserved : DWORD* optional
' dwFlags : DWORD
' phKey : UINT_PTR* out
Declare PtrSafe Function CryptDuplicateKey Lib "advapi32" ( _
    ByVal hKey As LongPtr, _
    ByVal pdwReserved As LongPtr, _
    ByVal dwFlags As Long, _
    ByRef phKey As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

CryptDuplicateKey = ctypes.windll.advapi32.CryptDuplicateKey
CryptDuplicateKey.restype = wintypes.BOOL
CryptDuplicateKey.argtypes = [
    ctypes.c_size_t,  # hKey : UINT_PTR
    ctypes.POINTER(wintypes.DWORD),  # pdwReserved : DWORD* optional
    wintypes.DWORD,  # dwFlags : DWORD
    ctypes.POINTER(ctypes.c_size_t),  # phKey : UINT_PTR* out
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('ADVAPI32.dll')
CryptDuplicateKey = Fiddle::Function.new(
  lib['CryptDuplicateKey'],
  [
    Fiddle::TYPE_UINTPTR_T,  # hKey : UINT_PTR
    Fiddle::TYPE_VOIDP,  # pdwReserved : DWORD* optional
    -Fiddle::TYPE_INT,  # dwFlags : DWORD
    Fiddle::TYPE_VOIDP,  # phKey : UINT_PTR* out
  ],
  Fiddle::TYPE_INT)

#[link(name = "advapi32")]
extern "system" {
    fn CryptDuplicateKey(
        hKey: usize,  // UINT_PTR
        pdwReserved: *mut u32,  // DWORD* optional
        dwFlags: u32,  // DWORD
        phKey: *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 CryptDuplicateKey(UIntPtr hKey, IntPtr pdwReserved, uint dwFlags, out UIntPtr phKey);
"@
$api = Add-Type -MemberDefinition $sig -Name 'ADVAPI32_CryptDuplicateKey' -Namespace Win32 -PassThru
# $api::CryptDuplicateKey(hKey, pdwReserved, dwFlags, phKey)

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

出力引数:

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