Tcl

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.

Note: This example requires Chilkat v10.1.0 or later.

Tcl

load ./chilkat.dll

set success 0

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

set secrets [new_CkSecrets]

# The default value of AutoSplit is 1.
# 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.
CkSecrets_put_AutoSplit $secrets 1

# 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.)
CkSecrets_put_Location $secrets "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.
set json [new_CkJsonObject]

CkJsonObject_UpdateString $json "appName" "AA_MyApp"
CkJsonObject_UpdateString $json "service" "OAuth2"
CkJsonObject_UpdateString $json "domain" "onedrive"
CkJsonObject_UpdateString $json "username" "matt"

# Get the secret to be stored.
set jsonSecret [new_CkJsonObject]

set success [CkJsonObject_LoadFile $jsonSecret "qa_data/tokens/oneDrive.json"]
if {$success == 0} then {
    puts [CkJsonObject_lastErrorText $jsonSecret]
    delete_CkSecrets $secrets
    delete_CkJsonObject $json
    delete_CkJsonObject $jsonSecret
    exit
}

# 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.
set success [CkSecrets_UpdateSecretJson $secrets $json $jsonSecret]
if {$success == 0} then {
    puts [CkSecrets_lastErrorText $secrets]
    delete_CkSecrets $secrets
    delete_CkJsonObject $json
    delete_CkJsonObject $jsonSecret
    exit
}

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

puts "Success"

delete_CkSecrets $secrets
delete_CkJsonObject $json
delete_CkJsonObject $jsonSecret