(Delphi DLL) 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.

For more information, see https://cknotes.com/chilkat-secrets-class-added-in-version-10-1-0/

Chilkat for Delphi Downloads Chilkat non-ActiveX DLL for Delphi Chilkat ActiveX DLL for Delphi * The examples here use the non-ActiveX DLL.

uses
    Winapi.Windows, Winapi.Messages, System.SysUtils, System.Variants, System.Classes, Vcl.Graphics,
    Vcl.Controls, Vcl.Forms, Vcl.Dialogs, Vcl.StdCtrls, Secrets, JsonObject;

...

procedure TForm1.Button1Click(Sender: TObject);
var
secrets: HCkSecrets;
jsonMatch: HCkJsonObject;
results: HCkJsonObject;
success: Boolean;
appName: PWideChar;
service: PWideChar;
domain: PWideChar;
username: PWideChar;
targetName: PWideChar;
keyChainService: PWideChar;
keyChainAccount: PWideChar;
i: Integer;
count_i: Integer;

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

secrets := CkSecrets_Create();

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

results := CkJsonObject_Create();
CkJsonObject_putEmitCompact(results,False);

success := CkSecrets_ListSecrets(secrets,jsonMatch,results);
if (success = False) then
  begin
    Memo1.Lines.Add(CkSecrets__lastErrorText(secrets));
    Exit;
  end;

Memo1.Lines.Add(CkJsonObject__emit(results));

// 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 := CkJsonObject_SizeOfArray(results,'secrets');
while i < count_i do
  begin
    CkJsonObject_putI(results,i);
    appName := CkJsonObject__stringOf(results,'secrets[i].appName');
    service := CkJsonObject__stringOf(results,'secrets[i].service');
    domain := CkJsonObject__stringOf(results,'secrets[i].domain');
    username := CkJsonObject__stringOf(results,'secrets[i].username');
    // Information field for Windows Credentials Manager.
    targetName := CkJsonObject__stringOf(results,'secrets[i].targetName');
    // Informational fields if on MacOS using the Apple Keychain.
    keyChainService := CkJsonObject__stringOf(results,'secrets[i].keyChainService');
    keyChainAccount := CkJsonObject__stringOf(results,'secrets[i].keyChainAccount');
    i := i + 1;
  end;

CkSecrets_Dispose(secrets);
CkJsonObject_Dispose(jsonMatch);
CkJsonObject_Dispose(results);

end;