ホーム › Security.Cryptography › CryptGetObjectUrl

CryptGetObjectUrl

関数

証明書などから関連オブジェクトの取得URL一覧を取得する。

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

シグネチャ

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

BOOL CryptGetObjectUrl(
    LPCSTR pszUrlOid,
    void* pvPara,
    CRYPT_GET_URL_FLAGS dwFlags,
    CRYPT_URL_ARRAY* pUrlArray,   // optional
    DWORD* pcbUrlArray,
    CRYPT_URL_INFO* pUrlInfo,   // optional
    DWORD* pcbUrlInfo,   // optional
    void* pvReserved   // optional
);

パラメーター

名前

型

方向

説明

pszUrlOid

LPCSTR

要求する URL を識別するオブジェクト識別子 (OID) へのポインター。pszUrlOid パラメーターの HIWORD が 0 の場合、LOWORD は指定された構造体の種類の整数識別子を表します。

このパラメーターには、次のいずれかの値を指定できます。これらの値が pvPara パラメーターにどのように影響するかについては、意味列の見出し「pvPara パラメーターの場合」を参照してください。

値	意味
URL_OID_CERTIFICATE_ISSUER	証明書の機関情報アクセス拡張またはプロパティから取得した証明書発行者の URL を提供します。 pvPara パラメーターの場合: URL を要求する発行者によって発行された CERT_CONTEXT 構造体へのポインター。
URL_OID_CERTIFICATE_CRL_DIST_POINT	証明書の CRL 配布ポイント拡張またはプロパティから取得した CRL 配布ポイントの URL の一覧を提供します。 pvPara パラメーターの場合: CRL 配布ポイントを要求する CERT_CONTEXT 構造体へのポインター。
URL_OID_CERTIFICATE_CRL_DIST_POINT_AND_OCSP	証明書の機関情報アクセス (AIA) 拡張および CRL 配布ポイント拡張またはプロパティから、OCSP および CRL 配布ポイントの URL の一覧を提供します。この関数は最初に CRL 配布ポイントの URL を返します。OCSP の URL を使用する前に、L"ocsp:" プレフィックスを削除する必要があります。 pvPara パラメーターの場合: OCSP および CRL 配布ポイントの URL を要求する CERT_CONTEXT 構造体へのポインター。
URL_OID_CERTIFICATE_OCSP	証明書の機関情報アクセス (AIA) 拡張またはプロパティから OCSP の URL を提供します。 pvPara パラメーターの場合: OCSP の URL を要求する CERT_CONTEXT 構造体へのポインター。
URL_OID_CERTIFICATE_OCSP_AND_CRL_DIST_POINT	証明書の機関情報アクセス (AIA) 拡張および CRL 配布ポイント拡張またはプロパティから、OCSP および CRL 配布ポイントの URL の一覧を提供します。この関数は最初に OCSP の URL を返します。OCSP の URL を使用する前に、L"ocsp:" プレフィックスを削除する必要があります。 pvPara パラメーターの場合: OCSP および CRL 配布ポイントの URL を要求する CERT_CONTEXT 構造体へのポインター。
URL_OID_CERTIFICATE_ONLY_OCSP	証明書の機関情報アクセス (AIA) 拡張またはプロパティから OCSP の URL の一覧を提供します。OCSP の URL を使用する前に、L"ocsp:" プレフィックスを削除する必要があります。 pvPara パラメーターの場合: OCSP の URL を要求する CERT_CONTEXT 構造体へのポインター。
URL_OID_CTL_ISSUER	PKCS #7 CTL の各署名者情報にエンコードされた機関情報アクセス属性メソッドから取得した CTL 発行者の URL を提供します。 pvPara パラメーターの場合: 署名者インデックスによって識別される URL を要求する発行者によって発行された、署名者インデックス付きの CTL_CONTEXT 構造体へのポインター。
URL_OID_CTL_NEXT_UPDATE	機関情報アクセスの CTL 拡張、プロパティ、または署名者情報属性メソッドから取得した、その CTL の次回更新の URL を提供します。 pvPara パラメーターの場合: 次回更新の URL を要求する署名者インデックス付きの CTL_CONTEXT 構造体へのポインター。署名者情報属性の確認が必要な場合に備えて、署名者インデックスを任意で指定できます。
URL_OID_CRL_ISSUER	サブジェクト証明書から継承された CRL 上のプロパティ (サブジェクト証明書の発行者またはサブジェクト証明書の配布ポイント拡張のいずれか) から取得した CRL 発行者の URL を提供します。これは機関情報アクセス拡張メソッドとしてエンコードされます。 pvPara パラメーターの場合: URL を要求する発行者によって発行された CRL_CONTEXT 構造体へのポインター。
URL_OID_CERTIFICATE_FRESHEST_CRL	証明書の最新の CRL 拡張またはプロパティを取得します。 pvPara パラメーターの場合: 最新の CRL 配布ポイントを要求する証明書の PCCERT_CONTEXT。
URL_OID_CRL_FRESHEST_CRL	CRL の最新の CRL 拡張またはプロパティを取得します。 pvPara パラメーターの場合: 最新の CRL 配布ポイントを要求する証明書のベース CRL を含む CERT_CRL_CONTEXT_PAIR 構造体へのポインター。
URL_OID_CROSS_CERT_DIST_POINT	証明書のクロス証明書配布ポイント拡張またはプロパティを取得します。 pvPara パラメーターの場合: クロス証明書配布ポイントを要求する証明書の PCCERT_CONTEXT。
URL_OID_CROSS_CERT_SUBJECT_INFO_ACCESS	証明書のクロス証明書サブジェクト情報アクセス拡張またはプロパティを取得します。 pvPara パラメーターの場合: クロス証明書サブジェクト情報アクセスを要求する証明書の PCCERT_CONTEXT。

