Skip to content

Commit

Permalink
docs: add interactive TRC signing ceremony builder (#4624)
Browse files Browse the repository at this point in the history
And an interactive TRC signing ceremony builder.
It supports all three types of TRC ceremony: base, regular, and
sensitive. The user can select between scion-pki and openssl.
Furthermore, support for pkcs11 is available for openssl. In a future
iteration, support for scion-pki kms will be added.

The builder is intended to be used by a voting (or root CA) participant.
The adminstrator role is not supported in this version. (Administrators
should be very knowledgable about the TRC ceremony anyway.)

The builder is based on aplinejs and tailwindcss. This allows us to
included it in our RTD page with zero dependency and build steps.


![image](https://github.com/user-attachments/assets/e02dc043-7233-4713-8267-fa67ce489b2d)


[doc]
  • Loading branch information
oncilla authored Sep 19, 2024
1 parent 07b6b15 commit 2610321
Show file tree
Hide file tree
Showing 6 changed files with 1,030 additions and 3 deletions.
3 changes: 2 additions & 1 deletion doc/Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@ SPHINX_AUTOBUILD ?= bazel run //doc:sphinx-autobuild --
SPHINXOPTS ?= -W --keep-going # treat warnings as errors, but process all files when an error occurs
SOURCEDIR = $(abspath .)
BUILDDIR = $(abspath ./_build)
HOST ?= localhost

# Build docs with Sphinx using the "make mode" option.
# Explicitly list the main build targets so they auto-complete in shells.
Expand All @@ -30,7 +31,7 @@ html latex latexpdf linkcheck help:
# Note: most options are forwarded as-is to sphinx, but --keep-going is not understood and we explicitly drop it.
.PHONY: autobuild
autobuild:
$(SPHINX_AUTOBUILD) "$(SOURCEDIR)" "$(BUILDDIR)" $(filter-out --keep-going,$(SPHINXOPTS))
$(SPHINX_AUTOBUILD) "--host=$(HOST)" "$(SOURCEDIR)" "$(BUILDDIR)" $(filter-out --keep-going,$(SPHINXOPTS))

.PHONY: clean
clean:
Expand Down
5 changes: 5 additions & 0 deletions doc/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -106,3 +106,8 @@
html_css_files = [
"css/custom.css",
]

html_js_files = [
"https://unpkg.com/@alpinejs/persist@3.14.1/dist/cdn.min.js",
"https://unpkg.com/alpinejs@3.14.1/dist/cdn.min.js",
]
1 change: 1 addition & 0 deletions doc/cryptography/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ SCION Cryptography
trc-signing-ceremony-preparations
trc-signing-ceremony-phases-base
trc-signing-ceremony-phases-sensitive
trc-signing-ceremony-builder
ca-operations
interactions
drkey
Expand Down
Loading

0 comments on commit 2610321

Please sign in to comment.