ホーム › Security.Cryptography › CryptStringToBinaryW

CryptStringToBinaryW

関数

Base64などのUnicode文字列をバイナリデータに変換する。

DLLCRYPT32.dll文字セットUnicode (-W)呼出規約winapiSetLastErrorあり対応OSWindows XP 以降

シグネチャ

// CRYPT32.dll  (Unicode / -W)
#include <windows.h>

BOOL CryptStringToBinaryW(
    LPCWSTR pszString,
    DWORD cchString,
    CRYPT_STRING dwFlags,
    BYTE* pbBinary,   // optional
    DWORD* pcbBinary,
    DWORD* pdwSkip,   // optional
    DWORD* pdwFlags   // optional
);

パラメーター

名前型方向説明

pszString LPCWSTR in 変換対象の書式付き文字列を格納した文字列へのポインター。

cchString DWORD in 変換する書式付き文字列の文字数。終端の NULL 文字は含めません。このパラメーターが 0 の場合、pszString は null 終端文字列とみなされます。

dwFlags

CRYPT_STRING

変換する文字列の形式を示します。次のいずれかの値を指定できます。

値	意味
CRYPT_STRING_BASE64HEADER 0x00000000	`-----BEGIN ...-----` および `-----END ...-----` の形式の行に挟まれた Base64。以下の「解説」を参照してください。
CRYPT_STRING_BASE64 0x00000001	ヘッダーなしの Base64。
CRYPT_STRING_BINARY 0x00000002	純粋なバイナリのコピー。
CRYPT_STRING_BASE64REQUESTHEADER 0x00000003	`-----BEGIN ...-----` および `-----END ...-----` の形式の行に挟まれた Base64。以下の「解説」を参照してください。
CRYPT_STRING_HEX 0x00000004	16 進数のみの形式。
CRYPT_STRING_HEXASCII 0x00000005	ASCII 文字表示付きの 16 進数形式。
CRYPT_STRING_BASE64_ANY 0x00000006	次の順で試行します。 CRYPT_STRING_BASE64HEADER CRYPT_STRING_BASE64
CRYPT_STRING_ANY 0x00000007	次の順で試行します。 CRYPT_STRING_BASE64HEADER CRYPT_STRING_BASE64 CRYPT_STRING_BINARY
CRYPT_STRING_HEX_ANY 0x00000008	次の順で試行します。 CRYPT_STRING_HEXADDR CRYPT_STRING_HEXASCIIADDR CRYPT_STRING_HEX CRYPT_STRING_HEXRAW CRYPT_STRING_HEXASCII
CRYPT_STRING_BASE64X509CRLHEADER 0x00000009	`-----BEGIN ...-----` および `-----END ...-----` の形式の行に挟まれた Base64。以下の「解説」を参照してください。
CRYPT_STRING_HEXADDR 0x0000000a	アドレス表示付きの 16 進数。
CRYPT_STRING_HEXASCIIADDR 0x0000000b	ASCII 文字表示およびアドレス表示付きの 16 進数。
CRYPT_STRING_HEXRAW 0x0000000c	そのままの 16 進数文字列。 Windows Server 2003 および Windows XP: この値はサポートされていません。
CRYPT_STRING_STRICT 0x20000000	Base64 データに対してこのフラグを設定すると、バイナリデータの末尾には空白文字と最大 3 個の等号 "=" のみが含まれることを指定します。 Windows Server 2008、Windows Vista、Windows Server 2003 および Windows XP: この値はサポートされていません。

pbBinary BYTE* outoptional 返されるバイト列を受け取るバッファーへのポインター。このパラメーターが NULL の場合、関数は必要なバッファーの長さを計算し、必要なメモリのサイズ(バイト単位)を pcbBinary が指す DWORD に返します。

pcbBinary

DWORD*

inout

DWORD 変数へのポインター。呼び出し時には pbBinary バッファーのサイズ(バイト単位)を格納します。関数が戻ると、この変数にはバッファーへコピーされたバイト数が格納されます。この値がすべてのデータを格納するのに十分な大きさでない場合、関数は失敗し、GetLastError は ERROR_MORE_DATA を返します。

pbBinary が NULL の場合、pcbBinary が指す DWORD は無視されます。

pdwSkip DWORD* outoptional -----BEGIN ...----- ヘッダーの先頭に到達するまでにスキップされた文字数を受け取る DWORD 値へのポインター。ヘッダーが存在しない場合、この DWORD は 0 に設定されます。このパラメーターは省略可能で、不要な場合は NULL を指定できます。

pdwFlags

DWORD*

outoptional

変換で実際に使用されたフラグを受け取る DWORD 値へのポインター。これらは dwFlags パラメーターで使用されるフラグと同じものです。多くの場合、dwFlags パラメーターに渡されたフラグと同じになります。dwFlags が次のいずれかのフラグを含む場合、この値には文字列の実際の形式を示すフラグが格納されます。このパラメーターは省略可能で、不要な場合は NULL を指定できます。

