React Native

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.

React Native

import { JsonObject, Secrets } from '@chilkat/react-native'

async function chilkatExample() {
  // This example requires the Chilkat API to have been previously unlocked.
  // See Global Unlock Sample for sample code.

  const secrets = new 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.
  const jsonMatch = new JsonObject();
  jsonMatch.updateString('appName', 'Test*');
  jsonMatch.updateString('service', '*');
  jsonMatch.updateString('domain', '*');
  jsonMatch.updateString('username', 'Starfish*');

  const results = new JsonObject();
  results.emitCompact = false;

  try {
    await secrets.listSecretsAsync(jsonMatch, results);
  } catch {
    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.

  let appName = '';
  let service = '';
  let domain = '';
  let username = '';
  let targetName = '';
  let keyChainService = '';
  let keyChainAccount = '';

  let i = 0;
  const countI = results.sizeOfArray('secrets');
  while (i < countI) {
    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++;
  }
}