(PHP Extension) Get a .pfx/.p12 Safe Bag Attribute

Demonstrates how to get the value of a private key or certificate safe bag attribute. Safe bag attributes are associated with a key or certificate. They are attributes stored in the .p12/.pfx alongside a key or certificate.

Note: 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");

$pfx = new CkPfx();

$success = $pfx->LoadPfxFile('qa_data/pfx/test_ecdsa_secret.pfx','secret');
if ($success == false) {
    print $pfx->lastErrorText() . "\n";
    exit;
}

// json is a CkJsonObject
$json = $pfx->LastJsonData();
$json->put_EmitCompact(false);
print $json->emit() . "\n";

// The LastJsonData provides information about the what is contained in the PFX after loading.
// For example:

// {
//   "authenticatedSafe": {
//     "contentInfo": [
//       {
//         "type": "Data",
//         "safeBag": [
//           {
//             "type": "pkcs8ShroudedKeyBag",
//             "attrs": {
//               "localKeyId": "16777216",
//               "keyContainerName": "{B99EB9E7-6AF7-42AF-A43A-D4B2225B7605}",
//               "msStorageProvider": "Microsoft Software Key Storage Provider"
//             }
//           }
//         ]
//       },
//       {
//         "type": "EncryptedData",
//         "safeBag": [
//           {
//             "type": "certBag",
//             "attrs": {
//               "localKeyId": "16777216"
//             },
//             "subject": "EE",
//             "serialNumber": "1a9da86df17ad411bb413b2aa724fe56fc71242d"
//           },
//           {
//             "type": "certBag",
//             "subject": "CA",
//             "serialNumber": "02742228acbf3dd2e71f403abd8281ab6d70d490"
//           }
//         ]
//       }
//     ]
//   }
// }

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

// In the above JSON, we can see the .pfx contains one private key (a pkcs8ShroudedKeyBag) and two certificates (each in a certBag).
// The certificates in a .pfx/.p12 are typicaly a single certificate with associated private key, along with the other certificates
// in the chain of authentication.

// We can see that the private key has 3 safebag attributes: localKeyId, keyContainerName, and msStorageProvider.
// The certificate associated with the private key contains one safebag attribute: localKeyId.
// Notice the localKeyId is the same.  The localKeyId helps associate the private key that corresponds to the given certificate.

// Let's demonstrate the GetSafeBagAttr method:

// Get each of the private key safebag attributes:
$getPrivateKeyAttr = true;
$privateKeyIdx = 0;
print '---- private key safebag attributes ----' . "\n";
print $pfx->getSafeBagAttr($getPrivateKeyAttr,$privateKeyIdx,'localKeyId') . "\n";
print $pfx->getSafeBagAttr($getPrivateKeyAttr,$privateKeyIdx,'keyContainerName') . "\n";
print $pfx->getSafeBagAttr($getPrivateKeyAttr,$privateKeyIdx,'storageProvider') . "\n";

// Get the localKeyId attribute for the 1st certificate.
$getPrivateKeyAttr = false;
print '---- cert safebag attributes ----' . "\n";
print $pfx->getSafeBagAttr($getPrivateKeyAttr,0,'localKeyId') . "\n";

?>