ホーム › Security.Cryptography › CryptDecodeObject

CryptDecodeObject

関数

符号化されたデータを暗号構造体に復号する。

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

シグネチャ

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

BOOL CryptDecodeObject(
    CERT_QUERY_ENCODING_TYPE dwCertEncodingType,
    LPCSTR lpszStructType,
    const BYTE* pbEncoded,
    DWORD cbEncoded,
    DWORD dwFlags,
    void* pvStructInfo,   // optional
    DWORD* pcbStructInfo
);

パラメーター

名前

型

方向

説明

dwCertEncodingType

CERT_QUERY_ENCODING_TYPE

使用するエンコーディングの種類です。次の例のように、証明書のエンコーディングの種類とメッセージのエンコーディングの種類の両方を、ビット単位の OR 演算で組み合わせて指定することも常に可能です。

X509_ASN_ENCODING | PKCS_7_ASN_ENCODING

現在定義されているエンコーディングの種類は次のとおりです。

注意証明書またはメッセージのエンコーディングの種類のいずれかが必要です。既定値は X509_ASN_ENCODING です。この種類が指定されている場合はそれが使用されます。指定されていない場合、PKCS7_ASN_ENCODING 種類が指定されていれば、それが使用されます。

lpszStructType

LPCSTR

構造体の型を定義する OID へのポインターです。lpszStructType パラメーターの上位ワードが 0 の場合、下位ワードは指定された構造体の型を表す整数識別子を指定します。それ以外の場合、このパラメーターは null 終端文字列への long ポインターです。

オブジェクト識別子文字列、その定義済み定数、および対応する構造体の詳細については、 Constants for CryptEncodeObject and CryptDecodeObject を参照してください。

pbEncoded

BYTE*

デコードするエンコード済み構造体へのポインターです。

cbEncoded

DWORD

pbEncoded が指すバイト数です。

dwFlags

DWORD

次のフラグが定義されています。これらはビット単位の OR 演算で組み合わせることができます。

値	意味
CRYPT_DECODE_NOCOPY_FLAG	このフラグを設定すると、「コピーなし」の最適化が有効になることを示します。この最適化では、該当する場合に、コンテンツのコピーを作成して pvStructInfo に追加する代わりに、pvStructInfo パラメーターを pbEncoded 内に存在するコンテンツを指すように更新します。該当するケースでは、呼び出し側アプリケーションが割り当てる必要のあるメモリが少なくなり、コピーが作成されないため実行が高速になります。「コピーなし」のデコードを行う際のトレードオフとして、pvStructInfo が解放されるまで pbEncoded を解放できないことに注意してください。
CRYPT_UNICODE_NAME_DECODE_DISABLE_IE4_UTF8_FLAG	このフラグは、X509_UNICODE_NAME、X509_UNICODE_NAME_VALUE、または X509_UNICODE_ANY_STRING をデコードする際に適用されます。既定では、CERT_RDN_T61_STRING でエンコードされた値は、最初に UTF8 としてデコードされます。UTF8 でのデコードに失敗した場合、その値は 8 ビット文字としてデコードされます。このフラグが設定されている場合、最初の UTF8 としてのデコードの試行をスキップし、値を 8 ビット文字としてデコードします。
CRYPT_DECODE_TO_BE_SIGNED_FLAG	既定では、pbEncoded が指すバッファーの内容には、署名されたコンテンツと署名の両方が含まれます。このフラグが設定されている場合、バッファーには「署名対象」のコンテンツのみが含まれます。このフラグは、X509_CERT_TO_BE_SIGNED、X509_CERT_CRL_TO_BE_SIGNED、X509_CRT_REQUEST_TO_BE_SIGNED、および X509_KEYGEN_REQUEST_TO_BE_SIGNED の各オブジェクトに適用されます。
CRYPT_DECODE_SHARE_OID_STRING_FLAG	このフラグが設定されている場合、OID 文字列は返されるデータ構造体にコピーされるのではなく、Crypt32.dll 内に割り当てられて共有されます。このフラグは、呼び出し側がアンロードされる前に Crypt32.dll がアンロードされない場合に設定できます。
CRYPT_DECODE_NO_SIGNATURE_BYTE_REVERSAL_FLAG	既定では、署名のバイトは反転されます。このフラグが設定されている場合、このバイト反転は抑制されます。

pvStructInfo

void*

outoptional

デコードされた構造体を受け取るバッファーへのポインターです。指定されたバッファーがデコードされた構造体を受け取るのに十分な大きさでない場合、関数は ERROR_MORE_DATA コードを設定し、必要なバッファーサイズ (バイト単位) を pcbStructInfo が指す変数に格納します。

このパラメーターは、メモリ割り当ての目的でこの情報のサイズを取得するために NULL にすることができます。詳細については、 Retrieving Data of Unknown Length を参照してください。

pcbStructInfo

DWORD*

inout

