feat(identity): implement protobuf encoding for all key types #3681

drHuangMHT · 2023-03-27T03:49:32Z

Description

Previously, we only supported encoding the ed25519 private key. To be fully compliant with the spec, we also need to support encoding the other 3 key types ECDSA, RSA and secp256k1.

Resolves #3630.
Related #3623.
Related #3350.
Related #3649.

Notes & open questions

Breaking change.
~~Should we make the code panic when encountering missing feature?~~
Blocked by #540.

Change checklist

I have performed a self-review of my own code
I have made corresponding changes to the documentation
I have added tests that prove my fix is effective or that my feature works
A changelog entry has been made in the appropriate crates

Unreleased patch version 0.43.1 bumped. Added entry for PR 3606: Deriving 'Clone' for 'mdns::Event'

New unreleased minor version 0.44.0.

Co-authored-by: Thomas Eizinger <thomas@eizinger.io>

Unsynced co-authered change.

…s to disabled feature

drHuangMHT · 2023-03-27T12:01:16Z

Now I don't expect the branch to be merged with such aggressive changes......

thomaseizinger

Thank you for the tidy-up!

There are some good ideas in here. I've made some comments throughout. Most importantly, I think we can easily do this in a non-breaking way by just adding new functions and deprecating old ones.

identity/src/keypair.rs

identity/src/ecdsa.rs

identity/src/keypair.rs

identity/src/lib.rs

identity/src/rsa.rs

thomaseizinger · 2023-03-29T09:06:27Z

I merged latest master because there was some diff of other PRs.

protocols/mdns/CHANGELOG.md

identity/Cargo.toml

thomaseizinger · 2023-05-05T10:54:25Z

I've resolved the merge conflicts on this one for you. Are you still planning on splitting multiple PRs out of this one? Probably the easiest is to:

branch off here
undo some changes you don't want
open a new PR
merge master against once that new PR is merged

That way, we can slowly chip away at the changes in this PR and land them in master piece-wise!

…-libp2p into identity-keypair

Related: #3681 Pull-Request: #3887.

mergify · 2023-05-05T13:19:26Z

This pull request has merge conflicts. Could you please resolve them @drHuangMHT? 🙏

drHuangMHT · 2023-05-05T14:13:22Z

Now I guess this commit is mostly about renaming.

mergify · 2023-05-05T20:21:18Z

This pull request has merge conflicts. Could you please resolve them @drHuangMHT? 🙏

thomaseizinger · 2023-05-05T20:47:05Z

identity/src/keypair.rs

