feat(cli): introduce `planet key sign` command #1920

moreal · 2022-04-26T05:30:52Z

This pull requests introduces planet key sign command through KeyCommand in Libplanet.Extensions.Cocona.

The command provides a feature to sign the given message encoded by base64 with the given private key, and prints the signature encoded by base64.

$ dotnet run --project Libplanet.Tools/Libplanet.Tools.csproj -- key sign b8b01397-eee7-4c03-9a8d-4beee26ca7b9 AA== --passphrase ""
MEUCIQCvyRlQMqtuowjNSoR+5FCvzr/hcRWeWYAsZCQpAjtq7gIgJJLwq5YPCHktTKExhsyiiQmWj+aMQFVP6ZVucf+g5Rg=

moreal · 2022-04-27T12:44:53Z

As a remind, could you review this pull request if you have a time please?

riemannulus · 2022-04-28T01:04:51Z

Libplanet.Extensions.Cocona/Commands/KeyCommand.cs

+        )
+        {
+            PrivateKey key = UnprotectKey(keyId, passphrase);
+            Console.WriteLine(Convert.ToBase64String(key.Sign(Convert.FromBase64String(message))));


It's trivial but could you break the line? It looks quite long.

How about printing out the raw bytes instead of base64?

Or at least hexadecimals might be better than base64, because there are quite many variations of base64, which confuse those who need to decode them.

If such behavior causing average terminal emulators to go weird concerns you, we could provide an option like -o/--binary-output=FILE:

# The signature is printed out in hexadecimals: planet key sign 00000000-0000-0000-0000-000000000000 msg.dat # The signature is written in the "sig.dat" file (no hex, but raw binary): planet key sign \ --binary-output sig.dat \ 00000000-0000-0000-0000-000000000000 \ msg.dat # The signature is printed out in raw bytes: planet key sign \ --binary-output - \ 00000000-0000-0000-0000-000000000000 \ msg.dat # The signature is written in the "-" file: planet key sign \ --binary-output ./- \ 00000000-0000-0000-0000-000000000000 \ msg.dat

I tried to implement the feature in 4487e53 commit. --binary-output option is optional and it prints the signature as hexadecimal string in default behaviour.

dahlia · 2022-04-28T01:38:46Z

Libplanet.Extensions.Cocona/Commands/KeyCommand.cs

+            [Argument(
+                "MESSAGE",
+                Description = "A message encoded by base64 encoding to sign."
+            )]
+            string message,


It'd better to take the message through a file as it can be long. (That's how gpg --sign command works.) Of course, - should mean the standard input here. E.g.:

# Sign the message that the "msg.dat" file contains: planet key sign 00000000-0000-0000-0000-000000000000 msg.dat # Sign the message provided from the stnadard input: planet key sign 00000000-0000-0000-0000-000000000000 - # Sign the message that the "-" file contains: planet key sign 00000000-0000-0000-0000-000000000000 ./-

I tried to implement the feature in 735756f commit.

dahlia · 2022-04-28T02:08:05Z

Libplanet.Extensions.Cocona/Commands/KeyCommand.cs

