ホーム › Security.Cryptography › CryptEncodeObject

CryptEncodeObject

関数

暗号構造体を指定したエンコード形式に符号化する。

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

シグネチャ

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

BOOL CryptEncodeObject(
    CERT_QUERY_ENCODING_TYPE dwCertEncodingType,
    LPCSTR lpszStructType,
    const void* pvStructInfo,
    BYTE* pbEncoded,   // optional
    DWORD* pcbEncoded
);

パラメーター

名前	型	方向	説明
dwCertEncodingType	CERT_QUERY_ENCODING_TYPE	in	使用するエンコードの種類。証明書のエンコードの種類とメッセージのエンコードの種類の両方を、次の例のようにビットごとの OR 演算で組み合わせて指定することは常に許可されています。 X509_ASN_ENCODING \| PKCS_7_ASN_ENCODING 現在定義されているエンコードの種類は次のとおりです。 X509_ASN_ENCODING PKCS_7_ASN_ENCODING 注証明書またはメッセージのエンコードの種類のいずれかが必要です。既定は X509_ASN_ENCODING です。この種類が指定されている場合は、それが使用されます。指定されていない場合で PKCS7_ASN_ENCODING の種類が指定されているときは、それが使用されます。
lpszStructType	LPCSTR	in	構造体の型を定義する OID へのポインター。lpszStructType パラメーターの上位ワードが 0 の場合、下位ワードは指定された構造体の型の整数識別子を表します。それ以外の場合、このパラメーターは null で終わる文字列への long ポインターです。オブジェクト識別子文字列、その定義済み定数、および対応する構造体の詳細については、 Constants for CryptEncodeObject and CryptDecodeObject を参照してください。
pvStructInfo	void*	in	エンコードする構造体へのポインター。構造体は lpszStructType で指定された型でなければなりません。
pbEncoded	BYTE*	outoptional	エンコードされた構造体を受け取るバッファーへのポインター。指定したバッファーがデコードされた構造体を受け取るのに十分な大きさでない場合、関数は ERROR_MORE_DATA コードを設定し、必要なバッファーサイズ (バイト単位) を pcbEncoded が指す変数に格納します。このパラメーターは、メモリ割り当てを目的としてこの情報のサイズを取得するために NULL にすることができます。詳細については、 Retrieving Data of Unknown Length を参照してください。
pcbEncoded	DWORD*	inout	pbEncoded パラメーターが指すバッファーのサイズ (バイト単位) を格納する DWORD 変数へのポインター。関数が戻ると、DWORD 値にはバッファーに格納された、割り当て済みのエンコード済みバイト数が格納されます。注バッファーに返されたデータを処理する際、アプリケーションは返されたデータの実際のサイズを使用しなければなりません。実際のサイズは、入力時に指定したバッファーのサイズよりわずかに小さくなる場合があります。(入力時には、想定される最大の出力データがバッファーに収まるように、通常は十分な大きさのバッファーサイズが指定されます。) 出力時には、このパラメーターが指す変数が、バッファーにコピーされたデータの実際のサイズを反映するように更新されます。

戻り値の型: BOOL

公式ドキュメント

CryptEncodeObject 関数は、lpszStructType パラメーターの値で示される型の構造体をエンコードします。同じ機能を大幅に高速化して実行する API として、CryptEncodeObjectEx の使用を推奨します。

戻り値

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

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

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

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

解説(Remarks)

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

例

この関数を使用する例については、 Example C Program: Making a Certificate Request および 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 CryptEncodeObject(
    CERT_QUERY_ENCODING_TYPE dwCertEncodingType,
    LPCSTR lpszStructType,
    const void* pvStructInfo,
    BYTE* pbEncoded,   // optional
    DWORD* pcbEncoded
);

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

<DllImport("CRYPT32.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function CryptEncodeObject(
    dwCertEncodingType As UInteger,   ' CERT_QUERY_ENCODING_TYPE
    <MarshalAs(UnmanagedType.LPStr)> lpszStructType As String,   ' LPCSTR
    pvStructInfo As IntPtr,   ' void*
    pbEncoded As IntPtr,   ' BYTE* 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*
' pbEncoded : BYTE* optional, out
' pcbEncoded : DWORD* in/out
Declare PtrSafe Function CryptEncodeObject Lib "crypt32" ( _
    ByVal dwCertEncodingType As Long, _
    ByVal lpszStructType As String, _
    ByVal pvStructInfo As LongPtr, _
    ByVal pbEncoded 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

CryptEncodeObject = ctypes.windll.crypt32.CryptEncodeObject
CryptEncodeObject.restype = wintypes.BOOL
CryptEncodeObject.argtypes = [
    wintypes.DWORD,  # dwCertEncodingType : CERT_QUERY_ENCODING_TYPE
    wintypes.LPCSTR,  # lpszStructType : LPCSTR
    ctypes.POINTER(None),  # pvStructInfo : void*
    ctypes.POINTER(ctypes.c_ubyte),  # pbEncoded : BYTE* 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')
CryptEncodeObject = Fiddle::Function.new(
  lib['CryptEncodeObject'],
  [
    -Fiddle::TYPE_INT,  # dwCertEncodingType : CERT_QUERY_ENCODING_TYPE
    Fiddle::TYPE_VOIDP,  # lpszStructType : LPCSTR
    Fiddle::TYPE_VOIDP,  # pvStructInfo : void*
    Fiddle::TYPE_VOIDP,  # pbEncoded : BYTE* optional, out
    Fiddle::TYPE_VOIDP,  # pcbEncoded : DWORD* in/out
  ],
  Fiddle::TYPE_INT)

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

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

出力引数:

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