(Objective-C) 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 Objective-C Library Downloads MAC OS X (Cocoa) Libs iOS Libs

#import <CkoJsonObject.h>
#import <NSString.h>
#import <CkoBinData.h>
#import <CkoCert.h>
#import <CkoPrivateKey.h>
#import <CkoStringBuilder.h>
#import <CkoHttp.h>
#import <CkoHttpResponse.h>

// 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.
CkoJsonObject *json = [[CkoJsonObject alloc] init];
[json UpdateString: @"client_id" value: @"APP_ID"];
[json UpdateString: @"client_secret" value: @"APP_PASSWORD"];
[json UpdateString: @"resource" value: @"https://vault.azure.net"];
[json UpdateString: @"token_endpoint" value: @"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..
NSString *pfxFilePath = @"qa_data/pfx/myCertAndKey.pfx";

// Load the PFX file to be imported to the Azure Key Vault.
CkoBinData *bdPfx = [[CkoBinData alloc] init];
BOOL success = [bdPfx LoadFile: pfxFilePath];
if (success == NO) {
    NSLog(@"%@",@"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.
CkoCert *cert = [[CkoCert alloc] init];
success = [cert LoadPfxFile: pfxFilePath password: @"pfx_password"];
if (success == NO) {
    NSLog(@"%@",cert.LastErrorText);
    return;
}

CkoPrivateKey *privKey = [cert ExportPrivateKey];
if (cert.LastMethodSuccess == NO) {
    NSLog(@"%@",@"The certificate does not have a private key.");
    return;
}

// Get the private key as a JWK so we can get information about it..
CkoJsonObject *jwk = [[CkoJsonObject alloc] init];
[jwk Load: [privKey GetJwk]];

// Get the key type
CkoStringBuilder *sbKty = [[CkoStringBuilder alloc] init];
[sbKty Append: [jwk StringOf: @"kty"]];

// If this is an EC key, get the curve name
CkoStringBuilder *sbCurve = [[CkoStringBuilder alloc] init];
if ([jwk HasMember: @"crv"] == YES) {
    [sbCurve Append: [jwk StringOf: @"crv"]];
}

// Build the JSON that will be the body of the HTTP POST.
CkoJsonObject *jsonBody = [[CkoJsonObject alloc] init];
[jsonBody UpdateString: @"value" value: [bdPfx GetEncoded: @"base64"]];
[jsonBody UpdateString: @"pwd" value: @"pfx_password"];
[jsonBody UpdateBool: @"policy.key_props.exportable" value: YES];
[jsonBody UpdateString: @"policy.key_props.kty" value: [sbKty GetAsString]];
if ([sbKty ContentsEqual: @"RSA" caseSensitive: NO] == YES) {
    [jsonBody UpdateInt: @"policy.key_props.key_size" value: privKey.BitLength];
}

if ([sbKty ContentsEqual: @"EC" caseSensitive: NO] == YES) {
    [jsonBody UpdateString: @"policy.key_props.crv" value: [sbCurve GetAsString]];
}

[jsonBody UpdateBool: @"policy.key_props.reuse_key" value: NO];
[jsonBody UpdateString: @"policy.secret_props.contentType" value: @"application/x-pkcs12"];

CkoHttp *http = [[CkoHttp alloc] init];

// 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" value: @"importCert01"];
// Note: Replace "VAULT_NAME" with the name of your Azure key vault.
NSString *url = @"https://VAULT_NAME.vault.azure.net/certificates/{$certificateName}/import?api-version=7.4";
CkoHttpResponse *resp = [http PostJson3: url contentType: @"application/json" json: jsonBody];
if (http.LastMethodSuccess == NO) {
    // This means something failed before we got a response.
    NSLog(@"%@",http.LastErrorText);
    return;
}

int statusCode = [resp.StatusCode intValue];

CkoJsonObject *jsonResp = [[CkoJsonObject alloc] init];
[resp GetBodyJson: jsonResp];

jsonResp.EmitCompact = NO;
NSLog(@"%@",[jsonResp Emit]);

if (statusCode != 200) {
    NSLog(@"%@",@"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

NSString *strVal = 0;
int Lifetime_percentage;
NSString *Action_type = 0;

NSString *id = [jsonResp StringOf: @"id"];
NSString *kid = [jsonResp StringOf: @"kid"];
NSString *sid = [jsonResp StringOf: @"sid"];
NSString *x5t = [jsonResp StringOf: @"x5t"];
NSString *cer = [jsonResp StringOf: @"cer"];
BOOL Enabled = [jsonResp BoolOf: @"attributes.enabled"];
int Nbf = [[jsonResp IntOf: @"attributes.nbf"] intValue];
int Exp = [[jsonResp IntOf: @"attributes.exp"] intValue];
int Created = [[jsonResp IntOf: @"attributes.created"] intValue];
int Updated = [[jsonResp IntOf: @"attributes.updated"] intValue];
NSString *RecoveryLevel = [jsonResp StringOf: @"attributes.recoveryLevel"];
int RecoverableDays = [[jsonResp IntOf: @"attributes.recoverableDays"] intValue];
NSString *Id = [jsonResp StringOf: @"policy.id"];
BOOL Exportable = [jsonResp BoolOf: @"policy.key_props.exportable"];
NSString *Kty = [jsonResp StringOf: @"policy.key_props.kty"];
int Key_size = [[jsonResp IntOf: @"policy.key_props.key_size"] intValue];
BOOL Reuse_key = [jsonResp BoolOf: @"policy.key_props.reuse_key"];
NSString *ContentType = [jsonResp StringOf: @"policy.secret_props.contentType"];
NSString *Subject = [jsonResp StringOf: @"policy.x509_props.subject"];
int Validity_months = [[jsonResp IntOf: @"policy.x509_props.validity_months"] intValue];
BOOL Ca = [jsonResp BoolOf: @"policy.x509_props.basic_constraints.ca"];
NSString *Name = [jsonResp StringOf: @"policy.issuer.name"];
BOOL AttributesEnabled = [jsonResp BoolOf: @"policy.attributes.enabled"];
int AttributesCreated = [[jsonResp IntOf: @"policy.attributes.created"] intValue];
int AttributesUpdated = [[jsonResp IntOf: @"policy.attributes.updated"] intValue];
int i = 0;
int count_i = [[jsonResp SizeOfArray: @"policy.x509_props.ekus"] intValue];
while (i < count_i) {
    jsonResp.I = [NSNumber numberWithInt: i];
    strVal = [jsonResp StringOf: @"policy.x509_props.ekus[i]"];
    i = i + 1;
}

i = 0;
count_i = [[jsonResp SizeOfArray: @"policy.x509_props.key_usage"] intValue];
while (i < count_i) {
    jsonResp.I = [NSNumber numberWithInt: i];
    strVal = [jsonResp StringOf: @"policy.x509_props.key_usage[i]"];
    i = i + 1;
}

i = 0;
count_i = [[jsonResp SizeOfArray: @"policy.lifetime_actions"] intValue];
while (i < count_i) {
    jsonResp.I = [NSNumber numberWithInt: i];
    Lifetime_percentage = [[jsonResp IntOf: @"policy.lifetime_actions[i].trigger.lifetime_percentage"] intValue];
    Action_type = [jsonResp StringOf: @"policy.lifetime_actions[i].action.action_type"];
    i = i + 1;
}