(Node.js) 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

Install Chilkat for Node.js and Electron using npm at Chilkat npm packages for Node.js Chilkat npm packages for Electron on Windows, Linux, MacOSX, and ARM

var os = require('os');
if (os.platform() == 'win32') {  
    if (os.arch() == 'ia32') {
        var chilkat = require('@chilkat/ck-node21-win-ia32');
    } else {
        var chilkat = require('@chilkat/ck-node21-win64'); 
    }
} else if (os.platform() == 'linux') {
    if (os.arch() == 'arm') {
        var chilkat = require('@chilkat/ck-node21-arm');
    } else if (os.arch() == 'x86') {
        var chilkat = require('@chilkat/ck-node21-linux32');
    } else {
        var chilkat = require('@chilkat/ck-node21-linux64');
    }
} else if (os.platform() == 'darwin') {
    if (os.arch() == 'arm64') {
        var chilkat = require('@chilkat/ck-node21-mac-m1');
    } else {
        var chilkat = require('@chilkat/ck-node21-macosx');
    }
}

function 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.
    var json = new chilkat.JsonObject();
    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");

    // 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..
    var pfxFilePath = "qa_data/pfx/myCertAndKey.pfx";

    // Load the PFX file to be imported to the Azure Key Vault.
    var bdPfx = new chilkat.BinData();
    var success = bdPfx.LoadFile(pfxFilePath);
    if (success == false) {
        console.log("Failed to load the PFX file.");
        return;
    }

    // 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.
    var cert = new chilkat.Cert();
    success = cert.LoadPfxFile(pfxFilePath,"pfx_password");
    if (success == false) {
        console.log(cert.LastErrorText);
        return;
    }

    // privKey: PrivateKey
    var privKey = cert.ExportPrivateKey();
    if (cert.LastMethodSuccess == false) {
        console.log("The certificate does not have a private key.");
        return;
    }

    // Get the private key as a JWK so we can get information about it..
    var jwk = new chilkat.JsonObject();
    jwk.Load(privKey.GetJwk());

    // Get the key type
    var sbKty = new chilkat.StringBuilder();
    sbKty.Append(jwk.StringOf("kty"));

    // If this is an EC key, get the curve name
    var sbCurve = new chilkat.StringBuilder();
    if (jwk.HasMember("crv") == true) {
        sbCurve.Append(jwk.StringOf("crv"));
    }

    // Build the JSON that will be the body of the HTTP POST.
    var jsonBody = new chilkat.JsonObject();
    jsonBody.UpdateString("value",bdPfx.GetEncoded("base64"));
    jsonBody.UpdateString("pwd","pfx_password");
    jsonBody.UpdateBool("policy.key_props.exportable",true);
    jsonBody.UpdateString("policy.key_props.kty",sbKty.GetAsString());
    if (sbKty.ContentsEqual("RSA",false) == true) {
        jsonBody.UpdateInt("policy.key_props.key_size",privKey.BitLength);
    }

    if (sbKty.ContentsEqual("EC",false) == true) {
        jsonBody.UpdateString("policy.key_props.crv",sbCurve.GetAsString());
    }

    jsonBody.UpdateBool("policy.key_props.reuse_key",false);
    jsonBody.UpdateString("policy.secret_props.contentType","application/x-pkcs12");

    var http = 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.
    http.SetUrlVar("certificateName","importCert01");
    // Note: Replace "VAULT_NAME" with the name of your Azure key vault.
    var url = "https://VAULT_NAME.vault.azure.net/certificates/{$certificateName}/import?api-version=7.4";
    // resp: HttpResponse
    var resp = http.PostJson3(url,"application/json",jsonBody);
    if (http.LastMethodSuccess == false) {
        // This means something failed before we got a response.
        console.log(http.LastErrorText);
        return;
    }

    var statusCode = resp.StatusCode;

    var jsonResp = new chilkat.JsonObject();
    resp.GetBodyJson(jsonResp);

    jsonResp.EmitCompact = false;
    console.log(jsonResp.Emit());

    if (statusCode !== 200) {
        console.log("Failed.");
        return;
    }

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

    var strVal;
    var Lifetime_percentage;
    var Action_type;

    var id = jsonResp.StringOf("id");
    var kid = jsonResp.StringOf("kid");
    var sid = jsonResp.StringOf("sid");
    var x5t = jsonResp.StringOf("x5t");
    var cer = jsonResp.StringOf("cer");
    var Enabled = jsonResp.BoolOf("attributes.enabled");
    var Nbf = jsonResp.IntOf("attributes.nbf");
    var Exp = jsonResp.IntOf("attributes.exp");
    var Created = jsonResp.IntOf("attributes.created");
    var Updated = jsonResp.IntOf("attributes.updated");
    var RecoveryLevel = jsonResp.StringOf("attributes.recoveryLevel");
    var RecoverableDays = jsonResp.IntOf("attributes.recoverableDays");
    var Id = jsonResp.StringOf("policy.id");
    var Exportable = jsonResp.BoolOf("policy.key_props.exportable");
    var Kty = jsonResp.StringOf("policy.key_props.kty");
    var Key_size = jsonResp.IntOf("policy.key_props.key_size");
    var Reuse_key = jsonResp.BoolOf("policy.key_props.reuse_key");
    var ContentType = jsonResp.StringOf("policy.secret_props.contentType");
    var Subject = jsonResp.StringOf("policy.x509_props.subject");
    var Validity_months = jsonResp.IntOf("policy.x509_props.validity_months");
    var Ca = jsonResp.BoolOf("policy.x509_props.basic_constraints.ca");
    var Name = jsonResp.StringOf("policy.issuer.name");
    var AttributesEnabled = jsonResp.BoolOf("policy.attributes.enabled");
    var AttributesCreated = jsonResp.IntOf("policy.attributes.created");
    var AttributesUpdated = jsonResp.IntOf("policy.attributes.updated");
    var i = 0;
    var 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;
    }

    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;
    }

    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;
    }


}

chilkatExample();