C++

Oracle Cloud Secrets - List Matching Secrets

See more Secrets Examples

List secrets in the Oracle Cloud 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 <CkSecrets.h>
#include <CkJsonObject.h>

void ChilkatSample(void)
    {
    bool success = false;

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

    // The bootstrap secret will contain the following information:

    // Private Key PEM

    // See following examples for setting up a bootstrap secret in memory, 
    // or in the local manager (Windows Credentials Manager or Apple Keychain)
    // Setup Bootstrap Secret in Local Manager
    // Setup Bootstrap Secret in Memory
    CkSecrets bootstrap;

    // Set the location of the bootstrap secret.
    // Can be "local_manager" or "memory", depending on how you setup the bootstrap secret.
    // ---------------------------------------------------------------------------------------------
    // If your operating system is NOT Windows or MacOS/iOS, then change "local_manager" to "memory"
    // You can also, if desired, use "memory" on Windows and MacOS/iOS if your bootstrap secret was previously setup in memory.
    // ---------------------------------------------------------------------------------------------
    bootstrap.put_Location("local_manager");

    // Specify the bootstrap secret to be used.
    CkJsonObject bsId;
    bsId.UpdateString("appName","oracle_bs");
    bsId.UpdateString("service","Example");
    bsId.UpdateString("username","Joe");

    // ----------------------------------------------------
    CkSecrets secrets;

    // Setup for the Oracle Cloud Secrets
    secrets.put_Location("oracle_cloud");
    success = secrets.SetBootstrapSecret(bsId,bootstrap);
    if (success == false) {
        std::cout << secrets.lastErrorText() << "\r\n";
        return;
    }

    // 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.
    CkJsonObject jsonMatch;
    jsonMatch.UpdateString("appName","Test*");
    // The following lines can be omitted. Not specifying anything for service, domain, or username is the same as "*".
    jsonMatch.UpdateString("service","*");
    jsonMatch.UpdateString("domain","*");
    jsonMatch.UpdateString("username","*");

    // Oracle Cloud Secrets requires a lot of additional information for each API call.
    // You'll need to replace the following with your values.
    // Note: To learn how to find these values, go to an AI such as ChatGPT and ask (for example) "In Oracle Cloud, where do I find my master key OCID?"
    jsonMatch.UpdateString("vault_name","ocid1.vault.oc1.us-chicago-1.ijttzlz7aadxo.abxxeljt4gv6tgrar66i5ugffincjmp52oveht3y2zn74rgo6raz6h72qtia");
    jsonMatch.UpdateString("region","us-chicago-1");
    jsonMatch.UpdateString("tenancy_ocid","ocid1.tenancy.oc1..aaaaaaaaov6vd3xdybgvwblezx2kmgjmo3dvsuljbwpf2m27mk47kkxsa5aa");
    jsonMatch.UpdateString("user_ocid","ocid1.user.oc1..aaaaaaaarsn42gwcl5rvahcmt5r6aheek65z54k5nbd6gtclmqn6emkqxajq");
    jsonMatch.UpdateString("master_key_ocid","ocid1.key.oc1.us-chicago-1.ijttzlz7aadxo.abxyeljtfbqhl5h2velmojmm6ls77lskmc7ardpekjgw264my6fuyxmhm6xa");

    CkJsonObject results;
    results.put_EmitCompact(false);

    success = secrets.ListSecrets(jsonMatch,results);
    if (success == false) {
        std::cout << secrets.lastErrorText() << "\r\n";
        return;
    }

    std::cout << results.emit() << "\r\n";

    // Sample output:

    // {
    //   "secrets": [
    //     {
    //       "appName": "Test2",
    //       "service": "Custom",
    //       "domain": "Ocean",
    //       "username": "Starfish",
    //       "oracleName": "Test2-Custom-Ocean-Starfish"
    //     },
    //     {
    //       "appName": "Test",
    //       "service": "Something",
    //       "domain": "Xyz",
    //       "username": "Abc",
    //       "oracleName": "Test-Something-Xyz-Abc"
    //     }
    //   ]
    // }

    // ---------------------------------------------------------------------------------------
    // Here's sample code for parsing the JSON list of secrets.

    const char *appName = 0;
    const char *service = 0;
    const char *domain = 0;
    const char *username = 0;
    const char *oracleName = 0;

    int i = 0;
    int numSecrets = results.SizeOfArray("secrets");
    while (i < numSecrets) {
        results.put_I(i);
        // Note: appName and domain are optional and may not exist in any given secret.
        appName = results.stringOf("secrets[i].appName");
        service = results.stringOf("secrets[i].service");
        domain = results.stringOf("secrets[i].domain");
        username = results.stringOf("secrets[i].username");
        // Informational field for the raw Oracle secret name.
        oracleName = results.stringOf("secrets[i].oracleName");
        i = i + 1;
    }
    }