Chilkat Online Tools

DescribeKey phpExt Example

AWS Key Management Service

<?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.

$rest = new CkRest();

$authAws = new CkAuthAws();
$authAws->put_AccessKey('AWS_ACCESS_KEY');
$authAws->put_SecretKey('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.)
$authAws->put_Region('us-west-2');
$authAws->put_ServiceName('kms');
// SetAuthAws causes Chilkat to automatically add the following headers: Authorization, X-Amz-Date
$rest->SetAuthAws($authAws);

// URL: https://kms.us-west-2.amazonaws.com/
// Use the same region as specified above.
$success = $rest->Connect('kms.us-west-2.amazonaws.com',443,true,true);
if ($success != true) {
    print 'ConnectFailReason: ' . $rest->get_ConnectFailReason() . "\n";
    print $rest->lastErrorText() . "\n";
    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

$json = new CkJsonObject();
$json->UpdateString('GrantTokens[0]','string');
$json->UpdateString('KeyId','string');

// The JSON request body created by the above code:

// {
//   "GrantTokens": [
//     "string"
//   ],
//   "KeyId": "string"
// }

$rest->AddHeader('Content-Type','application/x-amz-json-1.1');
$rest->AddHeader('X-Amz-Target','TrentService.DescribeKey');

$sbRequestBody = new CkStringBuilder();
$json->EmitSb($sbRequestBody);
$sbResponseBody = new CkStringBuilder();
$success = $rest->FullRequestSb('POST','/',$sbRequestBody,$sbResponseBody);
if ($success != true) {
    print $rest->lastErrorText() . "\n";
    exit;
}

$respStatusCode = $rest->get_ResponseStatusCode();
print 'response status code = ' . $respStatusCode . "\n";
if ($respStatusCode != 200) {
    print 'Response Header:' . "\n";
    print $rest->responseHeader() . "\n";
    print 'Response Body:' . "\n";
    print $sbResponseBody->getAsString() . "\n";
    exit;
}

$jResp = new CkJsonObject();
$jResp->LoadSb($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

$Arn = $jResp->stringOf('KeyMetadata.Arn');
$AWSAccountId = $jResp->stringOf('KeyMetadata.AWSAccountId');
$CloudHsmClusterId = $jResp->stringOf('KeyMetadata.CloudHsmClusterId');
$CreationDate = $jResp->IntOf('KeyMetadata.CreationDate');
$CustomerMasterKeySpec = $jResp->stringOf('KeyMetadata.CustomerMasterKeySpec');
$CustomKeyStoreId = $jResp->stringOf('KeyMetadata.CustomKeyStoreId');
$DeletionDate = $jResp->IntOf('KeyMetadata.DeletionDate');
$Description = $jResp->stringOf('KeyMetadata.Description');
$Enabled = $jResp->IntOf('KeyMetadata.Enabled');
$ExpirationModel = $jResp->stringOf('KeyMetadata.ExpirationModel');
$KeyId = $jResp->stringOf('KeyMetadata.KeyId');
$KeyManager = $jResp->stringOf('KeyMetadata.KeyManager');
$KeySpec = $jResp->stringOf('KeyMetadata.KeySpec');
$KeyState = $jResp->stringOf('KeyMetadata.KeyState');
$KeyUsage = $jResp->stringOf('KeyMetadata.KeyUsage');
$MultiRegion = $jResp->IntOf('KeyMetadata.MultiRegion');
$MultiRegionKeyType = $jResp->stringOf('KeyMetadata.MultiRegionConfiguration.MultiRegionKeyType');
$PrimaryKeyArn = $jResp->stringOf('KeyMetadata.MultiRegionConfiguration.PrimaryKey.Arn');
$Region = $jResp->stringOf('KeyMetadata.MultiRegionConfiguration.PrimaryKey.Region');
$Origin = $jResp->stringOf('KeyMetadata.Origin');
$PendingDeletionWindowInDays = $jResp->IntOf('KeyMetadata.PendingDeletionWindowInDays');
$ValidTo = $jResp->IntOf('KeyMetadata.ValidTo');
$i = 0;
$count_i = $jResp->SizeOfArray('KeyMetadata.EncryptionAlgorithms');
while ($i < $count_i) {
    $jResp->put_I($i);
    $strVal = $jResp->stringOf('KeyMetadata.EncryptionAlgorithms[i]');
    $i = $i + 1;
}

$i = 0;
$count_i = $jResp->SizeOfArray('KeyMetadata.MacAlgorithms');
while ($i < $count_i) {
    $jResp->put_I($i);
    $strVal = $jResp->stringOf('KeyMetadata.MacAlgorithms[i]');
    $i = $i + 1;
}

$i = 0;
$count_i = $jResp->SizeOfArray('KeyMetadata.MultiRegionConfiguration.ReplicaKeys');
while ($i < $count_i) {
    $jResp->put_I($i);
    $Arn = $jResp->stringOf('KeyMetadata.MultiRegionConfiguration.ReplicaKeys[i].Arn');
    $Region = $jResp->stringOf('KeyMetadata.MultiRegionConfiguration.ReplicaKeys[i].Region');
    $i = $i + 1;
}

$i = 0;
$count_i = $jResp->SizeOfArray('KeyMetadata.SigningAlgorithms');
while ($i < $count_i) {
    $jResp->put_I($i);
    $strVal = $jResp->stringOf('KeyMetadata.SigningAlgorithms[i]');
    $i = $i + 1;
}

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

// {
//   "KeyMetadata": {
//     "Arn": "string",
//     "AWSAccountId": "string",
//     "CloudHsmClusterId": "string",
//     "CreationDate": number,
//     "CustomerMasterKeySpec": "string",
//     "CustomKeyStoreId": "string",
//     "DeletionDate": number,
//     "Description": "string",
//     "Enabled": boolean,
//     "EncryptionAlgorithms": [
//       "string"
//     ],
//     "ExpirationModel": "string",
//     "KeyId": "string",
//     "KeyManager": "string",
//     "KeySpec": "string",
//     "KeyState": "string",
//     "KeyUsage": "string",
//     "MacAlgorithms": [
//       "string"
//     ],
//     "MultiRegion": boolean,
//     "MultiRegionConfiguration": {
//       "MultiRegionKeyType": "string",
//       "PrimaryKey": {
//         "Arn": "string",
//         "Region": "string"
//       },
//       "ReplicaKeys": [
//         {
//           "Arn": "string",
//           "Region": "string"
//         }
//       ]
//     },
//     "Origin": "string",
//     "PendingDeletionWindowInDays": number,
//     "SigningAlgorithms": [
//       "string"
//     ],
//     "ValidTo": number
//   }
// }

?>