Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Initial manual page for tor-genkey #538

Open
wants to merge 1 commit into
base: master
from

Conversation

Projects
None yet
3 participants
@haxxpop
Copy link
Contributor

commented Nov 22, 2018

ticket18098 (review only)

Initial manual page for tor-genkey
tor-genkey is used to generate keys for various subsystems in tor. The
first subsystem that uses tor-genkey is the onion service v3 client
authorization.
@coveralls

This comment has been minimized.

Copy link

commented Nov 22, 2018

Pull Request Test Coverage Report for Build 3087

  • 0 of 0 changed or added relevant lines in 0 files are covered.
  • 1 unchanged line in 1 file lost coverage.
  • Overall coverage decreased (-0.001%) to 62.194%

Files with Coverage Reduction New Missed Lines %
src/feature/hs/hs_common.c 1 83.28%
Totals Coverage Status
Change from base Build 3082: -0.001%
Covered Lines: 44396
Relevant Lines: 71383

💛 - Coveralls
:man manual: Tor Manual
tor-genkey(1)
==============
Suphanat Chunhapanya

This comment has been minimized.

Copy link
@dgoulet-tor

dgoulet-tor Nov 23, 2018

Contributor

I think this name here makes it that there is an AUTHOR section and then just above there is the AUTHORS section so this could be removed.


SYNOPSIS
--------
**tor-genkey** [-t|--type __keytype__] [-o|--out __filename__]

This comment has been minimized.

Copy link
@dgoulet-tor

dgoulet-tor Nov 23, 2018

Contributor

I would propose that we go with [OPTIONS...] instead of specifically listing them all. We might get overwhelmed by the amount of options over time so better to just mention roughly what goes where and then have a section for it.

for many subsystems of tor.

OPTIONS
-------

This comment has been minimized.

Copy link
@dgoulet-tor

dgoulet-tor Nov 23, 2018

Contributor

Simply mention here that the following is a detailed description of each options that can be used within [OPTIONS...]


SEE ALSO
--------
**tor**(1) +

This comment has been minimized.

Copy link
@dgoulet-tor

dgoulet-tor Nov 23, 2018

Contributor

Might be good to mention also tor-gencert(1).


KEY TYPES
---------
**HsClientDescriptorAuth**::

This comment has been minimized.

Copy link
@dgoulet-tor

dgoulet-tor Nov 23, 2018

Contributor

I propose we use HS instead of Hs.

Small fix, maybe: HSDescriptorClientAuth or HSClientAuthDescriptor instead? Since this is "client authorization", we should just namespace it clearly so it is easy to understand/categorized. If we had let say the introduction authorization, then we would have also something like HSClientAuthIntro` which starts the same way as the Descriptor one.

For usability, I would make it case insensitive in the implementation so probably also good to mention it in the manpage.


SYNOPSIS
--------
**tor-genkey** [-t|--type __keytype__] [-o|--out __filename__]

This comment has been minimized.

Copy link
@dgoulet-tor

dgoulet-tor Nov 23, 2018

Contributor

Here is another thought now. What about a git alike style command?

tor-genkey hs clientauth descriptor -o <filename> type of command? (not final format, just to give an idea)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
You can’t perform that action at this time.