Lua Requires Chilkat v11.0.0+

Azure Key Vault Import Certificate

See more Azure Key Vault Examples

Imports a certificate into a specified Azure key vault.

Imports an existing valid certificate, containing a private key, into Azure Key Vault. The certificate to be imported can be in either PFX or PEM format. If the certificate is in PEM format the PEM file must contain the key as well as x509 certificates. Key Vault will only accept a key in PKCS#8 format.

Lua

local chilkat = require("chilkat")

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

-- See Azure Key Vault Get Certificates for a more detailed explanation
-- for how Chilkat is automatically getting the OAuth2 access token for your application.

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

-- Note: This example is using a relative file path.  You can also specify a full file path, such as "C:/someDir/myCertAndKey.pfx"
-- or a file path the makes sense on non-Windows operating systems..
local pfxFilePath = "qa_data/pfx/myCertAndKey.pfx"

-- Load the PFX file to be imported to the Azure Key Vault.
local bdPfx = chilkat.BinData.new()
local success = bdPfx:load_file(pfxFilePath)
if not success then
    print("Failed to load the PFX file.")
    return
end

-- We'll be sending a POST request like this:

-- POST https://myvault.vault.azure.net//certificates/importCert01/import?api-version=7.4
--
-- {
--   "value": "MIIJ...",
--   "pwd": "123",
--   "policy": {
--     "key_props": {
--       "exportable": true,
--       "kty": "RSA",
--       "key_size": 2048,
--       "reuse_key": false
--     },
--     "secret_props": {
--       "contentType": "application/x-pkcs12"
--     }
--   }
-- }

-- Also load the PFX into the Chilkat certificate object so we can get
-- information about the key type and size.
local cert = chilkat.Cert.new()
success = cert:load_pfx_file(pfxFilePath, "pfx_password")
if not success then
    print(cert.last_error_text)
    return
end

local privKey = chilkat.PrivateKey.new()
success = cert:get_private_key(privKey)
if not success then
    print(cert.last_error_text)
    return
end

-- Get the private key as a JWK so we can get information about it..
local jwk = chilkat.JsonObject.new()
jwk:load(privKey:get_jwk())

-- Get the key type
local sbKty = chilkat.StringBuilder.new()
sbKty:append(jwk:string_of("kty"))

-- If this is an EC key, get the curve name
local sbCurve = chilkat.StringBuilder.new()
if jwk:has_member("crv") then
    sbCurve:append(jwk:string_of("crv"))
end

-- Build the JSON that will be the body of the HTTP POST.
local jsonBody = chilkat.JsonObject.new()
jsonBody:update_string("value", bdPfx:get_encoded("base64"))
jsonBody:update_string("pwd", "pfx_password")
jsonBody:update_bool("policy.key_props.exportable", true)
jsonBody:update_string("policy.key_props.kty", sbKty:get_as_string())
if sbKty:contents_equal("RSA", false) then
    jsonBody:update_int("policy.key_props.key_size", privKey.bit_length)
end

if sbKty:contents_equal("EC", false) then
    jsonBody:update_string("policy.key_props.crv", sbCurve:get_as_string())
end

jsonBody:update_bool("policy.key_props.reuse_key", false)
jsonBody:update_string("policy.secret_props.contentType", "application/x-pkcs12")

local http = chilkat.Http.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.auth_token = json:emit()

-- Choose anything to be the name of your imported certificate.
http:set_url_var("certificateName", "importCert01")
-- Note: Replace "VAULT_NAME" with the name of your Azure key vault.
local url = "https://VAULT_NAME.vault.azure.net/certificates/{$certificateName}/import?api-version=7.4"
local resp = chilkat.HttpResponse.new()
success = http:http_json("POST", url, jsonBody, "application/json", resp)
if not success then
    print(http.last_error_text)
    return
end

local statusCode = resp.status_code

local jsonResp = chilkat.JsonObject.new()
resp:get_body_json(jsonResp)

jsonResp.emit_compact = false
print(jsonResp:emit())

if statusCode ~= 200 then
    print("Failed.")
    return
end

-- A successful JSON response looks like this:

