| Amna | 77e27dc | 2024-07-24 13:09:40 -0400 | [diff] [blame] | 1 | .TH DHTNET-CRTMGR 1 "July 2024" |
| 2 | .SH NAME |
| 3 | dhtnet-crtmgr \- DHTNet Certificate Manager |
| 4 | .SH SYNOPSIS |
| 5 | .B dhtnet-crtmgr |
| 6 | [OPTIONS]... |
| 7 | .SH DESCRIPTION |
| 8 | \fBdhtnet-crtmgr\fR is a command-line utility designed to manage certificates for the DHTNet network. |
| 9 | It enables users to generate, sign, and configure certificates for secure communication across the network. |
| 10 | |
| 11 | For easy setup and testing purpose, you can use \fBdhtner-crtmgr \-\-interactive\fR to generate a self-signed certificate for server and/or client. |
| 12 | .SH OPTIONS |
| 13 | |
| 14 | .TP |
| 15 | .B \-h, \-\-help |
| 16 | Display help information and exit. |
| 17 | |
| 18 | .TP |
| 19 | .B \-v, \-\-version |
| 20 | Show program version. |
| 21 | |
| 22 | .TP |
| 23 | .B \-i, \-\-interactive |
| 24 | Generate a self-signed certificate interactively and edit configuration to use it. |
| 25 | |
| 26 | .TP |
| 27 | .B \-a, \-\-identifier |
| 28 | Print the identifier of the certificate in stdout. This identifier is the one used to reach node on DHT network. |
| 29 | Require options \fB\-c\fR and \fB\-p\fR to be set. |
| 30 | |
| 31 | .TP |
| 32 | .B \-s, \-\-setup |
| 33 | Generate a CA and a certificate signed with this CA. Require \fB\-o\fR option. If used with \fB\-c\fR and \fB\-p\fR, will generate a certificate signed with the CA given by these options. |
| 34 | |
| 35 | Will create sub-folders \fICA\fR and \fIid\fR in the output folder given at \fB\-o\fR. |
| 36 | |
| 37 | .TP |
| 38 | .B \-o, \-\-output \fIFOLDER\fR |
| 39 | Define the output folder for the generated certificate. |
| 40 | |
| 41 | .TP |
| 42 | .B \-c, \-\-certificate \fIFILE\fR |
| 43 | Define the certificate file to use. Usually a \fI.crt\fR file. |
| 44 | |
| 45 | .TP |
| 46 | .B \-p, \-\-privatekey \fIFILE\fR |
| 47 | Define the private key file to use. Usually a \fI.pem\fR file. |
| 48 | |
| 49 | .TP |
| 50 | .B \-n, \-\-name \fINAME\fR |
| 51 | Define the name of the certificate. Will be used to generate \fINAME.crt\fR and \fINAME.pem\fR. Doesn't work with \fB\-s, \-\-setup\fR but must be used with \fB\-o, \-\-output\fR. |
| 52 | |
| 53 | .SH EXAMPLES |
| 54 | |
| 55 | Use interactive mode to generate a self-signed certificate: |
| 56 | .B dhtnet-crtmgr \-\-interactive |
| 57 | |
| 58 | Generate a CA in \fIoutput_folder\fR: |
| 59 | .B dhtnet-crtmgr \-\-name \fImy_ca\fB \-\-output \fIoutput_folder\fR |
| 60 | |
| 61 | Generate a key signed by previously generated CA: |
| 62 | .B dhtnet-crtmgr \-\-certificate \fIoutput_folder/my_ca.crt\fB \-\-privateKey \fIoutput_folder/my_ca.pem\fB \-\-name \fImy_key\fB \-\-output \fIkeys_folder\fR |
| 63 | |
| 64 | Print the identifier of this newly generated key: |
| 65 | .B dhtnet-crtmgr \-\-certificate \fIkeys_folder/my_key.crt\fB \-\-privateKey \fIkeys_folder/my_key.pem\fB \-\-identifier\fR |
| 66 | |
| 67 | .SH "SEE ALSO" |
| 68 | .TP |
| 69 | .BR dnc(1), |
| 70 | .BR dsh(1), |
| 71 | .BR dvpn(1) |