PureBasic

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.

PureBasic

IncludeFile "CkJsonObject.pb"
IncludeFile "CkSecrets.pb"

Procedure ChilkatExample()

    success.i = 0

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

    secrets.i = CkSecrets::ckCreate()
    If secrets.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    ; 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::setCkAutoSplit(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::setCkLocation(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.
    json.i = CkJsonObject::ckCreate()
    If json.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkJsonObject::ckUpdateString(json,"appName","AA_MyApp")
    CkJsonObject::ckUpdateString(json,"service","OAuth2")
    CkJsonObject::ckUpdateString(json,"domain","onedrive")
    CkJsonObject::ckUpdateString(json,"username","matt")

    ; Get the secret to be stored.
    jsonSecret.i = CkJsonObject::ckCreate()
    If jsonSecret.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    success = CkJsonObject::ckLoadFile(jsonSecret,"qa_data/tokens/oneDrive.json")
    If success = 0
        Debug CkJsonObject::ckLastErrorText(jsonSecret)
        CkSecrets::ckDispose(secrets)
        CkJsonObject::ckDispose(json)
        CkJsonObject::ckDispose(jsonSecret)
        ProcedureReturn
    EndIf

    ; 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 = CkSecrets::ckUpdateSecretJson(secrets,json,jsonSecret)
    If success = 0
        Debug CkSecrets::ckLastErrorText(secrets)
        CkSecrets::ckDispose(secrets)
        CkJsonObject::ckDispose(json)
        CkJsonObject::ckDispose(jsonSecret)
        ProcedureReturn
    EndIf

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

    Debug "Success"


    CkSecrets::ckDispose(secrets)
    CkJsonObject::ckDispose(json)
    CkJsonObject::ckDispose(jsonSecret)


    ProcedureReturn
EndProcedure