(Ruby) Azure Key Vault Find Certificate

See more Azure Key Vault Examples

Let's say you have the certificate locally, but not with the private key. You only have the certificate, such as in a .cer file, but not the .pfx. The purpose of this example is to show how to find the same certificate in Azure Key Vault, and return the Azure Key Vault's name for the certificate.

Note: This example requires Chilkat v9.5.0.96 or later.

Chilkat Ruby Downloads install from rubygems.org gem install chilkat or download... Ruby Library for Windows, MacOS, Linux, Alpine Linux

require 'chilkat'

# This requires the Chilkat API to have been previously unlocked.
# See Global Unlock Sample for sample code.

# We have a .cer file locally, and we want to find this same certificate in Azure Key Vault
# because we'll need Azure Key Vault's name (and version) for the certificate if we are going to ask
# Key Vault to sign using the cert's private key.

cert = Chilkat::CkCert.new()
success = cert.LoadFromFile("qa_data/certs/myCert.cer")
if (success == false)
    print cert.lastErrorText() + "\n";
    exit
end

# Let's the the SHA1 thumbprint for our cert in base64url format.  This is the "x5t" member that we'll 
# be seeking in the list of certificates returned from Azure Key Vault.
bdThumbprint = Chilkat::CkBinData.new()
bdThumbprint.AppendEncoded(cert.sha1Thumbprint(),"hex")
seek_x5t = bdThumbprint.getEncoded("base64url")
print "Seeking the cert with x5t = " + seek_x5t + "\n";

# Provide information needed for Chilkat to automatically get an OAuth2 access token as needed.
json = Chilkat::CkJsonObject.new()
json.UpdateString("client_id","APP_ID")
json.UpdateString("client_secret","APP_PASSWORD")
json.UpdateString("resource","https://vault.azure.net")
json.UpdateString("token_endpoint","https://login.microsoftonline.com/TENANT_ID/oauth2/token")

http = Chilkat::CkHttp.new()

# Instead of providing an actual access token, we give Chilkat the information that allows it to 
# automatically fetch the access token using the OAuth2 client credentials flow.
http.put_AuthToken(json.emit())

# Download JSON containing information about the certs in the Azure Key Vault.
# Replace VAULT_NAME with the name of your Azure Key Vault.
sbResponse = Chilkat::CkStringBuilder.new()
success = http.QuickGetSb("https://VAULT_NAME.vault.azure.net/certificates?api-version=7.4",sbResponse)
if (success == false)

    statusCode = http.get_LastStatus()
    if (statusCode == 0)
        # We did not get a response from the server..
        print http.lastErrorText() + "\n";
    else
        # We received a response, but it was an error.
        print "Error response status code: " + statusCode.to_s() + "\n";
        print "Error response:" + "\n";
        print sbResponse.getAsString() + "\n";
    end

    exit
end

jsonResp = Chilkat::CkJsonObject.new()
jsonResp.LoadSb(sbResponse)
jsonResp.put_EmitCompact(false)

# The JSON will contain an array of certs like this:

# {
#   "value": [
#     {
#       "id": "https://kvchilkat.vault.azure.net/certificates/BadSSL",
#       "x5t": "U04xLnb8Ww7BKkW9dD7P1cCHNDY",
#       "attributes": {
#         "enabled": true,
#         "nbf": 1674409014,
#         "exp": 1737481014,
#         "created": 1697294224,
#         "updated": 1697294224
#       },
#       "subject": ""
#     },
# ...
# ...

# Find the record having an "x5t" value equal to the one we're seeking.
# jsonRec is a CkJsonObject
jsonRec = jsonResp.FindRecord("value","x5t",seek_x5t,true)
if (jsonResp.get_LastMethodSuccess() == false)
    print "Did not find a matching certificate." + "\n";
else
    print "Found the matching certificate." + "\n";
    # The id is a value such as https://kvchilkat.vault.azure.net/certificates/BadSSL
    print "id: " + jsonRec.stringOf("id") + "\n";

    # The name of the certificate is the last word after the final "/", such as "BadSSL"
    sbId = Chilkat::CkStringBuilder.new()
    sbId.Append(jsonRec.stringOf("id"))
    certName = sbId.getAfterFinal("/",false)
    print "name: " + certName + "\n";

end