ホーム › Security.Cryptography › CertIsRDNAttrsInCertificateName

CertIsRDNAttrsInCertificateName

関数

指定したRDN属性が証明書名に含まれるか判定する。

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

シグネチャ

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

BOOL CertIsRDNAttrsInCertificateName(
    CERT_QUERY_ENCODING_TYPE dwCertEncodingType,
    DWORD dwFlags,
    CRYPT_INTEGER_BLOB* pCertName,
    CERT_RDN* pRDN
);

パラメーター

名前	型	方向	説明
dwCertEncodingType	CERT_QUERY_ENCODING_TYPE	in	使用するエンコード種類を指定します。次の例のように、証明書とメッセージのエンコード種類の両方をビットごとの OR 演算で組み合わせて指定することも常に可能です。 X509_ASN_ENCODING \| PKCS_7_ASN_ENCODING 現在定義されているエンコード種類は次のとおりです。 X509_ASN_ENCODING PKCS_7_ASN_ENCODING
dwFlags	DWORD	in	pRDN が、lpszStructType を X509_UNICODE_NAME に設定した CryptEncodeObject のように Unicode 文字列で初期化されている場合は、CERT_UNICODE_IS_RDN_ATTRS_FLAG を設定する必要があります。大文字と小文字を区別しない一致を行うには CERT_CASE_INSENSITIVE_IS_RDN_ATTRS_FLAG を設定します。設定しない場合は、大文字と小文字を区別した完全一致が行われます。
pCertName	CRYPT_INTEGER_BLOB*	in	エンコードされたサブジェクト名または発行者名を格納する CRYPT_INTEGER_BLOB へのポインターです。
pRDN	CERT_RDN*	in	名前の中で検索する属性を格納する CERT_RDN 構造体の配列です。CERT_RDN 構造体の CERT_RDN_ATTR メンバーは、次の規則に従って動作します。 pszObjId が NULL の場合、属性のオブジェクト識別子 (OID) は無視されます。 dwValueType が CERT_RDN_ANY_TYPE の場合、値の種類は無視されます。 Value の pbData メンバーが NULL の場合、任意の値が一致と見なされます。

戻り値の型: BOOL

公式ドキュメント

CertIsRDNAttrsInCertificateName 関数は、証明書名の属性を指定された CERT_RDN と比較し、すべての属性がそこに含まれているかどうかを判定します。

戻り値

関数が成功し、指定された CERT_RDN 内のすべての RDN 値が証明書名に含まれている場合、戻り値は 0 以外 (TRUE) になります。

関数が失敗した場合、または指定された CERT_RDN 内に証明書名に含まれない RDN 値がある場合、戻り値は 0 (FALSE) になります。拡張エラー情報を取得するには、 GetLastError を呼び出します。

次の表に、発生し得るエラーコードの一部を示します。

戻り値コード	説明
CRYPT_E_NO_MATCH	すべての属性が検出されて一致したわけではありませんでした。
ERROR_FILE_NOT_FOUND	証明書のエンコード種類が無効です。現在サポートされているのは X509_ASN_ENCODING のみです。

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

解説(Remarks)

現在サポートされているのは、大文字と小文字を区別する完全一致のみです。

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

各言語での呼び出し定義

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

BOOL CertIsRDNAttrsInCertificateName(
    CERT_QUERY_ENCODING_TYPE dwCertEncodingType,
    DWORD dwFlags,
    CRYPT_INTEGER_BLOB* pCertName,
    CERT_RDN* pRDN
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("CRYPT32.dll", SetLastError = true, ExactSpelling = true)]
static extern bool CertIsRDNAttrsInCertificateName(
    uint dwCertEncodingType,   // CERT_QUERY_ENCODING_TYPE
    uint dwFlags,   // DWORD
    IntPtr pCertName,   // CRYPT_INTEGER_BLOB*
    IntPtr pRDN   // CERT_RDN*
);

<DllImport("CRYPT32.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function CertIsRDNAttrsInCertificateName(
    dwCertEncodingType As UInteger,   ' CERT_QUERY_ENCODING_TYPE
    dwFlags As UInteger,   ' DWORD
    pCertName As IntPtr,   ' CRYPT_INTEGER_BLOB*
    pRDN As IntPtr   ' CERT_RDN*
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function

' dwCertEncodingType : CERT_QUERY_ENCODING_TYPE
' dwFlags : DWORD
' pCertName : CRYPT_INTEGER_BLOB*
' pRDN : CERT_RDN*
Declare PtrSafe Function CertIsRDNAttrsInCertificateName Lib "crypt32" ( _
    ByVal dwCertEncodingType As Long, _
    ByVal dwFlags As Long, _
    ByVal pCertName As LongPtr, _
    ByVal pRDN As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

CertIsRDNAttrsInCertificateName = ctypes.windll.crypt32.CertIsRDNAttrsInCertificateName
CertIsRDNAttrsInCertificateName.restype = wintypes.BOOL
CertIsRDNAttrsInCertificateName.argtypes = [
    wintypes.DWORD,  # dwCertEncodingType : CERT_QUERY_ENCODING_TYPE
    wintypes.DWORD,  # dwFlags : DWORD
    ctypes.c_void_p,  # pCertName : CRYPT_INTEGER_BLOB*
    ctypes.c_void_p,  # pRDN : CERT_RDN*
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('CRYPT32.dll')
CertIsRDNAttrsInCertificateName = Fiddle::Function.new(
  lib['CertIsRDNAttrsInCertificateName'],
  [
    -Fiddle::TYPE_INT,  # dwCertEncodingType : CERT_QUERY_ENCODING_TYPE
    -Fiddle::TYPE_INT,  # dwFlags : DWORD
    Fiddle::TYPE_VOIDP,  # pCertName : CRYPT_INTEGER_BLOB*
    Fiddle::TYPE_VOIDP,  # pRDN : CERT_RDN*
  ],
  Fiddle::TYPE_INT)

#[link(name = "crypt32")]
extern "system" {
    fn CertIsRDNAttrsInCertificateName(
        dwCertEncodingType: u32,  // CERT_QUERY_ENCODING_TYPE
        dwFlags: u32,  // DWORD
        pCertName: *mut CRYPT_INTEGER_BLOB,  // CRYPT_INTEGER_BLOB*
        pRDN: *mut CERT_RDN  // CERT_RDN*
    ) -> 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 CertIsRDNAttrsInCertificateName(uint dwCertEncodingType, uint dwFlags, IntPtr pCertName, IntPtr pRDN);
"@
$api = Add-Type -MemberDefinition $sig -Name 'CRYPT32_CertIsRDNAttrsInCertificateName' -Namespace Win32 -PassThru
# $api::CertIsRDNAttrsInCertificateName(dwCertEncodingType, dwFlags, pCertName, pRDN)

#uselib "CRYPT32.dll"
#func global CertIsRDNAttrsInCertificateName "CertIsRDNAttrsInCertificateName" sptr, sptr, sptr, sptr
; CertIsRDNAttrsInCertificateName dwCertEncodingType, dwFlags, varptr(pCertName), varptr(pRDN)   ; 戻り値は stat
; dwCertEncodingType : CERT_QUERY_ENCODING_TYPE -> "sptr"
; dwFlags : DWORD -> "sptr"
; pCertName : CRYPT_INTEGER_BLOB* -> "sptr"
; pRDN : CERT_RDN* -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

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