pvStructInfo パラメーターが指すバッファーのサイズ (バイト単位) を指定する DWORD 値へのポインターです。関数が返るとき、この DWORD 値には pvStructInfo にコピーされたデコード済みデータのサイズが格納されます。pcbStructInfo が指す変数に格納されるサイズは、デコードされた構造体が他の構造体へのポインターを含むことがあるため、デコードされた構造体よりも大きいサイズを示す場合があります。このサイズは、デコードされた構造体が必要とするサイズと、それが指す他の構造体が必要とするサイズの合計です。

注意バッファーで返されたデータを処理する際、アプリケーションは実際に返されたデータのサイズを使用する必要があります。実際のサイズは、入力時に指定したバッファーのサイズよりわずかに小さい場合があります。(入力時には、出力されうる最大のデータがバッファーに収まることを保証するため、通常はバッファーサイズを十分に大きく指定します。) 出力時には、このパラメーターが指す変数は、バッファーにコピーされたデータの実際のサイズを反映するように更新されます。

戻り値の型: BOOL

公式ドキュメント

CryptDecodeObject 関数は、lpszStructType パラメーターで指定された型の構造体をデコードします。同じ機能をより高いパフォーマンスで実行する API として、CryptDecodeObjectEx の使用が推奨されます。

戻り値

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

関数が失敗した場合、戻り値は 0 (FALSE) です。拡張エラー情報を取得するには、 GetLastError を呼び出します。発生しうるエラーコードの一部を次の表に示します。

戻りコード	説明
CRYPT_E_BAD_ENCODE	デコード中にエラーが発生しました。
ERROR_FILE_NOT_FOUND	指定された dwCertEncodingType と lpszStructType に対するデコード関数が見つかりませんでした。
ERROR_MORE_DATA	pvStructInfo パラメーターで指定されたバッファーが、返されるデータを保持するのに十分な大きさでない場合、関数は ERROR_MORE_DATA コードを設定し、必要なバッファーサイズ (バイト単位) を pcbStructInfo が指す変数に格納します。

関数が失敗した場合、GetLastError は Abstract Syntax Notation One (ASN.1) のエンコード/デコードエラーを返すことがあります。これらのエラーの詳細については、 ASN.1 Encoding/Decoding Return Values を参照してください。

解説(Remarks)

推奨される CryptEncodeObjectEx 関数を使用して暗号オブジェクトをエンコードする場合、終端の NULL 文字が含まれます。推奨される CryptDecodeObjectEx 関数を使用してデコードする場合、終端の NULL 文字は保持されません。

例

この関数を使用する例については、 Example C Program: ASN.1 Encoding and Decoding を参照してください。

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

各言語での呼び出し定義

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

BOOL CryptDecodeObject(
    CERT_QUERY_ENCODING_TYPE dwCertEncodingType,
    LPCSTR lpszStructType,
    const BYTE* pbEncoded,
    DWORD cbEncoded,
    DWORD dwFlags,
    void* pvStructInfo,   // optional
    DWORD* pcbStructInfo
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("CRYPT32.dll", SetLastError = true, ExactSpelling = true)]
static extern bool CryptDecodeObject(
    uint dwCertEncodingType,   // CERT_QUERY_ENCODING_TYPE
    [MarshalAs(UnmanagedType.LPStr)] string lpszStructType,   // LPCSTR
    IntPtr pbEncoded,   // BYTE*
    uint cbEncoded,   // DWORD
    uint dwFlags,   // DWORD
    IntPtr pvStructInfo,   // void* optional, out
    ref uint pcbStructInfo   // DWORD* in/out
);

