(Lianja) 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 Lianja Extension Download Chilkat Lianja Extension

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

loSecrets = createobject("CkSecrets")

// On Windows, this is the Windows Credentials Manager
// On MacOS/iOS, it is the Apple Keychain
loSecrets.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.
loJsonMatch = createobject("CkJsonObject")
loJsonMatch.UpdateString("appName","Test*")
loJsonMatch.UpdateString("service","*")
loJsonMatch.UpdateString("domain","*")
loJsonMatch.UpdateString("username","Starfish*")

loResults = createobject("CkJsonObject")
loResults.EmitCompact = .F.

llSuccess = loSecrets.ListSecrets(loJsonMatch,loResults)
if (llSuccess = .F.) then
    ? loSecrets.LastErrorText
    release loSecrets
    release loJsonMatch
    release loResults
    return
endif

? loResults.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
lnCount_i = loResults.SizeOfArray("secrets")
do while i < lnCount_i
    loResults.I = i
    lcAppName = loResults.StringOf("secrets[i].appName")
    lcService = loResults.StringOf("secrets[i].service")
    lcDomain = loResults.StringOf("secrets[i].domain")
    lcUsername = loResults.StringOf("secrets[i].username")
    // Information field for Windows Credentials Manager.
    lcTargetName = loResults.StringOf("secrets[i].targetName")
    // Informational fields if on MacOS using the Apple Keychain.
    lcKeyChainService = loResults.StringOf("secrets[i].keyChainService")
    lcKeyChainAccount = loResults.StringOf("secrets[i].keyChainAccount")
    i = i + 1
enddo


release loSecrets
release loJsonMatch
release loResults