This is an automated email from the ASF dual-hosted git repository. chibenwa pushed a commit to branch master in repository https://gitbox.apache.org/repos/asf/james-jdkim.git
commit 77212f57097a667e2b321ba56c44e5423203fb74 Author: Benoit TELLIER <[email protected]> AuthorDate: Sun Aug 23 23:28:35 2026 +0700 [DOC] Migrate src/site to Antora --- docs/antora.yml | 4 +++- docs/modules/ROOT/nav.adoc | 8 ++++++++ docs/modules/ROOT/pages/index.adoc | 26 ++++++++++++++++++++++++-- docs/modules/ROOT/pages/main/index.adoc | 15 +++++++++++++++ 4 files changed, 50 insertions(+), 3 deletions(-) diff --git a/docs/antora.yml b/docs/antora.yml index 4b57624..60835cc 100644 --- a/docs/antora.yml +++ b/docs/antora.yml @@ -1,4 +1,6 @@ name: jdkim title: Apache James JDKIM -version: '0.3-SNAPSHOT' +version: '0.6-SNAPSHOT' prerelease: true +nav: + - modules/ROOT/nav.adoc diff --git a/docs/modules/ROOT/nav.adoc b/docs/modules/ROOT/nav.adoc new file mode 100644 index 0000000..85017ec --- /dev/null +++ b/docs/modules/ROOT/nav.adoc @@ -0,0 +1,8 @@ +* xref:index.adoc[Overview] +* xref:main/index.adoc[Library] +* https://issues.apache.org/jira/browse/JDKIM[Issue Tracker] +* Related Projects +** https://james.apache.org/jspf/index.html[jSPF] +** https://dkim-javamail.sourceforge.net[DKIM Javamail] +** https://www.badpenguin.co.uk/dkim/[JavaDKIM] +* https://james.apache.org/download.cgi#Apache_jDKIM[Download Releases] diff --git a/docs/modules/ROOT/pages/index.adoc b/docs/modules/ROOT/pages/index.adoc index b73da30..2902420 100644 --- a/docs/modules/ROOT/pages/index.adoc +++ b/docs/modules/ROOT/pages/index.adoc @@ -1,4 +1,26 @@ -= Apache James JDKIM documentation += Apache jDKIM Project +jDKIM is a DKIM implementation library written in Java. It provides both +verification and signing. -TODO: This is a placeholder. Migrate older documentation. +The architecture is thought to handle multiple signatures with performance in +mind: body hashing for multiple signatures is computed concurrently in a single +stream run. + +The whole internal verification/signing is done via `OutputStream`, leaving much +more flexibility than the use of `InputStream`. As the `InputStream` approach is +easier from the user side, the default implementation simply prepares the +`OutputStream` and copies the supplied `InputStream` to the `OutputStream`. + +jDKIM requires Java 11 at runtime, and it requires the JVM running the library +to support the `SHA256withRSA` cipher suite. If your JVM doesn't support it you +can install a third party cryptography provider like BouncyCastle and configure +it appropriately in your JVM. + +The product currently consists of a single generic library module, +xref:main/index.adoc[main]. + +The DKIM mailets for the Apache James server are no longer part of this project. +They live in +https://github.com/apache/james-project/tree/master/server/mailet/dkim[james-project] +under `server/mailet/dkim`. diff --git a/docs/modules/ROOT/pages/main/index.adoc b/docs/modules/ROOT/pages/main/index.adoc new file mode 100644 index 0000000..5ef4f66 --- /dev/null +++ b/docs/modules/ROOT/pages/main/index.adoc @@ -0,0 +1,15 @@ += Java DKIM Library + +This is a DKIM implementation library written in Java. + +The architecture is interface based and pluggable. You can tweak it in almost +every behaviour. + +The architecture is thought to handle multiple signatures with performance in +mind: body hashing for multiple signatures is computed concurrently in a single +stream run. + +The whole internal verification/signing is done via `OutputStream`, leaving much +more flexibility than the use of `InputStream`. As the `InputStream` approach is +easier from the user side, the default implementation simply prepares the +`OutputStream` and copies the supplied `InputStream` to the `OutputStream`. --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
