(Ruby) AWS Secrets Manager - List Matching Secrets

See more Secrets Examples

List secrets in the AWS Secrets Manager 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 Ruby Downloads install from rubygems.org gem install chilkat or download... Ruby Library for Windows, MacOS, Linux, Alpine Linux

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:

# AWS Region
# AWS Access Key
# AWS Secret Key

# 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 = Chilkat::CkSecrets.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.put_Location("local_manager")

# Specify the bootstrap secret to be used.
bsId = Chilkat::CkJsonObject.new()
bsId.UpdateString("appName","AWS")
bsId.UpdateString("service","Example")
bsId.UpdateString("username","Joe")

# ----------------------------------------------------
secrets = Chilkat::CkSecrets.new()

# Setup for the AWS Secrets Manager
secrets.put_Location("aws_secrets_manager")
success = secrets.SetBootstrapSecret(bsId,bootstrap)
if (success == false)
    print secrets.lastErrorText() + "\n";
    exit
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.
jsonMatch = Chilkat::CkJsonObject.new()
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","*")

results = Chilkat::CkJsonObject.new()
results.put_EmitCompact(false)

success = secrets.ListSecrets(jsonMatch,results)
if (success == false)
    print secrets.lastErrorText() + "\n";
    exit
end

print results.emit() + "\n";

# Sample output:

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

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

i = 0
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")
    # Information field for the raw AWS secret name.
    awsName = results.stringOf("secrets[i].awsName")
    i = i + 1
end