Skip to content

Flow 5 – ML-KEM-512 Non-Streaming Encrypt / Decrypt (Compact JWE)

In this flow we use the non-streaming helpers of the SDK (compact-token mode) to encrypt and decrypt a file with a post-quantum ML-KEM-512 key.

Steps

  1. Resolve the pre-provisioned ML-KEM-512 key-pair.
  2. Encrypt a file via encryptFile(…)  → compact JWE on disk.
  3. Decrypt the token via decryptFile(…).
  4. Validate that plaintext round-trips intact.

Non-streaming = the whole compact token is handled in memory.
For GB-scale files use the streaming APIs shown in Flows 1-4.

Key points\ - Leverages the encryptFile( ) / decryptFile( ) helpers – the entire ciphertext is one Compact JWE string kept in memory. - Uses a post-quantum ML-KEM-512 key, giving long-term confidentiality that survives future RSA/ECC breaks.

Prerequisites

The flow examples are data-plane only. They never create, rotate, or delete keys — they resolve pre-provisioned playground keys and operate on them. Before running any flow example you must:

  1. Provision a fresh demo-cli playground. Use the ankasecure-demo-provisioning tool to provision the demo-cli playground. This seeds the cryptographic keys the examples operate on and the cli-reference@demo-cli actor that holds capability grants on them.
  2. Use the emitted cli.properties. The provisioning tool writes a cli.properties file that carries the ankasecure.demo.kids catalogue line — the comma-separated list of provisioned key ids, in YAML file order. The examples load this file to discover which keys exist.
  3. Authenticate as cli-reference@demo-cli. Authenticate the SDK as the cli-reference@demo-cli actor — the all-operations actor of the demo-cli playground — so the resolved keys carry the capability grants each operation needs.

Key selection in the examples is by algorithm or by exact name:

  • kidForAlgorithm(alg) returns a pre-provisioned key id matching the requested algorithm — used by the single-key operation flows.
  • requireKid(name) asserts that an exact, named cross-kid endpoint is present in the ankasecure.demo.kids catalogue — used by the cross-kid REENCRYPT / RESIGN flows that must operate on a specific granted source/target pair.

If cli.properties is missing the ankasecure.demo.kids line, the examples fail fast with a clear message instructing you to (re-)provision the demo-cli playground — they will not silently fall back.

PKCS#7 / CMS examples (Flow 19 & Flow 20)

The PKCS#7 interop examples operate on a packaged, non-sensitive CMS EnvelopedData fixture — you do not supply a PKCS#7 file:

  • Fixture: src/main/resources/pkcs7/enveloped-data-sample.p7m, loaded from the classpath by Pkcs7ExampleFixture. It is a single-recipient, zero-signer EnvelopedData artifact from the QA test signer; it carries no private key and no secret.
  • Flow 19 (analysis) needs no key. Structural analysis (analyzePkcs7 / analyzePkcs7Stream) inspects the CMS envelope metadata only, so it runs with no decryption key and no extra configuration.
  • Flow 20 (conversion) needs a pre-provisioned recipient key. Converting EnvelopedData to JWE requires the platform to decrypt the envelope, so it needs the recipient's private key referenced by the pkcs7.decryptionKid property in cli.properties. That key is matched by issuer DN + serial number and is imported by a control-plane step (outside the data-plane SDK); until it is provisioned, Flow 20's conversion calls fail at the server while Flow 19 still runs. The calling actor also needs the in-place REENCRYPT grant on that kid, requested with the kid twice (assetKids: [kid, kid]) and stored as [kid]: a conversion is authorized by REENCRYPT / RESIGN grants, never by DECRYPT, and no wildcard REENCRYPT grant exists.
  • Data-plane only. Like every flow example, these never import keystores or perform any key-lifecycle operation.

When to use it

  • Single-blob logistics – perfect when you want a self-contained text token that can be logged, emailed, checked into Git, or embedded in a manifest without worrying about binary streams or multipart boundaries.
  • Quantum-resilient archives – ideal for backups, legal holds, or research data that must remain secret for decades; ML-KEM-512 protects against both classical and quantum adversaries.
  • Offline or air-gapped workflows – the exported JSON + Compact JWE give auditors (or disaster-recovery teams) everything they need to decrypt on an isolated machine with no API calls.

Shared helper – this code imports the utility class from
example-util.md (configuration, authentication, JSON).


Complete Java implementation

src/main/java/co/ankatech/ankasecure/sdk/examples/ExampleScenario5.java

