ホーム › Security.Cryptography › CryptEncodeObjectEx

CryptEncodeObjectEx

関数

構造体を指定エンコード形式に符号化する拡張版関数。

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

シグネチャ

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

BOOL CryptEncodeObjectEx(
    CERT_QUERY_ENCODING_TYPE dwCertEncodingType,
    LPCSTR lpszStructType,
    const void* pvStructInfo,
    CRYPT_ENCODE_OBJECT_FLAGS dwFlags,
    CRYPT_ENCODE_PARA* pEncodePara,   // optional
    void* pvEncoded,   // optional
    DWORD* pcbEncoded
);

パラメーター

名前

型

方向

説明

dwCertEncodingType

CERT_QUERY_ENCODING_TYPE

オブジェクトのエンコードに使用する証明書エンコード型およびメッセージエンコード型です。このパラメーターには、次の値の 1 つ以上を組み合わせて指定できます。

値	意味
PKCS_7_ASN_ENCODING 65536 (0x10000)	PKCS 7 メッセージエンコードを指定します。
X509_ASN_ENCODING 1 (0x1)	X.509 証明書エンコードを指定します。

lpszStructType

LPCSTR

構造体の型を定義するオブジェクト識別子 (OID) へのポインターです。lpszStructType パラメーターの上位ワードがゼロの場合、下位ワードが指定された構造体の型を表す整数識別子を示します。そうでない場合、このパラメーターは OID の文字列表現を含む null 終端文字列へのポインターです。

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

pvStructInfo

void*

エンコードする構造体へのポインターです。この構造体は lpszStructType で指定された型でなければなりません。

dwFlags

CRYPT_ENCODE_OBJECT_FLAGS

エンコードのオプションを指定します。このパラメーターには、ゼロ、または次の値の 1 つ以上の組み合わせを指定できます。

値	意味
CRYPT_ENCODE_ALLOC_FLAG 32768 (0x8000)	呼び出されたエンコード関数が、エンコードされたバイト列のためのメモリを割り当てます。割り当てられたバイト列へのポインターは pvEncoded に返されます。
CRYPT_ENCODE_ENABLE_PUNYCODE_FLAG 131072 (0x20000)	このフラグは、Unicode 文字列値の Punycode エンコードを有効にする場合に適用されます。詳細については「解説」を参照してください。 Windows Server 2008、Windows Vista、Windows Server 2003 および Windows XP: このフラグはサポートされていません。
CRYPT_UNICODE_NAME_ENCODE_DISABLE_CHECK_TYPE_FLAG 1073741824 (0x40000000)	このフラグは、X509_UNICODE_NAME、X509_UNICODE_NAME_VALUE、または X509_UNICODE_ANY_STRING をエンコードする場合に適用されます。このフラグが設定されている場合、文字が指定された値の型に対して有効かどうかのチェックは行われません。
CRYPT_UNICODE_NAME_ENCODE_ENABLE_T61_UNICODE_FLAG 2147483648 (0x80000000)	このフラグは、X509_UNICODE_NAME をエンコードする場合に適用されます。このフラグが設定されており、すべての Unicode 文字が <= 0xFF である場合、CERT_RDN_UNICODE_STRING の代わりに CERT_RDN_T61_STRING が選択されます。
CRYPT_UNICODE_NAME_ENCODE_ENABLE_UTF8_UNICODE_FLAG 536870912 (0x20000000)	このフラグは、X509_UNICODE_NAME をエンコードする場合に適用されます。設定されている場合、CERT_RDN_UNICODE_STRING の代わりに CERT_RDN_UTF8_STRING が選択されます。
CRYPT_UNICODE_NAME_ENCODE_FORCE_UTF8_UNICODE_FLAG 268435456 (0x10000000)	このフラグは、X509_UNICODE_NAME をエンコードする場合に適用されます。設定されている場合、ディレクトリ文字列型に対して CERT_RDN_PRINTABLE_STRING の代わりに CERT_RDN_UTF8_STRING が選択されます。また、このフラグは CRYPT_UNICODE_NAME_ENCODE_ENABLE_UTF8_UNICODE_FLAG を有効にします。

pEncodePara

CRYPT_ENCODE_PARA*

inoptional

エンコード情報を含む CRYPT_ENCODE_PARA 構造体へのポインターです。このパラメーターは NULL でもかまいません。

pEncodePara または pEncodePara の pfnAlloc メンバーのいずれかが NULL の場合、割り当てには LocalAlloc が使用され、メモリの解放には LocalFree を呼び出す必要があります。

