(Visual FoxPro) 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.

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

For more information, see https://learn.microsoft.com/en-us/rest/api/keyvault/certificates/import-certificate/import-certificate?tabs=HTTP

Chilkat ActiveX Downloads ActiveX for 32-bit and 64-bit Windows

LOCAL loJson
LOCAL lcPfxFilePath
LOCAL loBdPfx
LOCAL lnSuccess
LOCAL loCert
LOCAL loPrivKey
LOCAL loJwk
LOCAL loSbKty
LOCAL loSbCurve
LOCAL loJsonBody
LOCAL loHttp
LOCAL lcUrl
LOCAL loResp
LOCAL lnStatusCode
LOCAL loJsonResp
LOCAL lcStrVal
LOCAL lnLifetime_percentage
LOCAL lcAction_type
LOCAL lcId
LOCAL lcKid
LOCAL lcSid
LOCAL lcX5t
LOCAL lcCer
LOCAL lnEnabled
LOCAL lnNbf
LOCAL lnExp
LOCAL lnCreated
LOCAL lnUpdated
LOCAL lcRecoveryLevel
LOCAL lnRecoverableDays
LOCAL lcId
LOCAL lnExportable
LOCAL lcKty
LOCAL lnKey_size
LOCAL lnReuse_key
LOCAL lcContentType
LOCAL lcSubject
LOCAL lnValidity_months
LOCAL lnCa
LOCAL lcName
LOCAL lnAttributesEnabled
LOCAL lnAttributesCreated
LOCAL lnAttributesUpdated
LOCAL i
LOCAL lnCount_i

* 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.
* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.JsonObject')
loJson = CreateObject('Chilkat.JsonObject')
loJson.UpdateString("client_id","APP_ID")
loJson.UpdateString("client_secret","APP_PASSWORD")
loJson.UpdateString("resource","https://vault.azure.net")
loJson.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..
lcPfxFilePath = "qa_data/pfx/myCertAndKey.pfx"

* Load the PFX file to be imported to the Azure Key Vault.
* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.BinData')
loBdPfx = CreateObject('Chilkat.BinData')
lnSuccess = loBdPfx.LoadFile(lcPfxFilePath)
IF (lnSuccess = 0) THEN
    ? "Failed to load the PFX file."
    RELEASE loJson
    RELEASE loBdPfx
    CANCEL
ENDIF

* 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.
* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.Cert')
loCert = CreateObject('Chilkat.Cert')
lnSuccess = loCert.LoadPfxFile(lcPfxFilePath,"pfx_password")
IF (lnSuccess = 0) THEN
    ? loCert.LastErrorText
    RELEASE loJson
    RELEASE loBdPfx
    RELEASE loCert
    CANCEL
ENDIF

loPrivKey = loCert.ExportPrivateKey()
IF (loCert.LastMethodSuccess = 0) THEN
    ? "The certificate does not have a private key."
    RELEASE loJson
    RELEASE loBdPfx
    RELEASE loCert
    CANCEL
ENDIF

* Get the private key as a JWK so we can get information about it..
* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.JsonObject')
loJwk = CreateObject('Chilkat.JsonObject')
loJwk.Load(loPrivKey.GetJwk())

* Get the key type
* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.StringBuilder')
loSbKty = CreateObject('Chilkat.StringBuilder')
loSbKty.Append(loJwk.StringOf("kty"))

* If this is an EC key, get the curve name
* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.StringBuilder')
loSbCurve = CreateObject('Chilkat.StringBuilder')
IF (loJwk.HasMember("crv") = 1) THEN
    loSbCurve.Append(loJwk.StringOf("crv"))
ENDIF

* Build the JSON that will be the body of the HTTP POST.
* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.JsonObject')
loJsonBody = CreateObject('Chilkat.JsonObject')
loJsonBody.UpdateString("value",loBdPfx.GetEncoded("base64"))
loJsonBody.UpdateString("pwd","pfx_password")
loJsonBody.UpdateBool("policy.key_props.exportable",1)
loJsonBody.UpdateString("policy.key_props.kty",loSbKty.GetAsString())
IF (loSbKty.ContentsEqual("RSA",0) = 1) THEN
    loJsonBody.UpdateInt("policy.key_props.key_size",loPrivKey.BitLength)
ENDIF

IF (loSbKty.ContentsEqual("EC",0) = 1) THEN
    loJsonBody.UpdateString("policy.key_props.crv",loSbCurve.GetAsString())
ENDIF

loJsonBody.UpdateBool("policy.key_props.reuse_key",0)
loJsonBody.UpdateString("policy.secret_props.contentType","application/x-pkcs12")

