How to check the revocation status of a x509 certificate in c++ with wincrypt.h?

Question

I'm trying to check the revocation state of a X509 certificate in a c++ program with the use of wincrypt.h. Sadly I'm not able to find a comprehensive example. In c# the code would be the following:

X509Certificate2 certificate = new X509Certificate2();
//Create X509Certificate2 object from .cer file.
byte[] rawData = ReadFile(@"C:\Users\z002m76a\Desktop\cert.pem");
certificate.Import(rawData);

X509Chain ch = new X509Chain();
ch.ChainPolicy.RevocationMode = X509RevocationMode.Online;
ch.Build(certificate);

Console.WriteLine("Chain revocation flag: {0}", ch.ChainPolicy.RevocationFlag);

Answer 1

Based on the excellent comment by @crypt32 I created the following c++ program. Probably it is not the most beautiful c++ code in the world (mine c++ is pretty rusty) but it seems so work

// ValidationCheckCPP.cpp : This file contains the 'main' function. Program execution begins and ends there.
//

#include <iostream>

#include <windows.h>
#include <wincrypt.h>
#include "ValidationCheckCPP.h"

int main()
{
    char keyFile[] = "C:\\Users\\z002m76a\\Desktop\\2698514447.crt";

    SECURITY_ATTRIBUTES sa;
    sa.nLength = sizeof(sa);
    sa.lpSecurityDescriptor = NULL;
    sa.bInheritHandle = FALSE;

    HANDLE hKeyFile;
    hKeyFile = CreateFile(keyFile, GENERIC_READ, FILE_SHARE_READ, &sa, OPEN_EXISTING, FILE_ATTRIBUTE_NORMAL, NULL);

    if (hKeyFile) {

        BYTE lp[65536];
        DWORD flags;
        DWORD bytes;

        if (ReadFile(hKeyFile, lp, GetFileSize(hKeyFile, NULL), &bytes, NULL) && bytes > 0) {

            BYTE* p;
            p = lp + bytes;
            if (CryptStringToBinary((char*)lp, p - lp, CRYPT_STRING_BASE64_ANY, p, &bytes, NULL, &flags) && bytes > 0) {

                PCCERT_CONTEXT  pCertContext;
                pCertContext = CertCreateCertificateContext(X509_ASN_ENCODING, p, bytes);

                if (pCertContext)
                {
                    printf("Certificate loaded");

                    CERT_ENHKEY_USAGE EnhkeyUsage;
                    EnhkeyUsage.cUsageIdentifier = 0;
                    EnhkeyUsage.rgpszUsageIdentifier = NULL;

                    CERT_USAGE_MATCH CertUsage;
                    CertUsage.dwType = USAGE_MATCH_TYPE_AND;
                    CertUsage.Usage = EnhkeyUsage;

                    CERT_CHAIN_PARA ChainPara;
                    ChainPara.cbSize = sizeof(CERT_CHAIN_PARA);
                    ChainPara.RequestedUsage = CertUsage;

                    PCCERT_CHAIN_CONTEXT pChainContext;

                    if (CertGetCertificateChain(
                        NULL,                  // use the default chain engine
                        pCertContext,          // pointer to the end certificate
                        NULL,                  // use the default time
                        NULL,                  // search no additional stores
                        &ChainPara,
                        CERT_CHAIN_REVOCATION_CHECK_CHAIN_EXCLUDE_ROOT,
                        NULL,                  // currently reserved
                        &pChainContext))       // return a pointer to the chain created
                    {
                        printf("Chain built with %d certificates.\n", pChainContext->rgpChain[0]->cElement);

                        CERT_CHAIN_POLICY_PARA ChainPolicy = { 0 };
                        ChainPolicy.cbSize = sizeof(ChainPolicy);

                        CERT_CHAIN_POLICY_STATUS PolicyStatus = { 0 };
                        PolicyStatus.cbSize = sizeof(PolicyStatus);

                        CertVerifyCertificateChainPolicy(
                            CERT_CHAIN_POLICY_BASE,
                            pChainContext,          // pointer to the chain    
                            &ChainPolicy,
                            &PolicyStatus);

                        CERT_REVOCATION_STATUS revocationStatus;
                        revocationStatus.cbSize = sizeof(CERT_REVOCATION_STATUS);

                        PCERT_CONTEXT* pCerts = new PCERT_CONTEXT[pChainContext->cChain];

                        for (DWORD i = 0; i < pChainContext->cChain; i++) {
                            pCerts[i] = (PCERT_CONTEXT)(pChainContext->rgpChain[i]->rgpElement[0]->pCertContext);
                        }

                        // CERT_VERIFY_REV_CHAIN_FLAG
                        // Verification of the chain of certificates is done assuming each certificate except the first certificate is the issuer of the certificate that precedes it.If dwRevType is not CERT_CONTEXT_REVOCATION_TYPE, no assumptions are made about the order of the contexts.
                        // CERT_VERIFY_CACHE_ONLY_BASED_REVOCATION
                        // Prevents the revocation handler from accessing any network - based resources for revocation checking.
                        // CERT_VERIFY_REV_ACCUMULATIVE_TIMEOUT_FLAG
                        // When set, dwUrlRetrievalTimeout is the cumulative time - out across all URL wire retrievals.
                        // CERT_VERIFY_REV_SERVER_OCSP_FLAG
                        // When set, this function only uses online certificate status protocol(OCSP) for revocation checking.If the certificate does not have any OCSP AIA URLs, the dwError member of the pRevStatus parameter is set to CRYPT_E_NOT_IN_REVOCATION_DATABASE.
                        DWORD revocationCheckType = CERT_VERIFY_REV_CHAIN_FLAG;

                        BOOL bRc = CertVerifyRevocation(
                            X509_ASN_ENCODING,
                            CERT_CONTEXT_REVOCATION_TYPE,
                            pChainContext->cChain,
                            (void**)pCerts,
                            revocationCheckType,
                            NULL,
                            &revocationStatus);

                        printf("The size of the chain context is %d. \n", pChainContext->cbSize);
                        printf("%d simple chains found.\n", pChainContext->cChain);
                        printf("\nError status for the chain:\n");

                        switch (pChainContext->TrustStatus.dwErrorStatus)
                        {
                        case CERT_TRUST_NO_ERROR:
                            printf("No error found for this certificate or chain.\n");
                            break;
                        case CERT_TRUST_IS_NOT_TIME_VALID:
                            printf("This certificate or one of the certificates in the certificate chain is not time-valid.\n");
                            break;
                        case CERT_TRUST_IS_REVOKED:
                            printf("Trust for this certificate or one of the certificates in the certificate chain has been revoked.\n");
                            break;
                        case CERT_TRUST_IS_NOT_SIGNATURE_VALID:
                            printf("The certificate or one of the certificates in the certificate chain does not have a valid signature.\n");
                            break;
                        case CERT_TRUST_IS_NOT_VALID_FOR_USAGE:
                            printf("The certificate or certificate chain is not valid in its proposed usage.\n");
                            break;
                        case CERT_TRUST_IS_UNTRUSTED_ROOT:
                            printf("The certificate or certificate chain is based on an untrusted root.\n");
                            break;
                        case CERT_TRUST_REVOCATION_STATUS_UNKNOWN:
                            printf("The revocation status of the certificate or one of the certificates in the certificate chain is unknown.\n");
                            break;
                        case CERT_TRUST_IS_CYCLIC:
                            printf("One of the certificates in the chain was issued by a certification authority that the original certificate had certified.\n");
                            break;
                        case CERT_TRUST_IS_PARTIAL_CHAIN:
                            printf("The certificate chain is not complete.\n");
                            break;
                        case CERT_TRUST_CTL_IS_NOT_TIME_VALID:
                            printf("A CTL used to create this chain was not time-valid.\n");
                            break;
                        case CERT_TRUST_CTL_IS_NOT_SIGNATURE_VALID:
                            printf("A CTL used to create this chain did not have a valid signature.\n");
                            break;
                        case CERT_TRUST_CTL_IS_NOT_VALID_FOR_USAGE:
                            printf("A CTL used to create this chain is not valid for this usage.\n");
                        }

                        printf("Info status for the chain:\n");
                        switch (pChainContext->TrustStatus.dwInfoStatus)
                        {
                        case 0:
                            printf("No information status reported.\n");
                            break;
                        case CERT_TRUST_HAS_EXACT_MATCH_ISSUER:
                            printf("An exact match issuer certificate has been found for this certificate.\n");
                            break;
                        case CERT_TRUST_HAS_KEY_MATCH_ISSUER:
                            printf("A key match issuer certificate has been found for this certificate.\n");
                            break;
                        case CERT_TRUST_HAS_NAME_MATCH_ISSUER:
                            printf("A name match issuer certificate has been found for this certificate.\n");
                            break;
                        case CERT_TRUST_IS_SELF_SIGNED:
                            printf("This certificate is self-signed.\n");
                            break;
                        case CERT_TRUST_IS_COMPLEX_CHAIN:
                            printf("The certificate chain created is a complex chain.\n");
                            break;
                        } // end switch
                    }

                    CertFreeCertificateContext(pCertContext);
                }
                else {
                    printf("Could not convert certificate to internal form\n");
                }
            }
            else {
                printf("Failed to convert from PEM\n");
            }
        }
        else {
            printf("Failed to read key file: %s\n", keyFile);
        }
    }
    else {
        printf("Failed to open key file: %s\n", keyFile);
    }

    CloseHandle(hKeyFile);

    return 0;
}

