C

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.

C

#include <C_CkSecrets.h>
#include <C_CkJsonObject.h>

void ChilkatSample(void)
    {
    BOOL success;
    HCkSecrets secrets;
    HCkJsonObject jsonMatch;
    HCkJsonObject results;
    const char *appName;
    const char *service;
    const char *domain;
    const char *username;
    const char *targetName;
    const char *keyChainService;
    const char *keyChainAccount;
    int i;
    int count_i;

    success = FALSE;

    // 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) {
        printf("%s\n",CkSecrets_lastErrorText(secrets));
        CkSecrets_Dispose(secrets);
        CkJsonObject_Dispose(jsonMatch);
        CkJsonObject_Dispose(results);
        return;
    }

    printf("%s\n",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) {
        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;
    }



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

    }