Egothor/ZeroEcho
2
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases 2 Wiki Activity

fix: JavaDoc improvements
Some checks failed
Release / release (push) Failing after 1m48s
Details

Browse Source
This commit is contained in:
Leo Galambos
2025-08-04 23:43:23 +02:00
parent 55b0153f56
commit 2e6664551e
3 changed files with 124 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

1
lib/build.gradle
View File

@@ -13,4 +13,5 @@ dependencies {
javadoc {
options.links("https://www.egothor.org/javadoc/conflux")
options.overview = file("src/main/javadoc/overview.html")
}

44
lib/src/main/javadoc/overview.html Normal file
View File

@@ -0,0 +1,44 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<title>ZeroEcho API Library</title>
</head>
<body>
<p>
The ZeroEcho library provides a cohesive and extensible toolkit for secure data processing, cryptographic transformation,
and covert communication. Its architecture is centered around composability: data flows through builder-defined pipelines,
enabling dynamic combinations of encoding, encryption, formatting, and output strategies.
</p>
<p>
ZeroEcho is particularly suited for applications that require secure transmission or obfuscation of binary data in
constrained or adversarial environments - including command-line payload delivery, steganographic embedding,
and post-quantum cryptographic operations.
</p>
<h1>Design Principles</h1>
<ul>
<li><b>Modularity:</b> Each package targets a specific concern (e.g., encryption, data formatting, covert encoding) and is designed for minimal dependencies and high interoperability.</li>
<li><b>Security:</b> Cryptographic operations leverage trusted providers (notably Bouncy Castle) and emphasize secure defaults, authenticated encryption, and entropy-aware key handling.</li>
<li><b>Builder-Driven APIs:</b> Pipeline construction is managed through fluent builders that abstract away complexity while preserving control.</li>
<li><b>Covert &amp; Controlled Output:</b> Support for covert encoding into media formats (like JPEG) and output to script-ready formats (e.g., Base64 in shell wrappers) makes it ideal for discreet or cross-platform delivery.</li>
</ul>
<h1>Key Capabilities</h1>
<p>
The library includes:
</p>
<ul>
<li>Construction and chaining of content transformations via the <code>builder</code> module</li>
<li>Data hiding mechanisms in binary and JPEG images through the <code>covert</code> packages</li>
<li>Robust support for AES and asymmetric encryption, password-based key derivation, and post-quantum cryptography via <code>util.aes</code>, <code>util.asymmetric</code>, and <code>util.bc</code></li>
<li>Flexible data output in raw, Base64, or platform-specific shell-script forms via <code>data.output</code></li>
</ul>
<p>
ZeroEcho aims to bridge high-assurance cryptographic practices with practical concerns around portability,
concealment, and controlled delivery - whether in a CLI toolchain, embedded device, or secure messaging layer.
</p>
</body>
</html>