PHP

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.

Chilkat2 PHP

<?php

use Chilkat2\JsonObject;
use Chilkat2\Secrets;

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

$secrets = new Secrets();

// 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->AutoSplit = 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.
$json = new JsonObject();
$json->UpdateString('appName', 'AA_MyApp');
$json->UpdateString('service', 'OAuth2');
$json->UpdateString('domain', 'onedrive');
$json->UpdateString('username', 'matt');

// Get the secret to be stored.
$jsonSecret = new JsonObject();
try {
    $jsonSecret->LoadFile('qa_data/tokens/oneDrive.json');

    // 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.
    $secrets->UpdateSecretJson($json, $jsonSecret);
} catch (\Chilkat2\Exception $e) {
    echo $e->getMessage(), "\n";
    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.

echo "Success\n";