Skip to content
GitLab
Explore
Sign in
Register
Primary navigation
Search or go to…
Project
O
obfs4-deprecated
Manage
Activity
Members
Labels
Plan
Wiki
Code
Merge requests
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Build
Pipelines
Jobs
Pipeline schedules
Artifacts
Deploy
Releases
Model registry
Operate
Environments
Analyze
Model experiments
Help
Help
Support
GitLab documentation
Compare GitLab plans
Community forum
Contribute to GitLab
Provide feedback
Keyboard shortcuts
?
Snippets
Groups
Projects
Show more breadcrumbs
leap
obfs4-deprecated
Commits
09633500
Commit
09633500
authored
10 years ago
by
Yawning Angel
Browse files
Options
Downloads
Patches
Plain Diff
Add a man page for obfs4proxy.
parent
cedd6a5f
No related branches found
Branches containing commit
No related tags found
Tags containing commit
No related merge requests found
Changes
2
Hide whitespace changes
Inline
Side-by-side
Showing
2 changed files
ChangeLog
+3
-0
3 additions, 0 deletions
ChangeLog
doc/obfs4proxy.1
+88
-0
88 additions, 0 deletions
doc/obfs4proxy.1
with
91 additions
and
0 deletions
ChangeLog
+
3
−
0
View file @
09633500
Changes in version 0.0.2 - UNRELEASED
- Add a man page for obfs4proxy.
Changes in version 0.0.1 - 2014-09-03
Changes in version 0.0.1 - 2014-09-03
- Initial release.
- Initial release.
This diff is collapsed.
Click to expand it.
doc/obfs4proxy.1
0 → 100644
+
88
−
0
View file @
09633500
.TH OBFS4PROXY 1 "2014-09-06"
.SH NAME
obfs4proxy \- pluggable transport proxy for Tor, implementing obfs4
.SH SYNOPSIS
.B obfs4proxy
[\fIoptions\fR]
.SH DESCRIPTION
obfs4proxy is a tool that attempts to circumvent censorship by
transforming the Tor traffic between the client and the bridge. This way
censors, who usually monitor traffic between the client and the bridge,
will see innocent-looking transformed traffic instead of the actual Tor
traffic.
.PP
obfs4proxy implements the obfuscation protocols obfs2, obfs3 and obfs4.
.PP
obfs4proxy is currently only supported as a managed pluggable transport
spawned as a helper process via the \fBtor\fR daemon.
.SH OPTIONS
.TP
\fB\-h\fR, \fB\-\-help\fR
Display usage information and exit.
.TP
\fB\-\-version\fR
Display version information and exit.
.TP
\fB\-\-enableLogging\fR
Enable logging.
.TP
\fB\-\-logLevel\fR=\fIlevel\fR
Specify the maximum log severity to log out of "\fBERROR\fR", "\fBWARN\fR", and
"\fBINFO\fR".
.TP
\fB\-\-unsafeLogging\fR
Disable the IP address scrubber when logging, storing personally identifiable
information in the logs.
.TP
\fB\-\-obfs4\-distBias\fR
When generating probability distributions for the obfs4 lenght and timing
obfuscation, generate biased distributions similar to ScrambleSuit.
.SH ENVIORNMENT
obfs4proxy honors all of the enviornment variables as specified in the Tor
Pluggable Transport Specification.
.SH FILES
.PP
\fIDataDirectory\fR\fB/pt_state/obfs4proxy.log\fR
.RS 4
The log file, assuming logging is enabled.
.RE
.PP
\fIDataDirectory\fR\fB/pt_state/obfs4_state.json\fR
.RS 4
The Bridge (server) auto-generated obfs4 bridge parameters file. This file
will not be created if the administrator specifies them in the \fBtorrc\fR
via a \fBServerTransportOptions\fR directive.
.RE
.SH "CONFORMING TO"
Tor Pluggable Transport Specification
.SH NOTES
Using the obfs4 protocol requires tor-0.2.5.x or later.
.PP
The obfs2 protocol is included for backwards compatibility purposes only, and
should not be used in new deployments.
.SH EXAMPLE
To configure tor to be able to use obfs4 bridges (as a client), add obfs4proxy
to the \fBtorrc\fR like thus:
.PP
.nf
.RS
# Use obfs4proxy to provide the obfs4 protocol.
ClientTransportPlugin obfs4 exec /usr/bin/obfs4proxy
.RE
.fi
.PP
To configure tor to act as an obfs4 bridge (as the server), add obfs4proxy
to the \fBtorrc\fR like thus:
.PP
.nf
.RS
#
# In addition to the standard tor bridge configuration, add:
#
# Use obfs4proxy to provide the obfs4 protocol.
ServerTransportPlugin obfs4 exec /usr/bin/obfs4proxy
.RE
.fi
.SH "SEE ALSO"
\fBtor (1), \fBtorrc (5), \fBobfsproxy (1)
This diff is collapsed.
Click to expand it.
Preview
0%
Loading
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Save comment
Cancel
Please
register
or
sign in
to comment