aboutsummaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
Diffstat (limited to 'docs')
-rw-r--r--docs/guides/federation/building-on-the-api.md8
-rw-r--r--docs/guides/federation/getting-started.md6
-rw-r--r--docs/guides/federation/keys.md22
3 files changed, 30 insertions, 6 deletions
diff --git a/docs/guides/federation/building-on-the-api.md b/docs/guides/federation/building-on-the-api.md
index 9f144be..4f37b91 100644
--- a/docs/guides/federation/building-on-the-api.md
+++ b/docs/guides/federation/building-on-the-api.md
@@ -41,11 +41,13 @@ sorts them:
* `deps`: the heads it read (`heads` in `GET /events`), each as 64 lower-case hex digits,
ascending, one at least.
-* `key`: the key it signs with, `ssh-ed25519`, a space, the base64 of its blob, no
- comment; one of the party's keys.
+* `key`: the key it signs with, its type (`ssh-ed25519` or `ecdsa-sha2-nistp256`), a
+ space, the base64 of its blob, no comment; one of the party's keys.
* `sig`: an SSH signature (`ssh-keygen -Y sign`, namespace `continuum-federation`, hashed
with `sha512`) over the JCS bytes of the object without `sig`: the SSHSIG blob, its
- reserved field empty, in base64, unarmored.
+ reserved field empty, in base64, unarmored. Of an ECDSA key, its `s` low, at most half
+ the curve's order: `ssh-keygen` makes a high one half the time, which no node takes;
+ sign again, or put the order less `s` in its place.
* The value is any JSON with integers only, from −2⁵³ to 2⁵³; the event up to 256 KiB.
Put its bytes as they are:
diff --git a/docs/guides/federation/getting-started.md b/docs/guides/federation/getting-started.md
index ce2b614..3570ee3 100644
--- a/docs/guides/federation/getting-started.md
+++ b/docs/guides/federation/getting-started.md
@@ -17,8 +17,10 @@ That builds the node, `continuum`, and the party's client, `continuum-party`, in
## A key for each party
-The version names each party's keys, and the party signs with them. The client reads an
-OpenSSH Ed25519 key without a passphrase:
+The version names each party's keys, and the party signs with them. A key is
+`ssh-ed25519` or `ecdsa-sha2-nistp256`. The client reads an OpenSSH private key file
+without a passphrase, of an Ed25519 key, or signs through an ssh-agent holding the key
+([`keys.md`](keys.md), Keys in an ssh-agent):
```sh
ssh-keygen -t ed25519 -N '' -f tv.key
diff --git a/docs/guides/federation/keys.md b/docs/guides/federation/keys.md
index 48018a3..a84ed5a 100644
--- a/docs/guides/federation/keys.md
+++ b/docs/guides/federation/keys.md
@@ -25,12 +25,32 @@ continuum-party --node http://tv:secret@localhost:3000 --key laptop.key \
Each key goes as one argument, an `authorized_keys` line; its comment is left out. A
set holds up to 16 keys. A node voting by itself keeps a key its version names on that
-node (`--store-vote-key`): one stolen there votes for the party.
+node (`--store-vote-key`), an Ed25519 key in a file: one stolen there votes for the
+party.
A set counts where it is written under a version numbered at least the `since` the
current version gives the party's keys: once a version names a party's keys anew, no set
written before counts, and the party writes its set again.
+## Keys in an ssh-agent
+
+A key no file holds, in a security key, a phone or a Secure Enclave, signs through an
+ssh-agent. Give the client its public key, a `.pub` file, as `--key`: it asks the agent
+at `SSH_AUTH_SOCK` to sign, and writes the signature as `ssh-keygen -Y sign` does
+through that agent. Such a key is `ecdsa-sha2-nistp256` or `ssh-ed25519`.
+
+```sh
+ssh-add -L # ecdsa-sha2-nistp256 AAAA… tv@phone
+ssh-add -L | grep tv@phone > phone.pub
+cut -d' ' -f1,2 phone.pub # the key as a version or a set names it
+continuum-party --node http://tv:secret@localhost:3000 --key phone.pub \
+ --record tv.record write home/tv/motd '"from the phone"'
+```
+
+Of an ECDSA signature, `s` and the curve's order less `s` both check. The federation
+takes the low one alone, so that nobody makes another event of what the party signed;
+the client makes `s` low, whichever the agent gives.
+
## Changing the keys of a set
A write counts only while the key that signed it is among the party's keys: what a key