mirror of
https://codeberg.org/openpgp/notes.git
synced 2024-11-29 19:12:06 +01:00
feat: Add license attribution for all files
Signed-off-by: David Runge <dave@sleepmap.de>
This commit is contained in:
parent
7aa096db39
commit
121e352b59
34 changed files with 161 additions and 3 deletions
|
@ -1 +1,4 @@
|
||||||
book/build
|
# SPDX-FileCopyrightText: 2023 The "Notes on OpenPGP" project
|
||||||
|
# SPDX-License-Identifier: CC0-1.0
|
||||||
|
|
||||||
|
book/build
|
||||||
|
|
4
.gitignore
vendored
4
.gitignore
vendored
|
@ -1,3 +1,5 @@
|
||||||
|
# SPDX-FileCopyrightText: 2023 The "Notes on OpenPGP" project
|
||||||
|
# SPDX-License-Identifier: CC0-1.0
|
||||||
|
|
||||||
.idea
|
.idea
|
||||||
book/build/
|
book/build/
|
||||||
|
|
||||||
|
|
8
.reuse/dep5
Normal file
8
.reuse/dep5
Normal 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
|
|
@ -1,3 +1,6 @@
|
||||||
|
# SPDX-FileCopyrightText: 2023 The "Notes on OpenPGP" project
|
||||||
|
# SPDX-License-Identifier: CC0-1.0
|
||||||
|
|
||||||
steps:
|
steps:
|
||||||
pages:
|
pages:
|
||||||
image: woodpeckerci/plugin-docker-buildx
|
image: woodpeckerci/plugin-docker-buildx
|
||||||
|
|
|
@ -1,3 +1,6 @@
|
||||||
|
# SPDX-FileCopyrightText: 2023 The "Notes on OpenPGP" project
|
||||||
|
# SPDX-License-Identifier: CC0-1.0
|
||||||
|
|
||||||
FROM sphinxdoc/sphinx AS build
|
FROM sphinxdoc/sphinx AS build
|
||||||
RUN pip install myst-parser
|
RUN pip install myst-parser
|
||||||
COPY book/ /book
|
COPY book/ /book
|
||||||
|
|
|
@ -1,3 +1,8 @@
|
||||||
|
<!--
|
||||||
|
SPDX-FileCopyrightText: 2023 The "Notes on OpenPGP" project
|
||||||
|
SPDX-License-Identifier: CC-BY-SA-4.0
|
||||||
|
-->
|
||||||
|
|
||||||
# Notes on OpenPGP
|
# Notes on OpenPGP
|
||||||
|
|
||||||
The "Notes on OpenPGP" project aims to produce accessible documentation for various aspects of the OpenPGP ecosystem.
|
The "Notes on OpenPGP" project aims to produce accessible documentation for various aspects of the OpenPGP ecosystem.
|
||||||
|
|
|
@ -1,3 +1,6 @@
|
||||||
|
# SPDX-FileCopyrightText: 2023 The "Notes on OpenPGP" project
|
||||||
|
# SPDX-License-Identifier: CC0-1.0
|
||||||
|
#
|
||||||
# Minimal makefile for Sphinx documentation
|
# Minimal makefile for Sphinx documentation
|
||||||
#
|
#
|
||||||
|
|
||||||
|
|
|
@ -1,3 +1,6 @@
|
||||||
|
:: SPDX-FileCopyrightText: 2023 The "Notes on OpenPGP" project
|
||||||
|
:: SPDX-License-Identifier: CC0-1.0
|
||||||
|
|
||||||
@ECHO OFF
|
@ECHO OFF
|
||||||
|
|
||||||
pushd %~dp0
|
pushd %~dp0
|
||||||
|
|
|
@ -1,3 +1,8 @@
|
||||||
|
<!--
|
||||||
|
SPDX-FileCopyrightText: 2023 The "Notes on OpenPGP" project
|
||||||
|
SPDX-License-Identifier: CC-BY-SA-4.0
|
||||||
|
-->
|
||||||
|
|
||||||
# Introducing OpenPGP
|
# Introducing OpenPGP
|
||||||
|
|
||||||
This documentation project seeks to introduce OpenPGP concepts and functionalities to software developers who wish to use it in their projects.
|
This documentation project seeks to introduce OpenPGP concepts and functionalities to software developers who wish to use it in their projects.
|
||||||
|
|
|
@ -1,3 +1,8 @@
|
||||||
|
<!--
|
||||||
|
SPDX-FileCopyrightText: 2023 The "Notes on OpenPGP" project
|
||||||
|
SPDX-License-Identifier: CC-BY-SA-4.0
|
||||||
|
-->
|
||||||
|
|
||||||
# A high-level view
|
# A high-level view
|
||||||
|
|
||||||
## Why OpenPGP?
|
## Why OpenPGP?
|
||||||
|
|
|
@ -1,3 +1,8 @@
|
||||||
|
<!--
|
||||||
|
SPDX-FileCopyrightText: 2023 The "Notes on OpenPGP" project
|
||||||
|
SPDX-License-Identifier: CC-BY-SA-4.0
|
||||||
|
-->
|
||||||
|
|
||||||
(cyrptography_chapter)=
|
(cyrptography_chapter)=
|
||||||
# Cryptographic concepts and terms
|
# Cryptographic concepts and terms
|
||||||
|
|
||||||
|
|
|
@ -1,3 +1,8 @@
|
||||||
|
<!--
|
||||||
|
SPDX-FileCopyrightText: 2023 The "Notes on OpenPGP" project
|
||||||
|
SPDX-License-Identifier: CC-BY-SA-4.0
|
||||||
|
-->
|
||||||
|
|
||||||
(certificates_chapter)=
|
(certificates_chapter)=
|
||||||
# Certificates
|
# Certificates
|
||||||
|
|
||||||
|
|
|
@ -1,3 +1,8 @@
|
||||||
|
<!--
|
||||||
|
SPDX-FileCopyrightText: 2023 The "Notes on OpenPGP" project
|
||||||
|
SPDX-License-Identifier: CC-BY-SA-4.0
|
||||||
|
-->
|
||||||
|
|
||||||
(private_key_chapter)=
|
(private_key_chapter)=
|
||||||
# OpenPGP private keys
|
# OpenPGP private keys
|
||||||
|
|
||||||
|
|
|
@ -1,3 +1,8 @@
|
||||||
|
<!--
|
||||||
|
SPDX-FileCopyrightText: 2023 The "Notes on OpenPGP" project
|
||||||
|
SPDX-License-Identifier: CC-BY-SA-4.0
|
||||||
|
-->
|
||||||
|
|
||||||
(certifications_chapter)=
|
(certifications_chapter)=
|
||||||
|
|
||||||
# Certification signatures
|
# Certification signatures
|
||||||
|
|
|
@ -1,3 +1,8 @@
|
||||||
|
<!--
|
||||||
|
SPDX-FileCopyrightText: 2023 The "Notes on OpenPGP" project
|
||||||
|
SPDX-License-Identifier: CC-BY-SA-4.0
|
||||||
|
-->
|
||||||
|
|
||||||
(signing_data)=
|
(signing_data)=
|
||||||
# Signatures over data
|
# Signatures over data
|
||||||
|
|
||||||
|
|
|
@ -1,3 +1,8 @@
|
||||||
|
<!--
|
||||||
|
SPDX-FileCopyrightText: 2023 The "Notes on OpenPGP" project
|
||||||
|
SPDX-License-Identifier: CC-BY-SA-4.0
|
||||||
|
-->
|
||||||
|
|
||||||
# Signature "internals"
|
# Signature "internals"
|
||||||
|
|
||||||
```{admonition} TODO
|
```{admonition} TODO
|
||||||
|
|
|
@ -1,3 +1,8 @@
|
||||||
|
<!--
|
||||||
|
SPDX-FileCopyrightText: 2023 The "Notes on OpenPGP" project
|
||||||
|
SPDX-License-Identifier: CC-BY-SA-4.0
|
||||||
|
-->
|
||||||
|
|
||||||
(verification_chapter)=
|
(verification_chapter)=
|
||||||
# Verification
|
# Verification
|
||||||
|
|
||||||
|
|
|
@ -1,3 +1,8 @@
|
||||||
|
<!--
|
||||||
|
SPDX-FileCopyrightText: 2023 The "Notes on OpenPGP" project
|
||||||
|
SPDX-License-Identifier: CC-BY-SA-4.0
|
||||||
|
-->
|
||||||
|
|
||||||
(encryption_chapter)=
|
(encryption_chapter)=
|
||||||
# Encryption
|
# Encryption
|
||||||
|
|
||||||
|
|
|
@ -1,3 +1,8 @@
|
||||||
|
<!--
|
||||||
|
SPDX-FileCopyrightText: 2023 The "Notes on OpenPGP" project
|
||||||
|
SPDX-License-Identifier: CC-BY-SA-4.0
|
||||||
|
-->
|
||||||
|
|
||||||
(decryption_chapter)=
|
(decryption_chapter)=
|
||||||
# Decryption
|
# Decryption
|
||||||
|
|
||||||
|
|
|
@ -1,3 +1,8 @@
|
||||||
|
<!--
|
||||||
|
SPDX-FileCopyrightText: 2023 The "Notes on OpenPGP" project
|
||||||
|
SPDX-License-Identifier: CC-BY-SA-4.0
|
||||||
|
-->
|
||||||
|
|
||||||
# Compression
|
# Compression
|
||||||
|
|
||||||
## Zooming in: Packet structure
|
## Zooming in: Packet structure
|
||||||
|
|
|
@ -1,3 +1,8 @@
|
||||||
|
<!--
|
||||||
|
SPDX-FileCopyrightText: 2023 The "Notes on OpenPGP" project
|
||||||
|
SPDX-License-Identifier: CC-BY-SA-4.0
|
||||||
|
-->
|
||||||
|
|
||||||
# ASCII Armor
|
# ASCII Armor
|
||||||
|
|
||||||
The native format of OpenPGP data is binary.
|
The native format of OpenPGP data is binary.
|
||||||
|
|
|
@ -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
|
# Pitfalls / Things to keep in mind
|
||||||
|
|
||||||
## Key IDs are really not guaranteed to be unique
|
## Key IDs are really not guaranteed to be unique
|
||||||
|
|
|
@ -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
|
# Migration from v4 to v6
|
||||||
|
|
||||||
```{admonition} TODO
|
```{admonition} TODO
|
||||||
|
|
|
@ -1,3 +1,8 @@
|
||||||
|
<!--
|
||||||
|
SPDX-FileCopyrightText: 2023 The "Notes on OpenPGP" project
|
||||||
|
SPDX-License-Identifier: CC-BY-SA-4.0
|
||||||
|
-->
|
||||||
|
|
||||||
# Algorithms and Policy
|
# Algorithms and Policy
|
||||||
|
|
||||||
```{admonition} TODO
|
```{admonition} TODO
|
||||||
|
|
|
@ -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
|
# 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.
|
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.
|
||||||
|
|
|
@ -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
|
# Zooming in: Packet structure of private key material
|
||||||
|
|
||||||
## A look at Alice's (unencrypted) private key packets
|
## A look at Alice's (unencrypted) private key packets
|
||||||
|
|
|
@ -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
|
# Zooming in: Packet structure of data signatures
|
||||||
|
|
|
@ -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
|
# Zooming in: Packet structure of encrypted data
|
||||||
|
|
|
@ -1,3 +1,8 @@
|
||||||
|
<!--
|
||||||
|
SPDX-FileCopyrightText: 2023 The "Notes on OpenPGP" project
|
||||||
|
SPDX-License-Identifier: CC-BY-SA-4.0
|
||||||
|
-->
|
||||||
|
|
||||||
# External resources
|
# External resources
|
||||||
|
|
||||||
[OpenPGP version 6 draft specification](https://datatracker.ietf.org/doc/draft-ietf-openpgp-crypto-refresh/) draft-ietf-openpgp-crypto-refresh [2023]
|
[OpenPGP version 6 draft specification](https://datatracker.ietf.org/doc/draft-ietf-openpgp-crypto-refresh/) draft-ietf-openpgp-crypto-refresh [2023]
|
||||||
|
|
|
@ -1,3 +1,8 @@
|
||||||
|
<!--
|
||||||
|
SPDX-FileCopyrightText: 2023 The "Notes on OpenPGP" project
|
||||||
|
SPDX-License-Identifier: CC-BY-SA-4.0
|
||||||
|
-->
|
||||||
|
|
||||||
# Glossary
|
# Glossary
|
||||||
|
|
||||||
```{glossary}
|
```{glossary}
|
||||||
|
|
|
@ -1 +1,6 @@
|
||||||
|
<!--
|
||||||
|
SPDX-FileCopyrightText: 2023 The "Notes on OpenPGP" project
|
||||||
|
SPDX-License-Identifier: CC-BY-SA-4.0
|
||||||
|
-->
|
||||||
|
|
||||||
# Acknowledgements
|
# Acknowledgements
|
||||||
|
|
|
@ -1,3 +1,8 @@
|
||||||
|
<!--
|
||||||
|
SPDX-FileCopyrightText: 2023 The "Notes on OpenPGP" project
|
||||||
|
SPDX-License-Identifier: CC-BY-SA-4.0
|
||||||
|
-->
|
||||||
|
|
||||||
# Appendix A: OpenPGP artifacts
|
# Appendix A: OpenPGP artifacts
|
||||||
|
|
||||||
(alice_priv)=
|
(alice_priv)=
|
||||||
|
|
|
@ -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.
|
# Configuration file for the Sphinx documentation builder.
|
||||||
#
|
#
|
||||||
# For the full list of built-in configuration values, see the documentation:
|
# 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
|
# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
|
||||||
|
|
||||||
project = 'OpenPGP for application developers'
|
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"
|
version = "0.01"
|
||||||
|
|
||||||
# -- General configuration ---------------------------------------------------
|
# -- General configuration ---------------------------------------------------
|
||||||
|
|
|
@ -1,3 +1,8 @@
|
||||||
|
<!--
|
||||||
|
SPDX-FileCopyrightText: 2023 The "Notes on OpenPGP" project
|
||||||
|
SPDX-License-Identifier: CC-BY-SA-4.0
|
||||||
|
-->
|
||||||
|
|
||||||
# OpenPGP for application developers
|
# OpenPGP for application developers
|
||||||
|
|
||||||
**{sub-ref}`today`**
|
**{sub-ref}`today`**
|
||||||
|
|
Loading…
Reference in a new issue