pEncodePara と pEncodePara の pfnAlloc メンバーの両方が NULL でない場合、割り当てには pEncodePara が指す CRYPT_ENCODE_PARA 構造体の pfnAlloc メンバーが指す関数が呼び出されます。メモリの解放には、pEncodePara の pfnFree メンバーが指す関数を呼び出す必要があります。

pvEncoded

void*

outoptional

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

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

dwFlags に CRYPT_ENCODE_ALLOC_FLAG フラグが含まれている場合、pvEncoded はバッファーへのポインターではなく、バッファーへのポインターのアドレスとなります。メモリは関数内部で割り当てられ、ポインターは pvEncoded に格納されるため、pvEncoded を NULL にすることはできません。

pcbEncoded

DWORD*

inout

pvEncoded パラメーターが指すバッファーのサイズ (バイト単位) を格納する DWORD 変数へのポインターです。関数が戻ると、pcbEncoded パラメーターが指す変数には、バッファーに格納された、割り当て済みのエンコードされたバイト数が格納されます。

dwFlags に CRYPT_ENCODE_ALLOC_FLAG フラグが含まれている場合、pcbEncoded は更新される DWORD 値へのポインターのアドレスとなります。

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

戻り値の型: BOOL

公式ドキュメント

lpszStructType パラメーターの値によって示される型の構造体をエンコードします。

戻り値

成功した場合は 0 以外、失敗した場合は 0 を返します。

拡張エラー情報を取得するには、 GetLastError を呼び出します。次の表は、CryptEncodeObjectEx が失敗したときに GetLastError から返される可能性のあるエラーコードの一部を示します。

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

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

解説(Remarks)

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

CryptEncodeObjectEx はまず、インストール可能な拡張エンコード関数を検索します。拡張エンコード関数が見つからない場合は、従来の非拡張のインストール可能な関数が検索されます。

オブジェクトの直接的な IA5String エンコードができない場合、dwFlag パラメーターに CRYPT_ENCODE_ENABLE_PUNYCODE_FLAG 値を設定することで Punycode エンコードを指定できます。CRYPT_ENCODE_ENABLE_PUNYCODE_FLAG フラグを設定した場合の効果は、lpszStructType パラメーターの値で指定される、エンコードされる構造体の型によって異なります。

以下のリストの各定数には、pvStructInfo パラメーターが指す関連する構造体型があります。その指される構造体は、直接的または間接的に CERT_ALT_NAME_ENTRY 構造体への参照を持ちます。

X509_ALTERNATE_NAME
szOID_AUTHORITY_INFO_ACCESS
X509_AUTHORITY_INFO_ACCESS
X509_AUTHORITY_KEY_ID2
szOID_AUTHORITY_KEY_IDENTIFIER2
szOID_CRL_DIST_POINTS
X509_CRL_DIST_POINTS
szOID_CROSS_CERT_DIST_POINTS
X509_CROSS_CERT_DIST_POINTS
szOID_ISSUER_ALT_NAME
szOID_ISSUER_ALT_NAME2
szOID_ISSUING_DIST_POINT
X509_ISSUING_DIST_POINT
szOID_NAME_CONSTRAINTS
X509_NAME_CONSTRAINTS
szOID_NEXT_UPDATE_LOCATION
OCSP_REQUEST
zOID_SUBJECT_ALT_NAME
szOID_SUBJECT_ALT_NAME2

CRYPT_ENCODE_ENABLE_PUNYCODE_FLAG フラグは、CERT_ALT_NAME_ENTRY 構造体の dwAltNameChoice メンバーの値と組み合わさって、文字列のエンコード方法を決定します。

dwAltNameChoice	効果
CERT_ALT_NAME_DNS_NAME	ホスト名に ASCII 文字セット外の Unicode 文字が含まれている場合、ホスト名はまず Punycode でエンコードされ、その後 IA5String 文字列としてエンコードされます。
CERT_ALT_NAME_RFC822_NAME	メールアドレスのホスト名部分に ASCII 文字セット外の Unicode 文字が含まれている場合、メールアドレスのホスト名部分が Punycode でエンコードされます。その結果得られるメールアドレスは、その後 IA5String 文字列としてエンコードされます。
CERT_ALT_NAME_URL	URI のサーバーホスト名に ASCII 文字セット外の Unicode 文字が含まれている場合、URI のホスト名部分が Punycode でエンコードされます。その後、結果として得られる URI がエスケープされ、URL は IA5String 文字列としてエンコードされます。