pvPara

void*

pszUrlOid の値によって決まる構造体。詳細については、pszUrlOid パラメーターの説明を参照してください。

dwFlags

CRYPT_GET_URL_FLAGS

オブジェクトの URL ロケーターを取得するために使用するフラグのセット。0、または次の値の 1 つ以上の組み合わせを指定できます。

値	意味
CRYPT_GET_URL_FROM_PROPERTY	オブジェクトのプロパティ (データの場所) から URL を特定します。
CRYPT_GET_URL_FROM_EXTENSION	オブジェクトの拡張から URL を特定します。
CRYPT_GET_URL_FROM_UNAUTH_ATTRIBUTE	署名者情報データの未認証属性から URL を特定します。
CRYPT_GET_URL_FROM_AUTH_ATTRIBUTE	署名者情報データの認証済み属性から URL を特定します。

pUrlArray

CRYPT_URL_ARRAY*

outoptional

値エントリのデータを受け取るバッファーへのポインター。データを保持するために必要なバッファーの長さを取得するには、このパラメーターを NULL にできます。

詳細については、長さが不明なデータの取得を参照してください。

pcbUrlArray

DWORD*

inout

pUrlArray パラメーターが指すバッファーのサイズ (バイト単位) を指定する DWORD へのポインター。関数が戻ると、この DWORD にはバッファーに格納されたバイト数が入ります。このパラメーターは、pUrlArray が NULL の場合に限り NULL にできます。

pUrlInfo

CRYPT_URL_INFO*

outoptional

値エントリのデータを受け取る CRYPT_URL_INFO 構造体への任意のポインター。

pcbUrlInfo

DWORD*

inoutoptional

pUrlArray パラメーターが指すバッファーのサイズ (バイト単位) を指定する DWORD へのポインター。関数が戻ると、この DWORD にはバッファーに格納されたバイト数が入ります。

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

pvReserved

void*

optional

将来の使用のために予約されており、NULL である必要があります。

戻り値の型: BOOL

公式ドキュメント

証明書、証明書信頼リスト (CTL)、または証明書失効リスト (CRL) からリモートオブジェクトの URL を取得します。

戻り値

関数が成功した場合は、0 以外の値 (TRUE) を返します。

関数が失敗した場合は、0 (FALSE) を返します。拡張エラー情報を取得するには、 GetLastError を呼び出します。

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

各言語での呼び出し定義

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

