ホーム › Security.Cryptography › CertGetValidUsages

CertGetValidUsages

関数

複数の証明書に共通して有効な使用法OIDの一覧を取得する。

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

シグネチャ

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

BOOL CertGetValidUsages(
    DWORD cCerts,
    CERT_CONTEXT** rghCerts,
    INT* cNumOIDs,
    LPSTR* rghOIDs,   // optional
    DWORD* pcbOIDs
);

パラメーター

名前	型	方向	説明
cCerts	DWORD	in	検査対象となる配列内の証明書の数。
rghCerts	CERT_CONTEXT**	in	有効な用途を検査する証明書の配列。
cNumOIDs	INT*	out	配列内のすべての証明書の有効な用途の積集合として見つかった、有効な用途の数。すべての証明書がすべての用途について有効である場合、cNumOIDs はマイナス 1 (–1) に設定されます。
rghOIDs	LPSTR*	outoptional	rghCerts 配列内のすべての証明書で共有される有効な用途のオブジェクト識別子 (OID) の配列。このパラメーターは、メモリ割り当てのためにこの構造体のサイズを設定する目的で NULL を指定できます。詳細については、 Retrieving Data of Unknown Length を参照してください。
pcbOIDs	DWORD*	inout	rghOIDs 配列とそこから指し示される文字列のサイズ (バイト単位) を指定する DWORD 値へのポインター。関数が戻ると、この DWORD 値には配列に必要なバイト数が格納されます。

戻り値の型: BOOL

公式ドキュメント

証明書の配列に含まれるすべての証明書について、有効な用途の積集合からなる用途の配列を返します。

戻り値

関数が成功した場合、戻り値は 0 以外になります。関数が失敗した場合、戻り値は 0 になります。拡張エラー情報を取得するには、 GetLastError を呼び出します。

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

各言語での呼び出し定義

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

BOOL CertGetValidUsages(
    DWORD cCerts,
    CERT_CONTEXT** rghCerts,
    INT* cNumOIDs,
    LPSTR* rghOIDs,   // optional
    DWORD* pcbOIDs
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("CRYPT32.dll", SetLastError = true, ExactSpelling = true)]
static extern bool CertGetValidUsages(
    uint cCerts,   // DWORD
    IntPtr rghCerts,   // CERT_CONTEXT**
    out int cNumOIDs,   // INT* out
    IntPtr rghOIDs,   // LPSTR* optional, out
    ref uint pcbOIDs   // DWORD* in/out
);

<DllImport("CRYPT32.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function CertGetValidUsages(
    cCerts As UInteger,   ' DWORD
    rghCerts As IntPtr,   ' CERT_CONTEXT**
    <Out> ByRef cNumOIDs As Integer,   ' INT* out
    rghOIDs As IntPtr,   ' LPSTR* optional, out
    ByRef pcbOIDs As UInteger   ' DWORD* in/out
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function

' cCerts : DWORD
' rghCerts : CERT_CONTEXT**
' cNumOIDs : INT* out
' rghOIDs : LPSTR* optional, out
' pcbOIDs : DWORD* in/out
Declare PtrSafe Function CertGetValidUsages Lib "crypt32" ( _
    ByVal cCerts As Long, _
    ByVal rghCerts As LongPtr, _
    ByRef cNumOIDs As Long, _
    ByVal rghOIDs As LongPtr, _
    ByRef pcbOIDs As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

CertGetValidUsages = ctypes.windll.crypt32.CertGetValidUsages
CertGetValidUsages.restype = wintypes.BOOL
CertGetValidUsages.argtypes = [
    wintypes.DWORD,  # cCerts : DWORD
    ctypes.c_void_p,  # rghCerts : CERT_CONTEXT**
    ctypes.POINTER(ctypes.c_int),  # cNumOIDs : INT* out
    ctypes.c_void_p,  # rghOIDs : LPSTR* optional, out
    ctypes.POINTER(wintypes.DWORD),  # pcbOIDs : DWORD* in/out
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('CRYPT32.dll')
CertGetValidUsages = Fiddle::Function.new(
  lib['CertGetValidUsages'],
  [
    -Fiddle::TYPE_INT,  # cCerts : DWORD
    Fiddle::TYPE_VOIDP,  # rghCerts : CERT_CONTEXT**
    Fiddle::TYPE_VOIDP,  # cNumOIDs : INT* out
    Fiddle::TYPE_VOIDP,  # rghOIDs : LPSTR* optional, out
    Fiddle::TYPE_VOIDP,  # pcbOIDs : DWORD* in/out
  ],
  Fiddle::TYPE_INT)

#[link(name = "crypt32")]
extern "system" {
    fn CertGetValidUsages(
        cCerts: u32,  // DWORD
        rghCerts: *mut *mut CERT_CONTEXT,  // CERT_CONTEXT**
        cNumOIDs: *mut i32,  // INT* out
        rghOIDs: *mut *mut u8,  // LPSTR* optional, out
        pcbOIDs: *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 CertGetValidUsages(uint cCerts, IntPtr rghCerts, out int cNumOIDs, IntPtr rghOIDs, ref uint pcbOIDs);
"@
$api = Add-Type -MemberDefinition $sig -Name 'CRYPT32_CertGetValidUsages' -Namespace Win32 -PassThru
# $api::CertGetValidUsages(cCerts, rghCerts, cNumOIDs, rghOIDs, pcbOIDs)

#uselib "CRYPT32.dll"
#func global CertGetValidUsages "CertGetValidUsages" sptr, sptr, sptr, sptr, sptr
; CertGetValidUsages cCerts, varptr(rghCerts), varptr(cNumOIDs), varptr(rghOIDs), varptr(pcbOIDs)   ; 戻り値は stat
; cCerts : DWORD -> "sptr"
; rghCerts : CERT_CONTEXT** -> "sptr"
; cNumOIDs : INT* out -> "sptr"
; rghOIDs : LPSTR* optional, out -> "sptr"
; pcbOIDs : DWORD* in/out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "CRYPT32.dll"
#cfunc global CertGetValidUsages "CertGetValidUsages" int, var, var, var, var
; res = CertGetValidUsages(cCerts, rghCerts, cNumOIDs, rghOIDs, pcbOIDs)
; cCerts : DWORD -> "int"
; rghCerts : CERT_CONTEXT** -> "var"
; cNumOIDs : INT* out -> "var"
; rghOIDs : LPSTR* optional, out -> "var"
; pcbOIDs : DWORD* in/out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "CRYPT32.dll"
#cfunc global CertGetValidUsages "CertGetValidUsages" int, sptr, sptr, sptr, sptr
; res = CertGetValidUsages(cCerts, varptr(rghCerts), varptr(cNumOIDs), varptr(rghOIDs), varptr(pcbOIDs))
; cCerts : DWORD -> "int"
; rghCerts : CERT_CONTEXT** -> "sptr"
; cNumOIDs : INT* out -> "sptr"
; rghOIDs : LPSTR* optional, out -> "sptr"
; pcbOIDs : DWORD* in/out -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。