(SQL Server) 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 ActiveX Downloads ActiveX for 32-bit and 64-bit Windows

-- Important: See this note about string length limitations for strings returned by sp_OAMethod calls.
--
CREATE PROCEDURE ChilkatSample
AS
BEGIN
    DECLARE @hr int
    -- Important: Do not use nvarchar(max).  See the warning about using nvarchar(max).
    DECLARE @sTmp0 nvarchar(4000)
    -- 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
    DECLARE @bootstrap int
    -- Use "Chilkat_9_5_0.Secrets" for versions of Chilkat < 10.0.0
    EXEC @hr = sp_OACreate 'Chilkat.Secrets', @bootstrap OUT
    IF @hr <> 0
    BEGIN
        PRINT 'Failed to create ActiveX component'
        RETURN
    END

    -- 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.
    -- ---------------------------------------------------------------------------------------------
    EXEC sp_OASetProperty @bootstrap, 'Location', 'local_manager'

    -- Specify the bootstrap secret to be used.
    DECLARE @bsId int
    -- Use "Chilkat_9_5_0.JsonObject" for versions of Chilkat < 10.0.0
    EXEC @hr = sp_OACreate 'Chilkat.JsonObject', @bsId OUT

    DECLARE @success int
    EXEC sp_OAMethod @bsId, 'UpdateString', @success OUT, 'appName', 'AWS'
    EXEC sp_OAMethod @bsId, 'UpdateString', @success OUT, 'service', 'Example'
    EXEC sp_OAMethod @bsId, 'UpdateString', @success OUT, 'username', 'Joe'

    -- ----------------------------------------------------
    DECLARE @secrets int
    -- Use "Chilkat_9_5_0.Secrets" for versions of Chilkat < 10.0.0
    EXEC @hr = sp_OACreate 'Chilkat.Secrets', @secrets OUT

    -- Setup for the AWS Secrets Manager
    EXEC sp_OASetProperty @secrets, 'Location', 'aws_secrets_manager'
    DECLARE @success int
    EXEC sp_OAMethod @secrets, 'SetBootstrapSecret', @success OUT, @bsId, @bootstrap
    IF @success = 0
      BEGIN
        EXEC sp_OAGetProperty @secrets, 'LastErrorText', @sTmp0 OUT
        PRINT @sTmp0
        EXEC @hr = sp_OADestroy @bootstrap
        EXEC @hr = sp_OADestroy @bsId
        EXEC @hr = sp_OADestroy @secrets
        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.
    DECLARE @jsonMatch int
    -- Use "Chilkat_9_5_0.JsonObject" for versions of Chilkat < 10.0.0
    EXEC @hr = sp_OACreate 'Chilkat.JsonObject', @jsonMatch OUT

    EXEC sp_OAMethod @jsonMatch, 'UpdateString', @success OUT, 'appName', 'Test*'
    -- The following lines can be omitted. Not specifying anything for service, domain, or username is the same as "*".
    EXEC sp_OAMethod @jsonMatch, 'UpdateString', @success OUT, 'service', '*'
    EXEC sp_OAMethod @jsonMatch, 'UpdateString', @success OUT, 'domain', '*'
    EXEC sp_OAMethod @jsonMatch, 'UpdateString', @success OUT, 'username', '*'

    DECLARE @results int
    -- Use "Chilkat_9_5_0.JsonObject" for versions of Chilkat < 10.0.0
    EXEC @hr = sp_OACreate 'Chilkat.JsonObject', @results OUT

    EXEC sp_OASetProperty @results, 'EmitCompact', 0

    EXEC sp_OAMethod @secrets, 'ListSecrets', @success OUT, @jsonMatch, @results
    IF @success = 0
      BEGIN
        EXEC sp_OAGetProperty @secrets, 'LastErrorText', @sTmp0 OUT
        PRINT @sTmp0
        EXEC @hr = sp_OADestroy @bootstrap
        EXEC @hr = sp_OADestroy @bsId
        EXEC @hr = sp_OADestroy @secrets
        EXEC @hr = sp_OADestroy @jsonMatch
        EXEC @hr = sp_OADestroy @results
        RETURN
      END

    EXEC sp_OAMethod @results, 'Emit', @sTmp0 OUT
    PRINT @sTmp0

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

    DECLARE @appName nvarchar(4000)

    DECLARE @service nvarchar(4000)

    DECLARE @domain nvarchar(4000)

    DECLARE @username nvarchar(4000)

    DECLARE @awsName nvarchar(4000)

    DECLARE @i int
    SELECT @i = 0
    DECLARE @numSecrets int
    EXEC sp_OAMethod @results, 'SizeOfArray', @numSecrets OUT, 'secrets'
    WHILE @i < @numSecrets
      BEGIN
        EXEC sp_OASetProperty @results, 'I', @i
        -- Note: appName and domain are optional and may not exist in any given secret.
        EXEC sp_OAMethod @results, 'StringOf', @appName OUT, 'secrets[i].appName'
        EXEC sp_OAMethod @results, 'StringOf', @service OUT, 'secrets[i].service'
        EXEC sp_OAMethod @results, 'StringOf', @domain OUT, 'secrets[i].domain'
        EXEC sp_OAMethod @results, 'StringOf', @username OUT, 'secrets[i].username'
        -- Information field for the raw AWS secret name.
        EXEC sp_OAMethod @results, 'StringOf', @awsName OUT, 'secrets[i].awsName'
        SELECT @i = @i + 1
      END

    EXEC @hr = sp_OADestroy @bootstrap
    EXEC @hr = sp_OADestroy @bsId
    EXEC @hr = sp_OADestroy @secrets
    EXEC @hr = sp_OADestroy @jsonMatch
    EXEC @hr = sp_OADestroy @results


END
GO