Lua Requires Chilkat v10.1.0+

Windows Credentials Manager - AutoSplit Larger Secrets

See more Secrets Examples

Secrets stored in the Windows Credentials Manager can be a maximum of 2560 bytes in size. If the content of the secret is too large for the Windows Credential Manager, Chilkat will automatically split the secret into parts and store a shorter JSON manifest. Lua

local chilkat = require("chilkat")

-- This example requires the Chilkat API to have been previously unlocked.
-- See Global Unlock Sample for sample code.

local secrets = chilkat.Secrets.new()

-- The default value of AutoSplit is true.
-- Note: AutoSplit only applies when the secret location is "local_manager"
-- and the app is running on the Windows OS.  All other secret locations, such as Apple Keychain,
-- AWS Secrets Manager, Azure Key Vault, etc. don't have limitations that are so small.
secrets.auto_split = true

-- On Windows, this is the Windows Credentials Manager
-- On MacOS/iOS, it is the Apple Keychain
-- (This example is explaining how a secret too large for the Windows Credential Manager
-- is automatically compressed and split into parts if needed.)
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.
local json = chilkat.JsonObject.new()
json:update_string("appName", "AA_MyApp")
json:update_string("service", "OAuth2")
json:update_string("domain", "onedrive")
json:update_string("username", "matt")

-- Get the secret to be stored.
local jsonSecret = chilkat.JsonObject.new()
local success = jsonSecret:load_file("qa_data/tokens/oneDrive.json")
if not success then
    print(jsonSecret.last_error_text)
    return
end

-- Note: The oneDrive.json file we used for testing is 4824 bytes in size,
-- which exceeds the maximum size (2560 bytes) allowed by the Windows Credentials Manager.

-- When the size is too large, Chilkat will first compress the content of the secret.
-- If the compressed size is small enough, then it is stored compressed without splitting.
-- Otherwise the compressed data is split

-- Your application does not need to know how the secret is stored in the Windows Credentials Manager.
-- When fetching the secret, Chilkat automatically decompresses and re-composes from parts.

-- Create or update the secret.
success = secrets:update_secret_json(json, jsonSecret)
if not success then
    print(secrets.last_error_text)
    return
end

-- This is the auto-split secret viewed in the Windows Credentials Manager:
-- 

-- Note: If you delete the auto-split secret by calling Chilkat's DeleteSecret method,
-- the parts are automatically deleted.
-- Also, if you update the secret, the old parts are automatically deleted and new parts are created.

print("Success")