Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Use Internet-Draft format #55

Merged
merged 1 commit into from
Aug 23, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
51 changes: 51 additions & 0 deletions .github/workflows/editor.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,51 @@
name: Editor

on:
push:
paths-ignore:
- media/deployment.svg
- Makefile
- README.md
- feedback.md
- prototype.worksheet.sc
- .gitignore
pull_request:
paths-ignore:
- media/deployment.svg
- Makefile
- README.md
- feedback.md
- prototype.worksheet.sc
- .gitignore

permissions:
contents: write

jobs:
build:
name: Editor’s Copy
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- id: setup
run: date -u "+date=%FT%T" >> $GITHUB_OUTPUT
- uses: actions/cache@v3
with:
path: |
.refcache
.venv
.gems
node_modules
.targets.mk
key: i-d-${{ steps.setup.outputs.date }}
restore-keys: i-d-
- name: Build
uses: martinthomson/i-d-template@v1
with:
token: ${{ github.token }}
- name: Publish
uses: martinthomson/i-d-template@v1
if: ${{ github.event_name == 'push' }}
with:
make: gh-pages
token: ${{ github.token }}
16 changes: 14 additions & 2 deletions Makefile
Original file line number Diff line number Diff line change
@@ -1,12 +1,24 @@
pdf:
LIBDIR := lib
include $(LIBDIR)/main.mk

$(LIBDIR)/main.mk:
ifneq (,$(shell grep "path *= *$(LIBDIR)" .gitmodules 2>/dev/null))
git submodule sync
git submodule update $(CLONE_ARGS) --init
else
git clone -q --depth 10 $(CLONE_ARGS) \
-b main https://github.com/martinthomson/i-d-template $(LIBDIR)
endif

hdk.pdf:
mkdir -p build
cp -r media build
echo \
"<!doctype html>" \
"<title>Hierarchical Deterministic Keys for the European Digital Identity Wallet</title>" \
"<meta charset=utf-8>" \
> build/hdk.html
npx -p @mermaid-js/mermaid-cli mmdc -i keys.md -o build/keys.md -e svg -t neutral -w 400
npx -p @mermaid-js/mermaid-cli mmdc -i draft-dijkhuis-cfrg-hierarchical-deterministic-keys.md -o build/keys.md -e svg -t neutral -w 400
cat README.md | \
sed -e "s/# Hierarchical Deterministic Keys for the European Digital Identity Wallet/# Introduction to Hierarchical Deterministic Keys/g" | \
sed -e "s/keys.md/#hierarchical-deterministic-keys/g" | \
Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ Expert participants from Potential:

## Contents

To address challenges 5 and 6, this repository contains a freely accessible, unencumbered specification of **[Hierarchical Deterministic Keys](keys.md)**. This enables an EU Digital Identity Wallet deployment that distributes key management efficiently:
To address challenges 5 and 6, this repository contains a freely accessible, unencumbered specification of **[Hierarchical Deterministic Keys](draft-dijkhuis-cfrg-hierarchical-deterministic-keys.md)**. This enables an EU Digital Identity Wallet deployment that distributes key management efficiently:

![A wallet architecture using Hierarchical Deterministic Keys associated with keys protected using a wallet secure cryptographic device, optionally using Asynchronous Remote Key Generation (ARKG).](media/deployment.svg)

Expand Down
Loading
Loading