(SQL Server) Oracle Cloud Secrets - Get a Binary Secret

See more Secrets Examples

Demonstrates how to fetch the content of a binary secret from the Oracle Cloud Secrets.

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:

    -- 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
    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', 'oracle_bs'
    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 Oracle Cloud Secrets
    EXEC sp_OASetProperty @secrets, 'Location', 'oracle_cloud'
    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

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

    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'appName', 'Test2'
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'service', 'Custom'
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'domain', 'Ocean'
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'username', 'Starfish'

    -- 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?"
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'vault_name', 'ocid1.vault.oc1.us-chicago-1.ijttzlz7aadxo.abxxeljt4gv6tgrar66i5ugffincjmp52oveht3y2zn74rgo6raz6h72qtia'
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'region', 'us-chicago-1'
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'tenancy_ocid', 'ocid1.tenancy.oc1..aaaaaaaaov6vd3xdybgvwblezx2kmgjmo3dvsuljbwpf2m27mk47kkxsa5aa'
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'user_ocid', 'ocid1.user.oc1..aaaaaaaarsn42gwcl5rvahcmt5r6aheek65z54k5nbd6gtclmqn6emkqxajq'
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'master_key_ocid', 'ocid1.key.oc1.us-chicago-1.ijttzlz7aadxo.abxyeljtfbqhl5h2velmojmm6ls77lskmc7ardpekjgw264my6fuyxmhm6xa'

    -- Get the binary secret data.
    DECLARE @bd int
    -- Use "Chilkat_9_5_0.BinData" for versions of Chilkat < 10.0.0
    EXEC @hr = sp_OACreate 'Chilkat.BinData', @bd OUT

    EXEC sp_OAMethod @secrets, 'GetSecretBd', @success OUT, @json, @bd
    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 @json
        EXEC @hr = sp_OADestroy @bd
        RETURN
      END

    -- For our testing, the binary secret was a JPG image..
    EXEC sp_OAMethod @bd, 'WriteFile', @success OUT, 'c:/temp/qa_output/starfish.jpg'


    PRINT 'Success.'

    EXEC @hr = sp_OADestroy @bootstrap
    EXEC @hr = sp_OADestroy @bsId
    EXEC @hr = sp_OADestroy @secrets
    EXEC @hr = sp_OADestroy @json
    EXEC @hr = sp_OADestroy @bd


END
GO