.\" Macros
.ds PX \s-1POSIX\s+1
.de EXAMPLE .\" Example formta
.RS 10
.BR "\\$1"
.RE
..

.TH socks5d 1.0 "21 June 2022"
.LO 8
.SH NAME
socks5d \- proxy SOCKS version 5 (BProxy)

.SH SYNOPSIS
.HP 10
.B  socks5d
[ POSIX style options ]

.SH OPTIONS

.IP "\fB-h\fR"
Prints help.

.IP "\fB\-l\fB \fIsocks-address\fR"
Establishes address where proxy SOCKS will be served.
By default listens in every interface.

.IP "\fB\-L\fB \fImanagement-address\fR"
Establishes address where management srrver will be served.
By default listens to loopback.

.IP "\fB\-p\fB \fIsocks-port\fR"
TCP port where it will listen for incoming SOCKS connections.
Default value is \fI1080\fR.

.IP "\fB\-P\fB \fImanagement-port\fR"
UDP port where it will listen for incoming Bottler Configuration Protocol connections
Default value is \fI8080\fR.

.IP "\fB\-u\fB \fIuser:pass\fR"
Declares a proxy user with its password <uname>:<pass>.
A maximum of 1024 users is established.


.IP "\fB\-v\fB"
Prints version information.

.SH ACCESS LOGGING

Logs use of proxy server in standard output and file \fIaccess.log\fR. A line per connections.
Each field is delimited by a space:

.IP "\fBdate\fR" 
in which the connection has been made in ISO-8601 format.
Example 2022-06-15T19:56:34Z.

.IP "\fBusername\fR" 
that makes the request. \fIanon\fR if not authenticated.
Example user123.

.IP "\fBregister type\fR" 
Always character A.

.IP "\fBorigin IP address\fR" 
from which the user made the connection.
Example ::1.

.IP "\fBorigin port\fR" 
from which the user made the connection.
Example 54786.

.IP "\fBdestination\fR"
to which the connection has been made. Name or IP address (according to ATY).
Example www.itba.edu.ar.
Example ::1.

.IP "\fBdestination port\fR"
to which the connection has been made.
Example 443.

.IP "\fBstatus\fR"
status SOCKS (0 success, ...)
Status code de SOCKSv5. Example 0.


.SH PASSWORD LOGGING

Logs uncovered credentials in standard output and file \fIpasswords.log\fR. One
credential per line. Fields are delimited by spaces:

.IP "\fBdate\fR" 
in which the connection has been processed in ISO-8601 format.
Example 2020-06-15T19:56:34Z.

.IP "\fBusername\fR" 
that makes the request. \fIanon\fR if not authenticated
Example user123.

.IP "\fBregister type\fR" 
Always character P.


.IP "\fBprotocol\fR"
Inferred protocol user. If unknown then UNK.
Between partenthesis if suspected.

.IP "\fBdestination\fR"
to which the connection has been made. Name or IP address (according to ATY).
Example www.itba.edu.ar.
Example ::1.

.IP "\fBdestination port\fR"
to which the connection has been made.
Example 443.

.IP "\fBdiss_user\fR"
Uncovered username.

.IP "\fBdiss_pass\fR"
Uncovered password.