From 0f952c7ba39da91e8cd9ec633a221b4ae07f7437 Mon Sep 17 00:00:00 2001 From: Mark Haines Date: Fri, 19 May 2017 14:25:13 +0100 Subject: [PATCH] Comment on the key format --- src/github.com/matrix-org/dendrite/common/readkey.go | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/src/github.com/matrix-org/dendrite/common/readkey.go b/src/github.com/matrix-org/dendrite/common/readkey.go index 4971ddd59..7c7d95dfd 100644 --- a/src/github.com/matrix-org/dendrite/common/readkey.go +++ b/src/github.com/matrix-org/dendrite/common/readkey.go @@ -25,6 +25,10 @@ import ( ) // ReadKey reads a server's private ed25519 key. +// If the key is the empty string then a random key is generated. +// Otherwise the key is the key ID and the base64 encoded private key +// separated by a single space character. +// E.g "ed25519:abcd ABCDEFGHIJKLMNOPabcdefghijklmnop01234567890" func ReadKey(key string) (gomatrixserverlib.KeyID, ed25519.PrivateKey, error) { var keyID gomatrixserverlib.KeyID var seed io.Reader