CryptRetrieveObjectByUrlW 関数 (wincrypt.h)

CryptRetrieveObjectByUrl 関数は、URL で指定された場所から公開キー 基盤 (PKI) オブジェクトを取得します。

これらのリモート オブジェクトはエンコードされた形式であり、"コンテキスト" 形式で取得されます。

構文

BOOL CryptRetrieveObjectByUrlW(
  [in]           LPCWSTR                  pszUrl,
  [in]           LPCSTR                   pszObjectOid,
  [in]           DWORD                    dwRetrievalFlags,
  [in]           DWORD                    dwTimeout,
  [out]          LPVOID                   *ppvObject,
  [in]           HCRYPTASYNC              hAsyncRetrieve,
  [in, optional] PCRYPT_CREDENTIALS       pCredentials,
  [in, optional] LPVOID                   pvVerify,
  [in]           PCRYPT_RETRIEVE_AUX_INFO pAuxInfo
);

パラメーター

[in] pszUrl

取得する PKI オブジェクトのアドレス。 次のスキームがサポートされています。

• ldap (ライトウェイト ディレクトリ アクセス プロトコル)
• http
• https (証明書失効リスト (CRL) または オンライン証明書状態プロトコル (OCSP) の取得のみ)
• file

[in] pszObjectOid

取得するオブジェクトの種類を識別する null で終わる ANSI 文字列のアドレス。 次のいずれかの値を指定できます。

[in] dwRetrievalFlags

キャッシュされた URL を使用するか、ワイヤ URL から取得した URL を使用するかを決定します。 オブジェクトが返されるフォームは、 pszObjectOid の値によって決まります。

[in] dwTimeout

取得を待機する最大ミリ秒数を指定します。 0 の値を指定した場合、この関数はタイムアウトしません。URL スキームが file:/// されている場合、このパラメーターは使用されません。

[out] ppvObject

返されるオブジェクトへのポインターのアドレス。 戻り値の型には、 pszObjectOid でサポートされている型のいずれかを指定できます。

[in] hAsyncRetrieve

このパラメーターは予約済みであり、 NULL に設定する必要があります。

[in, optional] pCredentials

このパラメーターは使用されません。

[in, optional] pvVerify

検証オブジェクトへのポインター。 このオブジェクトは dwRetrievalFlags パラメーターの 関数です。 dwRetrievalFlags がCRYPT_VERIFY_CONTEXT_SIGNATUREされている場合、呼び出し元が署名者の証明書コンテキストまたはインデックスの取得に関心を持たないことを示すには、NULL を指定できます。

[in] pAuxInfo

CRYPT_RETRIEVE_AUX_INFO構造体への省略可能なポインター。 NULL でない場合、および構造体の cbSize メンバーが設定されている場合、このパラメーターは最後に正常にワイヤ取得が成功した時刻を返します。

戻り値

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

関数が失敗した場合、戻り値は 0 (FALSE) になります。

注釈

リモート オブジェクト取得マネージャーは、2 つのプロバイダー モデルを公開します。 1 つは、URL スキームによって定義されたインストール可能なプロトコル プロバイダー (ldap、http、ftp、またはファイル) を可能にするスキーム プロバイダー モデルです。 スキーム プロバイダーのエントリ ポイントは、 CryptRetrieveObjectByUrl 関数と同じです。ただし、返される *ppvObject は常に、エンコードされたビット (取得されたオブジェクトごとに 1 つ) のカウントされた配列です。

2 番目のプロバイダー モデルはコンテキスト プロバイダー モデルであり、取得したエンコードされたビットに基づいてコンテキスト ハンドル (オブジェクト) のインストール可能な作成者を許可します。 これらは、CryptRetrieveObjectByUrl の呼び出しで指定されたオブジェクト識別子 (OID) に基づいてディスパッチされます。

証明書、信頼リスト、失効リスト、PKCS #7 メッセージ、複数の同種オブジェクトなどの個々の PKI オブジェクトを取得できます。 Windows Vista Service Pack 1 (SP1) および Windows Server 2008 以降では、"http:" と "ldap:" の取得のセキュリティが強化されています。

この関数は、"http:" および "ldap:" URL スキームと、新しく定義されたスキームをサポートします。

Windows XP: "ftp:" はネットワーク取得ではサポートされていません。

要件

こちらもご覧ください

CryptGetObjectUrl