PHP

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.

Chilkat2 PHP

<?php

use Chilkat2\JsonObject;
use Chilkat2\Secrets;

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

$secrets = new Secrets();

// On Windows, this is the Windows Credentials Manager
// On MacOS/iOS, it is the Apple Keychain
$secrets->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 JsonObject();
$jsonMatch->UpdateString('appName', 'Test*');
$jsonMatch->UpdateString('service', '*');
$jsonMatch->UpdateString('domain', '*');
$jsonMatch->UpdateString('username', 'Starfish*');

$results = new JsonObject();
$results->EmitCompact = false;

try {
    $secrets->ListSecrets($jsonMatch, $results);
} catch (\Chilkat2\Exception $e) {
    echo $e->getMessage(), "\n";
    exit;
}

echo $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.

$appName = '';
$service = '';
$domain = '';
$username = '';
$targetName = '';
$keyChainService = '';
$keyChainAccount = '';

$i = 0;
$count_i = $results->SizeOfArray('secrets');
while ($i < $count_i) {
    $results->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;
}