Chilkat Tools

DescribeCertificateAuthority TCL Example

AWS Private CA

load ./chilkat.dll

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

set rest [new_CkRest]

set authAws [new_CkAuthAws]

CkAuthAws_put_AccessKey $authAws "AWS_ACCESS_KEY"
CkAuthAws_put_SecretKey $authAws "AWS_SECRET_KEY"

# Don't forget to change the region to your particular region. (Also make the same change in the call to Connect below.)
CkAuthAws_put_Region $authAws "us-west-2"
CkAuthAws_put_ServiceName $authAws "acm-pca"
# SetAuthAws causes Chilkat to automatically add the following headers: Authorization, X-Amz-Date
CkRest_SetAuthAws $rest $authAws

# URL: https://acm-pca.us-west-2.amazonaws.com/
# Use the same region as specified above.
set success [CkRest_Connect $rest "acm-pca.us-west-2.amazonaws.com" 443 1 1]
if {$success != 1} then {
    puts "ConnectFailReason: [CkRest_get_ConnectFailReason $rest]"
    puts [CkRest_lastErrorText $rest]
    delete_CkRest $rest
    delete_CkAuthAws $authAws
    exit
}

# The following code creates the JSON request body.
# The JSON created by this code is shown below.

# Use this online tool to generate code from sample JSON:
# Generate Code to Create JSON

set json [new_CkJsonObject]

CkJsonObject_UpdateString $json "CertificateAuthorityArn" "string"

# The JSON request body created by the above code:

# {
#   "CertificateAuthorityArn": "string"
# }

CkRest_AddHeader $rest "Content-Type" "application/x-amz-json-1.1"
CkRest_AddHeader $rest "X-Amz-Target" "ACMPrivateCA.DescribeCertificateAuthority"

set sbRequestBody [new_CkStringBuilder]

CkJsonObject_EmitSb $json $sbRequestBody
set sbResponseBody [new_CkStringBuilder]

set success [CkRest_FullRequestSb $rest "POST" "/" $sbRequestBody $sbResponseBody]
if {$success != 1} then {
    puts [CkRest_lastErrorText $rest]
    delete_CkRest $rest
    delete_CkAuthAws $authAws
    delete_CkJsonObject $json
    delete_CkStringBuilder $sbRequestBody
    delete_CkStringBuilder $sbResponseBody
    exit
}

set respStatusCode [CkRest_get_ResponseStatusCode $rest]
puts "response status code = $respStatusCode"
if {$respStatusCode != 200} then {
    puts "Response Header:"
    puts [CkRest_responseHeader $rest]
    puts "Response Body:"
    puts [CkStringBuilder_getAsString $sbResponseBody]
    delete_CkRest $rest
    delete_CkAuthAws $authAws
    delete_CkJsonObject $json
    delete_CkStringBuilder $sbRequestBody
    delete_CkStringBuilder $sbResponseBody
    exit
}

set jResp [new_CkJsonObject]

CkJsonObject_LoadSb $jResp $sbResponseBody

# The following code parses the JSON response.
# A sample JSON response is shown below the sample code.

# Use this online tool to generate parsing code from sample JSON:
# Generate Parsing Code from JSON

