Skip to content

Commit 41612da

Browse files
committed
ipns: mark RSA keys as 'SHOULD' (if legacy matters)
#319 (comment)
1 parent 78c9f04 commit 41612da

1 file changed

Lines changed: 9 additions & 3 deletions

File tree

IPNS.md

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -42,11 +42,17 @@ IPNS is based on [SFS](http://en.wikipedia.org/wiki/Self-certifying_File_System)
4242
### Key Types
4343

4444
Implementations MUST support Ed25519 with signatures defined in [RFC8032](https://www.rfc-editor.org/rfc/rfc8032#section-5.1).
45+
Ed25519 is the current default key type.
4546

46-
Implementations MAY support RSA, Secp256k1 and ECDSA for private use, but peers
47+
Implementations SHOULD support RSA if they wish to interoperate with legacy
48+
IPNS names (RSA was used before Ed25519).
49+
50+
Implementations MAY support Secp256k1 and ECDSA for private use, but peers
4751
from the public IPFS swarm and DHT may not be able to resolve IPNS records
48-
signed by these optional key types. When implementing support for these optional key
49-
types, follow signature implementation notes from [PeerID specs](https://github.com/libp2p/specs/blob/master/peer-ids/peer-ids.md#key-types).
52+
signed by these optional key types.
53+
54+
When implementing support for key types, follow signature implementation notes
55+
from [PeerID specs](https://github.com/libp2p/specs/blob/master/peer-ids/peer-ids.md#key-types).
5056

5157
In all cases, the IPNS implementation MAY allow the user to enable/disable specific key types via configuration. Note that disabling support for compulsory key type will hinder IPNS interop.
5258

0 commit comments

Comments
 (0)