(PowerBuilder) 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 ActiveX Downloads ActiveX for 32-bit and 64-bit Windows

integer li_rc
oleobject loo_Secrets
oleobject loo_JsonMatch
oleobject loo_Results
integer li_Success
string ls_AppName
string ls_Service
string ls_Domain
string ls_Username
string ls_TargetName
string ls_KeyChainService
string ls_KeyChainAccount
integer i
integer li_Count_i

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

loo_Secrets = create oleobject
// Use "Chilkat_9_5_0.Secrets" for versions of Chilkat < 10.0.0
li_rc = loo_Secrets.ConnectToNewObject("Chilkat.Secrets")
if li_rc < 0 then
    destroy loo_Secrets
    MessageBox("Error","Connecting to COM object failed")
    return
end if

// On Windows, this is the Windows Credentials Manager
// On MacOS/iOS, it is the Apple Keychain
loo_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.
loo_JsonMatch = create oleobject
// Use "Chilkat_9_5_0.JsonObject" for versions of Chilkat < 10.0.0
li_rc = loo_JsonMatch.ConnectToNewObject("Chilkat.JsonObject")

loo_JsonMatch.UpdateString("appName","Test*")
loo_JsonMatch.UpdateString("service","*")
loo_JsonMatch.UpdateString("domain","*")
loo_JsonMatch.UpdateString("username","Starfish*")

loo_Results = create oleobject
// Use "Chilkat_9_5_0.JsonObject" for versions of Chilkat < 10.0.0
li_rc = loo_Results.ConnectToNewObject("Chilkat.JsonObject")

loo_Results.EmitCompact = 0

li_Success = loo_Secrets.ListSecrets(loo_JsonMatch,loo_Results)
if li_Success = 0 then
    Write-Debug loo_Secrets.LastErrorText
    destroy loo_Secrets
    destroy loo_JsonMatch
    destroy loo_Results
    return
end if

Write-Debug loo_Results.Emit()

// 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
li_Count_i = loo_Results.SizeOfArray("secrets")
do while i < li_Count_i
    loo_Results.I = i
    ls_AppName = loo_Results.StringOf("secrets[i].appName")
    ls_Service = loo_Results.StringOf("secrets[i].service")
    ls_Domain = loo_Results.StringOf("secrets[i].domain")
    ls_Username = loo_Results.StringOf("secrets[i].username")
    // Information field for Windows Credentials Manager.
    ls_TargetName = loo_Results.StringOf("secrets[i].targetName")
    // Informational fields if on MacOS using the Apple Keychain.
    ls_KeyChainService = loo_Results.StringOf("secrets[i].keyChainService")
    ls_KeyChainAccount = loo_Results.StringOf("secrets[i].keyChainAccount")
    i = i + 1
loop


destroy loo_Secrets
destroy loo_JsonMatch
destroy loo_Results