(Tcl) 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 Tcl Extension Downloads Chilkat Tcl Extension Downloads

load ./chilkat.dll

# 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..
set cert [new_CkCert]

set success [CkCert_LoadPfxFile $cert "qa_data/pfx/myCertAndKey.pfx" "pfx_password"]
if {$success == 0} then {
    puts [CkCert_lastErrorText $cert]
    delete_CkCert $cert
    exit
}

# Get the cert's private key.  This is what will be uploaded to AWS KMS.
# privKey is a CkPrivateKey
set privKey [CkCert_ExportPrivateKey $cert]
if {[CkCert_get_LastMethodSuccess $cert] == 0} then {
    puts "The certificate does not have a private key."
    delete_CkCert $cert
    exit
}

set json [new_CkJsonObject]

CkJsonObject_UpdateString $json "service" "aws-kms"
CkJsonObject_UpdateString $json "auth.access_key" "AWS_ACCESS_KEY"
CkJsonObject_UpdateString $json "auth.secret_key" "AWS_SECRET_KEY"
CkJsonObject_UpdateString $json "auth.region" "us-west-2"
CkJsonObject_UpdateString $json "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.
CkJsonObject_UpdateString $json "tags[0].key" "CertSerial"
CkJsonObject_UpdateString $json "tags[0].value" [CkCert_serialNumber $cert]
CkJsonObject_UpdateString $json "tags[1].key" "CertIssuer"
CkJsonObject_UpdateString $json "tags[1].value" [CkCert_issuerCN $cert]
CkJsonObject_UpdateString $json "tags[2].key" "CertSubject"
CkJsonObject_UpdateString $json "tags[2].value" [CkCert_subjectCN $cert]

CkJsonObject_UpdateString $json "keyUsage" "SIGN_VERIFY"

# The UploadToCloud method was added in Chilkat v9.5.0.96
set jsonOut [new_CkJsonObject]

set success [CkPrivateKey_UploadToCloud $privKey $json $jsonOut]
if {$success == 0} then {
    puts [CkPrivateKey_lastErrorText $privKey]
    delete_CkPrivateKey $privKey

    delete_CkCert $cert
    delete_CkJsonObject $json
    delete_CkJsonObject $jsonOut
    exit
}

delete_CkPrivateKey $privKey

# When successful, the jsonOut contains information about the private key in AWS KMS.
# Most importantly, the KeyId.
CkJsonObject_put_EmitCompact $jsonOut 0
puts [CkJsonObject_emit $jsonOut]

# 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"
# }

delete_CkCert $cert
delete_CkJsonObject $json
delete_CkJsonObject $jsonOut