Gitiles
Code Review Sign In
review.jami.net / dhtnet / 5170f76d79bef7f031434d365ef5f336a49d1054 / . / tools / dnc / dnc.1
blob: c6b7aaee68b78cd87e0fa7a1d6ed4dbf082f5984 [file] [log] [blame]
Amna6773b072024-02-08 16:08:44 -0500[diff] [blame]1.TH DNC 1 "February 2024" "Version 1.1" "Distributed nc"
Amnab10c6e72023-09-25 11:12:35 -0400[diff] [blame]2.SH NAME
Amna6773b072024-02-08 16:08:44 -0500[diff] [blame]3dnc \- Distributed Netcat
Amnab10c6e72023-09-25 11:12:35 -0400[diff] [blame]4.SH SYNOPSIS
5.B dnc
Amna6773b072024-02-08 16:08:44 -0500[diff] [blame]6[OPTIONS]... <YAML_FILE> <PEER_ID>
Amnab10c6e72023-09-25 11:12:35 -0400[diff] [blame]7.SH DESCRIPTION
Amna6773b072024-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
Amna77e27dc2024-07-24 13:09:40 -0400[diff] [blame]20.SH "OPTIONS"
21
Amnab10c6e72023-09-25 11:12:35 -0400[diff] [blame]22.TP
23.B \-h, \-\-help
Amna6773b072024-02-08 16:08:44 -0500[diff] [blame]24Display help information and exit.
Amna77e27dc2024-07-24 13:09:40 -0400[diff] [blame]25
Amnab10c6e72023-09-25 11:12:35 -0400[diff] [blame]26.TP
Amna6773b072024-02-08 16:08:44 -0500[diff] [blame]27.B \-v, \-\-version
28Show program version.
Amna77e27dc2024-07-24 13:09:40 -0400[diff] [blame]29
Amnab10c6e72023-09-25 11:12:35 -0400[diff] [blame]30.TP
Amna77e27dc2024-07-24 13:09:40 -0400[diff] [blame]31.B \-P, \-\-port \fIPORT\fR
Amna6773b072024-02-08 16:08:44 -0500[diff] [blame]32Define the port for socket creation.
Amna77e27dc2024-07-24 13:09:40 -0400[diff] [blame]33
Amnab10c6e72023-09-25 11:12:35 -0400[diff] [blame]34.TP
Amna77e27dc2024-07-24 13:09:40 -0400[diff] [blame]35.B \-i, \-\-ip \fIADDRESS\fR
Amna6773b072024-02-08 16:08:44 -0500[diff] [blame]36Define the IP address for socket creation.
Amna77e27dc2024-07-24 13:09:40 -0400[diff] [blame]37
Amnab10c6e72023-09-25 11:12:35 -0400[diff] [blame]38.TP
39.B \-l, \-\-listen
Amna6773b072024-02-08 16:08:44 -0500[diff] [blame]40Launch in listening mode.
Amna77e27dc2024-07-24 13:09:40 -0400[diff] [blame]41
Amnab10c6e72023-09-25 11:12:35 -0400[diff] [blame]42.TP
Amna77e27dc2024-07-24 13:09:40 -0400[diff] [blame]43.B \-b, \-\-bootstrap \fIADDRESS\fR
Amna6773b072024-02-08 16:08:44 -0500[diff] [blame]44Set the bootstrap node.
Amna77e27dc2024-07-24 13:09:40 -0400[diff] [blame]45
Amnab10c6e72023-09-25 11:12:35 -0400[diff] [blame]46.TP
Amna77e27dc2024-07-24 13:09:40 -0400[diff] [blame]47.B \-t, \-\-turn_host \fIADDRESS\fR
Amna6773b072024-02-08 16:08:44 -0500[diff] [blame]48Define the TURN server host.
Amna77e27dc2024-07-24 13:09:40 -0400[diff] [blame]49
Amnab10c6e72023-09-25 11:12:35 -0400[diff] [blame]50.TP
Amna77e27dc2024-07-24 13:09:40 -0400[diff] [blame]51.B \-u, \-\-turn_user \fIUSER\fR
Amna6773b072024-02-08 16:08:44 -0500[diff] [blame]52Define the TURN server username.
Amna77e27dc2024-07-24 13:09:40 -0400[diff] [blame]53
Amnab10c6e72023-09-25 11:12:35 -0400[diff] [blame]54.TP
Amna77e27dc2024-07-24 13:09:40 -0400[diff] [blame]55.B \-w, \-\-turn_pass \fISECRET\fR
Amna6773b072024-02-08 16:08:44 -0500[diff] [blame]56Define the TURN server password.
Amna77e27dc2024-07-24 13:09:40 -0400[diff] [blame]57
Amnab10c6e72023-09-25 11:12:35 -0400[diff] [blame]58.TP
Amna77e27dc2024-07-24 13:09:40 -0400[diff] [blame]59.B \-r, \-\-turn_realm \fIREALM\fR
Amna6773b072024-02-08 16:08:44 -0500[diff] [blame]60Specify the TURN server realm.
Amna77e27dc2024-07-24 13:09:40 -0400[diff] [blame]61
Amna6773b072024-02-08 16:08:44 -0500[diff] [blame]62.TP
Amna77e27dc2024-07-24 13:09:40 -0400[diff] [blame]63.B \-p, \-\-privateKey \fIFILE\fR
64Provide a private key.
65
66.TP
67.B \-c, \-\-certificate \fIFILE\fR
Amna6773b072024-02-08 16:08:44 -0500[diff] [blame]68Specify the certificate.
Amna77e27dc2024-07-24 13:09:40 -0400[diff] [blame]69
Amna6773b072024-02-08 16:08:44 -0500[diff] [blame]70.TP
Amna77e27dc2024-07-24 13:09:40 -0400[diff] [blame]71.B \-d, \-\-configuration \fIFILE\fR
Amna6773b072024-02-08 16:08:44 -0500[diff] [blame]72Define the dnc configuration with a YAML file path.
Amna77e27dc2024-07-24 13:09:40 -0400[diff] [blame]73
Amna6773b072024-02-08 16:08:44 -0500[diff] [blame]74.TP
Amna77e27dc2024-07-24 13:09:40 -0400[diff] [blame]75.B \-a, \-\-anonymous
Amna6773b072024-02-08 16:08:44 -0500[diff] [blame]76Activate anonymous connection mode.
Amna77e27dc2024-07-24 13:09:40 -0400[diff] [blame]77
Amna69996232024-07-23 14:04:44 -0400[diff] [blame]78.TP
79.B \-vv, \-\-verbose
80Enable verbose mode.
Amna6773b072024-02-08 16:08:44 -0500[diff] [blame]81
82.SH "ESTABLISHING SSH CONNECTIONS"
83To facilitate SSH connections, \fBdnc\fR establishes a DHT network connection followed by socket creation on port 22. This requires an operational OpenSSH server.
84
85.SH "PREREQUISITES"
86.TP
87.B \- OpenSSH Installation
88.TP
89.B \- Build dhtnet
90
91.SH "STARTING THE DNC SERVICE"
92To initiate, generate a certificate authority (CA) and an identity, then launch the \fBdnc\fR service. Obtain the hash ID (public key) for server identification.
93
94.SH "CLIENT CONNECTION"
95Establishing 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.
96
97.SH "EXAMPLE"
98To connect to a remote server:
99.nf
100\fBssh <ssh_remote_user>@dnc/<peer_id>\fR
101.fi
102
103.SH "SEE ALSO"
104.TP
105.BR ssh(1),
Amna77e27dc2024-07-24 13:09:40 -0400[diff] [blame]106.BR netcat(1),
107.BR dhtnet-crtmgr (1)
Amna6773b072024-02-08 16:08:44 -0500[diff] [blame]108