Lua Requires Chilkat v10.1.0+

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

local chilkat = require("chilkat")

-- 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
local bootstrap = chilkat.Secrets.new()

-- 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.location = "local_manager"

-- Specify the bootstrap secret to be used.
local bsId = chilkat.JsonObject.new()
bsId:update_string("appName", "oracle_bs")
bsId:update_string("service", "Example")
bsId:update_string("username", "Joe")

-- ----------------------------------------------------
local secrets = chilkat.Secrets.new()

-- Setup for the Oracle Cloud Secrets
secrets.location = "oracle_cloud"
local success = secrets:set_bootstrap_secret(bsId, bootstrap)
if not success then
    print(secrets.last_error_text)
    return
end

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

local results = chilkat.JsonObject.new()
results.emit_compact = false

success = secrets:list_secrets(jsonMatch, results)
if not success then
    print(secrets.last_error_text)
    return
end

print(results: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.

local appName = ""
local service = ""
local domain = ""
local username = ""
local oracleName = ""

local i = 0
local numSecrets = results:size_of_array("secrets")
while i < numSecrets do
    results.i = i
    -- Note: appName and domain are optional and may not exist in any given secret.
    appName = results:string_of("secrets[i].appName")
    service = results:string_of("secrets[i].service")
    domain = results:string_of("secrets[i].domain")
    username = results:string_of("secrets[i].username")
    -- Informational field for the raw Oracle secret name.
    oracleName = results:string_of("secrets[i].oracleName")
    i = i + 1
end