ホーム › Security.Cryptography › CertOpenServerOcspResponse

CertOpenServerOcspResponse

関数

サーバーベースのOCSP応答ハンドルを開く。

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

シグネチャ

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

void* CertOpenServerOcspResponse(
    CERT_CHAIN_CONTEXT* pChainContext,
    DWORD dwFlags,
    CERT_SERVER_OCSP_RESPONSE_OPEN_PARA* pOpenPara   // optional
);

パラメーター

名前

型

方向

説明

pChainContext

CERT_CHAIN_CONTEXT*

証明書チェーンを格納する CERT_CHAIN_CONTEXT 構造体のアドレスです。

dwFlags

DWORD

値	意味
0 0x00000000	この API は、戻る前に最初の OCSP 応答の取得を試みます。つまり、取得中はブロックされます。
CERT_SERVER_OCSP_RESPONSE_ASYNC_FLAG 0x00000001	最初の同期取得を行わずにただちに戻すには、このフラグを設定します。

pOpenPara

CERT_SERVER_OCSP_RESPONSE_OPEN_PARA*

inoptional

このパラメーターは使用されず、NULL である必要があります。

戻り値の型: void*

公式ドキュメント

サーバー証明書チェーンに関連付けられたオンライン証明書状態プロトコル (OCSP) 応答へのハンドルを開きます。

戻り値

成功した場合、サーバー証明書チェーンに関連付けられた OCSP 応答へのハンドルを返します。それ以外の場合は NULL を返します。このハンドルは、不要になったときに CertCloseServerOcspResponse 関数に渡す必要があります。

拡張エラー情報を取得するには、 GetLastError を呼び出します。 GetLastError 関数が返す可能性のあるエラーコードには、以下が含まれますが、これらに限定されません。

戻りコード	説明
ERROR_INVALID_PARAMETER	1 つ以上のパラメーターが無効です。
CRYPT_E_NOT_IN_REVOCATION_DATABASE	エンド証明書に OCSP の機関情報アクセス (AIA) URL が含まれていません。

解説(Remarks)

dwFlags が 0 に設定されている場合、CertOpenServerOcspResponse 関数は戻る前に最初の OCSP 応答の取得を試みます。取得中はプロセススレッドをブロックします。CertOpenServerOcspResponse 関数は、時間的に有効な OCSP 応答を事前取得するバックグラウンドスレッドを作成します。最初の OCSP 応答の取得に成功しなかった場合でも、前述のエラーケースのいずれかに該当しない限り、NULL 以外のハンドルが返されます。

dwFlags が 1 または CERT_SERVER_OCSP_RESPONSE_ASYNC_FLAG に設定されている場合、CertOpenServerOcspResponse 関数は最初の同期取得を行わずにただちに戻ります。

CertOpenServerOcspResponse 関数は、pChainContext パラメーターで表されるチェーンコンテキストの参照カウントをインクリメントします。チェーンコンテキストの使用を終えたら、CertCloseServerOcspResponse 関数を呼び出して、返されたハンドルを閉じてください。

CertOpenServerOcspResponse 関数は、以下の関数で使用される構成設定を初期化します。

まず、CertOpenServerOcspResponse 関数は Wincrypt.h の既定値に基づいて設定を初期化します。その後、関数が CERT_CHAIN_CONFIG_REGPATH で定義されたレジストリキーを見つけた場合、先に初期化された値をレジストリの値で更新します。

この関数によって初期化される構成設定名と既定値は次のとおりです。

CERT_SRV_OCSP_RESP_MIN_VALIDITY_SECONDS_VALUE_NAME
L"SrvOcspRespMinValiditySeconds"

CertGetServerOcspResponseContext によって返されるサーバー OCSP 応答の最小有効時間です。OCSP 応答の有効期間は、クライアントが時間的に有効と見なすのに十分な長さである必要があります。
CERT_SRV_OCSP_RESP_MIN_VALIDITY_SECONDS_DEFAULT
(10 × 60)