Answer 2

In C++, you use CertGetCertificateChain function. Along with call result, the function returns a a pointer to CERT_CHAIN_CONTEXT (via ppChainContext member). This CERT_CHAIN_CONTEXT structure stores a pointer to a CERT_SIMPLE_CHAIN structure (rgpChain member) which represents an array of chain elements (this is what X509Chain.ChainElements represents in .NET). Essentially, you need to check the very first element in rgpChain, which is a pointer to a CERT_SIMPLE_CHAIN structure. And examine TrustStatus member for revocation status flags (two flags).

Answer 3

The example provided by @Rufus Buschart is quite lovely. If checking OCSP in his example, simply change revocationCheckType to CERT_VERIFY_REV_SERVER_OCSP_FLAG. Here I'd like to provide an example using another api CertOpenServerOcspResponse()

// after construct the PCCERT_CHAIN_CONTEXT ppChainContext, which can be the same as @Rufus

// If async operation is required, change second parameter 0 to 1 (available since Win8.1, but not announced on official documentations)
HCERT_SERVER_OCSP_RESPONSE hServerOcspResponse = CertOpenServerOcspResponse(ppChainContext, 0, nullptr);
PCCERT_SERVER_OCSP_RESPONSE_CONTEXT recvdResponseCtx = CertGetServerOcspResponseContext(hServerOcspResponse, 0, nullptr);
if (recvdResponseCtx == nullptr)
{
    printf("Receive OCSP server response failed\n");
    showStrError("CertGetServerOcspResponseContext"); // show the description about GetLastError()
    return 1;
}

