(SQL Server) Windows Credentials Manager / Apple Keychain - List Matching Secrets

See more Secrets Examples

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

    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'

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

    DECLARE @success int
    EXEC sp_OAMethod @jsonMatch, 'UpdateString', @success OUT, 'appName', 'Test*'
    EXEC sp_OAMethod @jsonMatch, 'UpdateString', @success OUT, 'service', '*'
    EXEC sp_OAMethod @jsonMatch, 'UpdateString', @success OUT, 'domain', '*'
    EXEC sp_OAMethod @jsonMatch, 'UpdateString', @success OUT, 'username', 'Starfish*'

    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

    DECLARE @success int
    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 @secrets
        EXEC @hr = sp_OADestroy @jsonMatch
        EXEC @hr = sp_OADestroy @results
        RETURN
      END

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

    -- Sample output on Windows.
    -- The "targetName" is purely informational and indicates the raw TargetName of the secret (i.e. Credential) stored in the Credentials Manager.

    -- {
    --   "secrets": [
    --     {
    --       "appName": "Test2",
    --       "service": "Custom",
    --       "domain": "Ocean",
    --       "username": "Starfish20",
    --       "targetName": "Test2/Custom/Ocean/Starfish20"
    --     },
    --     {
    --       "appName": "Test2",
    --       "service": "Custom",
    --       "domain": "Ocean",
    --       "username": "Starfish",
    --       "targetName": "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 @targetName nvarchar(4000)

    DECLARE @keyChainService nvarchar(4000)

    DECLARE @keyChainAccount nvarchar(4000)

    DECLARE @i int
    SELECT @i = 0
    DECLARE @count_i int
    EXEC sp_OAMethod @results, 'SizeOfArray', @count_i OUT, 'secrets'
    WHILE @i < @count_i
      BEGIN
        EXEC sp_OASetProperty @results, 'I', @i
        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 Windows Credentials Manager.
        EXEC sp_OAMethod @results, 'StringOf', @targetName OUT, 'secrets[i].targetName'
        -- Informational fields if on MacOS using the Apple Keychain.
        EXEC sp_OAMethod @results, 'StringOf', @keyChainService OUT, 'secrets[i].keyChainService'
        EXEC sp_OAMethod @results, 'StringOf', @keyChainAccount OUT, 'secrets[i].keyChainAccount'
        SELECT @i = @i + 1
      END

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


END
GO