Java Requires Chilkat v11.0.0+
Chilkat2 Java
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 Java Downloads
import com.chilkatsoft.chilkat2.BinData;
import com.chilkatsoft.chilkat2.Cert;
import com.chilkatsoft.chilkat2.ChilkatException;
import com.chilkatsoft.chilkat2.Http;
import com.chilkatsoft.chilkat2.HttpResponse;
import com.chilkatsoft.chilkat2.JsonObject;
import com.chilkatsoft.chilkat2.PrivateKey;
import com.chilkatsoft.chilkat2.StringBuilder;
public class ChilkatExample {
public static void main(String[] args) {
// 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.
JsonObject json = new 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..
String pfxFilePath = "qa_data/pfx/myCertAndKey.pfx";
// Load the PFX file to be imported to the Azure Key Vault.
BinData bdPfx = new BinData();
try {
bdPfx.loadFile(pfxFilePath);
} catch (ChilkatException e) {
System.out.println("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.
Cert cert = new Cert();
try {
cert.loadPfxFile(pfxFilePath, "pfx_password");
} catch (ChilkatException e) {
System.out.println(e.getLastErrorText());
return;
}
PrivateKey privKey = new PrivateKey();
try {
cert.getPrivateKey(privKey);
} catch (ChilkatException e) {
System.out.println(e.getLastErrorText());
return;
}
// Get the private key as a JWK so we can get information about it..
JsonObject jwk = new JsonObject();
jwk.load(privKey.getJwk());
// Get the key type
StringBuilder sbKty = new StringBuilder();
sbKty.append(jwk.stringOf("kty"));
// If this is an EC key, get the curve name
StringBuilder sbCurve = new StringBuilder();
if (jwk.hasMember("crv")) {
sbCurve.append(jwk.stringOf("crv"));
}
// Build the JSON that will be the body of the HTTP POST.
JsonObject jsonBody = new 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)) {
jsonBody.updateInt("policy.key_props.key_size", privKey.getBitLength());
}
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");
Http http = new 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.setAuthToken(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.
String url = "https://VAULT_NAME.vault.azure.net/certificates/{$certificateName}/import?api-version=7.4";
HttpResponse resp = new HttpResponse();
try {
http.httpJson("POST", url, jsonBody, "application/json", resp);
} catch (ChilkatException e) {
System.out.println(e.getLastErrorText());
return;
}
int statusCode = resp.getStatusCode();
JsonObject jsonResp = new JsonObject();
resp.getBodyJson(jsonResp);
jsonResp.setEmitCompact(false);
System.out.println(jsonResp.emit());
if (statusCode != 200) {
System.out.println("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
String strVal = "";
int Lifetime_percentage = 0;
String Action_type = "";
String id = jsonResp.stringOf("id");
String kid = jsonResp.stringOf("kid");
String sid = jsonResp.stringOf("sid");
String x5t = jsonResp.stringOf("x5t");
String cer = jsonResp.stringOf("cer");
boolean Enabled = jsonResp.boolOf("attributes.enabled");
int Nbf = jsonResp.intOf("attributes.nbf");
int Exp = jsonResp.intOf("attributes.exp");
int Created = jsonResp.intOf("attributes.created");
int Updated = jsonResp.intOf("attributes.updated");
String RecoveryLevel = jsonResp.stringOf("attributes.recoveryLevel");
int RecoverableDays = jsonResp.intOf("attributes.recoverableDays");
String Id = jsonResp.stringOf("policy.id");
boolean Exportable = jsonResp.boolOf("policy.key_props.exportable");
String Kty = jsonResp.stringOf("policy.key_props.kty");
int Key_size = jsonResp.intOf("policy.key_props.key_size");
boolean Reuse_key = jsonResp.boolOf("policy.key_props.reuse_key");
String ContentType = jsonResp.stringOf("policy.secret_props.contentType");
String Subject = jsonResp.stringOf("policy.x509_props.subject");
int Validity_months = jsonResp.intOf("policy.x509_props.validity_months");
boolean Ca = jsonResp.boolOf("policy.x509_props.basic_constraints.ca");
String Name = jsonResp.stringOf("policy.issuer.name");
boolean AttributesEnabled = jsonResp.boolOf("policy.attributes.enabled");
int AttributesCreated = jsonResp.intOf("policy.attributes.created");
int AttributesUpdated = jsonResp.intOf("policy.attributes.updated");
int i = 0;
int count_i = jsonResp.sizeOfArray("policy.x509_props.ekus");
while (i < count_i) {
jsonResp.setI(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.setI(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.setI(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;
}
}
}