set Arn [CkJsonObject_stringOf $jResp "CertificateAuthority.Arn"]
set CRLSign [CkJsonObject_IntOf $jResp "CertificateAuthority.CertificateAuthorityConfiguration.CsrExtensions.KeyUsage.CRLSign"]
set DataEncipherment [CkJsonObject_IntOf $jResp "CertificateAuthority.CertificateAuthorityConfiguration.CsrExtensions.KeyUsage.DataEncipherment"]
set DecipherOnly [CkJsonObject_IntOf $jResp "CertificateAuthority.CertificateAuthorityConfiguration.CsrExtensions.KeyUsage.DecipherOnly"]
set DigitalSignature [CkJsonObject_IntOf $jResp "CertificateAuthority.CertificateAuthorityConfiguration.CsrExtensions.KeyUsage.DigitalSignature"]
set EncipherOnly [CkJsonObject_IntOf $jResp "CertificateAuthority.CertificateAuthorityConfiguration.CsrExtensions.KeyUsage.EncipherOnly"]
set KeyAgreement [CkJsonObject_IntOf $jResp "CertificateAuthority.CertificateAuthorityConfiguration.CsrExtensions.KeyUsage.KeyAgreement"]
set KeyCertSign [CkJsonObject_IntOf $jResp "CertificateAuthority.CertificateAuthorityConfiguration.CsrExtensions.KeyUsage.KeyCertSign"]
set KeyEncipherment [CkJsonObject_IntOf $jResp "CertificateAuthority.CertificateAuthorityConfiguration.CsrExtensions.KeyUsage.KeyEncipherment"]
set NonRepudiation [CkJsonObject_IntOf $jResp "CertificateAuthority.CertificateAuthorityConfiguration.CsrExtensions.KeyUsage.NonRepudiation"]
set KeyAlgorithm [CkJsonObject_stringOf $jResp "CertificateAuthority.CertificateAuthorityConfiguration.KeyAlgorithm"]
set SigningAlgorithm [CkJsonObject_stringOf $jResp "CertificateAuthority.CertificateAuthorityConfiguration.SigningAlgorithm"]
set CommonName [CkJsonObject_stringOf $jResp "CertificateAuthority.CertificateAuthorityConfiguration.Subject.CommonName"]
set Country [CkJsonObject_stringOf $jResp "CertificateAuthority.CertificateAuthorityConfiguration.Subject.Country"]
set DistinguishedNameQualifier [CkJsonObject_stringOf $jResp "CertificateAuthority.CertificateAuthorityConfiguration.Subject.DistinguishedNameQualifier"]
set GenerationQualifier [CkJsonObject_stringOf $jResp "CertificateAuthority.CertificateAuthorityConfiguration.Subject.GenerationQualifier"]
set GivenName [CkJsonObject_stringOf $jResp "CertificateAuthority.CertificateAuthorityConfiguration.Subject.GivenName"]
set Initials [CkJsonObject_stringOf $jResp "CertificateAuthority.CertificateAuthorityConfiguration.Subject.Initials"]
set Locality [CkJsonObject_stringOf $jResp "CertificateAuthority.CertificateAuthorityConfiguration.Subject.Locality"]
set Organization [CkJsonObject_stringOf $jResp "CertificateAuthority.CertificateAuthorityConfiguration.Subject.Organization"]
set OrganizationalUnit [CkJsonObject_stringOf $jResp "CertificateAuthority.CertificateAuthorityConfiguration.Subject.OrganizationalUnit"]
set Pseudonym [CkJsonObject_stringOf $jResp "CertificateAuthority.CertificateAuthorityConfiguration.Subject.Pseudonym"]
set SerialNumber [CkJsonObject_stringOf $jResp "CertificateAuthority.CertificateAuthorityConfiguration.Subject.SerialNumber"]
set State [CkJsonObject_stringOf $jResp "CertificateAuthority.CertificateAuthorityConfiguration.Subject.State"]
set Surname [CkJsonObject_stringOf $jResp "CertificateAuthority.CertificateAuthorityConfiguration.Subject.Surname"]
set Title [CkJsonObject_stringOf $jResp "CertificateAuthority.CertificateAuthorityConfiguration.Subject.Title"]
set CreatedAt [CkJsonObject_IntOf $jResp "CertificateAuthority.CreatedAt"]
set FailureReason [CkJsonObject_stringOf $jResp "CertificateAuthority.FailureReason"]
set KeyStorageSecurityStandard [CkJsonObject_stringOf $jResp "CertificateAuthority.KeyStorageSecurityStandard"]
set LastStateChangeAt [CkJsonObject_IntOf $jResp "CertificateAuthority.LastStateChangeAt"]
set NotAfter [CkJsonObject_IntOf $jResp "CertificateAuthority.NotAfter"]
set NotBefore [CkJsonObject_IntOf $jResp "CertificateAuthority.NotBefore"]
set OwnerAccount [CkJsonObject_stringOf $jResp "CertificateAuthority.OwnerAccount"]
set RestorableUntil [CkJsonObject_IntOf $jResp "CertificateAuthority.RestorableUntil"]
set CustomCname [CkJsonObject_stringOf $jResp "CertificateAuthority.RevocationConfiguration.CrlConfiguration.CustomCname"]
set Enabled [CkJsonObject_IntOf $jResp "CertificateAuthority.RevocationConfiguration.CrlConfiguration.Enabled"]
set ExpirationInDays [CkJsonObject_IntOf $jResp "CertificateAuthority.RevocationConfiguration.CrlConfiguration.ExpirationInDays"]
set S3BucketName [CkJsonObject_stringOf $jResp "CertificateAuthority.RevocationConfiguration.CrlConfiguration.S3BucketName"]
set S3ObjectAcl [CkJsonObject_stringOf $jResp "CertificateAuthority.RevocationConfiguration.CrlConfiguration.S3ObjectAcl"]
set OcspConfigurationEnabled [CkJsonObject_IntOf $jResp "CertificateAuthority.RevocationConfiguration.OcspConfiguration.Enabled"]
set OcspCustomCname [CkJsonObject_stringOf $jResp "CertificateAuthority.RevocationConfiguration.OcspConfiguration.OcspCustomCname"]
set Serial [CkJsonObject_stringOf $jResp "CertificateAuthority.Serial"]
set Status [CkJsonObject_stringOf $jResp "CertificateAuthority.Status"]
set v_Type [CkJsonObject_stringOf $jResp "CertificateAuthority.Type"]
set i 0
set count_i [CkJsonObject_SizeOfArray $jResp "CertificateAuthority.CertificateAuthorityConfiguration.CsrExtensions.SubjectInformationAccess"]
while {$i < $count_i} {
    CkJsonObject_put_I $jResp $i
    set DirectoryNameCommonName [CkJsonObject_stringOf $jResp "CertificateAuthority.CertificateAuthorityConfiguration.CsrExtensions.SubjectInformationAccess[i].AccessLocation.DirectoryName.CommonName"]
    set DirectoryNameCountry [CkJsonObject_stringOf $jResp "CertificateAuthority.CertificateAuthorityConfiguration.CsrExtensions.SubjectInformationAccess[i].AccessLocation.DirectoryName.Country"]
    set DirectoryNameDistinguishedNameQualifier [CkJsonObject_stringOf $jResp "CertificateAuthority.CertificateAuthorityConfiguration.CsrExtensions.SubjectInformationAccess[i].AccessLocation.DirectoryName.DistinguishedNameQualifier"]
    set DirectoryNameGenerationQualifier [CkJsonObject_stringOf $jResp "CertificateAuthority.CertificateAuthorityConfiguration.CsrExtensions.SubjectInformationAccess[i].AccessLocation.DirectoryName.GenerationQualifier"]
    set DirectoryNameGivenName [CkJsonObject_stringOf $jResp "CertificateAuthority.CertificateAuthorityConfiguration.CsrExtensions.SubjectInformationAccess[i].AccessLocation.DirectoryName.GivenName"]
    set DirectoryNameInitials [CkJsonObject_stringOf $jResp "CertificateAuthority.CertificateAuthorityConfiguration.CsrExtensions.SubjectInformationAccess[i].AccessLocation.DirectoryName.Initials"]
    set DirectoryNameLocality [CkJsonObject_stringOf $jResp "CertificateAuthority.CertificateAuthorityConfiguration.CsrExtensions.SubjectInformationAccess[i].AccessLocation.DirectoryName.Locality"]
    set DirectoryNameOrganization [CkJsonObject_stringOf $jResp "CertificateAuthority.CertificateAuthorityConfiguration.CsrExtensions.SubjectInformationAccess[i].AccessLocation.DirectoryName.Organization"]
    set DirectoryNameOrganizationalUnit [CkJsonObject_stringOf $jResp "CertificateAuthority.CertificateAuthorityConfiguration.CsrExtensions.SubjectInformationAccess[i].AccessLocation.DirectoryName.OrganizationalUnit"]
    set DirectoryNamePseudonym [CkJsonObject_stringOf $jResp "CertificateAuthority.CertificateAuthorityConfiguration.CsrExtensions.SubjectInformationAccess[i].AccessLocation.DirectoryName.Pseudonym"]
    set DirectoryNameSerialNumber [CkJsonObject_stringOf $jResp "CertificateAuthority.CertificateAuthorityConfiguration.CsrExtensions.SubjectInformationAccess[i].AccessLocation.DirectoryName.SerialNumber"]
    set DirectoryNameState [CkJsonObject_stringOf $jResp "CertificateAuthority.CertificateAuthorityConfiguration.CsrExtensions.SubjectInformationAccess[i].AccessLocation.DirectoryName.State"]
    set DirectoryNameSurname [CkJsonObject_stringOf $jResp "CertificateAuthority.CertificateAuthorityConfiguration.CsrExtensions.SubjectInformationAccess[i].AccessLocation.DirectoryName.Surname"]
    set DirectoryNameTitle [CkJsonObject_stringOf $jResp "CertificateAuthority.CertificateAuthorityConfiguration.CsrExtensions.SubjectInformationAccess[i].AccessLocation.DirectoryName.Title"]
    set DnsName [CkJsonObject_stringOf $jResp "CertificateAuthority.CertificateAuthorityConfiguration.CsrExtensions.SubjectInformationAccess[i].AccessLocation.DnsName"]
    set NameAssigner [CkJsonObject_stringOf $jResp "CertificateAuthority.CertificateAuthorityConfiguration.CsrExtensions.SubjectInformationAccess[i].AccessLocation.EdiPartyName.NameAssigner"]
    set PartyName [CkJsonObject_stringOf $jResp "CertificateAuthority.CertificateAuthorityConfiguration.CsrExtensions.SubjectInformationAccess[i].AccessLocation.EdiPartyName.PartyName"]
    set IpAddress [CkJsonObject_stringOf $jResp "CertificateAuthority.CertificateAuthorityConfiguration.CsrExtensions.SubjectInformationAccess[i].AccessLocation.IpAddress"]
    set TypeId [CkJsonObject_stringOf $jResp "CertificateAuthority.CertificateAuthorityConfiguration.CsrExtensions.SubjectInformationAccess[i].AccessLocation.OtherName.TypeId"]
    set Value [CkJsonObject_stringOf $jResp "CertificateAuthority.CertificateAuthorityConfiguration.CsrExtensions.SubjectInformationAccess[i].AccessLocation.OtherName.Value"]
    set RegisteredId [CkJsonObject_stringOf $jResp "CertificateAuthority.CertificateAuthorityConfiguration.CsrExtensions.SubjectInformationAccess[i].AccessLocation.RegisteredId"]
    set Rfc822Name [CkJsonObject_stringOf $jResp "CertificateAuthority.CertificateAuthorityConfiguration.CsrExtensions.SubjectInformationAccess[i].AccessLocation.Rfc822Name"]
    set UniformResourceIdentifier [CkJsonObject_stringOf $jResp "CertificateAuthority.CertificateAuthorityConfiguration.CsrExtensions.SubjectInformationAccess[i].AccessLocation.UniformResourceIdentifier"]
    set AccessMethodType [CkJsonObject_stringOf $jResp "CertificateAuthority.CertificateAuthorityConfiguration.CsrExtensions.SubjectInformationAccess[i].AccessMethod.AccessMethodType"]
    set CustomObjectIdentifier [CkJsonObject_stringOf $jResp "CertificateAuthority.CertificateAuthorityConfiguration.CsrExtensions.SubjectInformationAccess[i].AccessMethod.CustomObjectIdentifier"]
    set i [expr $i + 1]
}

