PHP Extension

Windows Credentials Manager / Apple Keychain - List Matching Secrets

See more Secrets Examples

List secrets matching one or more wildcarded names for app, service, domain, and username.

Note: This example requires Chilkat v10.1.0 or later.

PHP Extension

<?php

include("chilkat.php");

$success = false;

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

$secrets = new CkSecrets();

// On Windows, this is the Windows Credentials Manager
// On MacOS/iOS, it is the Apple Keychain
$secrets->put_Location('local_manager');

// Set wildcarded or exact values for appName, service, domain, and username.
// Omit any members where anything is allowed to match, or alternatively specify "*" to match anything.
$jsonMatch = new CkJsonObject();
$jsonMatch->UpdateString('appName','Test*');
$jsonMatch->UpdateString('service','*');
$jsonMatch->UpdateString('domain','*');
$jsonMatch->UpdateString('username','Starfish*');

$results = new CkJsonObject();
$results->put_EmitCompact(false);

$success = $secrets->ListSecrets($jsonMatch,$results);
if ($success == false) {
    print $secrets->lastErrorText() . "\n";
    exit;
}

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

// Sample output on Windows.
// The "targetName" is purely informational and indicates the raw TargetName of the secret (i.e. Credential) stored in the Credentials Manager.

// {
//   "secrets": [
//     {
//       "appName": "Test2",
//       "service": "Custom",
//       "domain": "Ocean",
//       "username": "Starfish20",
//       "targetName": "Test2/Custom/Ocean/Starfish20"
//     },
//     {
//       "appName": "Test2",
//       "service": "Custom",
//       "domain": "Ocean",
//       "username": "Starfish",
//       "targetName": "Test2/Custom/Ocean/Starfish"
//     }
//   ]
// }

// ---------------------------------------------------------------------------------------
// Here's sample code for parsing the JSON list of secrets.

$i = 0;
$count_i = $results->SizeOfArray('secrets');
while ($i < $count_i) {
    $results->put_I($i);
    $appName = $results->stringOf('secrets[i].appName');
    $service = $results->stringOf('secrets[i].service');
    $domain = $results->stringOf('secrets[i].domain');
    $username = $results->stringOf('secrets[i].username');
    // Information field for Windows Credentials Manager.
    $targetName = $results->stringOf('secrets[i].targetName');
    // Informational fields if on MacOS using the Apple Keychain.
    $keyChainService = $results->stringOf('secrets[i].keyChainService');
    $keyChainAccount = $results->stringOf('secrets[i].keyChainAccount');
    $i = $i + 1;
}


?>