PowerBuilder

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.

PowerBuilder

integer li_rc
integer li_Success
oleobject loo_Secrets
oleobject loo_Json
oleobject loo_JsonSecret

li_Success = 0

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

loo_Secrets = create oleobject
li_rc = loo_Secrets.ConnectToNewObject("Chilkat.Secrets")
if li_rc < 0 then
    destroy loo_Secrets
    MessageBox("Error","Connecting to COM object failed")
    return
end if

// 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.
loo_Secrets.AutoSplit = 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.)
loo_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.
loo_Json = create oleobject
li_rc = loo_Json.ConnectToNewObject("Chilkat.JsonObject")

loo_Json.UpdateString("appName","AA_MyApp")
loo_Json.UpdateString("service","OAuth2")
loo_Json.UpdateString("domain","onedrive")
loo_Json.UpdateString("username","matt")

// Get the secret to be stored.
loo_JsonSecret = create oleobject
li_rc = loo_JsonSecret.ConnectToNewObject("Chilkat.JsonObject")

li_Success = loo_JsonSecret.LoadFile("qa_data/tokens/oneDrive.json")
if li_Success = 0 then
    Write-Debug loo_JsonSecret.LastErrorText
    destroy loo_Secrets
    destroy loo_Json
    destroy loo_JsonSecret
    return
end if

// 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.
li_Success = loo_Secrets.UpdateSecretJson(loo_Json,loo_JsonSecret)
if li_Success = 0 then
    Write-Debug loo_Secrets.LastErrorText
    destroy loo_Secrets
    destroy loo_Json
    destroy loo_JsonSecret
    return
end if

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

Write-Debug "Success"


destroy loo_Secrets
destroy loo_Json
destroy loo_JsonSecret