ホーム › Security.Cryptography › CertGetIntendedKeyUsage

CertGetIntendedKeyUsage

関数

証明書情報から意図されたキー使用法ビットを取得する。

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

シグネチャ

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

BOOL CertGetIntendedKeyUsage(
    CERT_QUERY_ENCODING_TYPE dwCertEncodingType,
    CERT_INFO* pCertInfo,
    BYTE* pbKeyUsage,
    DWORD cbKeyUsage
);

パラメーター

名前	型	方向	説明
dwCertEncodingType	CERT_QUERY_ENCODING_TYPE	in	使用するエンコード方式の種類を指定します。次の例に示すように、証明書のエンコード方式とメッセージのエンコード方式の両方をビット単位のOR演算で組み合わせて指定することも常に可能です。 X509_ASN_ENCODING \| PKCS_7_ASN_ENCODING 現在定義されているエンコード方式の種類は次のとおりです。 X509_ASN_ENCODING PKCS_7_ASN_ENCODING
pCertInfo	CERT_INFO*	in	指定した証明書の CERT_INFO 構造体へのポインターです。
pbKeyUsage	BYTE*	out	想定されるキー用途を受け取るバッファーへのポインターです。次の一覧は、現在定義されている値を示します。これらはビット単位のOR演算で組み合わせることができます。 CERT_DATA_ENCIPHERMENT_KEY_USAGE CERT_DIGITAL_SIGNATURE_KEY_USAGE CERT_KEY_AGREEMENT_KEY_USAGE CERT_KEY_CERT_SIGN_KEY_USAGE CERT_KEY_ENCIPHERMENT_KEY_USAGE CERT_NON_REPUDIATION_KEY_USAGE CERT_OFFLINE_CRL_SIGN_KEY_USAGE
cbKeyUsage	DWORD	in	pbKeyUsage が指すバッファーのサイズ (バイト単位) です。現在のところ、想定されるキー用途のデータは 1 バイトまたは 2 バイトを占めます。

戻り値の型: BOOL

公式ドキュメント

証明書から、想定されるキー用途 (intended key usage) のバイト列を取得します。

戻り値

証明書に想定されるキー用途のバイトが存在しない場合は FALSE が返され、pbKeyUsage はゼロで埋められます。それ以外の場合は TRUE が返され、最大で cbKeyUsage バイト分のデータが pbKeyUsage にコピーされます。コピーされなかった残りのバイトはゼロで埋められます。

必要な拡張のいずれも見つからない場合、GetLastError は 0 を返します。

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

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

各言語での呼び出し定義

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

BOOL CertGetIntendedKeyUsage(
    CERT_QUERY_ENCODING_TYPE dwCertEncodingType,
    CERT_INFO* pCertInfo,
    BYTE* pbKeyUsage,
    DWORD cbKeyUsage
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("CRYPT32.dll", SetLastError = true, ExactSpelling = true)]
static extern bool CertGetIntendedKeyUsage(
    uint dwCertEncodingType,   // CERT_QUERY_ENCODING_TYPE
    IntPtr pCertInfo,   // CERT_INFO*
    IntPtr pbKeyUsage,   // BYTE* out
    uint cbKeyUsage   // DWORD
);

<DllImport("CRYPT32.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function CertGetIntendedKeyUsage(
    dwCertEncodingType As UInteger,   ' CERT_QUERY_ENCODING_TYPE
    pCertInfo As IntPtr,   ' CERT_INFO*
    pbKeyUsage As IntPtr,   ' BYTE* out
    cbKeyUsage As UInteger   ' DWORD
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function

' dwCertEncodingType : CERT_QUERY_ENCODING_TYPE
' pCertInfo : CERT_INFO*
' pbKeyUsage : BYTE* out
' cbKeyUsage : DWORD
Declare PtrSafe Function CertGetIntendedKeyUsage Lib "crypt32" ( _
    ByVal dwCertEncodingType As Long, _
    ByVal pCertInfo As LongPtr, _
    ByVal pbKeyUsage As LongPtr, _
    ByVal cbKeyUsage As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

CertGetIntendedKeyUsage = ctypes.windll.crypt32.CertGetIntendedKeyUsage
CertGetIntendedKeyUsage.restype = wintypes.BOOL
CertGetIntendedKeyUsage.argtypes = [
    wintypes.DWORD,  # dwCertEncodingType : CERT_QUERY_ENCODING_TYPE
    ctypes.c_void_p,  # pCertInfo : CERT_INFO*
    ctypes.POINTER(ctypes.c_ubyte),  # pbKeyUsage : BYTE* out
    wintypes.DWORD,  # cbKeyUsage : DWORD
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('CRYPT32.dll')
CertGetIntendedKeyUsage = Fiddle::Function.new(
  lib['CertGetIntendedKeyUsage'],
  [
    -Fiddle::TYPE_INT,  # dwCertEncodingType : CERT_QUERY_ENCODING_TYPE
    Fiddle::TYPE_VOIDP,  # pCertInfo : CERT_INFO*
    Fiddle::TYPE_VOIDP,  # pbKeyUsage : BYTE* out
    -Fiddle::TYPE_INT,  # cbKeyUsage : DWORD
  ],
  Fiddle::TYPE_INT)

#[link(name = "crypt32")]
extern "system" {
    fn CertGetIntendedKeyUsage(
        dwCertEncodingType: u32,  // CERT_QUERY_ENCODING_TYPE
        pCertInfo: *mut CERT_INFO,  // CERT_INFO*
        pbKeyUsage: *mut u8,  // BYTE* out
        cbKeyUsage: u32  // DWORD
    ) -> 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 CertGetIntendedKeyUsage(uint dwCertEncodingType, IntPtr pCertInfo, IntPtr pbKeyUsage, uint cbKeyUsage);
"@
$api = Add-Type -MemberDefinition $sig -Name 'CRYPT32_CertGetIntendedKeyUsage' -Namespace Win32 -PassThru
# $api::CertGetIntendedKeyUsage(dwCertEncodingType, pCertInfo, pbKeyUsage, cbKeyUsage)

#uselib "CRYPT32.dll"
#func global CertGetIntendedKeyUsage "CertGetIntendedKeyUsage" sptr, sptr, sptr, sptr
; CertGetIntendedKeyUsage dwCertEncodingType, varptr(pCertInfo), varptr(pbKeyUsage), cbKeyUsage   ; 戻り値は stat
; dwCertEncodingType : CERT_QUERY_ENCODING_TYPE -> "sptr"
; pCertInfo : CERT_INFO* -> "sptr"
; pbKeyUsage : BYTE* out -> "sptr"
; cbKeyUsage : DWORD -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

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