以下のリストの各定数には、pvStructInfo パラメーターが指す関連する構造体型があります。その指される構造体は、直接的または間接的に CERT_HASHED_URL 構造体への参照を持ちます。

szOID_BIOMETRIC_EXT
X509_BIOMETRIC_EXT
szOID_LOGOTYPE_EXT
X509_LOGOTYPE_EXT

CERT_HASHED_URL 構造体の値をエンコードする際、URI のサーバーホスト名に ASCII 文字セット外の Unicode 文字が含まれており、CRYPT_ENCODE_ENABLE_PUNYCODE_FLAG が設定されている場合、URI のホスト名部分が Punycode でエンコードされます。その後、結果として得られる URI がエスケープされ、URL は IA5String 文字列としてエンコードされます。

以下のリストの各 X509_UNICODE_NAME 定数には、pvStructInfo パラメーターが指す関連する構造体型があります。

X509_UNICODE_NAME

CERT_RDN_ATTR 構造体の pszObjId メンバーが szOID_RSA_emailAddr に設定されており、Value メンバー内のメールアドレスに ASCII 文字セット外の Unicode 文字が含まれている場合、メールアドレスのホスト名部分が Punycode でエンコードされます。その結果得られるメールアドレスは、その後 IA5String 文字列としてエンコードされます。

いずれの場合も、ホスト名の Punycode エンコードはラベルごとに実行されます。

例

次の例は、CryptEncodeObjectEx を使用して X509_NAME 構造体を初期化およびエンコードする方法を示します。この例の完全なコンテキストを含む例については、Example C Program: ASN.1 Encoding and Decoding を参照してください。

#include <windows.h>
#include <stdio.h>
#include <Wincrypt.h>
#pragma comment(lib, "crypt32.lib")


#define MY_TYPE (X509_ASN_ENCODING)

