(PureBasic) 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 PureBasic Module Download Chilkat PureBasic Module

IncludeFile "CkJsonObject.pb"
IncludeFile "CkPrivateKey.pb"
IncludeFile "CkHttp.pb"
IncludeFile "CkStringBuilder.pb"
IncludeFile "CkHttpResponse.pb"
IncludeFile "CkCert.pb"
IncludeFile "CkBinData.pb"

Procedure ChilkatExample()

    ; 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.
    json.i = CkJsonObject::ckCreate()
    If json.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkJsonObject::ckUpdateString(json,"client_id","APP_ID")
    CkJsonObject::ckUpdateString(json,"client_secret","APP_PASSWORD")
    CkJsonObject::ckUpdateString(json,"resource","https://vault.azure.net")
    CkJsonObject::ckUpdateString(json,"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..
    pfxFilePath.s = "qa_data/pfx/myCertAndKey.pfx"

    ; Load the PFX file to be imported to the Azure Key Vault.
    bdPfx.i = CkBinData::ckCreate()
    If bdPfx.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    success.i = CkBinData::ckLoadFile(bdPfx,pfxFilePath)
    If success = 0
        Debug "Failed to load the PFX file."
        CkJsonObject::ckDispose(json)
        CkBinData::ckDispose(bdPfx)
        ProcedureReturn
    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.
    cert.i = CkCert::ckCreate()
    If cert.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    success = CkCert::ckLoadPfxFile(cert,pfxFilePath,"pfx_password")
    If success = 0
        Debug CkCert::ckLastErrorText(cert)
        CkJsonObject::ckDispose(json)
        CkBinData::ckDispose(bdPfx)
        CkCert::ckDispose(cert)
        ProcedureReturn
    EndIf

    privKey.i = CkCert::ckExportPrivateKey(cert)
    If CkCert::ckLastMethodSuccess(cert) = 0
        Debug "The certificate does not have a private key."
        CkJsonObject::ckDispose(json)
        CkBinData::ckDispose(bdPfx)
        CkCert::ckDispose(cert)
        ProcedureReturn
    EndIf

    ; Get the private key as a JWK so we can get information about it..
    jwk.i = CkJsonObject::ckCreate()
    If jwk.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkJsonObject::ckLoad(jwk,CkPrivateKey::ckGetJwk(privKey))

    ; Get the key type
    sbKty.i = CkStringBuilder::ckCreate()
    If sbKty.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkStringBuilder::ckAppend(sbKty,CkJsonObject::ckStringOf(jwk,"kty"))

    ; If this is an EC key, get the curve name
    sbCurve.i = CkStringBuilder::ckCreate()
    If sbCurve.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    If CkJsonObject::ckHasMember(jwk,"crv") = 1
        CkStringBuilder::ckAppend(sbCurve,CkJsonObject::ckStringOf(jwk,"crv"))
    EndIf

    ; Build the JSON that will be the body of the HTTP POST.
    jsonBody.i = CkJsonObject::ckCreate()
    If jsonBody.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkJsonObject::ckUpdateString(jsonBody,"value",CkBinData::ckGetEncoded(bdPfx,"base64"))
    CkJsonObject::ckUpdateString(jsonBody,"pwd","pfx_password")
    CkJsonObject::ckUpdateBool(jsonBody,"policy.key_props.exportable",1)
    CkJsonObject::ckUpdateString(jsonBody,"policy.key_props.kty",CkStringBuilder::ckGetAsString(sbKty))
    If CkStringBuilder::ckContentsEqual(sbKty,"RSA",0) = 1
        CkJsonObject::ckUpdateInt(jsonBody,"policy.key_props.key_size",CkPrivateKey::ckBitLength(privKey))
    EndIf

    If CkStringBuilder::ckContentsEqual(sbKty,"EC",0) = 1
        CkJsonObject::ckUpdateString(jsonBody,"policy.key_props.crv",CkStringBuilder::ckGetAsString(sbCurve))
    EndIf

    CkJsonObject::ckUpdateBool(jsonBody,"policy.key_props.reuse_key",0)
    CkJsonObject::ckUpdateString(jsonBody,"policy.secret_props.contentType","application/x-pkcs12")

    CkPrivateKey::ckDispose(privKey)

    http.i = CkHttp::ckCreate()
    If http.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    ; 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.
    CkHttp::setCkAuthToken(http, CkJsonObject::ckEmit(json))

    ; Choose anything to be the name of your imported certificate.
    CkHttp::ckSetUrlVar(http,"certificateName","importCert01")
    ; Note: Replace "VAULT_NAME" with the name of your Azure key vault.
    url.s = "https://VAULT_NAME.vault.azure.net/certificates/{$certificateName}/import?api-version=7.4"
    resp.i = CkHttp::ckPostJson3(http,url,"application/json",jsonBody)
    If CkHttp::ckLastMethodSuccess(http) = 0
        ; This means something failed before we got a response.
        Debug CkHttp::ckLastErrorText(http)
        CkJsonObject::ckDispose(json)
        CkBinData::ckDispose(bdPfx)
        CkCert::ckDispose(cert)
        CkJsonObject::ckDispose(jwk)
        CkStringBuilder::ckDispose(sbKty)
        CkStringBuilder::ckDispose(sbCurve)
        CkJsonObject::ckDispose(jsonBody)
        CkHttp::ckDispose(http)
        ProcedureReturn
    EndIf

    statusCode.i = CkHttpResponse::ckStatusCode(resp)

    jsonResp.i = CkJsonObject::ckCreate()
    If jsonResp.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkHttpResponse::ckGetBodyJson(resp,jsonResp)
    CkHttpResponse::ckDispose(resp)

    CkJsonObject::setCkEmitCompact(jsonResp, 0)
    Debug CkJsonObject::ckEmit(jsonResp)

    If statusCode <> 200
        Debug "Failed."
        CkJsonObject::ckDispose(json)
        CkBinData::ckDispose(bdPfx)
        CkCert::ckDispose(cert)
        CkJsonObject::ckDispose(jwk)
        CkStringBuilder::ckDispose(sbKty)
        CkStringBuilder::ckDispose(sbCurve)
        CkJsonObject::ckDispose(jsonBody)
        CkHttp::ckDispose(http)
        CkJsonObject::ckDispose(jsonResp)
        ProcedureReturn
    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

    strVal.s
    Lifetime_percentage.i
    Action_type.s

    id.s = CkJsonObject::ckStringOf(jsonResp,"id")
    kid.s = CkJsonObject::ckStringOf(jsonResp,"kid")
    sid.s = CkJsonObject::ckStringOf(jsonResp,"sid")
    x5t.s = CkJsonObject::ckStringOf(jsonResp,"x5t")
    cer.s = CkJsonObject::ckStringOf(jsonResp,"cer")
    Enabled.i = CkJsonObject::ckBoolOf(jsonResp,"attributes.enabled")
    Nbf.i = CkJsonObject::ckIntOf(jsonResp,"attributes.nbf")
    Exp.i = CkJsonObject::ckIntOf(jsonResp,"attributes.exp")
    Created.i = CkJsonObject::ckIntOf(jsonResp,"attributes.created")
    Updated.i = CkJsonObject::ckIntOf(jsonResp,"attributes.updated")
    RecoveryLevel.s = CkJsonObject::ckStringOf(jsonResp,"attributes.recoveryLevel")
    RecoverableDays.i = CkJsonObject::ckIntOf(jsonResp,"attributes.recoverableDays")
    Id.s = CkJsonObject::ckStringOf(jsonResp,"policy.id")
    Exportable.i = CkJsonObject::ckBoolOf(jsonResp,"policy.key_props.exportable")
    Kty.s = CkJsonObject::ckStringOf(jsonResp,"policy.key_props.kty")
    Key_size.i = CkJsonObject::ckIntOf(jsonResp,"policy.key_props.key_size")
    Reuse_key.i = CkJsonObject::ckBoolOf(jsonResp,"policy.key_props.reuse_key")
    ContentType.s = CkJsonObject::ckStringOf(jsonResp,"policy.secret_props.contentType")
    Subject.s = CkJsonObject::ckStringOf(jsonResp,"policy.x509_props.subject")
    Validity_months.i = CkJsonObject::ckIntOf(jsonResp,"policy.x509_props.validity_months")
    Ca.i = CkJsonObject::ckBoolOf(jsonResp,"policy.x509_props.basic_constraints.ca")
    Name.s = CkJsonObject::ckStringOf(jsonResp,"policy.issuer.name")
    AttributesEnabled.i = CkJsonObject::ckBoolOf(jsonResp,"policy.attributes.enabled")
    AttributesCreated.i = CkJsonObject::ckIntOf(jsonResp,"policy.attributes.created")
    AttributesUpdated.i = CkJsonObject::ckIntOf(jsonResp,"policy.attributes.updated")
    i.i = 0
    count_i.i = CkJsonObject::ckSizeOfArray(jsonResp,"policy.x509_props.ekus")
    While i < count_i
        CkJsonObject::setCkI(jsonResp, i)
        strVal = CkJsonObject::ckStringOf(jsonResp,"policy.x509_props.ekus[i]")
        i = i + 1
    Wend
    i = 0
    count_i = CkJsonObject::ckSizeOfArray(jsonResp,"policy.x509_props.key_usage")
    While i < count_i
        CkJsonObject::setCkI(jsonResp, i)
        strVal = CkJsonObject::ckStringOf(jsonResp,"policy.x509_props.key_usage[i]")
        i = i + 1
    Wend
    i = 0
    count_i = CkJsonObject::ckSizeOfArray(jsonResp,"policy.lifetime_actions")
    While i < count_i
        CkJsonObject::setCkI(jsonResp, i)
        Lifetime_percentage = CkJsonObject::ckIntOf(jsonResp,"policy.lifetime_actions[i].trigger.lifetime_percentage")
        Action_type = CkJsonObject::ckStringOf(jsonResp,"policy.lifetime_actions[i].action.action_type")
        i = i + 1
    Wend


    CkJsonObject::ckDispose(json)
    CkBinData::ckDispose(bdPfx)
    CkCert::ckDispose(cert)
    CkJsonObject::ckDispose(jwk)
    CkStringBuilder::ckDispose(sbKty)
    CkStringBuilder::ckDispose(sbCurve)
    CkJsonObject::ckDispose(jsonBody)
    CkHttp::ckDispose(http)
    CkJsonObject::ckDispose(jsonResp)


    ProcedureReturn
EndProcedure