10 分です。
CERT_SRV_OCSP_RESP_URL_RETRIEVAL_TIMEOUT_MILLISECONDS_VALUE_NAME
L"SrvOcspRespUrlRetrievalTimeoutMilliseconds"

OCSP 応答の事前取得のためのワイヤー URL 取得がタイムアウトするまでの最大時間です。
CERT_SRV_OCSP_RESP_URL_RETRIEVAL_TIMEOUT_MILLISECONDS_DEFAULT
(15 × 1000)

15 秒です。
CERT_SRV_OCSP_RESP_MAX_BEFORE_NEXT_UPDATE_SECONDS_VALUE_NAME
L"SrvOcspRespMaxBeforeNextUpdateSeconds"

OCSP 応答の NextUpdate 日時より前に、サーバー OCSP 応答の事前取得を実行する最大秒数です。サーバー OCSP 応答スレッドは、現在の時刻が NextUpdate 日時からこの秒数を引いた時刻以上になるまで待ってから、事前取得を実行します。
CERT_SRV_OCSP_RESP_MAX_BEFORE_NEXT_UPDATE_SECONDS_DEFAULT
(4 ×60 × 60)

4 時間です。
CERT_SRV_OCSP_RESP_MIN_BEFORE_NEXT_UPDATE_SECONDS_VALUE_NAME
L"SrvOcspRespMinBeforeNextUpdateSeconds"

OCSP 応答の NextUpdate 日時より前に、サーバー OCSP 応答の事前取得を実行する最小秒数です。現在の時刻が NextUpdate 日時からこの秒数を引いた時刻以上である場合、サーバー OCSP 応答スレッドは、NextUpdate 日時に CERT_SRV_OCSP_RESP_MIN_AFTER_NEXT_UPDATE_SECONDS_VALUE_NAME の秒数を加えた時刻まで待ってから、事前取得を実行します。
CERT_SRV_OCSP_RESP_MIN_BEFORE_NEXT_UPDATE_SECONDS_DEFAULT
(2 × 60)

2 分です。
CERT_SRV_OCSP_RESP_MIN_AFTER_NEXT_UPDATE_SECONDS_VALUE_NAME
L"SrvOcspRespMinAfterNextUpdateSeconds"

OCSP 応答の NextUpdate 日時より後に、サーバー OCSP 応答の事前取得を実行する最小秒数です。現在の時刻が NextUpdate 日時から CERT_SRV_OCSP_RESP_MIN_BEFORE_NEXT_UPDATE_SECONDS_VALUE_NAME の秒数を引いた時刻より大きく、かつ NextUpdate 日時より小さい場合、サーバー OCSP 応答スレッドは、NextUpdate 日時からこの秒数だけ待ってから事前取得を実行します。
CERT_SRV_OCSP_RESP_MIN_AFTER_NEXT_UPDATE_SECONDS_DEFAULT
(1 × 60)

1 分です。

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

各言語での呼び出し定義

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

void* CertOpenServerOcspResponse(
    CERT_CHAIN_CONTEXT* pChainContext,
    DWORD dwFlags,
    CERT_SERVER_OCSP_RESPONSE_OPEN_PARA* pOpenPara   // optional
);

[DllImport("CRYPT32.dll", SetLastError = true, ExactSpelling = true)]
static extern IntPtr CertOpenServerOcspResponse(
    IntPtr pChainContext,   // CERT_CHAIN_CONTEXT*
    uint dwFlags,   // DWORD
    IntPtr pOpenPara   // CERT_SERVER_OCSP_RESPONSE_OPEN_PARA* optional
);

<DllImport("CRYPT32.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function CertOpenServerOcspResponse(
    pChainContext As IntPtr,   ' CERT_CHAIN_CONTEXT*
    dwFlags As UInteger,   ' DWORD
    pOpenPara As IntPtr   ' CERT_SERVER_OCSP_RESPONSE_OPEN_PARA* optional
) As IntPtr
End Function