+        )
+        {
+            PrivateKey key = UnprotectKey(keyId, passphrase);
+            Console.WriteLine(Convert.ToBase64String(key.Sign(Convert.FromBase64String(message))));


How about printing out the raw bytes instead of base64?

Or at least hexadecimals might be better than base64, because there are quite many variations of base64, which confuse those who need to decode them.

If such behavior causing average terminal emulators to go weird concerns you, we could provide an option like -o/--binary-output=FILE:

# The signature is printed out in hexadecimals: planet key sign 00000000-0000-0000-0000-000000000000 msg.dat # The signature is written in the "sig.dat" file (no hex, but raw binary): planet key sign \ --binary-output sig.dat \ 00000000-0000-0000-0000-000000000000 \ msg.dat # The signature is printed out in raw bytes: planet key sign \ --binary-output - \ 00000000-0000-0000-0000-000000000000 \ msg.dat # The signature is written in the "-" file: planet key sign \ --binary-output ./- \ 00000000-0000-0000-0000-000000000000 \ msg.dat

pull-request-quantifier-deprecated · 2022-04-29T09:09:49Z

This PR has 37 quantified lines of changes. In general, a change size of upto 200 lines is ideal for the best PR experience!

Quantification details

Label      : Extra Small
Size       : +37 -0
Percentile : 14.8%

Total files changed: 2

Change summary by file extension:
.md : +2 -0
.cs : +35 -0

Change counts above are quantified counts, based on the PullRequestQuantifier customizations.

Why proper sizing of changes matters

Optimal pull request sizes drive a better predictable PR flow as they strike a
balance between between PR complexity and PR review overhead. PRs within the
optimal size (typical small, or medium sized PRs) mean:

Fast and predictable releases to production:
- Optimal size changes are more likely to be reviewed faster with fewer
  iterations.
- Similarity in low PR complexity drives similar review times.
Review quality is likely higher as complexity is lower:
- Bugs are more likely to be detected.
- Code inconsistencies are more likely to be detetcted.
Knowledge sharing is improved within the participants:
- Small portions can be assimilated better.
Better engineering practices are exercised:
- Solving big problems by dividing them in well contained, smaller problems.
- Exercising separation of concerns within the code changes.

What can I do to optimize my changes

Use the PullRequestQuantifier to quantify your PR accurately
- Create a context profile for your repo using the context generator
- Exclude files that are not necessary to be reviewed or do not increase the review complexity. Example: Autogenerated code, docs, project IDE setting files, binaries, etc. Check out the Excluded section from your prquantifier.yaml context profile.
- Understand your typical change complexity, drive towards the desired complexity by adjusting the label mapping in your prquantifier.yaml context profile.
- Only use the labels that matter to you, see context specification to customize your prquantifier.yaml context profile.
Change your engineering behaviors
- For PRs that fall outside of the desired spectrum, review the details and check if:
  - Your PR could be split in smaller, self-contained PRs instead
  - Your PR only solves one particular issue. (For example, don't refactor and code new features in the same PR).

How to interpret the change counts in git diff output

One line was added: +1 -0
One line was deleted: +0 -1
One line was modified: +1 -1 (git diff doesn't know about modified, it will
interpret that line like one addition plus one deletion)
Change percentiles: Change characteristics (addition, deletion, modification)
of this PR in relation to all other PRs within the repository.

Was this comment helpful? 👍 :ok_hand: :thumbsdown: (Email)
Customize PullRequestQuantifier for this repository.

moreal · 2022-05-11T02:03:39Z

This pull request's build seems failed because the linux-unity-test is flaky 🤔
Is there something I should do to merge in implementation side?

dahlia · 2022-05-11T02:44:36Z

This pull request's build seems failed because the linux-unity-test is flaky 🤔 Is there something I should do to merge in implementation side?

Nevermind, I'm going to merge this right now. Thanks!

auto-assign bot requested review from dahlia, greymistcube, limebell, longfin and riemannulus April 26, 2022 05:30

auto-assign bot assigned moreal Apr 26, 2022

pull-request-quantifier-deprecated bot added the Extra Small label Apr 26, 2022

moreal added tools Related to CLI tools (Libplanet.Tools) suggestion Suggestion or feature request labels Apr 26, 2022

moreal force-pushed the sign-command branch 3 times, most recently from 618ab92 to 5292ec6 Compare April 26, 2022 09:28

moreal changed the title ~~feat(cli): introduce key sign command~~ feat(cli): introduce planet key sign command Apr 26, 2022

riemannulus reviewed Apr 28, 2022

View reviewed changes

dahlia reviewed Apr 28, 2022

View reviewed changes

moreal requested a review from dahlia April 29, 2022 09:09

moreal added 3 commits April 29, 2022 18:09

feat(cli): introduce key sign command

a7ff706

feat(cli): receive message from stdin when dash came

fbdf73d

feat(cli): provide --binary-output option to use raw bytes

fc82903

moreal force-pushed the sign-command branch from 4487e53 to fc82903 Compare April 29, 2022 09:09

dahlia approved these changes Apr 29, 2022

View reviewed changes

dahlia requested a review from riemannulus April 29, 2022 09:33

dahlia merged commit ca07196 into planetarium:main May 11, 2022

longfin mentioned this pull request Jul 1, 2022

Add GQL mutations & queries to Libplanet.Explorer #2130

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(cli): introduce `planet key sign` command #1920

feat(cli): introduce `planet key sign` command #1920

moreal commented Apr 26, 2022

moreal commented Apr 27, 2022

riemannulus Apr 28, 2022

dahlia Apr 28, 2022

moreal Apr 29, 2022

dahlia Apr 28, 2022

moreal Apr 29, 2022

dahlia Apr 28, 2022

pull-request-quantifier-deprecated bot commented Apr 29, 2022

What can I do to optimize my changes

How to interpret the change counts in git diff output

moreal commented May 11, 2022

dahlia commented May 11, 2022

feat(cli): introduce planet key sign command #1920

feat(cli): introduce planet key sign command #1920

Conversation

moreal commented Apr 26, 2022

moreal commented Apr 27, 2022

riemannulus Apr 28, 2022

Choose a reason for hiding this comment

dahlia Apr 28, 2022

Choose a reason for hiding this comment

moreal Apr 29, 2022

Choose a reason for hiding this comment

dahlia Apr 28, 2022

Choose a reason for hiding this comment

moreal Apr 29, 2022

Choose a reason for hiding this comment

dahlia Apr 28, 2022

Choose a reason for hiding this comment

pull-request-quantifier-deprecated bot commented Apr 29, 2022

What can I do to optimize my changes

How to interpret the change counts in git diff output

moreal commented May 11, 2022

dahlia commented May 11, 2022

feat(cli): introduce `planet key sign` command #1920

feat(cli): introduce `planet key sign` command #1920