RELEASE loPrivKey

* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.Http')
loHttp = CreateObject('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.
loHttp.AuthToken = loJson.Emit()

* Choose anything to be the name of your imported certificate.
loHttp.SetUrlVar("certificateName","importCert01")
* Note: Replace "VAULT_NAME" with the name of your Azure key vault.
lcUrl = "https://VAULT_NAME.vault.azure.net/certificates/{$certificateName}/import?api-version=7.4"
loResp = loHttp.PostJson3(lcUrl,"application/json",loJsonBody)
IF (loHttp.LastMethodSuccess = 0) THEN
    * This means something failed before we got a response.
    ? loHttp.LastErrorText
    RELEASE loJson
    RELEASE loBdPfx
    RELEASE loCert
    RELEASE loJwk
    RELEASE loSbKty
    RELEASE loSbCurve
    RELEASE loJsonBody
    RELEASE loHttp
    CANCEL
ENDIF

lnStatusCode = loResp.StatusCode

* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.JsonObject')
loJsonResp = CreateObject('Chilkat.JsonObject')
loResp.GetBodyJson(loJsonResp)
RELEASE loResp

loJsonResp.EmitCompact = 0
? loJsonResp.Emit()

IF (lnStatusCode <> 200) THEN
    ? "Failed."
    RELEASE loJson
    RELEASE loBdPfx
    RELEASE loCert
    RELEASE loJwk
    RELEASE loSbKty
    RELEASE loSbCurve
    RELEASE loJsonBody
    RELEASE loHttp
    RELEASE loJsonResp
    CANCEL
ENDIF

* 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

lcId = loJsonResp.StringOf("id")
lcKid = loJsonResp.StringOf("kid")
lcSid = loJsonResp.StringOf("sid")
lcX5t = loJsonResp.StringOf("x5t")
lcCer = loJsonResp.StringOf("cer")
lnEnabled = loJsonResp.BoolOf("attributes.enabled")
lnNbf = loJsonResp.IntOf("attributes.nbf")
lnExp = loJsonResp.IntOf("attributes.exp")
lnCreated = loJsonResp.IntOf("attributes.created")
lnUpdated = loJsonResp.IntOf("attributes.updated")
lcRecoveryLevel = loJsonResp.StringOf("attributes.recoveryLevel")
lnRecoverableDays = loJsonResp.IntOf("attributes.recoverableDays")
lcId = loJsonResp.StringOf("policy.id")
lnExportable = loJsonResp.BoolOf("policy.key_props.exportable")
lcKty = loJsonResp.StringOf("policy.key_props.kty")
lnKey_size = loJsonResp.IntOf("policy.key_props.key_size")
lnReuse_key = loJsonResp.BoolOf("policy.key_props.reuse_key")
lcContentType = loJsonResp.StringOf("policy.secret_props.contentType")
lcSubject = loJsonResp.StringOf("policy.x509_props.subject")
lnValidity_months = loJsonResp.IntOf("policy.x509_props.validity_months")
lnCa = loJsonResp.BoolOf("policy.x509_props.basic_constraints.ca")
lcName = loJsonResp.StringOf("policy.issuer.name")
lnAttributesEnabled = loJsonResp.BoolOf("policy.attributes.enabled")
lnAttributesCreated = loJsonResp.IntOf("policy.attributes.created")
lnAttributesUpdated = loJsonResp.IntOf("policy.attributes.updated")
i = 0
lnCount_i = loJsonResp.SizeOfArray("policy.x509_props.ekus")
DO WHILE i < lnCount_i
    loJsonResp.I = i
    lcStrVal = loJsonResp.StringOf("policy.x509_props.ekus[i]")
    i = i + 1
ENDDO
i = 0
lnCount_i = loJsonResp.SizeOfArray("policy.x509_props.key_usage")
DO WHILE i < lnCount_i
    loJsonResp.I = i
    lcStrVal = loJsonResp.StringOf("policy.x509_props.key_usage[i]")
    i = i + 1
ENDDO
i = 0
lnCount_i = loJsonResp.SizeOfArray("policy.lifetime_actions")
DO WHILE i < lnCount_i
    loJsonResp.I = i
    lnLifetime_percentage = loJsonResp.IntOf("policy.lifetime_actions[i].trigger.lifetime_percentage")
    lcAction_type = loJsonResp.StringOf("policy.lifetime_actions[i].action.action_type")
    i = i + 1
ENDDO

RELEASE loJson
RELEASE loBdPfx
RELEASE loCert
RELEASE loJwk
RELEASE loSbKty
RELEASE loSbCurve
RELEASE loJsonBody
RELEASE loHttp
RELEASE loJsonResp