| Amna | 6773b07 | 2024-02-08 16:08:44 -0500 | [diff] [blame] | 1 | .TH DNC 1 "February 2024" "Version 1.1" "Distributed nc" |
| Amna | b10c6e7 | 2023-09-25 11:12:35 -0400 | [diff] [blame] | 2 | .SH NAME |
| Amna | 6773b07 | 2024-02-08 16:08:44 -0500 | [diff] [blame] | 3 | dnc \- Distributed Netcat |
| Amna | b10c6e7 | 2023-09-25 11:12:35 -0400 | [diff] [blame] | 4 | .SH SYNOPSIS |
| 5 | .B dnc |
| Amna | 6773b07 | 2024-02-08 16:08:44 -0500 | [diff] [blame] | 6 | [OPTIONS]... <YAML_FILE> <PEER_ID> |
| Amna | b10c6e7 | 2023-09-25 11:12:35 -0400 | [diff] [blame] | 7 | .SH DESCRIPTION |
| Amna | 6773b07 | 2024-02-08 16:08:44 -0500 | [diff] [blame] | 8 | \fBdnc\fR is a command-line utility designed to facilitate network communication across a Distributed Hash Table (DHT) network. It enables users to initiate TCP connections and create sockets on remote devices, functioning similarly to the traditional netcat utility but with added features for DHT networks. |
| 9 | |
| 10 | .SH "MAIN FEATURES" |
| 11 | .TP |
| 12 | .B \- Initiates TCP connections on remote devices. |
| 13 | .TP |
| 14 | .B \- Facilitates peer-to-peer network connectivity. |
| 15 | .TP |
| 16 | .B \- Supports TURN for NAT traversal. |
| 17 | .TP |
| 18 | .B \- Manages identities for secure interactions. |
| 19 | |
| 20 | .SH "USAGE OPTIONS" |
| Amna | b10c6e7 | 2023-09-25 11:12:35 -0400 | [diff] [blame] | 21 | .TP |
| 22 | .B \-h, \-\-help |
| Amna | 6773b07 | 2024-02-08 16:08:44 -0500 | [diff] [blame] | 23 | Display help information and exit. |
| Amna | b10c6e7 | 2023-09-25 11:12:35 -0400 | [diff] [blame] | 24 | .TP |
| Amna | 6773b07 | 2024-02-08 16:08:44 -0500 | [diff] [blame] | 25 | .B \-v, \-\-version |
| 26 | Show program version. |
| Amna | b10c6e7 | 2023-09-25 11:12:35 -0400 | [diff] [blame] | 27 | .TP |
| Amna | 6773b07 | 2024-02-08 16:08:44 -0500 | [diff] [blame] | 28 | .B \-P, \-\-port |
| 29 | Define the port for socket creation. |
| Amna | b10c6e7 | 2023-09-25 11:12:35 -0400 | [diff] [blame] | 30 | .TP |
| Amna | 6773b07 | 2024-02-08 16:08:44 -0500 | [diff] [blame] | 31 | .B \-i, \-\-ip |
| 32 | Define the IP address for socket creation. |
| Amna | b10c6e7 | 2023-09-25 11:12:35 -0400 | [diff] [blame] | 33 | .TP |
| 34 | .B \-l, \-\-listen |
| Amna | 6773b07 | 2024-02-08 16:08:44 -0500 | [diff] [blame] | 35 | Launch in listening mode. |
| Amna | b10c6e7 | 2023-09-25 11:12:35 -0400 | [diff] [blame] | 36 | .TP |
| Amna | 6773b07 | 2024-02-08 16:08:44 -0500 | [diff] [blame] | 37 | .B \-b, \-\-bootstrap |
| 38 | Set the bootstrap node. |
| Amna | b10c6e7 | 2023-09-25 11:12:35 -0400 | [diff] [blame] | 39 | .TP |
| Amna | 6773b07 | 2024-02-08 16:08:44 -0500 | [diff] [blame] | 40 | .B \-p, \-\-privateKey |
| 41 | Provide a private key. |
| Amna | b10c6e7 | 2023-09-25 11:12:35 -0400 | [diff] [blame] | 42 | .TP |
| Amna | 6773b07 | 2024-02-08 16:08:44 -0500 | [diff] [blame] | 43 | .B \-t, \-\-turn_host |
| 44 | Define the TURN server host. |
| Amna | b10c6e7 | 2023-09-25 11:12:35 -0400 | [diff] [blame] | 45 | .TP |
| Amna | 6773b07 | 2024-02-08 16:08:44 -0500 | [diff] [blame] | 46 | .B \-u, \-\-turn_user |
| 47 | Define the TURN server username. |
| Amna | b10c6e7 | 2023-09-25 11:12:35 -0400 | [diff] [blame] | 48 | .TP |
| Amna | 6773b07 | 2024-02-08 16:08:44 -0500 | [diff] [blame] | 49 | .B \-w, \-\-turn_pass |
| 50 | Define the TURN server password. |
| Amna | b10c6e7 | 2023-09-25 11:12:35 -0400 | [diff] [blame] | 51 | .TP |
| Amna | 6773b07 | 2024-02-08 16:08:44 -0500 | [diff] [blame] | 52 | .B \-r, \-\-turn_realm |
| 53 | Specify the TURN server realm. |
| 54 | .TP |
| 55 | .B \-c, \-\-certificate |
| 56 | Specify the certificate. |
| 57 | .TP |
| 58 | .B \-d, \-\-dnc_configuration |
| 59 | Define the dnc configuration with a YAML file path. |
| 60 | .TP |
| 61 | .B \-a, \-\-anonymous_cnx |
| 62 | Activate anonymous connection mode. |
| 63 | |
| 64 | .SH "ESTABLISHING SSH CONNECTIONS" |
| 65 | To facilitate SSH connections, \fBdnc\fR establishes a DHT network connection followed by socket creation on port 22. This requires an operational OpenSSH server. |
| 66 | |
| 67 | .SH "PREREQUISITES" |
| 68 | .TP |
| 69 | .B \- OpenSSH Installation |
| 70 | .TP |
| 71 | .B \- Build dhtnet |
| 72 | |
| 73 | .SH "STARTING THE DNC SERVICE" |
| 74 | To initiate, generate a certificate authority (CA) and an identity, then launch the \fBdnc\fR service. Obtain the hash ID (public key) for server identification. |
| 75 | |
| 76 | .SH "CLIENT CONNECTION" |
| 77 | Establishing a secure connection from the client side involves generating a CA and a unique identity, including a private key and a certificate. Integrate \fBdnc\fR with your SSH workflow by configuring your SSH client. |
| 78 | |
| 79 | .SH "EXAMPLE" |
| 80 | To connect to a remote server: |
| 81 | .nf |
| 82 | \fBssh <ssh_remote_user>@dnc/<peer_id>\fR |
| 83 | .fi |
| 84 | |
| 85 | .SH "SEE ALSO" |
| 86 | .TP |
| 87 | .BR ssh(1), |
| 88 | .BR netcat(1) |
| 89 | |