Sample code for 30+ languages & platforms
Dart 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.

Chilkat Dart Downloads

Dart
import 'package:chilkat/chilkat.dart';

void main() {
  // 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.
  final json = CkJsonObject();
  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..
  final pfxFilePath = 'qa_data/pfx/myCertAndKey.pfx';

  // Load the PFX file to be imported to the Azure Key Vault.
  final bdPfx = CkBinData();
  try {
    bdPfx.loadFile(pfxFilePath);
  } on ChilkatException {
    print('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.
  final cert = CkCert();
  try {
    cert.loadPfxFile(pfxFilePath, 'pfx_password');
  } on ChilkatException catch (e) {
    print(e.lastErrorText);
    return;
  }

  final privKey = CkPrivateKey();
  try {
    cert.getPrivateKey(privKey);
  } on ChilkatException catch (e) {
    print(e.lastErrorText);
    return;
  }

  // Get the private key as a JWK so we can get information about it..
  final jwk = CkJsonObject();
  jwk.load(privKey.getJwk());

  // Get the key type
  final sbKty = CkStringBuilder();
  sbKty.append(jwk.stringOf('kty'));

  // If this is an EC key, get the curve name
  final sbCurve = CkStringBuilder();
  if (jwk.hasMember('crv')) {
    sbCurve.append(jwk.stringOf('crv'));
  }

  // Build the JSON that will be the body of the HTTP POST.
  final jsonBody = CkJsonObject();
  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)) {
    jsonBody.updateInt('policy.key_props.key_size', privKey.bitLength);
  }

  if (sbKty.contentsEqual('EC', false)) {
    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');

  final http = CkHttp();

  // 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.
  final url = 'https://VAULT_NAME.vault.azure.net/certificates/{\$certificateName}/import?api-version=7.4';
  final resp = CkHttpResponse();
  try {
    http.httpJson('POST', url, jsonBody, 'application/json', resp);
  } on ChilkatException catch (e) {
    print(e.lastErrorText);
    return;
  }

  final statusCode = resp.statusCode;

  final jsonResp = CkJsonObject();
  resp.getBodyJson(jsonResp);

  jsonResp.emitCompact = false;
  print(jsonResp.emit());

  if (statusCode != 200) {
    print('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 lifetimePercentage = 0;
  var actionType = '';

  var id = jsonResp.stringOf('id');
  final kid = jsonResp.stringOf('kid');
  final sid = jsonResp.stringOf('sid');
  final x5t = jsonResp.stringOf('x5t');
  final cer = jsonResp.stringOf('cer');
  final nbf = jsonResp.intOf('attributes.nbf');
  final exp = jsonResp.intOf('attributes.exp');
  final created = jsonResp.intOf('attributes.created');
  final updated = jsonResp.intOf('attributes.updated');
  final recoveryLevel = jsonResp.stringOf('attributes.recoveryLevel');
  final recoverableDays = jsonResp.intOf('attributes.recoverableDays');
  id = jsonResp.stringOf('policy.id');
  final kty = jsonResp.stringOf('policy.key_props.kty');
  final keySize = jsonResp.intOf('policy.key_props.key_size');
  final contentType = jsonResp.stringOf('policy.secret_props.contentType');
  final subject = jsonResp.stringOf('policy.x509_props.subject');
  final validityMonths = jsonResp.intOf('policy.x509_props.validity_months');
  final name = jsonResp.stringOf('policy.issuer.name');
  final attributesCreated = jsonResp.intOf('policy.attributes.created');
  final attributesUpdated = jsonResp.intOf('policy.attributes.updated');
  var i = 0;
  var countI = jsonResp.sizeOfArray('policy.x509_props.ekus');
  while (i < countI) {
    jsonResp.i = i;
    strVal = jsonResp.stringOf('policy.x509_props.ekus[i]');
    i++;
  }

  i = 0;
  countI = jsonResp.sizeOfArray('policy.x509_props.key_usage');
  while (i < countI) {
    jsonResp.i = i;
    strVal = jsonResp.stringOf('policy.x509_props.key_usage[i]');
    i++;
  }

  i = 0;
  countI = jsonResp.sizeOfArray('policy.lifetime_actions');
  while (i < countI) {
    jsonResp.i = i;
    lifetimePercentage = jsonResp.intOf('policy.lifetime_actions[i].trigger.lifetime_percentage');
    actionType = jsonResp.stringOf('policy.lifetime_actions[i].action.action_type');
    i++;
  }
}