POCSP_RESPONSE_INFO pocspResponseInfo = nullptr;
DWORD ocspResponseSize = 0; // X509_SEQUENCE_OF_ANY
ret = CryptDecodeObjectEx(PKCS_7_ASN_ENCODING, OCSP_RESPONSE, recvdResponseCtx->pbEncodedOcspResponse, recvdResponseCtx->cbEncodedOcspResponse, CRYPT_DECODE_ALLOC_FLAG, nullptr, &pocspResponseInfo, &ocspResponseSize);
if (!ret)
{
    printf("Error decode ocsp response info from CERT_SERVER_OCSP_RESPONSE_CONTEXT.\n");
    showStrError("DecodeOcspServerResponse");
    return 1;
}
if (pocspResponseInfo->dwStatus != OCSP_SUCCESSFUL_RESPONSE)
{
    printf("Unsuccessfully ocsp response. The status value is %d, which means %s\n", pocspResponseInfo->dwStatus, "OCSP_MALFORMED_REQUEST_RESPONSE if it is 1");
    return 1;
}
if (strcmp(szOID_PKIX_OCSP_BASIC_SIGNED_RESPONSE, pocspResponseInfo->pszObjId))
{
    printf("Ocsp response info is %s\n, but it should be %s\n", pocspResponseInfo->pszObjId, szOID_PKIX_OCSP_BASIC_SIGNED_RESPONSE);
    return 1;
}