' pChainContext : CERT_CHAIN_CONTEXT*
' dwFlags : DWORD
' pOpenPara : CERT_SERVER_OCSP_RESPONSE_OPEN_PARA* optional
Declare PtrSafe Function CertOpenServerOcspResponse Lib "crypt32" ( _
    ByVal pChainContext As LongPtr, _
    ByVal dwFlags As Long, _
    ByVal pOpenPara As LongPtr) As LongPtr
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

CertOpenServerOcspResponse = ctypes.windll.crypt32.CertOpenServerOcspResponse
CertOpenServerOcspResponse.restype = ctypes.c_void_p
CertOpenServerOcspResponse.argtypes = [
    ctypes.c_void_p,  # pChainContext : CERT_CHAIN_CONTEXT*
    wintypes.DWORD,  # dwFlags : DWORD
    ctypes.c_void_p,  # pOpenPara : CERT_SERVER_OCSP_RESPONSE_OPEN_PARA* optional
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('CRYPT32.dll')
CertOpenServerOcspResponse = Fiddle::Function.new(
  lib['CertOpenServerOcspResponse'],
  [
    Fiddle::TYPE_VOIDP,  # pChainContext : CERT_CHAIN_CONTEXT*
    -Fiddle::TYPE_INT,  # dwFlags : DWORD
    Fiddle::TYPE_VOIDP,  # pOpenPara : CERT_SERVER_OCSP_RESPONSE_OPEN_PARA* optional
  ],
  Fiddle::TYPE_VOIDP)

#[link(name = "crypt32")]
extern "system" {
    fn CertOpenServerOcspResponse(
        pChainContext: *mut CERT_CHAIN_CONTEXT,  // CERT_CHAIN_CONTEXT*
        dwFlags: u32,  // DWORD
        pOpenPara: *mut CERT_SERVER_OCSP_RESPONSE_OPEN_PARA  // CERT_SERVER_OCSP_RESPONSE_OPEN_PARA* optional
    ) -> *mut ();
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("CRYPT32.dll", SetLastError = true)]
public static extern IntPtr CertOpenServerOcspResponse(IntPtr pChainContext, uint dwFlags, IntPtr pOpenPara);
"@
$api = Add-Type -MemberDefinition $sig -Name 'CRYPT32_CertOpenServerOcspResponse' -Namespace Win32 -PassThru
# $api::CertOpenServerOcspResponse(pChainContext, dwFlags, pOpenPara)

#uselib "CRYPT32.dll"
#func global CertOpenServerOcspResponse "CertOpenServerOcspResponse" sptr, sptr, sptr
; CertOpenServerOcspResponse varptr(pChainContext), dwFlags, varptr(pOpenPara)   ; 戻り値は stat
; pChainContext : CERT_CHAIN_CONTEXT* -> "sptr"
; dwFlags : DWORD -> "sptr"
; pOpenPara : CERT_SERVER_OCSP_RESPONSE_OPEN_PARA* optional -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "CRYPT32.dll"
#cfunc global CertOpenServerOcspResponse "CertOpenServerOcspResponse" var, int, var
; res = CertOpenServerOcspResponse(pChainContext, dwFlags, pOpenPara)
; pChainContext : CERT_CHAIN_CONTEXT* -> "var"
; dwFlags : DWORD -> "int"
; pOpenPara : CERT_SERVER_OCSP_RESPONSE_OPEN_PARA* optional -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "CRYPT32.dll"
#cfunc global CertOpenServerOcspResponse "CertOpenServerOcspResponse" sptr, int, sptr
; res = CertOpenServerOcspResponse(varptr(pChainContext), dwFlags, varptr(pOpenPara))
; pChainContext : CERT_CHAIN_CONTEXT* -> "sptr"
; dwFlags : DWORD -> "int"
; pOpenPara : CERT_SERVER_OCSP_RESPONSE_OPEN_PARA* optional -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。