feat: Add license attribution for all files

Signed-off-by: David Runge <dave@sleepmap.de>
This commit is contained in:
David Runge 2023-10-23 19:04:58 +02:00
parent 7aa096db39
commit 121e352b59
No known key found for this signature in database
GPG key ID: 90D4B9641E092971
34 changed files with 161 additions and 3 deletions

View file

@ -1 +1,4 @@
book/build
# SPDX-FileCopyrightText: 2023 The "Notes on OpenPGP" project
# SPDX-License-Identifier: CC0-1.0
book/build

4
.gitignore vendored
View file

@ -1,3 +1,5 @@
# SPDX-FileCopyrightText: 2023 The "Notes on OpenPGP" project
# SPDX-License-Identifier: CC0-1.0
.idea
book/build/

8
.reuse/dep5 Normal file
View file

@ -0,0 +1,8 @@
Format: https://www.debian.org/doc/packaging-manuals/copyright-format/1.0/
Upstream-Name: notes
Upstream-Contact: Heiko Schaefer <heiko@schaefer.name>
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

View file

@ -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

View file

@ -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

View file

@ -1,3 +1,8 @@
<!--
SPDX-FileCopyrightText: 2023 The "Notes on OpenPGP" project
SPDX-License-Identifier: CC-BY-SA-4.0
-->
# Notes on OpenPGP
The "Notes on OpenPGP" project aims to produce accessible documentation for various aspects of the OpenPGP ecosystem.

View file

@ -1,3 +1,6 @@
# SPDX-FileCopyrightText: 2023 The "Notes on OpenPGP" project
# SPDX-License-Identifier: CC0-1.0
#
# Minimal makefile for Sphinx documentation
#

View file

@ -1,3 +1,6 @@
:: SPDX-FileCopyrightText: 2023 The "Notes on OpenPGP" project
:: SPDX-License-Identifier: CC0-1.0
@ECHO OFF
pushd %~dp0

View file

@ -1,3 +1,8 @@
<!--
SPDX-FileCopyrightText: 2023 The "Notes on OpenPGP" project
SPDX-License-Identifier: CC-BY-SA-4.0
-->
# Introducing OpenPGP
This documentation project seeks to introduce OpenPGP concepts and functionalities to software developers who wish to use it in their projects.

View file

@ -1,3 +1,8 @@
<!--
SPDX-FileCopyrightText: 2023 The "Notes on OpenPGP" project
SPDX-License-Identifier: CC-BY-SA-4.0
-->
# A high-level view
## Why OpenPGP?

View file

@ -1,3 +1,8 @@
<!--
SPDX-FileCopyrightText: 2023 The "Notes on OpenPGP" project
SPDX-License-Identifier: CC-BY-SA-4.0
-->
(cyrptography_chapter)=
# Cryptographic concepts and terms

View file

@ -1,3 +1,8 @@
<!--
SPDX-FileCopyrightText: 2023 The "Notes on OpenPGP" project
SPDX-License-Identifier: CC-BY-SA-4.0
-->
(certificates_chapter)=
# Certificates

View file

@ -1,3 +1,8 @@
<!--
SPDX-FileCopyrightText: 2023 The "Notes on OpenPGP" project
SPDX-License-Identifier: CC-BY-SA-4.0
-->
(private_key_chapter)=
# OpenPGP private keys

View file

@ -1,3 +1,8 @@
<!--
SPDX-FileCopyrightText: 2023 The "Notes on OpenPGP" project
SPDX-License-Identifier: CC-BY-SA-4.0
-->
(certifications_chapter)=
# Certification signatures

View file

@ -1,3 +1,8 @@
<!--
SPDX-FileCopyrightText: 2023 The "Notes on OpenPGP" project
SPDX-License-Identifier: CC-BY-SA-4.0
-->
(signing_data)=
# Signatures over data

View file

