(Lianja) 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.

For more information, see https://cknotes.com/chilkat-secrets-class-added-in-version-10-1-0/

Chilkat Lianja Extension Download Chilkat Lianja Extension

// 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
loBootstrap = createobject("CkSecrets")

// 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.
// ---------------------------------------------------------------------------------------------
loBootstrap.Location = "local_manager"

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

// ----------------------------------------------------
loSecrets = createobject("CkSecrets")

// Setup for the Oracle Cloud Secrets
loSecrets.Location = "oracle_cloud"
llSuccess = loSecrets.SetBootstrapSecret(loBsId,loBootstrap)
if (llSuccess = .F.) then
    ? loSecrets.LastErrorText
    release loBootstrap
    release loBsId
    release loSecrets
    return
endif

// 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.
loJsonMatch = createobject("CkJsonObject")
loJsonMatch.UpdateString("appName","Test*")
// The following lines can be omitted. Not specifying anything for service, domain, or username is the same as "*".
loJsonMatch.UpdateString("service","*")
loJsonMatch.UpdateString("domain","*")
loJsonMatch.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?"
loJsonMatch.UpdateString("vault_name","ocid1.vault.oc1.us-chicago-1.ijttzlz7aadxo.abxxeljt4gv6tgrar66i5ugffincjmp52oveht3y2zn74rgo6raz6h72qtia")
loJsonMatch.UpdateString("region","us-chicago-1")
loJsonMatch.UpdateString("tenancy_ocid","ocid1.tenancy.oc1..aaaaaaaaov6vd3xdybgvwblezx2kmgjmo3dvsuljbwpf2m27mk47kkxsa5aa")
loJsonMatch.UpdateString("user_ocid","ocid1.user.oc1..aaaaaaaarsn42gwcl5rvahcmt5r6aheek65z54k5nbd6gtclmqn6emkqxajq")
loJsonMatch.UpdateString("master_key_ocid","ocid1.key.oc1.us-chicago-1.ijttzlz7aadxo.abxyeljtfbqhl5h2velmojmm6ls77lskmc7ardpekjgw264my6fuyxmhm6xa")

loResults = createobject("CkJsonObject")
loResults.EmitCompact = .F.

llSuccess = loSecrets.ListSecrets(loJsonMatch,loResults)
if (llSuccess = .F.) then
    ? loSecrets.LastErrorText
    release loBootstrap
    release loBsId
    release loSecrets
    release loJsonMatch
    release loResults
    return
endif

? loResults.Emit()

// 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
lnNumSecrets = loResults.SizeOfArray("secrets")
do while i < lnNumSecrets
    loResults.I = i
    // Note: appName and domain are optional and may not exist in any given secret.
    lcAppName = loResults.StringOf("secrets[i].appName")
    lcService = loResults.StringOf("secrets[i].service")
    lcDomain = loResults.StringOf("secrets[i].domain")
    lcUsername = loResults.StringOf("secrets[i].username")
    // Informational field for the raw Oracle secret name.
    lcOracleName = loResults.StringOf("secrets[i].oracleName")
    i = i + 1
enddo


release loBootstrap
release loBsId
release loSecrets
release loJsonMatch
release loResults