Skip to content

Commit 6f5cbdf

Browse files
committed
Update docs for signify
1 parent ef3dc70 commit 6f5cbdf

File tree

1 file changed

+18
-2
lines changed

1 file changed

+18
-2
lines changed

etc/signify/README.md

+18-2
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,30 @@
11
# signify
22

3-
## Generating a new key
3+
## Creating a new minor or major version
44

55
Please read <https://www.openbsd.org/papers/bsdcan-signify.html> for how to do key rotations.
66
The MlFront_Signify library has a detailed guide as well.
77

8-
Get the `mlfront-signify` executables from <https://gitlab.com/dkml/build-tools/MlFront/-/releases>.
8+
FIRST, get the `mlfront-signify` executable from <https://gitlab.com/dkml/build-tools/MlFront/-/releases>.
9+
10+
SECOND, decide whether the next version will be a minor upgrade or a major upgrade.
11+
If you don't know yet, use a minor version upgrade. Then, when a major version upgrade is needed, the
12+
minor version upgrade may be a change that does nothing except change the `VER` (step THREE) and
13+
`dk_distribution_next_version` field (step FOUR) to be a major version upgrade.
14+
15+
THREE:
916

1017
```sh
1118
VER=2.4 # change the version number during a key rotation
1219
SIGNIFY=mlfront-signify # you should be able to use OpenBSD signify as well (untested)
1320
"$SIGNIFY" -G -c "dk $VER: signify -G -p etc/signify/dk-$VER.pub -s build/dk-$VER.sec" -p etc/signify/dk-$VER.pub -s build/dk-$VER.sec
1421
```
22+
23+
FOUR:
24+
25+
1. Save the `build/dk-*.sec` secret key securely, and delete it from the filesystem.
26+
2. Make a new version branch (ex. 2.4) for dksdk-coder and dksdk-cmake.
27+
3. In dksdk-coder's `src/DkCoder_Std/PublicKeys.ml`:
28+
1. Copy the `dk_distribution_next_pubkey` into `dk_distribution_current_pubkey`.
29+
2. Copy the newly generated `dk-*.pub` into `dk_distribution_next_pubkey`.
30+
3. Set `dk_distribution_next_version` to whatever `VER` you used above.

0 commit comments

Comments
 (0)