Flow 6 – ML-DSA-87 Sign/Verify (Non-Streaming)

/*
 * 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.
 *
 * SPDX-License-Identifier: Apache-2.0
 */
package co.ankatech.ankasecure.sdk.examples;

import co.ankatech.ankasecure.sdk.AuthenticatedSdk;
import co.ankatech.ankasecure.sdk.model.GenerateKeySpec;
import co.ankatech.ankasecure.sdk.model.SignResult;
import co.ankatech.ankasecure.sdk.model.VerifySignatureResult;
import co.ankatech.ankasecure.sdk.util.FileIO;

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

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

/**
 * Scenario 6 — ML-DSA-87 Bulk Helpers (Compact JWS).
 *
 * <p>This scenario signs and verifies a document with <strong>non-streaming</strong>
 * helpers that operate on RFC&nbsp;7515 <em>Compact&nbsp;JWS</em> tokens:</p>
 * <ol>
 *   <li>Generate an <code>ML-DSA-87</code> key.</li>
 *   <li>Export its metadata.</li>
 *   <li>Create a Compact JWS on disk via {@link AuthenticatedSdk#signFile(String, Path, Path)}.</li>
 *   <li>Verify it via {@link AuthenticatedSdk#verifySignature(Path)}.</li>
 *   <li>Print server metadata and validate integrity.</li>
 * </ol>
 *
 * <p><b>Implementation notes (Java&nbsp;21+):</b></p>
 * <ul>
 *   <li>Filesystem interactions rely on the {@link java.nio.file.Path} API.</li>
 *   <li>UTF-8 is enforced explicitly for deterministic encoding.</li>
 *   <li>Temporary artefacts reside under <kbd>temp_files/</kbd>.</li>
 * </ul>
 *
 * <p><b>Thread-safety:</b> this class is stateless and immutable.</p>
 *
 * @author ANKATech Solutions Inc.
 * @since 3.0.0
 * @see ExampleUtil
 * @see AuthenticatedSdk
 */
public final class ExampleScenario6 {

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

    /**
     * Runs the ML-DSA-87 compact JWS sign/verify 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 6 START =====");
        System.out.println("""
                Purpose :
                  * ML-DSA-87 compact-JWS sign / verify helpers
                  * Non-streaming - token handled as text
                Steps   :
                  1) Generate ML-DSA-87 key
                  2) Export public metadata
                  3) Sign payload (compact JWS)
                  4) Verify signature
                  5) Validate integrity
                --------------------------------------------------------------""");

        try {
            ensureTempDir(TEMP_DIR);

            Properties   props = loadProperties();
            AuthenticatedSdk sdk  = authenticate(props);

            runScenario(sdk);

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

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

    /**
     * Executes the 5-step ML-DSA-87 sign/verify scenario.
     *
     * <ol>
     *   <li>Prepare document file.</li>
     *   <li>Generate ML-DSA-87 signing key.</li>
     *   <li>Export key metadata.</li>
     *   <li>Sign document (compact JWS).</li>
     *   <li>Verify signature and report result.</li>
     * </ol>
     *
     * @param sdk an authenticated {@link AuthenticatedSdk} instance;
     *            must not be {@code null}
     * @throws Exception if any step fails
     */
    private static void runScenario(final AuthenticatedSdk sdk) throws Exception {

        /* 1 -- prepare document --------------------------------------------- */
        Path doc = TEMP_DIR.resolve("scenario6_doc.txt");
        FileIO.writeUtf8(doc,
                "Scenario-6 - ML-DSA-87 compact-JWS sign / verify demo.");
        System.out.println("[1] Document ready          -> " + doc.toAbsolutePath());

        /* 2 -- generate ML-DSA-87 key --------------------------------------- */
        String kid = "sc6_mlds87_" + System.currentTimeMillis();
        sdk.generateKey(new GenerateKeySpec()
                .setKid(kid)
                .setKty("ML-DSA")
                .setAlg("ML-DSA-87"));
        System.out.println("[2] Key generated            -> kid = " + kid);

        /* 3 -- export metadata ---------------------------------------------- */
        Path metaFile = TEMP_DIR.resolve("scenario6_key.json");
        FileIO.writeUtf8(metaFile, toJson(sdk.exportKey(kid)));
        System.out.println("[3] Metadata exported        -> " + metaFile.toAbsolutePath());

        /* 4 -- sign (compact JWS) ------------------------------------------- */
        Path jwsFile = TEMP_DIR.resolve("scenario6.jws");
        SignResult signMeta = sdk.signFile(kid, doc, jwsFile);
        System.out.println("[4] JWS written              -> " + jwsFile.toAbsolutePath());
        printSignMeta(signMeta);

        /* 5 -- verify ------------------------------------------------------- */
        VerifySignatureResult verMeta = sdk.verifySignature(jwsFile);
        System.out.println(MessageFormat.format(
                "[5] Signature valid?        : {0}", verMeta.isValid()));
        printVerifyMeta(verMeta);

        System.out.println(verMeta.isValid()
                ? "[6] SUCCESS - signature verified."
                : "[6] FAILURE - signature invalid.");
    }
}