(SQL Server) Windows Credentials Manager / Apple Keychain - Create or Update a Binary Secret

See more Secrets Examples

On Windows, creates or updates a binary secret in the Windows Credentials Manager.

On MacOS or iOS, creates or updates a binary secret in the Apple Keychain.

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.

    DECLARE @secrets int
    -- Use "Chilkat_9_5_0.Secrets" for versions of Chilkat < 10.0.0
    EXEC @hr = sp_OACreate 'Chilkat.Secrets', @secrets OUT
    IF @hr <> 0
    BEGIN
        PRINT 'Failed to create ActiveX component'
        RETURN
    END

    -- On Windows, this is the Windows Credentials Manager
    -- On MacOS/iOS, it is the Apple Keychain
    EXEC sp_OASetProperty @secrets, 'Location', 'local_manager'

    -- Specify the name of the secret.
    -- service and username are required.
    -- appName and domain are optional.
    -- Note: The values are arbitrary and can be anything you want.
    DECLARE @json int
    -- Use "Chilkat_9_5_0.JsonObject" for versions of Chilkat < 10.0.0
    EXEC @hr = sp_OACreate 'Chilkat.JsonObject', @json OUT

    DECLARE @success int
    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', 'Starfish20'

    -- The purpose of this example is to show how arbitrary binary data
    -- can be stored as a secret.

    -- We'll use a small JPG image that is approximately 2KB in size.
    -- You can test using this same JPG at this URL:
    DECLARE @url nvarchar(4000)
    SELECT @url = 'https://chilkatdownload.com/sample_data/starfish20.jpg'
    DECLARE @http int
    -- Use "Chilkat_9_5_0.Http" for versions of Chilkat < 10.0.0
    EXEC @hr = sp_OACreate 'Chilkat.Http', @http OUT

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

    DECLARE @success int
    EXEC sp_OAMethod @http, 'DownloadBd', @success OUT, @url, @bd
    IF @success = 0
      BEGIN
        EXEC sp_OAGetProperty @http, 'LastErrorText', @sTmp0 OUT
        PRINT @sTmp0
        EXEC @hr = sp_OADestroy @secrets
        EXEC @hr = sp_OADestroy @json
        EXEC @hr = sp_OADestroy @http
        EXEC @hr = sp_OADestroy @bd
        RETURN
      END

    -- Create or update the binary secret.
    EXEC sp_OAMethod @secrets, 'UpdateSecretBd', @success OUT, @json, @bd
    IF @success = 0
      BEGIN
        EXEC sp_OAGetProperty @secrets, 'LastErrorText', @sTmp0 OUT
        PRINT @sTmp0
        EXEC @hr = sp_OADestroy @secrets
        EXEC @hr = sp_OADestroy @json
        EXEC @hr = sp_OADestroy @http
        EXEC @hr = sp_OADestroy @bd
        RETURN
      END


    PRINT 'Success.'

    EXEC @hr = sp_OADestroy @secrets
    EXEC @hr = sp_OADestroy @json
    EXEC @hr = sp_OADestroy @http
    EXEC @hr = sp_OADestroy @bd


END
GO