+    /// Encode a private key as protobuf structure.
+    ///
+    /// See <https://github.com/libp2p/specs/blob/master/peer-ids/peer-ids.md#key-types> for details on the encoding.
+    pub fn encode_protobuf(&self) -> Result<Vec<u8>, DecodingError> {


It is a shame that we rename the function here and cannot do the signature change to infalliblity at the same time. For that we need to also implement RSA encoding but I think for that we need to switch to the rsa crate which I want to debate first.

I wonder:

should we delay the rename of this function until then so we can land the rest now

should we rename it with the others and send users through another rename (+ signature change) once we support RSA

Delay the rename then.

drHuangMHT · 2023-05-22T02:48:25Z

Should we remove this from 0.52 milestone? We haven't decided to switch to rsa crate yet and I don't think we will do that very soon @thomaseizinger

thomaseizinger · 2023-05-22T18:12:28Z

Should we remove this from 0.52 milestone? We haven't decided to switch to rsa crate yet and I don't think we will do that very soon @thomaseizinger

Thanks, I removed the milestone.

drHuangMHT · 2023-12-27T12:34:42Z

Are we rsa yet? friendly ping @thomaseizinger

thomaseizinger · 2024-01-01T15:15:41Z

Are we rsa yet? friendly ping @thomaseizinger

Has anything changed around the situation of the rsa crate? I have not followed its state.

drHuangMHT · 2024-01-02T02:56:37Z

Has anything changed around the situation of the rsa crate? I have not followed its state.

Well the crate has been audited RustCrypto/RSA#60, but the non constant-time issue RustCrypto/RSA#19 is still not solved yet.

thomaseizinger · 2024-01-13T23:25:16Z

Has anything changed around the situation of the rsa crate? I have not followed its state.

Well the crate has been audited RustCrypto/RSA#60, but the non constant-time issue RustCrypto/RSA#19 is still not solved yet.

In that case, I'd say we keep things as is for now. I have very limited capacity this month and will step down from active maintenance after that so I'd like to focus the remaining time on other issues.

drHuangMHT · 2024-03-11T10:05:54Z

Not planned in the foreseeable future, closing this to clean up work tree on my fork.

drHuangMHT and others added 21 commits March 13, 2023 19:06

feat: make mdns::Event clone-able

7d5e606

Merge branch 'libp2p:master' into master

05ce438

docs: filling CHANGELOG for PR 3606

a72e5e2

Unreleased patch version 0.43.1 bumped. Added entry for PR 3606: Deriving 'Clone' for 'mdns::Event'

Merge branch 'master' of https://github.com/drHuangMHT/rust-libp2p

09bef20

Update protocols/mdns/CHANGELOG.md

926c7ca

Update protocols/mdns/CHANGELOG.md

49d26c4

Merge branch 'master' into master

4a35406

feat: change 'mdns::Event' to hold 'SmallVec'

a8ff1eb

test: adapting test to 'mdns::Event' change

4cec5fa

Merge branch 'master' of https://github.com/drHuangMHT/rust-libp2p

a876f2f

feat(mdns): change 'mdns::Event' to hold 'Vec'

18811d2

doc: add entry for libp2p#3621

abdce7e

New unreleased minor version 0.44.0.

Update protocols/mdns/CHANGELOG.md

d5c246c

Co-authored-by: Thomas Eizinger <thomas@eizinger.io>

Merge branch 'master' of https://github.com/drHuangMHT/rust-libp2p

ed128a7

Merge branch 'master' of https://github.com/drHuangMHT/rust-libp2p

0d06f4c

Unsynced co-authered change.

Remove conflict marker to resolve conflicts

9d45cf3

add 'try' to method returning 'Result'

947b368

implement protobuf encoding for RSA keys

e3e6355

fix: change 'encode_unsupported' to 'missing_feature' for branch lead…

b91bcc7

…s to disabled feature

fix: wrongly configured feature attributes when encoding to protobuf

959b90f

fix: clippy and fmt

20134d1

drHuangMHT changed the title ~~feat(identity): implement protobuf encoding for RSA, ECDSA and secp256k1 keypairs~~ feat(identity): implement protobuf encoding for libp2p-identity keypairs Mar 27, 2023

drHuangMHT added 2 commits March 27, 2023 19:45

doc: documentation for changed methods

d833904

feat: enforce naming rules

0896a61

drHuangMHT mentioned this pull request Mar 29, 2023

identity::Keypair ergonomics improvements #3649

Closed

thomaseizinger reviewed Mar 29, 2023

View reviewed changes

Merge branch 'master' into identity-keypair

593272c

thomaseizinger reviewed Mar 29, 2023

View reviewed changes

protocols/mdns/CHANGELOG.md Outdated Show resolved Hide resolved

thomaseizinger reviewed May 5, 2023

View reviewed changes

identity/Cargo.toml Outdated Show resolved Hide resolved

identity/Cargo.toml Outdated Show resolved Hide resolved

drHuangMHT added 2 commits May 5, 2023 19:07

Merge branch 'identity-keypair' of https://github.com/drHuangMHT/rust…

ce9ba0d

…-libp2p into identity-keypair

lock file update

7662073

drHuangMHT mentioned this pull request May 5, 2023

feat(identity): allow importing and exporting secp256k1 keys #3887

Merged

4 tasks

mergify bot pushed a commit that referenced this pull request May 5, 2023

feat(identity): allow importing and exporting secp256k1 keys

b8411d1

Related: #3681 Pull-Request: #3887.

drHuangMHT added 4 commits May 5, 2023 21:38

fix: wrong dependency 'p256' version

e4b6ec7

delete unused test keys

75ee978

revert RSA changes

fd7a660

Merge branch 'master' into identity-keypair

96ab553

remove feature flag on 'decoding_unsupported'

b23e111

thomaseizinger reviewed May 5, 2023

View reviewed changes

thomaseizinger mentioned this pull request May 5, 2023

identity: Implement protobuf encoding for RSA, ECDSA and secp256k1 keypairs #3630

Open

fix: duplicated outdated test

4d7b516

thomaseizinger removed this from the v0.52.0 milestone May 22, 2023

drHuangMHT added 3 commits December 27, 2023 16:14

upstream sync

11748b5

Merge branch 'master' into identity-keypair

cffd763

fix errors introduced by merging manually

07df6dc

drHuangMHT closed this Mar 11, 2024

drHuangMHT deleted the identity-keypair branch March 11, 2024 10:06

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(identity): implement protobuf encoding for all key types #3681

feat(identity): implement protobuf encoding for all key types #3681

drHuangMHT commented Mar 27, 2023 •

edited by thomaseizinger

Loading

drHuangMHT commented Mar 27, 2023

thomaseizinger left a comment

thomaseizinger commented Mar 29, 2023

thomaseizinger commented May 5, 2023

mergify bot commented May 5, 2023

drHuangMHT commented May 5, 2023

mergify bot commented May 5, 2023

thomaseizinger May 5, 2023

drHuangMHT May 5, 2023

drHuangMHT commented May 22, 2023 •

edited

Loading

thomaseizinger commented May 22, 2023

drHuangMHT commented Dec 27, 2023

thomaseizinger commented Jan 1, 2024

drHuangMHT commented Jan 2, 2024 •

edited

Loading

thomaseizinger commented Jan 13, 2024

drHuangMHT commented Mar 11, 2024

feat(identity): implement protobuf encoding for all key types #3681

feat(identity): implement protobuf encoding for all key types #3681

Conversation

drHuangMHT commented Mar 27, 2023 • edited by thomaseizinger Loading

Description

Notes & open questions

Change checklist

drHuangMHT commented Mar 27, 2023

thomaseizinger left a comment

Choose a reason for hiding this comment

thomaseizinger commented Mar 29, 2023

thomaseizinger commented May 5, 2023

mergify bot commented May 5, 2023

drHuangMHT commented May 5, 2023

mergify bot commented May 5, 2023

thomaseizinger May 5, 2023

Choose a reason for hiding this comment

drHuangMHT May 5, 2023

Choose a reason for hiding this comment

drHuangMHT commented May 22, 2023 • edited Loading

thomaseizinger commented May 22, 2023

drHuangMHT commented Dec 27, 2023

thomaseizinger commented Jan 1, 2024

drHuangMHT commented Jan 2, 2024 • edited Loading

thomaseizinger commented Jan 13, 2024

drHuangMHT commented Mar 11, 2024

drHuangMHT commented Mar 27, 2023 •

edited by thomaseizinger

Loading

drHuangMHT commented May 22, 2023 •

edited

Loading

drHuangMHT commented Jan 2, 2024 •

edited

Loading