-- {
--   "id": "https://kvchilkat.vault.azure.net/certificates/importCert01/7140c8755ed14839b5d86a9f7e7f0497",
--   "kid": "https://kvchilkat.vault.azure.net/keys/importCert01/7140c8755ed14839b5d86a9f7e7f0497",
--   "sid": "https://kvchilkat.vault.azure.net/secrets/importCert01/7140c8755ed14839b5d86a9f7e7f0497",
--   "x5t": "I_e3776K5Q_6PN1HHvJoI2ZGQRQ",
--   "cer": "MIIG ... jTsi7yIY=",
--   "attributes": {
--     "enabled": true,
--     "nbf": 1633996800,
--     "exp": 1728691199,
--     "created": 1697411128,
--     "updated": 1697411128,
--     "recoveryLevel": "CustomizedRecoverable+Purgeable",
--     "recoverableDays": 7
--   },
--   "policy": {
--     "id": "https://kvchilkat.vault.azure.net/certificates/importCert01/policy",
--     "key_props": {
--       "exportable": true,
--       "kty": "RSA",
--       "key_size": 4096,
--       "reuse_key": false
--     },
--     "secret_props": {
--       "contentType": "application/x-pkcs12"
--     },
--     "x509_props": {
--       "subject": "CN=\"Chilkat Software, Inc.\", O=\"Chilkat Software, Inc.\", S=Illinois, C=US",
--       "ekus": [
--         "1.3.6.1.5.5.7.3.3"
--       ],
--       "key_usage": [
--         "digitalSignature"
--       ],
--       "validity_months": 37,
--       "basic_constraints": {
--         "ca": false
--       }
--     },
--     "lifetime_actions": [
--       {
--         "trigger": {
--           "lifetime_percentage": 80
--         },
--         "action": {
--           "action_type": "EmailContacts"
--         }
--       }
--     ],
--     "issuer": {
--       "name": "Unknown"
--     },
--     "attributes": {
--       "enabled": true,
--       "created": 1697411128,
--       "updated": 1697411128
--     }
--   }
-- }

-- Use this online tool to generate parsing code from sample JSON:
-- Generate Parsing Code from JSON

local strVal = ""
local Lifetime_percentage = 0
local Action_type = ""

local id = jsonResp:string_of("id")
local kid = jsonResp:string_of("kid")
local sid = jsonResp:string_of("sid")
local x5t = jsonResp:string_of("x5t")
local cer = jsonResp:string_of("cer")
local Enabled = jsonResp:bool_of("attributes.enabled")
local Nbf = jsonResp:int_of("attributes.nbf")
local Exp = jsonResp:int_of("attributes.exp")
local Created = jsonResp:int_of("attributes.created")
local Updated = jsonResp:int_of("attributes.updated")
local RecoveryLevel = jsonResp:string_of("attributes.recoveryLevel")
local RecoverableDays = jsonResp:int_of("attributes.recoverableDays")
local Id = jsonResp:string_of("policy.id")
local Exportable = jsonResp:bool_of("policy.key_props.exportable")
local Kty = jsonResp:string_of("policy.key_props.kty")
local Key_size = jsonResp:int_of("policy.key_props.key_size")
local Reuse_key = jsonResp:bool_of("policy.key_props.reuse_key")
local ContentType = jsonResp:string_of("policy.secret_props.contentType")
local Subject = jsonResp:string_of("policy.x509_props.subject")
local Validity_months = jsonResp:int_of("policy.x509_props.validity_months")
local Ca = jsonResp:bool_of("policy.x509_props.basic_constraints.ca")
local Name = jsonResp:string_of("policy.issuer.name")
local AttributesEnabled = jsonResp:bool_of("policy.attributes.enabled")
local AttributesCreated = jsonResp:int_of("policy.attributes.created")
local AttributesUpdated = jsonResp:int_of("policy.attributes.updated")
local i = 0
local count_i = jsonResp:size_of_array("policy.x509_props.ekus")
while i < count_i do
    jsonResp.i = i
    strVal = jsonResp:string_of("policy.x509_props.ekus[i]")
    i = i + 1
end

i = 0
count_i = jsonResp:size_of_array("policy.x509_props.key_usage")
while i < count_i do
    jsonResp.i = i
    strVal = jsonResp:string_of("policy.x509_props.key_usage[i]")
    i = i + 1
end

i = 0
count_i = jsonResp:size_of_array("policy.lifetime_actions")
while i < count_i do
    jsonResp.i = i
    Lifetime_percentage = jsonResp:int_of("policy.lifetime_actions[i].trigger.lifetime_percentage")
    Action_type = jsonResp:string_of("policy.lifetime_actions[i].action.action_type")
    i = i + 1
end