(PHP Extension) AWS KMS Import PFX Key

See more AWS KMS Examples

Imports a certificate's private key from a .pfx file to new key created in AWS KMS.

Note: This example requires Chilkat v9.5.0.96 or later.

Chilkat PHP Downloads PHP Extension for Windows, Linux, MacOS, Alpine Linux, Solaris

<?php

// The version number (9_5_0) should match version of the Chilkat extension used, omitting the micro-version number.
// For example, if using Chilkat v9.5.0.48, then include as shown here:
include("chilkat_9_5_0.php");

// This example requires the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.

// 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..
$cert = new CkCert();
$success = $cert->LoadPfxFile('qa_data/pfx/myCertAndKey.pfx','pfx_password');
if ($success == false) {
    print $cert->lastErrorText() . "\n";
    exit;
}

// Get the cert's private key.  This is what will be uploaded to AWS KMS.
// privKey is a CkPrivateKey
$privKey = $cert->ExportPrivateKey();
if ($cert->get_LastMethodSuccess() == false) {
    print 'The certificate does not have a private key.' . "\n";
    exit;
}

$json = new CkJsonObject();
$json->UpdateString('service','aws-kms');
$json->UpdateString('auth.access_key','AWS_ACCESS_KEY');
$json->UpdateString('auth.secret_key','AWS_SECRET_KEY');
$json->UpdateString('auth.region','us-west-2');
$json->UpdateString('description','Test of uploading existing private key to AWS KMS');

// Let's add some information about the certificate this key belongs to.
// This is for informational purposes only, so that we can examine the tags
// in the AWS KMS console and know the corresponding certificate.
$json->UpdateString('tags[0].key','CertSerial');
$json->UpdateString('tags[0].value',$cert->serialNumber());
$json->UpdateString('tags[1].key','CertIssuer');
$json->UpdateString('tags[1].value',$cert->issuerCN());
$json->UpdateString('tags[2].key','CertSubject');
$json->UpdateString('tags[2].value',$cert->subjectCN());

$json->UpdateString('keyUsage','SIGN_VERIFY');

// The UploadToCloud method was added in Chilkat v9.5.0.96
$jsonOut = new CkJsonObject();
$success = $privKey->UploadToCloud($json,$jsonOut);
if ($success == false) {
    print $privKey->lastErrorText() . "\n";

    exit;
}

// When successful, the jsonOut contains information about the private key in AWS KMS.
// Most importantly, the KeyId.
$jsonOut->put_EmitCompact(false);
print $jsonOut->emit() . "\n";

// Sample JSON result:

// {
//   "AWSAccountId": "954491834127",
//   "Arn": "arn:aws:kms:us-west-2:954491834127:key/187012e8-008f-4fc7-b100-5efe6146dff2",
//   "KeySpec": "RSA_4096",
//   "Description": "Test of uploading existing private key to AWS KMS",
//   "KeyId": "187012e8-008f-4fc7-b100-5efe6146dff2",
//   "KeyUsage": "SIGN_VERIFY"
// }

?>