(PHP Extension) List Keys in a Microsoft Storage Provider

Demonstrates how to list the keys found in a Microsoft CNG Storage Provider, or a Legacy CryptoAPI Storage Provider.

Important: This example requires Chilkat v9.5.0.83 or greater.

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 Chilkat v9.5.0.83 or greater.

$keyCon = new CkKeyContainer();
$json = new CkJsonObject();
$json->put_EmitCompact(false);

$success = $keyCon->GetKeys('Microsoft Software Key Storage Provider',$json);
if ($success != true) {
    print $keyCon->lastErrorText() . "\n";
    exit;
}

print $json->emit() . "\n";

// Sample JSON returned by GetKeys

// If the storage provider is CNG, then each key has an "algId".
// If the storage provider is legacy CryptoAPI, then each key has a "provType" (see below)

// If the storage provider is CNG:
// {
//   "storageProvider": "Microsoft Software Key Storage Provider",
//   "key": [
//     {
//       "name": "cn=Chilkat Admin,ou=Persona Not Verified,ou=For Test Purposes Only Decryption Key",
//       "machineKey": false,
//       "algId": "ECDH_P384"
//     },
//     {
//       "name": "CD1CC265-0DA0-4230-8419-CB6F808FE688",
//       "machineKey": false,
//       "algId": "SP800_108_CTR_HMAC"
//     },
//     {
//       "name": "{FF14487C-0AED-471E-8FAD-4BF757C2195C}",
//       "machineKey": false,
//       "algId": "ECDH_P256"
//     },
//     {
//       "name": "{869FD9A6-D815-44FD-A916-4D4A708CD949}",
//       "machineKey": false,
//       "algId": "ECDH_P256"
//     },
//     {
//       "name": "D530ECA9-FF5A-4A6A-AAB3-6EC1870F2CC3",
//       "machineKey": false,
//       "algId": "SP800_108_CTR_HMAC"
//     },
//     {
//       "name": "{F524771E-93C0-4D56-8DE7-2FE3CB5BD837}",
//       "machineKey": false,
//       "algId": "RSA"
//     },
//     {
//       "name": "Microsoft Connected Devices Platform device certificate",
//       "machineKey": false,
//       "algId": "ECDSA_P256"
//     }
//   ]
// }

// If the storage provider is legacy CryptoAPI:

// {
//   "storageProvider": "Microsoft Base Cryptographic Provider v1.0",
//   "key": [
//     {
//       "name": "{48D7FF88-A52E-41E2-9EBD-0CC7E880DC65}",
//       "machineKey": false,
//       "provType": "PROV_RSA_FULL"
//     },
//     {
//       "name": "{CBF7A33A-F9CF-4C30-8A06-94A5C7981058}",
//       "machineKey": false,
//       "provType": "PROV_RSA_FULL"
//     }
//   ]
// }

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

$storageProvider = $json->stringOf('storageProvider');
$i = 0;
$count_i = $json->SizeOfArray('key');
while ($i < $count_i) {
    $json->put_I($i);
    $name = $json->stringOf('key[i].name');
    $machineKey = $json->BoolOf('key[i].machineKey');
    if ($json->HasMember('key[i].algId') == true) {
        $algId = $json->stringOf('key[i].algId');
    }

    if ($json->HasMember('key[i].provType') == true) {
        $provType = $json->stringOf('key[i].provType');
    }

    $i = $i + 1;
}


?>