void main()
{

//#define moved

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

char *Cert_Sub_Name ="Test User Name";

//--------------------------------------------------------------------
// Initialize a single RDN structure.

CERT_RDN_ATTR rgNameAttr = 
{
   "2.5.4.3",                      // The OID
   CERT_RDN_PRINTABLE_STRING,      // Type of string
   (DWORD)strlen(Cert_Sub_Name)+1, // String length including
                                   //  the terminating null character
   (BYTE *)Cert_Sub_Name           // Pointer to the string 
};
//--------------------------------------------------------------------
// Declare and initialize a structure to include
// the array of RDN structures.

CERT_RDN rgRDN[] = 
{
   1,               // The number of elements in the array
   &rgNameAttr      // Pointer to the array
};

//--------------------------------------------------------------------
//  Declare and initialize a CERT_NAME_INFO 
//  structure that includes a CERT_RND.

CERT_NAME_INFO CertName = 
{
    1,          // The number of elements in the CERT_RND's array
    rgRDN
};

//--------------------------------------------------------------------
//  Declare additional variables.

DWORD cbEncoded;              // Variable to hold the
                              //  length of the encoded string
BYTE *pbEncoded;              // Variable to hold a pointer to the 
                              //  encoded buffer
//--------------------------------------------------------------------
// Call CrypteEncodeObjectEx to get 
// length to allocate for pbEncoded.

if( CryptEncodeObjectEx(
     MY_TYPE,        // The encoding/decoding type
     X509_NAME,    
     &CertName,
     0,                 
     NULL, 
     NULL,
     &cbEncoded))    // Fill in the length needed for
                     // the encoded buffer.
{
     printf("The number of bytes needed is %d \n",cbEncoded);
}
else
{
     printf("The first call to the function failed.\n");
     exit(1);
}

if( pbEncoded = (BYTE*)malloc(cbEncoded))
{
     printf("Memory for pvEncoded has been allocated.\n");
}
else
{
    printf("Memory allocation failed.\n");
    exit(1);
}

if(CryptEncodeObjectEx(
     MY_TYPE,
     X509_NAME,
     &CertName,
     0,
     NULL, 
     pbEncoded,
     &cbEncoded))
{
     printf("The structure has been encoded.\n");
}
else
{
     printf("Encoding failed.");
     exit(1);
}
// Free allocated memory when done.
// ...
if(pbEncoded)
{
    free(pbEncoded);
}

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

各言語での呼び出し定義

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

BOOL CryptEncodeObjectEx(
    CERT_QUERY_ENCODING_TYPE dwCertEncodingType,
    LPCSTR lpszStructType,
    const void* pvStructInfo,
    CRYPT_ENCODE_OBJECT_FLAGS dwFlags,
    CRYPT_ENCODE_PARA* pEncodePara,   // optional
    void* pvEncoded,   // optional
    DWORD* pcbEncoded
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("CRYPT32.dll", SetLastError = true, ExactSpelling = true)]
static extern bool CryptEncodeObjectEx(
    uint dwCertEncodingType,   // CERT_QUERY_ENCODING_TYPE
    [MarshalAs(UnmanagedType.LPStr)] string lpszStructType,   // LPCSTR
    IntPtr pvStructInfo,   // void*
    uint dwFlags,   // CRYPT_ENCODE_OBJECT_FLAGS
    IntPtr pEncodePara,   // CRYPT_ENCODE_PARA* optional
    IntPtr pvEncoded,   // void* optional, out
    ref uint pcbEncoded   // DWORD* in/out
);

<DllImport("CRYPT32.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function CryptEncodeObjectEx(
    dwCertEncodingType As UInteger,   ' CERT_QUERY_ENCODING_TYPE
    <MarshalAs(UnmanagedType.LPStr)> lpszStructType As String,   ' LPCSTR
    pvStructInfo As IntPtr,   ' void*
    dwFlags As UInteger,   ' CRYPT_ENCODE_OBJECT_FLAGS
    pEncodePara As IntPtr,   ' CRYPT_ENCODE_PARA* optional
    pvEncoded As IntPtr,   ' void* optional, out
    ByRef pcbEncoded As UInteger   ' DWORD* in/out
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function

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

import ctypes
from ctypes import wintypes

CryptEncodeObjectEx = ctypes.windll.crypt32.CryptEncodeObjectEx
CryptEncodeObjectEx.restype = wintypes.BOOL
CryptEncodeObjectEx.argtypes = [
    wintypes.DWORD,  # dwCertEncodingType : CERT_QUERY_ENCODING_TYPE
    wintypes.LPCSTR,  # lpszStructType : LPCSTR
    ctypes.POINTER(None),  # pvStructInfo : void*
    wintypes.DWORD,  # dwFlags : CRYPT_ENCODE_OBJECT_FLAGS
    ctypes.c_void_p,  # pEncodePara : CRYPT_ENCODE_PARA* optional
    ctypes.POINTER(None),  # pvEncoded : void* optional, out
    ctypes.POINTER(wintypes.DWORD),  # pcbEncoded : DWORD* in/out
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('CRYPT32.dll')
CryptEncodeObjectEx = Fiddle::Function.new(
  lib['CryptEncodeObjectEx'],
  [
    -Fiddle::TYPE_INT,  # dwCertEncodingType : CERT_QUERY_ENCODING_TYPE
    Fiddle::TYPE_VOIDP,  # lpszStructType : LPCSTR
    Fiddle::TYPE_VOIDP,  # pvStructInfo : void*
    -Fiddle::TYPE_INT,  # dwFlags : CRYPT_ENCODE_OBJECT_FLAGS
    Fiddle::TYPE_VOIDP,  # pEncodePara : CRYPT_ENCODE_PARA* optional
    Fiddle::TYPE_VOIDP,  # pvEncoded : void* optional, out
    Fiddle::TYPE_VOIDP,  # pcbEncoded : DWORD* in/out
  ],
  Fiddle::TYPE_INT)

#[link(name = "crypt32")]
extern "system" {
    fn CryptEncodeObjectEx(
        dwCertEncodingType: u32,  // CERT_QUERY_ENCODING_TYPE
        lpszStructType: *const u8,  // LPCSTR
        pvStructInfo: *const (),  // void*
        dwFlags: u32,  // CRYPT_ENCODE_OBJECT_FLAGS
        pEncodePara: *mut CRYPT_ENCODE_PARA,  // CRYPT_ENCODE_PARA* optional
        pvEncoded: *mut (),  // void* optional, out
        pcbEncoded: *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 CryptEncodeObjectEx(uint dwCertEncodingType, [MarshalAs(UnmanagedType.LPStr)] string lpszStructType, IntPtr pvStructInfo, uint dwFlags, IntPtr pEncodePara, IntPtr pvEncoded, ref uint pcbEncoded);
"@
$api = Add-Type -MemberDefinition $sig -Name 'CRYPT32_CryptEncodeObjectEx' -Namespace Win32 -PassThru
# $api::CryptEncodeObjectEx(dwCertEncodingType, lpszStructType, pvStructInfo, dwFlags, pEncodePara, pvEncoded, pcbEncoded)

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

出力引数:

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