'\" t
.\"     Title: flashproxy-client
.\"    Author: [FIXME: author] [see http://docbook.sf.net/el/author]
.\" Generator: DocBook XSL Stylesheets v1.78.1 <http://docbook.sf.net/>
.\"      Date: 06/17/2015
.\"    Manual: \ \&
.\"    Source: \ \&
.\"  Language: English
.\"
.TH "FLASHPROXY\-CLIENT" "1" "06/17/2015" "\ \&" "\ \&"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" http://bugs.debian.org/507673
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
flashproxy-client \- The flash proxy client transport plugin
.SH "SYNOPSIS"
.sp
\fBflashproxy\-client\fR \fB\-\-register\fR [\fIOPTIONS\fR] [\fILOCAL\fR][:\fIPORT\fR] [\fIREMOTE\fR][:\fIPORT\fR]
.SH "DESCRIPTION"
.sp
Wait for connections on a local and a remote port\&. When any pair of connections exists, data is ferried between them until one side is closed\&. By default \fILOCAL\fR is localhost addresses on port 9001 and \fIREMOTE\fR is all addresses on port 9000\&.
.sp
The local connection acts as a SOCKS4a proxy, but the host and port in the SOCKS request are ignored and the local connection is always linked to a remote connection\&.
.sp
By default, runs as a managed proxy: informs a parent Tor process of support for the "flashproxy" or "websocket" pluggable transport\&. In managed mode, the \fILOCAL\fR port is chosen arbitrarily instead of defaulting to 9001; however this can be overridden by including a \fILOCAL\fR port in the command\&. This is the way the program should be invoked in a torrc ClientTransportPlugin "exec" line\&. Use the \fB\-\-external\fR option to run as an external proxy that does not interact with Tor\&.
.sp
If any of the \fB\-\-register\fR, \fB\-\-register\-addr\fR, or \fB\-\-register\-methods\fR options are used, then your IP address will be sent to the facilitator so that proxies can connect to you\&. You need to register in some way in order to get any service\&. The \fB\-\-facilitator\fR option allows controlling which facilitator is used; if omitted, it uses a public default\&.
.SH "OPTIONS"
.PP
\fB\-4\fR
.RS 4
Registration helpers use IPv4\&.
.RE
.PP
\fB\-6\fR
.RS 4
Registration helpers use IPv6\&.
.RE
.PP
\fB\-\-daemon\fR
.RS 4
Daemonize (Unix only)\&.
.RE
.PP
\fB\-\-external\fR
.RS 4
Be an external proxy (don\(cqt interact with Tor using environment variables and stdout)\&.
.RE
.PP
\fB\-f\fR, \fB\-\-facilitator\fR=\fIURL\fR
.RS 4
Advertise willingness to receive connections to URL\&.
.RE
.PP
\fB\-\-facilitator\-pubkey\fR=\fIFILENAME\fR
.RS 4
Encrypt registrations to the given PEM\-formatted public key (default built\-in)\&.
.RE
.PP
\fB\-h\fR, \fB\-\-help\fR
.RS 4
Display a help message and exit\&.
.RE
.PP
\fB\-l\fR, \fB\-\-log\fR=\fIFILENAME\fR
.RS 4
Write log to
\fIFILENAME\fR
(default is stdout)\&.
.RE
.PP
\fB\-\-pidfile\fR=\fIFILENAME\fR
.RS 4
Write PID to
\fIFILENAME\fR
after daemonizing\&.
.RE
.PP
\fB\-\-port\-forwarding\fR
.RS 4
Attempt to forward
\fIREMOTE\fR
port\&.
.RE
.PP
\fB\-\-port\-forwarding\-helper\fR=\fIPROGRAM\fR
.RS 4
Use the given
\fIPROGRAM\fR
to forward ports (default "tor\-fw\-helper")\&. Implies
\fB\-\-port\-forwarding\fR\&.
.RE
.PP
\fB\-\-port\-forwarding\-external\fR=\fIPORT\fR
.RS 4
Forward the external
\fIPORT\fR
to
\fIREMOTE\fR
on the local host (default same as REMOTE)\&. Implies
\fB\-\-port\-forwarding\fR\&.
.RE
.PP
\fB\-r\fR, \fB\-\-register\fR
.RS 4
Register with the facilitator\&.
.RE
.PP
\fB\-\-register\-addr\fR=\fIADDR\fR
.RS 4
Register the given address (in case it differs from
\fIREMOTE\fR)\&. Implies
\fB\-\-register\fR\&.
.RE
.PP
\fB\-\-register\-methods\fR=\fIMETHOD\fR[,\fIMETHOD\fR]
.RS 4
Register using the given comma\-separated list of methods\&. Implies
\fB\-\-register\fR\&. Possible methods are: appspot, email, http\&. Default is "appspot,email,http"\&.
.RE
.PP
\fB\-\-transport\fR=\fITRANSPORT\fR
.RS 4
Registrations include the fact that you intend to use the given
\fITRANSPORT\fR
(default "websocket")\&.
.RE
.PP
\fB\-\-unsafe\-logging\fR
.RS 4
Don\(cqt scrub IP addresses from logs\&.
.RE
.SH "SEE ALSO"
.sp
\fBhttp://crypto\&.stanford\&.edu/flashproxy/\fR
.SH "BUGS"
.sp
Please report using \fBhttps://trac\&.torproject\&.org/projects/tor\fR\&.