| Amna | b10c6e7 | 2023-09-25 11:12:35 -0400 | [diff] [blame] | 1 | .TH DSH 1 "September 2023" "Version 1.0" "Distributed Shell" |
| 2 | .SH NAME |
| 3 | dsh \- Distributed Shell |
| 4 | .SH SYNOPSIS |
| 5 | .B dsh |
| Amna | 77e27dc | 2024-07-24 13:09:40 -0400 | [diff] [blame] | 6 | [OPTIONS]... <PEER_ID> |
| Amna | b10c6e7 | 2023-09-25 11:12:35 -0400 | [diff] [blame] | 7 | .SH DESCRIPTION |
| 8 | \fBdsh\fR is a Distributed Shell program that enables peers to establish connections with other peers in a Distributed Hash Table (DHT) network and execute a binary on the remote target. |
| Amna | 77e27dc | 2024-07-24 13:09:40 -0400 | [diff] [blame] | 9 | |
| 10 | .B <PEER_ID> |
| 11 | is the identifiant of the target peer or device in the DHT network with which the connection should be established. |
| 12 | It is required when not running in listen mode. |
| Amna | b10c6e7 | 2023-09-25 11:12:35 -0400 | [diff] [blame] | 13 | .PP |
| 14 | \fBdsh\fR allows you to: |
| 15 | .IP |
| 16 | - Execute commands on remote peers in a DHT network. |
| Amna | 77e27dc | 2024-07-24 13:09:40 -0400 | [diff] [blame] | 17 | |
| Amna | b10c6e7 | 2023-09-25 11:12:35 -0400 | [diff] [blame] | 18 | - Establish connections with peers and execute binaries on their side. |
| Amna | 77e27dc | 2024-07-24 13:09:40 -0400 | [diff] [blame] | 19 | |
| Amna | b10c6e7 | 2023-09-25 11:12:35 -0400 | [diff] [blame] | 20 | .SH OPTIONS |
| Amna | 77e27dc | 2024-07-24 13:09:40 -0400 | [diff] [blame] | 21 | |
| Amna | b10c6e7 | 2023-09-25 11:12:35 -0400 | [diff] [blame] | 22 | .TP |
| 23 | .B \-h, \-\-help |
| 24 | Display help information for using \fBdsh\fR. |
| Amna | 77e27dc | 2024-07-24 13:09:40 -0400 | [diff] [blame] | 25 | |
| Amna | b10c6e7 | 2023-09-25 11:12:35 -0400 | [diff] [blame] | 26 | .TP |
| Amna | 77e27dc | 2024-07-24 13:09:40 -0400 | [diff] [blame] | 27 | .B \-v, \-\-version |
| Amna | b10c6e7 | 2023-09-25 11:12:35 -0400 | [diff] [blame] | 28 | Display the version information of \fBdsh\fR. |
| Amna | 77e27dc | 2024-07-24 13:09:40 -0400 | [diff] [blame] | 29 | |
| Amna | b10c6e7 | 2023-09-25 11:12:35 -0400 | [diff] [blame] | 30 | .TP |
| 31 | .B \-l, \-\-listen |
| 32 | Run \fBdsh\fR in listen mode, allowing the program to accept incoming network connections and perform network-related tasks on request. |
| Amna | 77e27dc | 2024-07-24 13:09:40 -0400 | [diff] [blame] | 33 | |
| Amna | b10c6e7 | 2023-09-25 11:12:35 -0400 | [diff] [blame] | 34 | .TP |
| Amna | 77e27dc | 2024-07-24 13:09:40 -0400 | [diff] [blame] | 35 | .B \-s, \-\-binary \fICOMMAND\fR |
| 36 | Specify the path to the binary that should be executed on the remote target when a connection is established. The default value is \fI"bash"\fR if not specified. |
| 37 | |
| Amna | b10c6e7 | 2023-09-25 11:12:35 -0400 | [diff] [blame] | 38 | .TP |
| Amna | 77e27dc | 2024-07-24 13:09:40 -0400 | [diff] [blame] | 39 | .B \-b, \-\-bootstrap \fIADDRESS\fR |
| 40 | Set the bootstrap node. |
| 41 | |
| Amna | b10c6e7 | 2023-09-25 11:12:35 -0400 | [diff] [blame] | 42 | .TP |
| Amna | 77e27dc | 2024-07-24 13:09:40 -0400 | [diff] [blame] | 43 | .B \-t, \-\-turn_host \fIADDRESS\fR |
| 44 | Define the TURN server host. |
| 45 | |
| Amna | b10c6e7 | 2023-09-25 11:12:35 -0400 | [diff] [blame] | 46 | .TP |
| Amna | 77e27dc | 2024-07-24 13:09:40 -0400 | [diff] [blame] | 47 | .B \-u, \-\-turn_user \fIUSER\fR |
| 48 | Define the TURN server username. |
| 49 | |
| 50 | .TP |
| 51 | .B \-w, \-\-turn_pass \fISECRET\fR |
| 52 | Define the TURN server password. |
| 53 | |
| 54 | .TP |
| 55 | .B \-r, \-\-turn_realm \fIREALM\fR |
| 56 | Specify the TURN server realm. |
| 57 | |
| 58 | .TP |
| 59 | .B \-p, \-\-privateKey \fIFILE\fR |
| 60 | Provide a private key. |
| 61 | |
| 62 | .TP |
| 63 | .B \-c, \-\-certificate \fIFILE\fR |
| 64 | Specify the certificate. |
| 65 | |
| 66 | .TP |
| 67 | .B \-d, \-\-configuration \fIFILE\fR |
| 68 | Define the dnc configuration with a YAML file path. |
| 69 | |
| 70 | .TP |
| 71 | .B \-a, \-\-anonymous |
| 72 | Activate anonymous connection mode. |
| 73 | |
| Amna | b10c6e7 | 2023-09-25 11:12:35 -0400 | [diff] [blame] | 74 | .SH EXAMPLE |
| Amna | 77e27dc | 2024-07-24 13:09:40 -0400 | [diff] [blame] | 75 | |
| Amna | b10c6e7 | 2023-09-25 11:12:35 -0400 | [diff] [blame] | 76 | To connect to a remote peer and specify a custom bootstrap node, binary, and identity file, you can use the following command: |
| 77 | .PP |
| 78 | .B |
| Amna | 77e27dc | 2024-07-24 13:09:40 -0400 | [diff] [blame] | 79 | dsh -b <BOOTSTRAP_ADDRESS> -s <COMMAND> -c <FILE.crt> -p <FILE.pem> <PEER_ID> |
| Amna | b10c6e7 | 2023-09-25 11:12:35 -0400 | [diff] [blame] | 80 | .SH SEE ALSO |
| 81 | .PP |
| Amna | 77e27dc | 2024-07-24 13:09:40 -0400 | [diff] [blame] | 82 | .BR dnc (1), |
| 83 | .BR dhtnet-crtmgr (1), |
| Amna | b10c6e7 | 2023-09-25 11:12:35 -0400 | [diff] [blame] | 84 | .BR dshd (1) |