Xojo Plugin

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.

Xojo Plugin

Dim success As Boolean
success = False

// 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.
Dim json As New Chilkat.JsonObject
success = json.UpdateString("client_id","APP_ID")
success = json.UpdateString("client_secret","APP_PASSWORD")
success = json.UpdateString("resource","https://vault.azure.net")
success = json.UpdateString("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..
Dim pfxFilePath As String
pfxFilePath = "qa_data/pfx/myCertAndKey.pfx"

// Load the PFX file to be imported to the Azure Key Vault.
Dim bdPfx As New Chilkat.BinData
success = bdPfx.LoadFile(pfxFilePath)
If (success = False) Then
    System.DebugLog("Failed to load the PFX file.")
    Return
End If

// 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.
Dim cert As New Chilkat.Cert
success = cert.LoadPfxFile(pfxFilePath,"pfx_password")
If (success = False) Then
    System.DebugLog(cert.LastErrorText)
    Return
End If

Dim privKey As New Chilkat.PrivateKey
success = cert.GetPrivateKey(privKey)
If (success = False) Then
    System.DebugLog(cert.LastErrorText)
    Return
End If

// Get the private key as a JWK so we can get information about it..
Dim jwk As New Chilkat.JsonObject
success = jwk.Load(privKey.GetJwk())

// Get the key type
Dim sbKty As New Chilkat.StringBuilder
success = sbKty.Append(jwk.StringOf("kty"))

// If this is an EC key, get the curve name
Dim sbCurve As New Chilkat.StringBuilder
If (jwk.HasMember("crv") = True) Then
    success = sbCurve.Append(jwk.StringOf("crv"))
End If

// Build the JSON that will be the body of the HTTP POST.
Dim jsonBody As New Chilkat.JsonObject
success = jsonBody.UpdateString("value",bdPfx.GetEncoded("base64"))
success = jsonBody.UpdateString("pwd","pfx_password")
success = jsonBody.UpdateBool("policy.key_props.exportable",True)
success = jsonBody.UpdateString("policy.key_props.kty",sbKty.GetAsString())
If (sbKty.ContentsEqual("RSA",False) = True) Then
    success = jsonBody.UpdateInt("policy.key_props.key_size",privKey.BitLength)
End If

If (sbKty.ContentsEqual("EC",False) = True) Then
    success = jsonBody.UpdateString("policy.key_props.crv",sbCurve.GetAsString())
End If

success = jsonBody.UpdateBool("policy.key_props.reuse_key",False)
success = jsonBody.UpdateString("policy.secret_props.contentType","application/x-pkcs12")

Dim http As New Chilkat.Http

// 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.AuthToken = json.Emit()

// Choose anything to be the name of your imported certificate.
success = http.SetUrlVar("certificateName","importCert01")
// Note: Replace "VAULT_NAME" with the name of your Azure key vault.
Dim url As String
url = "https://VAULT_NAME.vault.azure.net/certificates/{$certificateName}/import?api-version=7.4"
Dim resp As New Chilkat.HttpResponse
success = http.HttpJson("POST",url,jsonBody,"application/json",resp)
If (success = False) Then
    System.DebugLog(http.LastErrorText)
    Return
End If

Dim statusCode As Int32
statusCode = resp.StatusCode

Dim jsonResp As New Chilkat.JsonObject
success = resp.GetBodyJson(jsonResp)

jsonResp.EmitCompact = False
System.DebugLog(jsonResp.Emit())

If (statusCode <> 200) Then
    System.DebugLog("Failed.")
    Return
End If

// 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

Dim strVal As String
Dim Lifetime_percentage As Int32
Dim Action_type As String

Dim id As String
id = jsonResp.StringOf("id")
Dim kid As String
kid = jsonResp.StringOf("kid")
Dim sid As String
sid = jsonResp.StringOf("sid")
Dim x5t As String
x5t = jsonResp.StringOf("x5t")
Dim cer As String
cer = jsonResp.StringOf("cer")
Dim Enabled As Boolean
Enabled = jsonResp.BoolOf("attributes.enabled")
Dim Nbf As Int32
Nbf = jsonResp.IntOf("attributes.nbf")
Dim Exp As Int32
Exp = jsonResp.IntOf("attributes.exp")
Dim Created As Int32
Created = jsonResp.IntOf("attributes.created")
Dim Updated As Int32
Updated = jsonResp.IntOf("attributes.updated")
Dim RecoveryLevel As String
RecoveryLevel = jsonResp.StringOf("attributes.recoveryLevel")
Dim RecoverableDays As Int32
RecoverableDays = jsonResp.IntOf("attributes.recoverableDays")
Dim Id As String
Id = jsonResp.StringOf("policy.id")
Dim Exportable As Boolean
Exportable = jsonResp.BoolOf("policy.key_props.exportable")
Dim Kty As String
Kty = jsonResp.StringOf("policy.key_props.kty")
Dim Key_size As Int32
Key_size = jsonResp.IntOf("policy.key_props.key_size")
Dim Reuse_key As Boolean
Reuse_key = jsonResp.BoolOf("policy.key_props.reuse_key")
Dim ContentType As String
ContentType = jsonResp.StringOf("policy.secret_props.contentType")
Dim Subject As String
Subject = jsonResp.StringOf("policy.x509_props.subject")
Dim Validity_months As Int32
Validity_months = jsonResp.IntOf("policy.x509_props.validity_months")
Dim Ca As Boolean
Ca = jsonResp.BoolOf("policy.x509_props.basic_constraints.ca")
Dim Name As String
Name = jsonResp.StringOf("policy.issuer.name")
Dim AttributesEnabled As Boolean
AttributesEnabled = jsonResp.BoolOf("policy.attributes.enabled")
Dim AttributesCreated As Int32
AttributesCreated = jsonResp.IntOf("policy.attributes.created")
Dim AttributesUpdated As Int32
AttributesUpdated = jsonResp.IntOf("policy.attributes.updated")
Dim i As Int32
i = 0
Dim count_i As Int32
count_i = jsonResp.SizeOfArray("policy.x509_props.ekus")
While i < count_i
    jsonResp.I = i
    strVal = jsonResp.StringOf("policy.x509_props.ekus[i]")
    i = i + 1
Wend
i = 0
count_i = jsonResp.SizeOfArray("policy.x509_props.key_usage")
While i < count_i
    jsonResp.I = i
    strVal = jsonResp.StringOf("policy.x509_props.key_usage[i]")
    i = i + 1
Wend
i = 0
count_i = jsonResp.SizeOfArray("policy.lifetime_actions")
While i < count_i
    jsonResp.I = i
    Lifetime_percentage = jsonResp.IntOf("policy.lifetime_actions[i].trigger.lifetime_percentage")
    Action_type = jsonResp.StringOf("policy.lifetime_actions[i].action.action_type")
    i = i + 1
Wend