値	意味
CRYPT_STRING_ANY	この変数には次のいずれかの値が格納されます。各値は文字列の実際の形式を示します。 CRYPT_STRING_BASE64HEADER CRYPT_STRING_BASE64 CRYPT_STRING_BINARY
CRYPT_STRING_BASE64_ANY	この変数には次のいずれかの値が格納されます。各値は文字列の実際の形式を示します。 CRYPT_STRING_BASE64HEADER CRYPT_STRING_BASE64
CRYPT_STRING_HEX_ANY	この変数には次のいずれかの値が格納されます。各値は文字列の実際の形式を示します。 CRYPT_STRING_HEXADDR CRYPT_STRING_HEXASCIIADDR CRYPT_STRING_HEX CRYPT_STRING_HEXRAW CRYPT_STRING_HEXASCII

戻り値の型: BOOL

公式ドキュメント

書式付き文字列をバイト配列に変換します。(Unicode)

戻り値

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

関数が失敗した場合、戻り値は 0(FALSE)です。

解説(Remarks)

CRYPT_STRING_BASE64HEADER、 CRYPT_STRING_BASE64REQUESTHEADER、および CRYPT_STRING_BASE64X509CRLHEADER の各フラグは、この関数では同一に扱われます。これらは、-----BEGIN ...----- および -----END ...----- の形式の行に挟まれた base64 エンコードデータの最初のブロックの解析を試みます。 ... の部分は無視され、一致している必要はありません。解析に成功した場合、dwFlags パラメーターに渡された値が pdwFlags パラメーターが指す DWORD に返されます。なお、 CRYPT_STRING_BASE64REQUESTHEADER または CRYPT_STRING_BASE64X509CRLHEADER の値は、リクエストヘッダーや X.509 証明書失効リスト (CRL) が見つかったことを意味するものではありません。

メモ

wincrypt.h ヘッダーは、UNICODE プリプロセッサ定数の定義に基づいて、この関数の ANSI 版または Unicode 版を自動的に選択するエイリアスとして CryptStringToBinary を定義します。エンコーディング中立のエイリアスの使用を、エンコーディング中立でないコードと混在させると、不整合が生じてコンパイルエラーや実行時エラーを引き起こすおそれがあります。詳細については、関数プロトタイプの規則を参照してください。

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

各言語での呼び出し定義

// CRYPT32.dll  (Unicode / -W)
#include <windows.h>

BOOL CryptStringToBinaryW(
    LPCWSTR pszString,
    DWORD cchString,
    CRYPT_STRING dwFlags,
    BYTE* pbBinary,   // optional
    DWORD* pcbBinary,
    DWORD* pdwSkip,   // optional
    DWORD* pdwFlags   // optional
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("CRYPT32.dll", CharSet = CharSet.Unicode, SetLastError = true, ExactSpelling = true)]
static extern bool CryptStringToBinaryW(
    [MarshalAs(UnmanagedType.LPWStr)] string pszString,   // LPCWSTR
    uint cchString,   // DWORD
    uint dwFlags,   // CRYPT_STRING
    IntPtr pbBinary,   // BYTE* optional, out
    ref uint pcbBinary,   // DWORD* in/out
    IntPtr pdwSkip,   // DWORD* optional, out
    IntPtr pdwFlags   // DWORD* optional, out
);

