ホーム › Security.Cryptography › CryptGenRandom

CryptGenRandom

関数

暗号学的に安全な乱数バイト列をバッファに生成する。

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

シグネチャ

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

BOOL CryptGenRandom(
    UINT_PTR hProv,
    DWORD dwLen,
    BYTE* pbBuffer
);

パラメーター

名前	型	方向	説明
hProv	UINT_PTR	in	CryptAcquireContext の呼び出しによって作成された cryptographic service provider (CSP) のハンドルです。
dwLen	DWORD	in	生成する乱数データのバイト数です。
pbBuffer	BYTE*	inout	返されるデータを受け取るバッファです。このバッファの長さは少なくとも dwLen バイト以上である必要があります。任意で、アプリケーションは補助的な乱数シードとして使用するデータをこのバッファに格納できます。

名前

型

方向

説明

hProv

UINT_PTR

CryptAcquireContext の呼び出しによって作成された cryptographic service provider (CSP) のハンドルです。

dwLen

DWORD

生成する乱数データのバイト数です。

pbBuffer

BYTE*

inout

返されるデータを受け取るバッファです。このバッファの長さは少なくとも dwLen バイト以上である必要があります。

任意で、アプリケーションは補助的な乱数シードとして使用するデータをこのバッファに格納できます。

戻り値の型: BOOL

公式ドキュメント

バッファを暗号学的に安全な乱数バイトで埋めます。

戻り値

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

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

"NTE" が先頭に付くエラーコードは、使用されている特定の CSP によって生成されます。発生し得るエラーコードの一部を次の表に示します。

戻り値	説明
ERROR_INVALID_HANDLE	いずれかのパラメーターが有効でないハンドルを指定しています。
ERROR_INVALID_PARAMETER	いずれかのパラメーターが有効でない値を含んでいます。これは多くの場合、有効でないポインターです。
NTE_BAD_UID	hProv パラメーターが有効なコンテキストハンドルを含んでいません。
NTE_FAIL	関数が予期しない形で失敗しました。

解説(Remarks)

この関数が生成するデータは暗号学的に安全な乱数です。C コンパイラに付属する一般的な乱数生成器などが生成するデータよりもはるかにランダム性が高いものです。

この関数は、ランダムな initialization vectors や salt values の生成によく使用されます。

ソフトウェアによる乱数生成器は、基本的に同じ仕組みで動作します。シードと呼ばれる乱数から開始し、それを基にアルゴリズムを用いて擬似乱数のビット列を生成します。この過程で最も難しいのは、真にランダムなシードを取得することです。これは通常、ユーザー入力の遅延や、1 つ以上のハードウェアコンポーネントのジッターに基づきます。

Microsoft の CSP では、CryptGenRandom は他のセキュリティコンポーネントが使用するのと同じ乱数生成器を使用します。これにより、多数のプロセスがシステム全体のシードに寄与できます。CryptoAPI は、ユーザーごとに中間的な乱数シードを保存します。乱数生成器のシードを形成するために、呼び出し元のアプリケーションは保有している可能性のあるビット (たとえばマウスやキーボードのタイミング入力など) を提供し、それが保存済みのシードや、プロセス ID とスレッド ID、システムクロック、システム時刻、システムカウンター、メモリ状態、空きディスククラスター、ハッシュ化されたユーザー環境ブロックといったさまざまなシステムデータおよびユーザーデータと組み合わされます。この結果が擬似乱数生成器 (PRNG) のシードとして使用されます。Windows Vista with Service Pack 1 (SP1) 以降では、NIST Special Publication 800-90 で規定された AES カウンターモードベースの PRNG の実装が使用されます。Windows Vista、Windows Storage Server 2003、および Windows XP では、Federal Information Processing Standard (FIPS) 186-2 で規定された PRNG が使用されます。アプリケーションが良質な乱数源にアクセスできる場合は、CryptGenRandom を呼び出す前に pbBuffer バッファに何らかのランダムデータを格納できます。その後、CSP はこのデータを使用して内部シードをさらにランダム化します。CryptGenRandom を呼び出す前に pbBuffer バッファを初期化する手順は省略してもかまいません。

例

次の例は 8 バイトのランダムデータを生成する方法を示しています。これらは暗号鍵の作成や、乱数を使用するあらゆるアプリケーションで利用できます。この例の完全なコンテキストを含む例については、Example C Program: Duplicating a Session Key を参照してください。

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

HCRYPTPROV   hCryptProv;
BYTE         pbData[16];

//--------------------------------------------------------------------
//  This code assumes that a cryptographic context has been acquired 
//  For code details, see "Example C Program: Duplicating a Session 
//  Key."

//--------------------------------------------------------------------
// Generate a random initialization vector.

if(CryptGenRandom(
   hCryptProv, 
   8, 
   pbData)) 
{
     printf("Random sequence generated. \n");
}
else
{
     printf("Error during CryptGenRandom.\n");
     exit(1);
}

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

各言語での呼び出し定義

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

BOOL CryptGenRandom(
    UINT_PTR hProv,
    DWORD dwLen,
    BYTE* pbBuffer
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("ADVAPI32.dll", SetLastError = true, ExactSpelling = true)]
static extern bool CryptGenRandom(
    UIntPtr hProv,   // UINT_PTR
    uint dwLen,   // DWORD
    IntPtr pbBuffer   // BYTE* in/out
);

<DllImport("ADVAPI32.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function CryptGenRandom(
    hProv As UIntPtr,   ' UINT_PTR
    dwLen As UInteger,   ' DWORD
    pbBuffer As IntPtr   ' BYTE* in/out
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function

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

import ctypes
from ctypes import wintypes

CryptGenRandom = ctypes.windll.advapi32.CryptGenRandom
CryptGenRandom.restype = wintypes.BOOL
CryptGenRandom.argtypes = [
    ctypes.c_size_t,  # hProv : UINT_PTR
    wintypes.DWORD,  # dwLen : DWORD
    ctypes.POINTER(ctypes.c_ubyte),  # pbBuffer : BYTE* in/out
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('ADVAPI32.dll')
CryptGenRandom = Fiddle::Function.new(
  lib['CryptGenRandom'],
  [
    Fiddle::TYPE_UINTPTR_T,  # hProv : UINT_PTR
    -Fiddle::TYPE_INT,  # dwLen : DWORD
    Fiddle::TYPE_VOIDP,  # pbBuffer : BYTE* in/out
  ],
  Fiddle::TYPE_INT)

#[link(name = "advapi32")]
extern "system" {
    fn CryptGenRandom(
        hProv: usize,  // UINT_PTR
        dwLen: u32,  // DWORD
        pbBuffer: *mut u8  // BYTE* in/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 CryptGenRandom(UIntPtr hProv, uint dwLen, IntPtr pbBuffer);
"@
$api = Add-Type -MemberDefinition $sig -Name 'ADVAPI32_CryptGenRandom' -Namespace Win32 -PassThru
# $api::CryptGenRandom(hProv, dwLen, pbBuffer)

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

出力引数:

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