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 <C_CkSecrets.h>
#include <C_CkJsonObject.h>

void ChilkatSample(void)
    {
    BOOL success;
    HCkSecrets bootstrap;
    HCkJsonObject bsId;
    HCkSecrets secrets;
    HCkJsonObject jsonMatch;
    HCkJsonObject results;
    const char *appName;
    const char *service;
    const char *domain;
    const char *username;
    const char *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 = CkSecrets_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.
    //  ---------------------------------------------------------------------------------------------
    CkSecrets_putLocation(bootstrap,"local_manager");

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

    //  ----------------------------------------------------
    secrets = CkSecrets_Create();

    //  Setup for the Oracle Cloud Secrets
    CkSecrets_putLocation(secrets,"oracle_cloud");
    success = CkSecrets_SetBootstrapSecret(secrets,bsId,bootstrap);
    if (success == FALSE) {
        printf("%s\n",CkSecrets_lastErrorText(secrets));
        CkSecrets_Dispose(bootstrap);
        CkJsonObject_Dispose(bsId);
        CkSecrets_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 = CkJsonObject_Create();
    CkJsonObject_UpdateString(jsonMatch,"appName","Test*");
    //  The following lines can be omitted. Not specifying anything for service, domain, or username is the same as "*".
    CkJsonObject_UpdateString(jsonMatch,"service","*");
    CkJsonObject_UpdateString(jsonMatch,"domain","*");
    CkJsonObject_UpdateString(jsonMatch,"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?"
    CkJsonObject_UpdateString(jsonMatch,"vault_name","ocid1.vault.oc1.us-chicago-1.ijttzlz7aadxo.abxxeljt4gv6tgrar66i5ugffincjmp52oveht3y2zn74rgo6raz6h72qtia");
    CkJsonObject_UpdateString(jsonMatch,"region","us-chicago-1");
    CkJsonObject_UpdateString(jsonMatch,"tenancy_ocid","ocid1.tenancy.oc1..aaaaaaaaov6vd3xdybgvwblezx2kmgjmo3dvsuljbwpf2m27mk47kkxsa5aa");
    CkJsonObject_UpdateString(jsonMatch,"user_ocid","ocid1.user.oc1..aaaaaaaarsn42gwcl5rvahcmt5r6aheek65z54k5nbd6gtclmqn6emkqxajq");
    CkJsonObject_UpdateString(jsonMatch,"master_key_ocid","ocid1.key.oc1.us-chicago-1.ijttzlz7aadxo.abxyeljtfbqhl5h2velmojmm6ls77lskmc7ardpekjgw264my6fuyxmhm6xa");

    results = CkJsonObject_Create();
    CkJsonObject_putEmitCompact(results,FALSE);

    success = CkSecrets_ListSecrets(secrets,jsonMatch,results);
    if (success == FALSE) {
        printf("%s\n",CkSecrets_lastErrorText(secrets));
        CkSecrets_Dispose(bootstrap);
        CkJsonObject_Dispose(bsId);
        CkSecrets_Dispose(secrets);
        CkJsonObject_Dispose(jsonMatch);
        CkJsonObject_Dispose(results);
        return;
    }

    printf("%s\n",CkJsonObject_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 = CkJsonObject_SizeOfArray(results,"secrets");
    while (i < numSecrets) {
        CkJsonObject_putI(results,i);
        //  Note: appName and domain are optional and may not exist in any given secret.
        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");
        //  Informational field for the raw Oracle secret name.
        oracleName = CkJsonObject_stringOf(results,"secrets[i].oracleName");
        i = i + 1;
    }



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

    }