Initial commit

lib/src/main/java/zeroecho/data/processing/package-info.java

@@ -0,0 +1,79 @@
+/*******************************************************************************
+ * Copyright (C) 2025, Leo Galambos
+ * All rights reserved.
+ * 
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are met:
+ * 
+ * 1. Redistributions of source code must retain the above copyright notice,
+ *    this list of conditions and the following disclaimer.
+ * 
+ * 2. Redistributions in binary form must reproduce the above copyright notice,
+ *    this list of conditions and the following disclaimer in the documentation
+ *    and/or other materials provided with the distribution.
+ * 
+ * 3. All advertising materials mentioning features or use of this software must
+ *    display the following acknowledgement:
+ *    This product includes software developed by the Egothor project.
+ * 
+ * 4. Neither the name of the copyright holder nor the names of its contributors
+ *    may be used to endorse or promote products derived from this software
+ *    without specific prior written permission.
+ * 
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+ * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+ * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+ * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
+ * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+ * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+ * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+ * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+ * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+ * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+ * POSSIBILITY OF SUCH DAMAGE.
+ ******************************************************************************/
+/**
+ * Provides a comprehensive set of classes for AES encryption and decryption,
+ * password-based key derivation, and secure content handling.
+ *
+ * <p>
+ * This package contains the core AES cryptographic components:
+ * <ul>
+ * <li>{@link AesCommon} — common AES utilities and base class for encryptors
+ * and decryptors</li>
+ * <li>{@link AesEncryptor} and {@link AesDecryptor} — stream-based AES
+ * encryption and decryption handlers</li>
+ * <li>{@link PasswordBasedAesEncryptor} and {@link PasswordBasedAesDecryptor} —
+ * AES implementations using password-derived keys (via PBKDF2)</li>
+ * <li>{@link SecretRandom} — abstract base class for secure byte sequence
+ * generators</li>
+ * <li>{@link SecretAesRandom} — deterministic AES-based implementation of
+ * {@code SecretRandom}</li>
+ * <li>{@link SecretDerivedAesParameters} — encapsulates derived AES keys and
+ * IVs with contextual integrity checks</li>
+ * <li>{@link SecretMultiRecipientCryptor} — supports encrypting data for
+ * multiple recipients using independent key derivation paths</li>
+ * <li>{@link SecretPassword} — immutable password container designed for secure
+ * handling and comparison</li>
+ * </ul>
+ *
+ * <p>
+ * The package also offers plain content wrappers for handling unencrypted data
+ * sources:
+ * <ul>
+ * <li>{@link PlainBytes} — wraps raw byte arrays as content sources</li>
+ * <li>{@link PlainString} — wraps UTF-8 strings as content sources</li>
+ * <li>{@link PlainFile} — treats file-based or URL-based content as input
+ * sources</li>
+ * </ul>
+ *
+ * <p>
+ * This package is designed around streaming APIs and centralized context-based
+ * cryptographic parameter management using the shared {@link conflux.Ctx}
+ * object. It facilitates secure encryption workflows with support for dynamic
+ * derivation, deterministic streams, and multi-party encryption use cases.
+ * </p>
+ *
+ * @author Leo Galambos
+ */
+package zeroecho.data.processing;