@ -1,3 +1,8 @@
<!--
SPDX-FileCopyrightText: 2023 The "Notes on OpenPGP" project
SPDX-License-Identifier: CC-BY-SA-4.0
-->
# Signature "internals"
```{admonition} TODO

View file

@ -1,3 +1,8 @@
<!--
SPDX-FileCopyrightText: 2023 The "Notes on OpenPGP" project
SPDX-License-Identifier: CC-BY-SA-4.0
-->
(verification_chapter)=
# Verification

View file

@ -1,3 +1,8 @@
<!--
SPDX-FileCopyrightText: 2023 The "Notes on OpenPGP" project
SPDX-License-Identifier: CC-BY-SA-4.0
-->
(encryption_chapter)=
# Encryption

View file

@ -1,3 +1,8 @@
<!--
SPDX-FileCopyrightText: 2023 The "Notes on OpenPGP" project
SPDX-License-Identifier: CC-BY-SA-4.0
-->
(decryption_chapter)=
# Decryption

View file

@ -1,3 +1,8 @@
<!--
SPDX-FileCopyrightText: 2023 The "Notes on OpenPGP" project
SPDX-License-Identifier: CC-BY-SA-4.0
-->
# Compression
## Zooming in: Packet structure

View file

@ -1,3 +1,8 @@
<!--
SPDX-FileCopyrightText: 2023 The "Notes on OpenPGP" project
SPDX-License-Identifier: CC-BY-SA-4.0
-->
# ASCII Armor
The native format of OpenPGP data is binary.

View file

@ -1,3 +1,8 @@
<!--
SPDX-FileCopyrightText: 2023 The "Notes on OpenPGP" project
SPDX-License-Identifier: CC-BY-SA-4.0
-->
# Pitfalls / Things to keep in mind
## Key IDs are really not guaranteed to be unique

View file

@ -1,3 +1,8 @@
<!--
SPDX-FileCopyrightText: 2023 The "Notes on OpenPGP" project
SPDX-License-Identifier: CC-BY-SA-4.0
-->
# Migration from v4 to v6
```{admonition} TODO

View file

@ -1,3 +1,8 @@
<!--
SPDX-FileCopyrightText: 2023 The "Notes on OpenPGP" project
SPDX-License-Identifier: CC-BY-SA-4.0
-->
# Algorithms and Policy
```{admonition} TODO

View file

@ -1,3 +1,8 @@
<!--
SPDX-FileCopyrightText: 2023 The "Notes on OpenPGP" project
SPDX-License-Identifier: CC-BY-SA-4.0
-->
# 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.

View file

@ -1,3 +1,8 @@
<!--
SPDX-FileCopyrightText: 2023 The "Notes on OpenPGP" project
SPDX-License-Identifier: CC-BY-SA-4.0
-->
# Zooming in: Packet structure of private key material
## A look at Alice's (unencrypted) private key packets

View file

@ -1 +1,6 @@
<!--
SPDX-FileCopyrightText: 2023 The "Notes on OpenPGP" project
SPDX-License-Identifier: CC-BY-SA-4.0
-->
# Zooming in: Packet structure of data signatures

View file

@ -1 +1,6 @@
<!--
SPDX-FileCopyrightText: 2023 The "Notes on OpenPGP" project
SPDX-License-Identifier: CC-BY-SA-4.0
-->
# Zooming in: Packet structure of encrypted data

View file

@ -1,3 +1,8 @@
<!--
SPDX-FileCopyrightText: 2023 The "Notes on OpenPGP" project
SPDX-License-Identifier: CC-BY-SA-4.0
-->
# External resources
[OpenPGP version 6 draft specification](https://datatracker.ietf.org/doc/draft-ietf-openpgp-crypto-refresh/) draft-ietf-openpgp-crypto-refresh [2023]

View file

@ -1,3 +1,8 @@
<!--
SPDX-FileCopyrightText: 2023 The "Notes on OpenPGP" project
SPDX-License-Identifier: CC-BY-SA-4.0
-->
# Glossary
```{glossary}

View file

@ -1 +1,6 @@
<!--
SPDX-FileCopyrightText: 2023 The "Notes on OpenPGP" project
SPDX-License-Identifier: CC-BY-SA-4.0
-->
# Acknowledgements

View file

@ -1,3 +1,8 @@
<!--
SPDX-FileCopyrightText: 2023 The "Notes on OpenPGP" project
SPDX-License-Identifier: CC-BY-SA-4.0
-->
# Appendix A: OpenPGP artifacts
(alice_priv)=

View file

@ -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 ---------------------------------------------------

View file

@ -1,3 +1,8 @@
<!--
SPDX-FileCopyrightText: 2023 The "Notes on OpenPGP" project
SPDX-License-Identifier: CC-BY-SA-4.0
-->
# OpenPGP for application developers
**{sub-ref}`today`**