<DllImport("CRYPT32.dll", CharSet:=CharSet.Unicode, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function CryptStringToBinaryW(
    <MarshalAs(UnmanagedType.LPWStr)> pszString As String,   ' LPCWSTR
    cchString As UInteger,   ' DWORD
    dwFlags As UInteger,   ' CRYPT_STRING
    pbBinary As IntPtr,   ' BYTE* optional, out
    ByRef pcbBinary As UInteger,   ' DWORD* in/out
    pdwSkip As IntPtr,   ' DWORD* optional, out
    pdwFlags As IntPtr   ' DWORD* optional, out
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function

' pszString : LPCWSTR
' cchString : DWORD
' dwFlags : CRYPT_STRING
' pbBinary : BYTE* optional, out
' pcbBinary : DWORD* in/out
' pdwSkip : DWORD* optional, out
' pdwFlags : DWORD* optional, out
Declare PtrSafe Function CryptStringToBinaryW Lib "crypt32" ( _
    ByVal pszString As LongPtr, _
    ByVal cchString As Long, _
    ByVal dwFlags As Long, _
    ByVal pbBinary As LongPtr, _
    ByRef pcbBinary As Long, _
    ByVal pdwSkip As LongPtr, _
    ByVal pdwFlags As LongPtr) As Long
' Unicode(W): 文字列は ByVal As LongPtr とし StrPtr(unicodeStr) を渡す
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

CryptStringToBinaryW = ctypes.windll.crypt32.CryptStringToBinaryW
CryptStringToBinaryW.restype = wintypes.BOOL
CryptStringToBinaryW.argtypes = [
    wintypes.LPCWSTR,  # pszString : LPCWSTR
    wintypes.DWORD,  # cchString : DWORD
    wintypes.DWORD,  # dwFlags : CRYPT_STRING
    ctypes.POINTER(ctypes.c_ubyte),  # pbBinary : BYTE* optional, out
    ctypes.POINTER(wintypes.DWORD),  # pcbBinary : DWORD* in/out
    ctypes.POINTER(wintypes.DWORD),  # pdwSkip : DWORD* optional, out
    ctypes.POINTER(wintypes.DWORD),  # pdwFlags : DWORD* optional, out
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('CRYPT32.dll')
CryptStringToBinaryW = Fiddle::Function.new(
  lib['CryptStringToBinaryW'],
  [
    Fiddle::TYPE_VOIDP,  # pszString : LPCWSTR
    -Fiddle::TYPE_INT,  # cchString : DWORD
    -Fiddle::TYPE_INT,  # dwFlags : CRYPT_STRING
    Fiddle::TYPE_VOIDP,  # pbBinary : BYTE* optional, out
    Fiddle::TYPE_VOIDP,  # pcbBinary : DWORD* in/out
    Fiddle::TYPE_VOIDP,  # pdwSkip : DWORD* optional, out
    Fiddle::TYPE_VOIDP,  # pdwFlags : DWORD* optional, out
  ],
  Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"

#[link(name = "crypt32")]
extern "system" {
    fn CryptStringToBinaryW(
        pszString: *const u16,  // LPCWSTR
        cchString: u32,  // DWORD
        dwFlags: u32,  // CRYPT_STRING
        pbBinary: *mut u8,  // BYTE* optional, out
        pcbBinary: *mut u32,  // DWORD* in/out
        pdwSkip: *mut u32,  // DWORD* optional, out
        pdwFlags: *mut u32  // DWORD* optional, out
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("CRYPT32.dll", CharSet = CharSet.Unicode, SetLastError = true)]
public static extern bool CryptStringToBinaryW([MarshalAs(UnmanagedType.LPWStr)] string pszString, uint cchString, uint dwFlags, IntPtr pbBinary, ref uint pcbBinary, IntPtr pdwSkip, IntPtr pdwFlags);
"@
$api = Add-Type -MemberDefinition $sig -Name 'CRYPT32_CryptStringToBinaryW' -Namespace Win32 -PassThru
# $api::CryptStringToBinaryW(pszString, cchString, dwFlags, pbBinary, pcbBinary, pdwSkip, pdwFlags)

#uselib "CRYPT32.dll"
#func global CryptStringToBinaryW "CryptStringToBinaryW" wptr, wptr, wptr, wptr, wptr, wptr, wptr
; CryptStringToBinaryW pszString, cchString, dwFlags, varptr(pbBinary), varptr(pcbBinary), varptr(pdwSkip), varptr(pdwFlags)   ; 戻り値は stat
; pszString : LPCWSTR -> "wptr"
; cchString : DWORD -> "wptr"
; dwFlags : CRYPT_STRING -> "wptr"
; pbBinary : BYTE* optional, out -> "wptr"
; pcbBinary : DWORD* in/out -> "wptr"
; pdwSkip : DWORD* optional, out -> "wptr"
; pdwFlags : DWORD* optional, out -> "wptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "CRYPT32.dll"
#cfunc global CryptStringToBinaryW "CryptStringToBinaryW" wstr, int, int, var, var, var, var
; res = CryptStringToBinaryW(pszString, cchString, dwFlags, pbBinary, pcbBinary, pdwSkip, pdwFlags)
; pszString : LPCWSTR -> "wstr"
; cchString : DWORD -> "int"
; dwFlags : CRYPT_STRING -> "int"
; pbBinary : BYTE* optional, out -> "var"
; pcbBinary : DWORD* in/out -> "var"
; pdwSkip : DWORD* optional, out -> "var"
; pdwFlags : DWORD* optional, out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "CRYPT32.dll"
#cfunc global CryptStringToBinaryW "CryptStringToBinaryW" wstr, int, int, sptr, sptr, sptr, sptr
; res = CryptStringToBinaryW(pszString, cchString, dwFlags, varptr(pbBinary), varptr(pcbBinary), varptr(pdwSkip), varptr(pdwFlags))
; pszString : LPCWSTR -> "wstr"
; cchString : DWORD -> "int"
; dwFlags : CRYPT_STRING -> "int"
; pbBinary : BYTE* optional, out -> "sptr"
; pcbBinary : DWORD* in/out -> "sptr"
; pdwSkip : DWORD* optional, out -> "sptr"
; pdwFlags : DWORD* optional, out -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。