(Node.js) 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/

Install Chilkat for Node.js and Electron using npm at Chilkat npm packages for Node.js Chilkat npm packages for Electron on Windows, Linux, MacOSX, and ARM

var os = require('os');
if (os.platform() == 'win32') {  
    if (os.arch() == 'ia32') {
        var chilkat = require('@chilkat/ck-node21-win-ia32');
    } else {
        var chilkat = require('@chilkat/ck-node21-win64'); 
    }
} else if (os.platform() == 'linux') {
    if (os.arch() == 'arm') {
        var chilkat = require('@chilkat/ck-node21-arm');
    } else if (os.arch() == 'x86') {
        var chilkat = require('@chilkat/ck-node21-linux32');
    } else {
        var chilkat = require('@chilkat/ck-node21-linux64');
    }
} else if (os.platform() == 'darwin') {
    if (os.arch() == 'arm64') {
        var chilkat = require('@chilkat/ck-node21-mac-m1');
    } else {
        var chilkat = require('@chilkat/ck-node21-macosx');
    }
}

function chilkatExample() {

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

    var secrets = new chilkat.Secrets();

    // On Windows, this is the Windows Credentials Manager
    // On MacOS/iOS, it is the Apple Keychain
    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.
    var jsonMatch = new chilkat.JsonObject();
    jsonMatch.UpdateString("appName","Test*");
    jsonMatch.UpdateString("service","*");
    jsonMatch.UpdateString("domain","*");
    jsonMatch.UpdateString("username","Starfish*");

    var results = new chilkat.JsonObject();
    results.EmitCompact = false;

    var success = secrets.ListSecrets(jsonMatch,results);
    if (success == false) {
        console.log(secrets.LastErrorText);
        return;
    }

    console.log(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.

    var appName;
    var service;
    var domain;
    var username;
    var targetName;
    var keyChainService;
    var keyChainAccount;

    var i = 0;
    var count_i = results.SizeOfArray("secrets");
    while (i < count_i) {
        results.I = i;
        appName = results.StringOf("secrets[i].appName");
        service = results.StringOf("secrets[i].service");
        domain = results.StringOf("secrets[i].domain");
        username = results.StringOf("secrets[i].username");
        // Information field for Windows Credentials Manager.
        targetName = results.StringOf("secrets[i].targetName");
        // Informational fields if on MacOS using the Apple Keychain.
        keyChainService = results.StringOf("secrets[i].keyChainService");
        keyChainAccount = results.StringOf("secrets[i].keyChainAccount");
        i = i+1;
    }


}

chilkatExample();