(Tcl) 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 Tcl Extension Downloads Chilkat Tcl Extension Downloads

load ./chilkat.dll

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

set secrets [new_CkSecrets]

# On Windows, this is the Windows Credentials Manager
# On MacOS/iOS, it is the Apple Keychain
CkSecrets_put_Location $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.
set jsonMatch [new_CkJsonObject]

CkJsonObject_UpdateString $jsonMatch "appName" "Test*"
CkJsonObject_UpdateString $jsonMatch "service" "*"
CkJsonObject_UpdateString $jsonMatch "domain" "*"
CkJsonObject_UpdateString $jsonMatch "username" "Starfish*"

set results [new_CkJsonObject]

CkJsonObject_put_EmitCompact $results 0

set success [CkSecrets_ListSecrets $secrets $jsonMatch $results]
if {$success == 0} then {
    puts [CkSecrets_lastErrorText $secrets]
    delete_CkSecrets $secrets
    delete_CkJsonObject $jsonMatch
    delete_CkJsonObject $results
    exit
}

puts [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.

set i 0
set count_i [CkJsonObject_SizeOfArray $results "secrets"]
while {$i < $count_i} {
    CkJsonObject_put_I $results $i
    set appName [CkJsonObject_stringOf $results "secrets[i].appName"]
    set service [CkJsonObject_stringOf $results "secrets[i].service"]
    set domain [CkJsonObject_stringOf $results "secrets[i].domain"]
    set username [CkJsonObject_stringOf $results "secrets[i].username"]
    # Information field for Windows Credentials Manager.
    set targetName [CkJsonObject_stringOf $results "secrets[i].targetName"]
    # Informational fields if on MacOS using the Apple Keychain.
    set keyChainService [CkJsonObject_stringOf $results "secrets[i].keyChainService"]
    set keyChainAccount [CkJsonObject_stringOf $results "secrets[i].keyChainAccount"]
    set i [expr $i + 1]
}

delete_CkSecrets $secrets
delete_CkJsonObject $jsonMatch
delete_CkJsonObject $results