Xbase++

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.

Xbase++

LOCAL nSuccess
LOCAL oSecrets
LOCAL oJsonMatch
LOCAL oResults
LOCAL cAppName
LOCAL cService
LOCAL cDomain
LOCAL cUsername
LOCAL cTargetName
LOCAL cKeyChainService
LOCAL cKeyChainAccount
LOCAL i
LOCAL nCount_i

nSuccess := 0

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

oSecrets := CreateObject("Chilkat.Secrets")

//  On Windows, this is the Windows Credentials Manager
//  On MacOS/iOS, it is the Apple Keychain
oSecrets: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.
oJsonMatch := CreateObject("Chilkat.JsonObject")
oJsonMatch:UpdateString("appName", "Test*")
oJsonMatch:UpdateString("service", "*")
oJsonMatch:UpdateString("domain", "*")
oJsonMatch:UpdateString("username", "Starfish*")

oResults := CreateObject("Chilkat.JsonObject")
oResults:EmitCompact := 0

nSuccess := oSecrets:ListSecrets(oJsonMatch, oResults)
IF (nSuccess == 0)
    ? oSecrets:LastErrorText
    oSecrets:destroy()
    oJsonMatch:destroy()
    oResults:destroy()
    RETURN
ENDIF

? oResults: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
nCount_i := oResults:SizeOfArray("secrets")
DO WHILE i < nCount_i
    oResults:I := i
    cAppName := oResults:StringOf("secrets[i].appName")
    cService := oResults:StringOf("secrets[i].service")
    cDomain := oResults:StringOf("secrets[i].domain")
    cUsername := oResults:StringOf("secrets[i].username")
    //  Information field for Windows Credentials Manager.
    cTargetName := oResults:StringOf("secrets[i].targetName")
    //  Informational fields if on MacOS using the Apple Keychain.
    cKeyChainService := oResults:StringOf("secrets[i].keyChainService")
    cKeyChainAccount := oResults:StringOf("secrets[i].keyChainAccount")
    i := i + 1
ENDDO

oSecrets:destroy()
oJsonMatch:destroy()
oResults:destroy()