BOOL CryptGetObjectUrl(
    LPCSTR pszUrlOid,
    void* pvPara,
    CRYPT_GET_URL_FLAGS dwFlags,
    CRYPT_URL_ARRAY* pUrlArray,   // optional
    DWORD* pcbUrlArray,
    CRYPT_URL_INFO* pUrlInfo,   // optional
    DWORD* pcbUrlInfo,   // optional
    void* pvReserved   // optional
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("CRYPTNET.dll", SetLastError = true, ExactSpelling = true)]
static extern bool CryptGetObjectUrl(
    [MarshalAs(UnmanagedType.LPStr)] string pszUrlOid,   // LPCSTR
    IntPtr pvPara,   // void*
    uint dwFlags,   // CRYPT_GET_URL_FLAGS
    IntPtr pUrlArray,   // CRYPT_URL_ARRAY* optional, out
    ref uint pcbUrlArray,   // DWORD* in/out
    IntPtr pUrlInfo,   // CRYPT_URL_INFO* optional, out
    IntPtr pcbUrlInfo,   // DWORD* optional, in/out
    IntPtr pvReserved   // void* optional
);

<DllImport("CRYPTNET.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function CryptGetObjectUrl(
    <MarshalAs(UnmanagedType.LPStr)> pszUrlOid As String,   ' LPCSTR
    pvPara As IntPtr,   ' void*
    dwFlags As UInteger,   ' CRYPT_GET_URL_FLAGS
    pUrlArray As IntPtr,   ' CRYPT_URL_ARRAY* optional, out
    ByRef pcbUrlArray As UInteger,   ' DWORD* in/out
    pUrlInfo As IntPtr,   ' CRYPT_URL_INFO* optional, out
    pcbUrlInfo As IntPtr,   ' DWORD* optional, in/out
    pvReserved As IntPtr   ' void* optional
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function

' pszUrlOid : LPCSTR
' pvPara : void*
' dwFlags : CRYPT_GET_URL_FLAGS
' pUrlArray : CRYPT_URL_ARRAY* optional, out
' pcbUrlArray : DWORD* in/out
' pUrlInfo : CRYPT_URL_INFO* optional, out
' pcbUrlInfo : DWORD* optional, in/out
' pvReserved : void* optional
Declare PtrSafe Function CryptGetObjectUrl Lib "cryptnet" ( _
    ByVal pszUrlOid As String, _
    ByVal pvPara As LongPtr, _
    ByVal dwFlags As Long, _
    ByVal pUrlArray As LongPtr, _
    ByRef pcbUrlArray As Long, _
    ByVal pUrlInfo As LongPtr, _
    ByVal pcbUrlInfo As LongPtr, _
    ByVal pvReserved As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

CryptGetObjectUrl = ctypes.windll.cryptnet.CryptGetObjectUrl
CryptGetObjectUrl.restype = wintypes.BOOL
CryptGetObjectUrl.argtypes = [
    wintypes.LPCSTR,  # pszUrlOid : LPCSTR
    ctypes.POINTER(None),  # pvPara : void*
    wintypes.DWORD,  # dwFlags : CRYPT_GET_URL_FLAGS
    ctypes.c_void_p,  # pUrlArray : CRYPT_URL_ARRAY* optional, out
    ctypes.POINTER(wintypes.DWORD),  # pcbUrlArray : DWORD* in/out
    ctypes.c_void_p,  # pUrlInfo : CRYPT_URL_INFO* optional, out
    ctypes.POINTER(wintypes.DWORD),  # pcbUrlInfo : DWORD* optional, in/out
    ctypes.POINTER(None),  # pvReserved : void* optional
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('CRYPTNET.dll')
CryptGetObjectUrl = Fiddle::Function.new(
  lib['CryptGetObjectUrl'],
  [
    Fiddle::TYPE_VOIDP,  # pszUrlOid : LPCSTR
    Fiddle::TYPE_VOIDP,  # pvPara : void*
    -Fiddle::TYPE_INT,  # dwFlags : CRYPT_GET_URL_FLAGS
    Fiddle::TYPE_VOIDP,  # pUrlArray : CRYPT_URL_ARRAY* optional, out
    Fiddle::TYPE_VOIDP,  # pcbUrlArray : DWORD* in/out
    Fiddle::TYPE_VOIDP,  # pUrlInfo : CRYPT_URL_INFO* optional, out
    Fiddle::TYPE_VOIDP,  # pcbUrlInfo : DWORD* optional, in/out
    Fiddle::TYPE_VOIDP,  # pvReserved : void* optional
  ],
  Fiddle::TYPE_INT)

#[link(name = "cryptnet")]
extern "system" {
    fn CryptGetObjectUrl(
        pszUrlOid: *const u8,  // LPCSTR
        pvPara: *mut (),  // void*
        dwFlags: u32,  // CRYPT_GET_URL_FLAGS
        pUrlArray: *mut CRYPT_URL_ARRAY,  // CRYPT_URL_ARRAY* optional, out
        pcbUrlArray: *mut u32,  // DWORD* in/out
        pUrlInfo: *mut CRYPT_URL_INFO,  // CRYPT_URL_INFO* optional, out
        pcbUrlInfo: *mut u32,  // DWORD* optional, in/out
        pvReserved: *mut ()  // void* optional
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("CRYPTNET.dll", SetLastError = true)]
public static extern bool CryptGetObjectUrl([MarshalAs(UnmanagedType.LPStr)] string pszUrlOid, IntPtr pvPara, uint dwFlags, IntPtr pUrlArray, ref uint pcbUrlArray, IntPtr pUrlInfo, IntPtr pcbUrlInfo, IntPtr pvReserved);
"@
$api = Add-Type -MemberDefinition $sig -Name 'CRYPTNET_CryptGetObjectUrl' -Namespace Win32 -PassThru
# $api::CryptGetObjectUrl(pszUrlOid, pvPara, dwFlags, pUrlArray, pcbUrlArray, pUrlInfo, pcbUrlInfo, pvReserved)

#uselib "CRYPTNET.dll"
#func global CryptGetObjectUrl "CryptGetObjectUrl" sptr, sptr, sptr, sptr, sptr, sptr, sptr, sptr
; CryptGetObjectUrl pszUrlOid, pvPara, dwFlags, varptr(pUrlArray), varptr(pcbUrlArray), varptr(pUrlInfo), varptr(pcbUrlInfo), pvReserved   ; 戻り値は stat
; pszUrlOid : LPCSTR -> "sptr"
; pvPara : void* -> "sptr"
; dwFlags : CRYPT_GET_URL_FLAGS -> "sptr"
; pUrlArray : CRYPT_URL_ARRAY* optional, out -> "sptr"
; pcbUrlArray : DWORD* in/out -> "sptr"
; pUrlInfo : CRYPT_URL_INFO* optional, out -> "sptr"
; pcbUrlInfo : DWORD* optional, in/out -> "sptr"
; pvReserved : void* optional -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "CRYPTNET.dll"
#cfunc global CryptGetObjectUrl "CryptGetObjectUrl" str, sptr, int, var, var, var, var, sptr
; res = CryptGetObjectUrl(pszUrlOid, pvPara, dwFlags, pUrlArray, pcbUrlArray, pUrlInfo, pcbUrlInfo, pvReserved)
; pszUrlOid : LPCSTR -> "str"
; pvPara : void* -> "sptr"
; dwFlags : CRYPT_GET_URL_FLAGS -> "int"
; pUrlArray : CRYPT_URL_ARRAY* optional, out -> "var"
; pcbUrlArray : DWORD* in/out -> "var"
; pUrlInfo : CRYPT_URL_INFO* optional, out -> "var"
; pcbUrlInfo : DWORD* optional, in/out -> "var"
; pvReserved : void* optional -> "sptr"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "CRYPTNET.dll"
#cfunc global CryptGetObjectUrl "CryptGetObjectUrl" str, sptr, int, sptr, sptr, sptr, sptr, sptr
; res = CryptGetObjectUrl(pszUrlOid, pvPara, dwFlags, varptr(pUrlArray), varptr(pcbUrlArray), varptr(pUrlInfo), varptr(pcbUrlInfo), pvReserved)
; pszUrlOid : LPCSTR -> "str"
; pvPara : void* -> "sptr"
; dwFlags : CRYPT_GET_URL_FLAGS -> "int"
; pUrlArray : CRYPT_URL_ARRAY* optional, out -> "sptr"
; pcbUrlArray : DWORD* in/out -> "sptr"
; pUrlInfo : CRYPT_URL_INFO* optional, out -> "sptr"
; pcbUrlInfo : DWORD* optional, in/out -> "sptr"
; pvReserved : void* optional -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。