# A sample JSON response body parsed by the above code:

# {
#   "CertificateAuthority": {
#     "Arn": "string",
#     "CertificateAuthorityConfiguration": {
#       "CsrExtensions": {
#         "KeyUsage": {
#           "CRLSign": boolean,
#           "DataEncipherment": boolean,
#           "DecipherOnly": boolean,
#           "DigitalSignature": boolean,
#           "EncipherOnly": boolean,
#           "KeyAgreement": boolean,
#           "KeyCertSign": boolean,
#           "KeyEncipherment": boolean,
#           "NonRepudiation": boolean
#         },
#         "SubjectInformationAccess": [
#           {
#             "AccessLocation": {
#               "DirectoryName": {
#                 "CommonName": "string",
#                 "Country": "string",
#                 "DistinguishedNameQualifier": "string",
#                 "GenerationQualifier": "string",
#                 "GivenName": "string",
#                 "Initials": "string",
#                 "Locality": "string",
#                 "Organization": "string",
#                 "OrganizationalUnit": "string",
#                 "Pseudonym": "string",
#                 "SerialNumber": "string",
#                 "State": "string",
#                 "Surname": "string",
#                 "Title": "string"
#               },
#               "DnsName": "string",
#               "EdiPartyName": {
#                 "NameAssigner": "string",
#                 "PartyName": "string"
#               },
#               "IpAddress": "string",
#               "OtherName": {
#                 "TypeId": "string",
#                 "Value": "string"
#               },
#               "RegisteredId": "string",
#               "Rfc822Name": "string",
#               "UniformResourceIdentifier": "string"
#             },
#             "AccessMethod": {
#               "AccessMethodType": "string",
#               "CustomObjectIdentifier": "string"
#             }
#           }
#         ]
#       },
#       "KeyAlgorithm": "string",
#       "SigningAlgorithm": "string",
#       "Subject": {
#         "CommonName": "string",
#         "Country": "string",
#         "DistinguishedNameQualifier": "string",
#         "GenerationQualifier": "string",
#         "GivenName": "string",
#         "Initials": "string",
#         "Locality": "string",
#         "Organization": "string",
#         "OrganizationalUnit": "string",
#         "Pseudonym": "string",
#         "SerialNumber": "string",
#         "State": "string",
#         "Surname": "string",
#         "Title": "string"
#       }
#     },
#     "CreatedAt": number,
#     "FailureReason": "string",
#     "KeyStorageSecurityStandard": "string",
#     "LastStateChangeAt": number,
#     "NotAfter": number,
#     "NotBefore": number,
#     "OwnerAccount": "string",
#     "RestorableUntil": number,
#     "RevocationConfiguration": {
#       "CrlConfiguration": {
#         "CustomCname": "string",
#         "Enabled": boolean,
#         "ExpirationInDays": number,
#         "S3BucketName": "string",
#         "S3ObjectAcl": "string"
#       },
#       "OcspConfiguration": {
#         "Enabled": boolean,
#         "OcspCustomCname": "string"
#       }
#     },
#     "Serial": "string",
#     "Status": "string",
#     "Type": "string"
#   }
# }

delete_CkRest $rest
delete_CkAuthAws $authAws
delete_CkJsonObject $json
delete_CkStringBuilder $sbRequestBody
delete_CkStringBuilder $sbResponseBody
delete_CkJsonObject $jResp
Chilkat Online Tools

DescribeCertificateAuthority TCL Example

AWS Private CA