/*
 * Copyright 2025 ANKATech Solutions Inc.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package co.ankatech.ankasecure.sdk.examples;

import co.ankatech.ankasecure.sdk.AuthenticatedSdk;
import co.ankatech.ankasecure.sdk.model.DecryptResultMetadata;
import co.ankatech.ankasecure.sdk.model.EncryptResult;
import co.ankatech.ankasecure.sdk.util.FileIO;

import java.nio.file.Path;
import java.util.Properties;

import static co.ankatech.ankasecure.sdk.examples.ExampleUtil.*;

/**
 * Scenario 5 — ML-KEM-512 Bulk Helpers (Compact JWE).
 *
 * <p>This scenario demonstrates the <strong>non-streaming</strong> helper
 * methods that work with RFC&nbsp;7516 <em>Compact&nbsp;JWE</em> tokens:</p>
 * <ol>
 *   <li>Resolve a pre-provisioned <code>ML-KEM-512</code> key from the demo
 *       playground (the SDK is data-plane-only — it does not create keys).</li>
 *   <li>Encrypt a file via {@link AuthenticatedSdk#encryptFile(String, Path, Path)}
 *       (compact token written to disk).</li>
 *   <li>Decrypt via {@link AuthenticatedSdk#decryptFile(Path, Path)}.</li>
 *   <li>Print rich metadata for both operations.</li>
 *   <li>Validate round-trip integrity.</li>
 * </ol>
 *
 * <p><b>Implementation notes (Java&nbsp;21+):</b></p>
 * <ul>
 *   <li>All filesystem interactions use the {@link java.nio.file.Path} API.</li>
 *   <li>UTF-8 is enforced explicitly for deterministic encoding.</li>
 *   <li>Temporary artefacts are written under <kbd>temp_files/</kbd>.</li>
 * </ul>
 *
 * <p><b>Thread-safety:</b> this class is stateless and immutable.</p>
 *
 * @see ExampleUtil
 * @see ExamplePlaygroundKeys
 * @see AuthenticatedSdk
 */
public final class ExampleScenario5 {

    /** No instantiation &mdash; this class only exposes {@link #main(String[])}. */
    private ExampleScenario5() { }

    /**
     * Runs the ML-KEM-512 compact JWE encrypt/decrypt scenario.
     *
     * <p>Loads CLI properties, authenticates against ANKASecure&copy;,
     * and delegates to the scenario logic. On any unrecoverable error
     * the JVM terminates via
     * {@link ExampleUtil#fatal(String, Throwable)}.</p>
     *
     * @param args command-line arguments (ignored)
     */
    public static void main(final String[] args) {

        System.out.println("===== SCENARIO 5 START =====");
        System.out.println("""
                Purpose :
                  * ML-KEM-512 compact-JWE encrypt / decrypt helpers
                  * Non-streaming - full token handled in memory
                  * Operates on a pre-provisioned playground key
                Steps   :
                  1) Resolve pre-provisioned ML-KEM-512 key
                  2) Encrypt payload (compact JWE)
                  3) Decrypt ciphertext
                  4) Validate integrity
                --------------------------------------------------------------""");

        try {
            prepareWorkingDir();

            Properties            props      = loadProperties();
            AuthenticatedSdk      sdk        = authenticate(props);
            ExamplePlaygroundKeys playground = ExamplePlaygroundKeys.from(props, sdk);

            runScenario(sdk, playground);

        } catch (Exception ex) {
            fatal("Scenario 5 failed", ex);
        }

        System.out.println("===== SCENARIO 5 END =====");
    }

    /**
     * Executes the ML-KEM-512 compact JWE scenario on a pre-provisioned key.
     *
     * <ol>
     *   <li>Prepare plaintext file.</li>
     *   <li>Resolve a pre-provisioned ML-KEM-512 key.</li>
     *   <li>Encrypt file (compact JWE).</li>
     *   <li>Decrypt compact JWE.</li>
     *   <li>Validate round-trip integrity.</li>
     * </ol>
     *
     * @param sdk        an authenticated {@link AuthenticatedSdk} instance; must not be {@code null}
     * @param playground the pre-provisioned playground key resolver; must not be {@code null}
     * @throws Exception if any step fails
     */
    private static void runScenario(final AuthenticatedSdk sdk,
                                    final ExamplePlaygroundKeys playground) throws Exception {

        /* 1 -- prepare plaintext -------------------------------------------- */
        Path plainFile = TEMP_DIR.resolve("scenario5_plain.txt");
        FileIO.writeUtf8(plainFile,
                "Scenario-5 - ML-KEM-512 compact-JWE encryption demo.");
        System.out.println("[1] Plaintext ready          -> " + plainFile.toAbsolutePath());

        /* 2 -- resolve pre-provisioned key (data-plane SDK: no key creation) */
        final String kid = playground.kidForAlgorithm("ML-KEM-512");
        System.out.println("[2] Using pre-provisioned key -> kid = " + kid);

        /* 3 -- encrypt (compact JWE) ---------------------------------------- */
        Path cipherFile = TEMP_DIR.resolve("scenario5.cipher.jwe");
        EncryptResult encMeta = sdk.encryptFile(kid, plainFile, cipherFile);
        System.out.println("[3] Ciphertext written       -> " + cipherFile.toAbsolutePath());
        printEncryptMeta(encMeta);

        /* 4 -- decrypt ------------------------------------------------------ */
        Path decFile = TEMP_DIR.resolve("scenario5_decrypted.txt");
        DecryptResultMetadata decMeta = sdk.decryptFile(cipherFile, decFile);
        System.out.println("[4] Decrypted file           -> " + decFile.toAbsolutePath());
        printDecryptMeta(decMeta);

        /* 5 -- validation --------------------------------------------------- */
        String original  = FileIO.readUtf8(plainFile);
        String recovered = FileIO.readUtf8(decFile);
        System.out.println(original.equals(recovered)
                ? "[5] Validation OK - plaintext matches."
                : "[5] WARNING - plaintext mismatch!");
    }
}

How to run


mvn -q compile exec:java\
  -Dexec.mainClass="co.ankatech.ankasecure.sdk.examples.ExampleScenario5"

Console milestones:

  • ML-KEM-512 key resolution from the playground

  • Key metadata printed to the console

  • Non-streaming compact-JWE encryption → scenario5.cipher.jwe

  • Decryption → scenario5_decrypted.txt

  • Validation OK confirming byte-perfect round-trip


Where next?