Unicode 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.

Unicode C

#include <C_CkSecretsW.h>
#include <C_CkJsonObjectW.h>

void ChilkatSample(void)
    {
    BOOL success;
    HCkSecretsW bootstrap;
    HCkJsonObjectW bsId;
    HCkSecretsW secrets;
    HCkJsonObjectW jsonMatch;
    HCkJsonObjectW results;
    const wchar_t *appName;
    const wchar_t *service;
    const wchar_t *domain;
    const wchar_t *username;
    const wchar_t *oracleName;
    int i;
    int numSecrets;

    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
    bootstrap = CkSecretsW_Create();

    // 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.
    // ---------------------------------------------------------------------------------------------
    CkSecretsW_putLocation(bootstrap,L"local_manager");

    // Specify the bootstrap secret to be used.
    bsId = CkJsonObjectW_Create();
    CkJsonObjectW_UpdateString(bsId,L"appName",L"oracle_bs");
    CkJsonObjectW_UpdateString(bsId,L"service",L"Example");
    CkJsonObjectW_UpdateString(bsId,L"username",L"Joe");

    // ----------------------------------------------------
    secrets = CkSecretsW_Create();

    // Setup for the Oracle Cloud Secrets
    CkSecretsW_putLocation(secrets,L"oracle_cloud");
    success = CkSecretsW_SetBootstrapSecret(secrets,bsId,bootstrap);
    if (success == FALSE) {
        wprintf(L"%s\n",CkSecretsW_lastErrorText(secrets));
        CkSecretsW_Dispose(bootstrap);
        CkJsonObjectW_Dispose(bsId);
        CkSecretsW_Dispose(secrets);
        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.
    jsonMatch = CkJsonObjectW_Create();
    CkJsonObjectW_UpdateString(jsonMatch,L"appName",L"Test*");
    // The following lines can be omitted. Not specifying anything for service, domain, or username is the same as "*".
    CkJsonObjectW_UpdateString(jsonMatch,L"service",L"*");
    CkJsonObjectW_UpdateString(jsonMatch,L"domain",L"*");
    CkJsonObjectW_UpdateString(jsonMatch,L"username",L"*");

    // 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?"
    CkJsonObjectW_UpdateString(jsonMatch,L"vault_name",L"ocid1.vault.oc1.us-chicago-1.ijttzlz7aadxo.abxxeljt4gv6tgrar66i5ugffincjmp52oveht3y2zn74rgo6raz6h72qtia");
    CkJsonObjectW_UpdateString(jsonMatch,L"region",L"us-chicago-1");
    CkJsonObjectW_UpdateString(jsonMatch,L"tenancy_ocid",L"ocid1.tenancy.oc1..aaaaaaaaov6vd3xdybgvwblezx2kmgjmo3dvsuljbwpf2m27mk47kkxsa5aa");
    CkJsonObjectW_UpdateString(jsonMatch,L"user_ocid",L"ocid1.user.oc1..aaaaaaaarsn42gwcl5rvahcmt5r6aheek65z54k5nbd6gtclmqn6emkqxajq");
    CkJsonObjectW_UpdateString(jsonMatch,L"master_key_ocid",L"ocid1.key.oc1.us-chicago-1.ijttzlz7aadxo.abxyeljtfbqhl5h2velmojmm6ls77lskmc7ardpekjgw264my6fuyxmhm6xa");

    results = CkJsonObjectW_Create();
    CkJsonObjectW_putEmitCompact(results,FALSE);

    success = CkSecretsW_ListSecrets(secrets,jsonMatch,results);
    if (success == FALSE) {
        wprintf(L"%s\n",CkSecretsW_lastErrorText(secrets));
        CkSecretsW_Dispose(bootstrap);
        CkJsonObjectW_Dispose(bsId);
        CkSecretsW_Dispose(secrets);
        CkJsonObjectW_Dispose(jsonMatch);
        CkJsonObjectW_Dispose(results);
        return;
    }

    wprintf(L"%s\n",CkJsonObjectW_emit(results));

    // 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.

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



    CkSecretsW_Dispose(bootstrap);
    CkJsonObjectW_Dispose(bsId);
    CkSecretsW_Dispose(secrets);
    CkJsonObjectW_Dispose(jsonMatch);
    CkJsonObjectW_Dispose(results);

    }