diff --git a/.dockerignore b/.dockerignore index 7aa51b0..54fd6f2 100644 --- a/.dockerignore +++ b/.dockerignore @@ -1 +1,4 @@ -book/build \ No newline at end of file +# SPDX-FileCopyrightText: 2023 The "Notes on OpenPGP" project +# SPDX-License-Identifier: CC0-1.0 + +book/build diff --git a/.gitignore b/.gitignore index df84cb6..ad3d966 100644 --- a/.gitignore +++ b/.gitignore @@ -1,3 +1,5 @@ +# SPDX-FileCopyrightText: 2023 The "Notes on OpenPGP" project +# SPDX-License-Identifier: CC0-1.0 + .idea book/build/ - diff --git a/.reuse/dep5 b/.reuse/dep5 new file mode 100644 index 0000000..836a0a8 --- /dev/null +++ b/.reuse/dep5 @@ -0,0 +1,8 @@ +Format: https://www.debian.org/doc/packaging-manuals/copyright-format/1.0/ +Upstream-Name: notes +Upstream-Contact: Heiko Schaefer +Source: https://codeberg.org/openpgp/notes + +Files: book/source/diag/*.png book/source/diag/*.svg +Copyright: 2023 The "Notes on OpenPGP" project +License: CC-BY-SA-4.0 diff --git a/.woodpecker/doc-pages.yml b/.woodpecker/doc-pages.yml index 083936b..7761478 100644 --- a/.woodpecker/doc-pages.yml +++ b/.woodpecker/doc-pages.yml @@ -1,3 +1,6 @@ +# SPDX-FileCopyrightText: 2023 The "Notes on OpenPGP" project +# SPDX-License-Identifier: CC0-1.0 + steps: pages: image: woodpeckerci/plugin-docker-buildx diff --git a/Dockerfile b/Dockerfile index 14eb209..3941373 100644 --- a/Dockerfile +++ b/Dockerfile @@ -1,3 +1,6 @@ +# SPDX-FileCopyrightText: 2023 The "Notes on OpenPGP" project +# SPDX-License-Identifier: CC0-1.0 + FROM sphinxdoc/sphinx AS build RUN pip install myst-parser COPY book/ /book diff --git a/README.md b/README.md index 343a07f..8c4538a 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,8 @@ + + # Notes on OpenPGP The "Notes on OpenPGP" project aims to produce accessible documentation for various aspects of the OpenPGP ecosystem. diff --git a/book/Makefile b/book/Makefile index d0c3cbf..cda2a70 100644 --- a/book/Makefile +++ b/book/Makefile @@ -1,3 +1,6 @@ +# SPDX-FileCopyrightText: 2023 The "Notes on OpenPGP" project +# SPDX-License-Identifier: CC0-1.0 +# # Minimal makefile for Sphinx documentation # diff --git a/book/make.bat b/book/make.bat index dc1312a..f8a278d 100644 --- a/book/make.bat +++ b/book/make.bat @@ -1,3 +1,6 @@ +:: SPDX-FileCopyrightText: 2023 The "Notes on OpenPGP" project +:: SPDX-License-Identifier: CC0-1.0 + @ECHO OFF pushd %~dp0 diff --git a/book/source/01-intro.md b/book/source/01-intro.md index 3fa5b10..f5eba2b 100644 --- a/book/source/01-intro.md +++ b/book/source/01-intro.md @@ -1,3 +1,8 @@ + + # Introducing OpenPGP This documentation project seeks to introduce OpenPGP concepts and functionalities to software developers who wish to use it in their projects. diff --git a/book/source/02-highlevel.md b/book/source/02-highlevel.md index 221ee5b..6018205 100644 --- a/book/source/02-highlevel.md +++ b/book/source/02-highlevel.md @@ -1,3 +1,8 @@ + + # A high-level view ## Why OpenPGP? diff --git a/book/source/03-cryptography.md b/book/source/03-cryptography.md index 797d9f2..85344de 100644 --- a/book/source/03-cryptography.md +++ b/book/source/03-cryptography.md @@ -1,3 +1,8 @@ + + (cyrptography_chapter)= # Cryptographic concepts and terms diff --git a/book/source/04-certificates.md b/book/source/04-certificates.md index 644d1a5..b3149fe 100644 --- a/book/source/04-certificates.md +++ b/book/source/04-certificates.md @@ -1,3 +1,8 @@ + + (certificates_chapter)= # Certificates diff --git a/book/source/05-private.md b/book/source/05-private.md index 9820dec..bf52b20 100644 --- a/book/source/05-private.md +++ b/book/source/05-private.md @@ -1,3 +1,8 @@ + + (private_key_chapter)= # OpenPGP private keys diff --git a/book/source/06-certifications.md b/book/source/06-certifications.md index 6b12dde..d394bd2 100644 --- a/book/source/06-certifications.md +++ b/book/source/06-certifications.md @@ -1,3 +1,8 @@ + + (certifications_chapter)= # Certification signatures diff --git a/book/source/07-signing_data.md b/book/source/07-signing_data.md index 7ec8512..a778c09 100644 --- a/book/source/07-signing_data.md +++ b/book/source/07-signing_data.md @@ -1,3 +1,8 @@ + + (signing_data)= # Signatures over data diff --git a/book/source/08-signature_internals.md b/book/source/08-signature_internals.md index 0e3bc53..250abcd 100644 --- a/book/source/08-signature_internals.md +++ b/book/source/08-signature_internals.md @@ -1,3 +1,8 @@ + + # Signature "internals" ```{admonition} TODO diff --git a/book/source/09-verification.md b/book/source/09-verification.md index bee54ba..52f67f4 100644 --- a/book/source/09-verification.md +++ b/book/source/09-verification.md @@ -1,3 +1,8 @@ + + (verification_chapter)= # Verification diff --git a/book/source/10-encryption.md b/book/source/10-encryption.md index 6489040..0d0b1c5 100644 --- a/book/source/10-encryption.md +++ b/book/source/10-encryption.md @@ -1,3 +1,8 @@ + + (encryption_chapter)= # Encryption diff --git a/book/source/11-decryption.md b/book/source/11-decryption.md index 930a1b7..a3e39dd 100644 --- a/book/source/11-decryption.md +++ b/book/source/11-decryption.md @@ -1,3 +1,8 @@ + + (decryption_chapter)= # Decryption diff --git a/book/source/12-compression.md b/book/source/12-compression.md index aa6e6d4..9e3a0f5 100644 --- a/book/source/12-compression.md +++ b/book/source/12-compression.md @@ -1,3 +1,8 @@ + + # Compression ## Zooming in: Packet structure diff --git a/book/source/13-armor.md b/book/source/13-armor.md index a50c1fe..a7870e3 100644 --- a/book/source/13-armor.md +++ b/book/source/13-armor.md @@ -1,3 +1,8 @@ + + # ASCII Armor The native format of OpenPGP data is binary. diff --git a/book/source/14-pitfalls.md b/book/source/14-pitfalls.md index cd538ca..ae611f3 100644 --- a/book/source/14-pitfalls.md +++ b/book/source/14-pitfalls.md @@ -1,3 +1,8 @@ + + # Pitfalls / Things to keep in mind ## Key IDs are really not guaranteed to be unique diff --git a/book/source/15-migration.md b/book/source/15-migration.md index 9bb57a5..94c23b2 100644 --- a/book/source/15-migration.md +++ b/book/source/15-migration.md @@ -1,3 +1,8 @@ + + # Migration from v4 to v6 ```{admonition} TODO diff --git a/book/source/16-policy.md b/book/source/16-policy.md index d85f4f4..0bc613d 100644 --- a/book/source/16-policy.md +++ b/book/source/16-policy.md @@ -1,3 +1,8 @@ + + # Algorithms and Policy ```{admonition} TODO diff --git a/book/source/17-zoom_certificates.md b/book/source/17-zoom_certificates.md index e8324cd..3bcd65f 100644 --- a/book/source/17-zoom_certificates.md +++ b/book/source/17-zoom_certificates.md @@ -1,3 +1,8 @@ + + # Zooming in: Packet structure of certificates and keys Now that we've established these concepts, and the components that OpenPGP certificates consist of, let's look at the internal details of an example certificate. diff --git a/book/source/18-zoom_private_keys.md b/book/source/18-zoom_private_keys.md index f8eadab..d6a8acb 100644 --- a/book/source/18-zoom_private_keys.md +++ b/book/source/18-zoom_private_keys.md @@ -1,3 +1,8 @@ + + # Zooming in: Packet structure of private key material ## A look at Alice's (unencrypted) private key packets diff --git a/book/source/19-zoom_signatures.md b/book/source/19-zoom_signatures.md index 4de3db3..7f29aef 100644 --- a/book/source/19-zoom_signatures.md +++ b/book/source/19-zoom_signatures.md @@ -1 +1,6 @@ + + # Zooming in: Packet structure of data signatures diff --git a/book/source/20-zoom_encyption.md b/book/source/20-zoom_encyption.md index afb9ae9..79880f2 100644 --- a/book/source/20-zoom_encyption.md +++ b/book/source/20-zoom_encyption.md @@ -1 +1,6 @@ + + # Zooming in: Packet structure of encrypted data diff --git a/book/source/21-resources.md b/book/source/21-resources.md index ce828cf..7df2b4b 100644 --- a/book/source/21-resources.md +++ b/book/source/21-resources.md @@ -1,3 +1,8 @@ + + # External resources [OpenPGP version 6 draft specification](https://datatracker.ietf.org/doc/draft-ietf-openpgp-crypto-refresh/) draft-ietf-openpgp-crypto-refresh [2023] diff --git a/book/source/22-glossary.md b/book/source/22-glossary.md index 31d8674..3686526 100644 --- a/book/source/22-glossary.md +++ b/book/source/22-glossary.md @@ -1,3 +1,8 @@ + + # Glossary ```{glossary} diff --git a/book/source/23-acknowledgements.md b/book/source/23-acknowledgements.md index de67a3a..2c90fac 100644 --- a/book/source/23-acknowledgements.md +++ b/book/source/23-acknowledgements.md @@ -1 +1,6 @@ + + # Acknowledgements diff --git a/book/source/a-artifacts.md b/book/source/a-artifacts.md index 914a1d4..460a1b8 100644 --- a/book/source/a-artifacts.md +++ b/book/source/a-artifacts.md @@ -1,3 +1,8 @@ + + # Appendix A: OpenPGP artifacts (alice_priv)= diff --git a/book/source/conf.py b/book/source/conf.py index c734f9d..adaea50 100644 --- a/book/source/conf.py +++ b/book/source/conf.py @@ -1,3 +1,6 @@ +# SPDX-FileCopyrightText: 2023 The "Notes on OpenPGP" project +# SPDX-License-Identifier: CC0-1.0 +# # Configuration file for the Sphinx documentation builder. # # For the full list of built-in configuration values, see the documentation: @@ -7,7 +10,7 @@ # https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information project = 'OpenPGP for application developers' -copyright = '2023, The "Notes on OpenPGP" project' +copyright = '2023, The "Notes on OpenPGP" project, CC-BY-SA-4.0' version = "0.01" # -- General configuration --------------------------------------------------- diff --git a/book/source/index.md b/book/source/index.md index e56298d..23e7fcd 100644 --- a/book/source/index.md +++ b/book/source/index.md @@ -1,3 +1,8 @@ + + # OpenPGP for application developers **{sub-ref}`today`**