(DataFlex) 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.

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

Use ChilkatAx-win32.pkg

Procedure Test
    Handle hoSecrets
    Variant vJson
    Handle hoJson
    Boolean iSuccess
    Variant vJson
Secret    Handle hoJsonSecret
    Boolean iSuccess
    String sTemp1

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

    Get Create (RefClass(cComChilkatSecrets)) To hoSecrets
    If (Not(IsComObjectCreated(hoSecrets))) Begin
        Send CreateComObject of hoSecrets
    End

    // 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.
    Set ComAutoSplit Of hoSecrets To 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.)
    Set ComLocation Of hoSecrets To "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.
    Get Create (RefClass(cComChilkatJsonObject)) To hoJson
    If (Not(IsComObjectCreated(hoJson))) Begin
        Send CreateComObject of hoJson
    End
    Get ComUpdateString Of hoJson "appName" "AA_MyApp" To iSuccess
    Get ComUpdateString Of hoJson "service" "OAuth2" To iSuccess
    Get ComUpdateString Of hoJson "domain" "onedrive" To iSuccess
    Get ComUpdateString Of hoJson "username" "matt" To iSuccess

    // Get the secret to be stored.
    Get Create (RefClass(cComChilkatJsonObject)) To hoJsonSecret
    If (Not(IsComObjectCreated(hoJsonSecret))) Begin
        Send CreateComObject of hoJsonSecret
    End
    Get ComLoadFile Of hoJsonSecret "qa_data/tokens/oneDrive.json" To iSuccess
    If (iSuccess = False) Begin
        Get ComLastErrorText Of hoJsonSecret To sTemp1
        Showln sTemp1
        Procedure_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.
    Get pvComObject of hoJson to vJson
    Get pvComObject of hoJsonSecret to vJsonSecret
    Get ComUpdateSecretJson Of hoSecrets vJson vJsonSecret To iSuccess
    If (iSuccess = False) Begin
        Get ComLastErrorText Of hoSecrets To sTemp1
        Showln sTemp1
        Procedure_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.

    Showln "Success"


End_Procedure