POCSP_BASIC_SIGNED_RESPONSE_INFO pocspBasicSignedResponseInfo = nullptr;
DWORD ocspBasicSignedResponseSize = 0;
ret = CryptDecodeObjectEx(PKCS_7_ASN_ENCODING, OCSP_BASIC_SIGNED_RESPONSE, pocspResponseInfo->Value.pbData, pocspResponseInfo->Value.cbData, CRYPT_DECODE_ALLOC_FLAG, nullptr, &pocspBasicSignedResponseInfo, &ocspBasicSignedResponseSize);
if (!ret)
{
    showStrError("DecodeOCSP_BASIC_SIGNED_RESPONSE");
    return 1;
}

POCSP_BASIC_RESPONSE_INFO pocspBasicResponseInfo = nullptr;
DWORD ocspBasicResponseSize = 0;
ret = CryptDecodeObjectEx(PKCS_7_ASN_ENCODING, OCSP_BASIC_RESPONSE, pocspBasicSignedResponseInfo->ToBeSigned.pbData, pocspBasicSignedResponseInfo->ToBeSigned.cbData, CRYPT_DECODE_ALLOC_FLAG, nullptr, &pocspBasicResponseInfo, &ocspBasicResponseSize);
if (!ret)
{
    showStrError("DecodeOCSP_BASIC_RESPONSE");
    return 1;
}

DWORD certStatus = pocspBasicResponseInfo->rgResponseEntry->dwCertStatus;
printf("cert status is %d", certStatus); // good:0, revoked:1, unknown:2
return 0;

The showStrError() is modified from WinCrypt examples as below:

void showStrError(const char* lpszFunction)
{
    LPVOID lpMsgBuf;
    LPVOID lpDisplayBuf;
    DWORD dw = GetLastError();

    FormatMessage(
        FORMAT_MESSAGE_ALLOCATE_BUFFER |
        FORMAT_MESSAGE_FROM_SYSTEM |
        FORMAT_MESSAGE_IGNORE_INSERTS,
        NULL,
        dw,
        MAKELANGID(LANG_NEUTRAL, SUBLANG_DEFAULT),
        (LPTSTR)&lpMsgBuf,
        0, NULL);

    // Display the error message and exit the process

    lpDisplayBuf = (LPVOID)LocalAlloc(LMEM_ZEROINIT,
        (lstrlen((LPCTSTR)lpMsgBuf) + lstrlen((LPCTSTR)lpszFunction) + 40) * sizeof(TCHAR));
    StringCchPrintf((LPTSTR)lpDisplayBuf,
        LocalSize(lpDisplayBuf) / sizeof(TCHAR),
        TEXT("%s failed with error %d: %s"),
        lpszFunction, dw, lpMsgBuf);
    printf("%s failed with error %d: %ws\n", lpszFunction, dw, (LPCTSTR)lpMsgBuf);

    LocalFree(lpMsgBuf);
    LocalFree(lpDisplayBuf);
}