<DllImport("CRYPT32.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function CryptDecodeObject(
    dwCertEncodingType As UInteger,   ' CERT_QUERY_ENCODING_TYPE
    <MarshalAs(UnmanagedType.LPStr)> lpszStructType As String,   ' LPCSTR
    pbEncoded As IntPtr,   ' BYTE*
    cbEncoded As UInteger,   ' DWORD
    dwFlags As UInteger,   ' DWORD
    pvStructInfo As IntPtr,   ' void* optional, out
    ByRef pcbStructInfo As UInteger   ' DWORD* in/out
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function

' dwCertEncodingType : CERT_QUERY_ENCODING_TYPE
' lpszStructType : LPCSTR
' pbEncoded : BYTE*
' cbEncoded : DWORD
' dwFlags : DWORD
' pvStructInfo : void* optional, out
' pcbStructInfo : DWORD* in/out
Declare PtrSafe Function CryptDecodeObject Lib "crypt32" ( _
    ByVal dwCertEncodingType As Long, _
    ByVal lpszStructType As String, _
    ByVal pbEncoded As LongPtr, _
    ByVal cbEncoded As Long, _
    ByVal dwFlags As Long, _
    ByVal pvStructInfo As LongPtr, _
    ByRef pcbStructInfo As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

CryptDecodeObject = ctypes.windll.crypt32.CryptDecodeObject
CryptDecodeObject.restype = wintypes.BOOL
CryptDecodeObject.argtypes = [
    wintypes.DWORD,  # dwCertEncodingType : CERT_QUERY_ENCODING_TYPE
    wintypes.LPCSTR,  # lpszStructType : LPCSTR
    ctypes.POINTER(ctypes.c_ubyte),  # pbEncoded : BYTE*
    wintypes.DWORD,  # cbEncoded : DWORD
    wintypes.DWORD,  # dwFlags : DWORD
    ctypes.POINTER(None),  # pvStructInfo : void* optional, out
    ctypes.POINTER(wintypes.DWORD),  # pcbStructInfo : DWORD* in/out
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('CRYPT32.dll')
CryptDecodeObject = Fiddle::Function.new(
  lib['CryptDecodeObject'],
  [
    -Fiddle::TYPE_INT,  # dwCertEncodingType : CERT_QUERY_ENCODING_TYPE
    Fiddle::TYPE_VOIDP,  # lpszStructType : LPCSTR
    Fiddle::TYPE_VOIDP,  # pbEncoded : BYTE*
    -Fiddle::TYPE_INT,  # cbEncoded : DWORD
    -Fiddle::TYPE_INT,  # dwFlags : DWORD
    Fiddle::TYPE_VOIDP,  # pvStructInfo : void* optional, out
    Fiddle::TYPE_VOIDP,  # pcbStructInfo : DWORD* in/out
  ],
  Fiddle::TYPE_INT)

#[link(name = "crypt32")]
extern "system" {
    fn CryptDecodeObject(
        dwCertEncodingType: u32,  // CERT_QUERY_ENCODING_TYPE
        lpszStructType: *const u8,  // LPCSTR
        pbEncoded: *const u8,  // BYTE*
        cbEncoded: u32,  // DWORD
        dwFlags: u32,  // DWORD
        pvStructInfo: *mut (),  // void* optional, out
        pcbStructInfo: *mut u32  // DWORD* in/out
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("CRYPT32.dll", SetLastError = true)]
public static extern bool CryptDecodeObject(uint dwCertEncodingType, [MarshalAs(UnmanagedType.LPStr)] string lpszStructType, IntPtr pbEncoded, uint cbEncoded, uint dwFlags, IntPtr pvStructInfo, ref uint pcbStructInfo);
"@
$api = Add-Type -MemberDefinition $sig -Name 'CRYPT32_CryptDecodeObject' -Namespace Win32 -PassThru
# $api::CryptDecodeObject(dwCertEncodingType, lpszStructType, pbEncoded, cbEncoded, dwFlags, pvStructInfo, pcbStructInfo)

#uselib "CRYPT32.dll"
#func global CryptDecodeObject "CryptDecodeObject" sptr, sptr, sptr, sptr, sptr, sptr, sptr
; CryptDecodeObject dwCertEncodingType, lpszStructType, varptr(pbEncoded), cbEncoded, dwFlags, pvStructInfo, varptr(pcbStructInfo)   ; 戻り値は stat
; dwCertEncodingType : CERT_QUERY_ENCODING_TYPE -> "sptr"
; lpszStructType : LPCSTR -> "sptr"
; pbEncoded : BYTE* -> "sptr"
; cbEncoded : DWORD -> "sptr"
; dwFlags : DWORD -> "sptr"
; pvStructInfo : void* optional, out -> "sptr"
; pcbStructInfo : DWORD* in/out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "CRYPT32.dll"
#cfunc global CryptDecodeObject "CryptDecodeObject" int, str, var, int, int, sptr, var
; res = CryptDecodeObject(dwCertEncodingType, lpszStructType, pbEncoded, cbEncoded, dwFlags, pvStructInfo, pcbStructInfo)
; dwCertEncodingType : CERT_QUERY_ENCODING_TYPE -> "int"
; lpszStructType : LPCSTR -> "str"
; pbEncoded : BYTE* -> "var"
; cbEncoded : DWORD -> "int"
; dwFlags : DWORD -> "int"
; pvStructInfo : void* optional, out -> "sptr"
; pcbStructInfo : DWORD* in/out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "CRYPT32.dll"
#cfunc global CryptDecodeObject "CryptDecodeObject" int, str, sptr, int, int, sptr, sptr
; res = CryptDecodeObject(dwCertEncodingType, lpszStructType, varptr(pbEncoded), cbEncoded, dwFlags, pvStructInfo, varptr(pcbStructInfo))
; dwCertEncodingType : CERT_QUERY_ENCODING_TYPE -> "int"
; lpszStructType : LPCSTR -> "str"
; pbEncoded : BYTE* -> "sptr"
; cbEncoded : DWORD -> "int"
; dwFlags : DWORD -> "int"
; pvStructInfo : void* optional, out -> "sptr"
; pcbStructInfo : DWORD* in/out -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。