Commit Graph

4476 Commits

Author SHA1 Message Date
Alexander Færøy
8d4bbc337b Rewrite documentation on primary branch usage for Tor.git.
This patch is part of a series of patches where we try to change our
primary branch name of tor.git from master to main.

See: tpo/core/team#2
2021-05-25 00:20:46 +00:00
Nick Mathewson
9d7fca2306 Make MinTimeToReportBandwidth a testing-only option (and rename it) 2021-05-11 15:49:00 -04:00
Daniel Pinto
ce60454afd Add long format name --torrc-file for command line option -f. #40324 2021-03-28 03:56:31 +01:00
David Goulet
3a2593710b man: HiddenServiceStatistics applies for bridges
Closes #40346

Signed-off-by: David Goulet <dgoulet@torproject.org>
2021-03-23 08:32:26 -04:00
David Goulet
35b601a8b5 Merge branch 'tor-gitlab/mr/342' 2021-03-23 08:19:02 -04:00
Nick Mathewson
5c7f9844e4 manpage:Move BridgeRecordUsageByCountry to statistics section
patch from cypherpunks; closes #40323
2021-03-22 14:09:22 -04:00
George Kadianakis
ed7081ae2e Improve the man page entry for Address.
Fixes bug #40296 .
2021-03-22 16:38:34 +02:00
Nick Mathewson
2dfa19a871 Move ServerTransport* options to 'Server Options' section.
Patch from 'cypherpunks'. Closes #40331.
2021-03-19 13:23:29 -04:00
Nick Mathewson
40294c8ab1 Link to bridges.torproject.org/info in BridgeDistribution entry.
This incorporates a suggestion from cypherpunks on #40321

Closes #40321.
2021-03-19 13:10:41 -04:00
David Goulet
15a95df376 Merge branch 'tor-gitlab/mr/337' 2021-03-17 11:53:14 -04:00
Nick Mathewson
066748c9cd Add a DormantTimeoutEnabled to disable dormant mode entirely
(If you need to do this in an older version you can just set
DormantClientTimeout to something huge.)

Closes #40228.
2021-03-17 11:53:09 -04:00
Nick Mathewson
2ae24d003d Add a MinTimeToReportBandwidth option; make it 0 for testing networks.
This option changes the time for which a bandwidth measurement period
must have been in progress before we include it when reporting our
observed bandwidth in our descriptors.  Without this option, we only
consider a time period towards our maximum if it has been running
for a full day.  Obviously, that's unacceptable for testing
networks, where we'd like to get results as soon as possible.

For non-testing networks, I've put a (somewhat arbitrary) 2-hour
minimum on the option, since there are traffic analysis concerns
with immediate reporting here.

Closes #40337.
2021-03-17 08:45:37 -04:00
David Goulet
6fce18916f Merge branch 'tor-gitlab/mr/331' 2021-03-10 10:06:20 -05:00
Nick Mathewson
b599f489ae Fix documentation formatting for VirtualAddrNetworkIPv6
Fixes bug #40256; bugfix on 0.2.9.4-alpha.
2021-03-08 11:17:24 -05:00
Nick Mathewson
100221baac Merge remote-tracking branch 'origin/master' 2021-02-23 08:43:19 -05:00
Nick Mathewson
09614e0c9d Tweak documentation on 40282 2021-02-23 08:42:31 -05:00
David Goulet
100c758cd8 man: Note that relay now ignore the DirPort option
Signed-off-by: David Goulet <dgoulet@torproject.org>
2021-02-23 08:29:32 -05:00
David Goulet
94b56eaa75 dos: New client connect rate detection
This is a new detection type which is that a relay can now control the rate of
client connections from a single address.

The mechanism is pretty simple, if the rate/burst is reached, the address is
marked for a period of time and any connection from that address is denied.

Closes #40253

Signed-off-by: David Goulet <dgoulet@torproject.org>
2021-02-22 15:48:42 -05:00
David Goulet
330aec798b man: Cleanup of v2 options and config
Signed-off-by: David Goulet <dgoulet@torproject.org>
2021-02-19 13:20:49 -05:00
Nick Mathewson
aa0c4fd86d add brave to security cc list 2021-01-15 15:41:06 -05:00
Alexander Færøy
2d68fdc94c Merge branch 'maint-0.4.5' 2020-12-16 20:29:19 +00:00
Nick Mathewson
34baa1bdc3 Tweak the documentation for approved-routers
Document !badexit, and improve the documentation for !invalid.

Closes #40188.
2020-12-09 14:08:55 -05:00
Neel Chauhan
1588767e65 Allow listing ed25519 fingerprints on the command line 2020-11-17 11:23:08 -05:00
Samanta Navarro
4a0cd79588 Fix typos.
Typos found with codespell.

Please keep in mind that this should have impact on actual code
and must be carefully evaluated:

src/core/or/lttng_circuit.inc
-    ctf_enum_value("CONTROLER", CIRCUIT_PURPOSE_CONTROLLER)
+    ctf_enum_value("CONTROLLER", CIRCUIT_PURPOSE_CONTROLLER)
2020-11-12 11:44:09 -05:00
David Goulet
04ff22dc69 man: Add the MetricsPort manpage entry
Signed-off-by: David Goulet <dgoulet@torproject.org>
2020-10-27 10:43:42 -04:00
Nick Mathewson
c90535c539 Merge branch 'maint-0.4.4' 2020-10-26 16:39:31 -04:00
Roger Dingledine
00118355f5 Turn ConsensusParams into a Linelist
Make it possible to specify multiple ConsensusParams torrc
lines.

Now directory authority operators can for example put the
main ConsensusParams config in one torrc file and then add to it
from a different torrc file.

Closes ticket 40164.
2020-10-22 03:26:03 -04:00
Daniel Pinto
bb9707420e Allow mutiple lines on configuration for ROUTERSET entries. #28361
Affected entries are: EntryNodes, ExcludeNodes, ExcludeExitNodes,
ExitNodes, MiddleNodes, HSLayer2Nodes and HSLayer3Nodes.
2020-10-21 01:53:50 +01:00
David Goulet
bb249a221f Merge branch 'tor-gitlab/mr/170' 2020-10-14 09:46:44 -04:00
Nick Mathewson
f02f8f8946 Use "flavor" spelling consistently on manpage. 2020-10-14 09:45:41 -04:00
Nick Mathewson
d66cec8520 Apply typo fix patch from Samanta Navarro on #40161. 2020-10-14 09:43:26 -04:00
Nick Mathewson
42a5e652cb Make OptimisticData always-on.
We've been using it for years, and it seems to work just fine.  This
patch removes the option and its network parameter.

Part of #40139
2020-10-13 14:38:32 -04:00
Alexander Færøy
78aa037c41 Merge remote-tracking branch 'tor-gitlab/mr/161' 2020-10-13 13:50:14 +00:00
Alexander Færøy
5d23881770 Merge remote-tracking branch 'tor-gitlab/mr/165' 2020-10-13 13:45:01 +00:00
Alexander Færøy
db0aaf428e Add OutboundBindAddressPT to torrc.
This patch adds a new option to torrc: `OutboundBindAddressPT`. This
option works in the same way as `OutboundBindAddressOR` and
`OutboundBindAddressExit` in that it allows the user to specify which
outbound IP address the user wants the PT to make its connections from.

There is one difference though in that OutboundBindAddressPT will only
be a suggestion for the PT to use since Tor cannot enforce whether or
not the PT actually uses this option for anything.

See: https://bugs.torproject.org/5304
2020-10-06 09:30:10 -04:00
Nick Mathewson
25c8a3d66b Remove "AUTHORS" sections from manual pages.
These sections were incomplete and outdated; their presence is
strongly discouraged by man-pages(7).

Closes #40149.
2020-10-05 12:10:26 -04:00
Nick Mathewson
f2968c3aac Fix authors stanza in tor-gencert manpage
Closes #40148.
2020-10-02 09:08:33 -04:00
Nick Mathewson
5c9b4a0060 Remove support for old android "logcat" API
This is apparently obsolete; syslog is modern instead.  If users
have an android log configured, given them a syslog if we can.

Closes #32181.
2020-09-23 12:33:58 -04:00
Nick Mathewson
d0b83c7423 state-contents: correcct the description of unusable_circuits 2020-09-22 16:51:26 -04:00
Nick Mathewson
ce1dfb46fc Add a changes file for 40136 (state-contents.txt updates) 2020-09-22 14:46:41 -04:00
Nick Mathewson
5ffd8bf2b8 state-contents.txt: try to document circ-build-timeout fields
This should also get feedback from @mikeperry.

Closes #40136
2020-09-22 14:44:30 -04:00
Nick Mathewson
371cd7ac4f Try to document pathbias fields in state file.
This will require feedback from @mikeperry, since these are a bit
subtle and I've likely mangled some of these.
2020-09-22 14:35:11 -04:00
Nick Mathewson
d1a94a3a7f Improve doc/state-contents.txt
Part of a fix for #40136.

This patch adds all the state file entries to the documentation, and
documents the ones that I understand well.
2020-09-22 14:17:26 -04:00
Nick Mathewson
33380f6b27 Update remaining trac.tpo wiki urls 2020-09-14 11:02:38 -04:00
Nick Mathewson
563f8610fd Revise trac.torproject.org urls to refer to gitlab replacements.
Closes #40101.
2020-08-14 09:21:28 -04:00
Nick Mathewson
e82f36bccc Update ReleasingTor.md to current practice 2020-08-13 09:56:27 -04:00
Nick Mathewson
e151442037 Merge remote-tracking branch 'tor-gitlab/mr/62' 2020-08-12 14:37:21 -04:00
Nick Mathewson
b56985f022 CodingStandards.md: allow "bugfix on all supported versions.
Closes tpo/core/team#1 .
2020-08-11 17:58:11 -04:00
Daniel Pinto
0b633b1f6d Improved documentation and comments #25140 2020-08-11 18:26:41 +01:00
Nick Mathewson
d89c1799af manual: Describe Sandbox more accurately.
Closes #23378
2020-08-04 14:06:25 -04:00
Daniel Pinto
1474ab3395 Add --format argument to --key-expiration option. #30045 2020-08-01 01:08:37 +01:00
Nick Mathewson
4e71fc92c8 WritingTests.md: add a section about shells
Closes #29485
2020-07-28 22:59:47 -04:00
Nick Mathewson
92fc0d3699 Edit AddressDisableIPv6 man entry 2020-07-21 09:01:31 -04:00
David Goulet
c3d113a464 relay: Add AddressDisableIPv6 torrc option
This option controls if a tor relay will attempt address auto discovery and
thus ultimately publish an IPv6 ORPort in the descriptor.

Behavior is from proposal 312 section 3.2.6.

Closes #33245

Signed-off-by: David Goulet <dgoulet@torproject.org>
2020-07-21 08:18:31 -04:00
Nick Mathewson
5f969681a0 Combine text into existing "what does not need a changes file" section. 2020-07-16 14:54:17 -04:00
Nick Mathewson
85219d887d Merge remote-tracking branch 'tor-gitlab/mr/57' 2020-07-16 14:53:03 -04:00
David Goulet
e66eba664a doc: Fix wrong path in include.am
Tracing.md moved to doc/tracing/ so fix the distcheck path in include.am. Also
add the new EventsCircuit.md file.

Signed-off-by: David Goulet <dgoulet@torproject.org>
2020-07-16 14:07:33 -04:00
David Goulet
ca1003b791 doc: Update our requirements for changes file
Closes tpo/core/team#3.

Signed-off-by: David Goulet <dgoulet@torproject.org>
2020-07-16 13:34:52 -04:00
David Goulet
9c653e58b4 doc: Document circuit subsystem tracing events
Create a doc/tracing/ directory to contain a top level README.md which is the
previously named Tracing.md and add the EventsCircuit.md which describes the
circuit subsystem tracing events in depth.

Closes #40036

Signed-off-by: David Goulet <dgoulet@torproject.org>
2020-07-16 14:19:04 +00:00
Daniel Pinto
34fa2c4d0d Add support for patterns on %include #25140
Also adds generic tor_glob function to expand globs.
2020-07-15 22:01:08 +01:00
Alexander Færøy
aba0ff4cb5 Merge remote-tracking branch 'tor-gitlab/merge-requests/48' 2020-07-14 16:07:36 +00:00
David Goulet
770e047c83 doc: Fix aesthetic issues in HACKING/Tracing.md
Remove all the escape character "\" which is not needed for Markdown files.
This also fixes the tracing event include to the correct path.

Signed-off-by: David Goulet <dgoulet@torproject.org>
2020-07-14 10:09:01 -04:00
David Goulet
456be93956 doc: Move manpages into doc/man/
Closes #40044

Signed-off-by: David Goulet <dgoulet@torproject.org>
2020-07-14 09:02:03 -04:00
Nick Mathewson
ecb43ce21c Merge branch 'maint-0.4.4' 2020-07-13 10:45:04 -04:00
JeremyRand
0be80fb650 Bug 31812: Change http URL's to https 2020-07-13 10:42:46 -04:00
Guinness
b119c55776 Syntax highlighting in the docs
This adds the syntax highlights in the MarkDown files.
Fixes #33741
2020-07-13 11:45:14 +02:00
Nick Mathewson
6fb1637255 Merge remote-tracking branch 'tor-gitlab/mr/29' 2020-07-10 12:53:46 -04:00
Nick Mathewson
be6b30e642 Merge branch 'maint-0.4.4' 2020-07-09 09:59:54 -04:00
David Goulet
942ecfa835 doc: Add a WARNING section to Tracing.md
Explain what is safe or not with tracing data.

Signed-off-by: David Goulet <dgoulet@torproject.org>
2020-07-08 11:11:58 -04:00
David Goulet
79d6127a47 trace: Comments and improve doc/HACKING/Tracing.md
Signed-off-by: David Goulet <dgoulet@torproject.org>
2020-07-08 09:12:36 -04:00
David Goulet
66d5292ee6 Revert "config: Make clients tell dual-stack exits they prefer IPv6"
This reverts commit bf2a399fc0.

Don't set by default the prefer IPv6 feature on client ports because it breaks
the torsocks use case. The SOCKS resolve command is lacking a mechanism to ask
for a specific address family (v4 or v6) thus prioritizing IPv6 when an IPv4
address is asked on the resolve SOCKS interface resulting in a failure.

Tor Browser explicitly set PreferIPv6 so this should not affect the majority
of our users.

Closes #33796

Signed-off-by: David Goulet <dgoulet@torproject.org>
2020-07-07 12:58:41 -04:00
David Goulet
b039d3e803 Merge branch 'tor-github/pr/1953' 2020-07-01 09:47:26 -04:00
Nick Mathewson
5336ac2669 Move remaining CodeStructure.md contents into doxygen. 2020-06-26 10:11:42 -04:00
Nick Mathewson
a7aa97298b Remove special authority semantics for AssumeReachable.
AssumeReachable should only be about whether a relay thinks that it
is reachable itself.  But previously, we've had it also turn off
reachability checking of _other_ relays on authorities.
(Technically, reachability tests were still run, but we would ignore
the results.)

With this patch, there is a new AuthDirTestReachability option
(default 1) that controls whether authorities run reachability
tests.

Making this change allows us to have test networks where authorities
set AssumeReachable without disabling their reachability testing
entirely.

Closes ticket #34445.
2020-06-26 08:37:36 -04:00
Nick Mathewson
dbc2b75009 Merge branch 'assume_reachable_revamp' 2020-06-26 08:34:56 -04:00
Nick Mathewson
62e1d983cf Deprecate the "--dump-config non-builtin" option
When it works, "non-builtin" doesn't do anything different from
"short".  (When it doesn't work, it gives an assertion failure.)

Closes ticket #33398.
2020-06-25 10:01:40 -04:00
Nick Mathewson
edb023b1e7 Add an AssumeReachableIPv6 autobool option.
This option tells Tor that our IPv6 orport is reachable, and doesn't
need to be checked.

Closes the rest of 33224.
2020-06-24 15:25:34 -04:00
Nick Mathewson
9fdaede3f7 Remove AssumeReachable from TestingTorNetwork.
Closes ticket 34446.
2020-06-15 14:08:42 -04:00
Nick Mathewson
354f085e5f Merge remote-tracking branch 'tor-github/pr/1888/head' 2020-06-09 15:44:58 -04:00
c
284e9459b8
doc: specify C99 coding standards
Make clear that Tor's C code targets C99 standards. This makes it more
explicit what to expect for new code, because guessing from existing
code is not always reliable, especially for code that predates the
change in standard.
2020-06-04 13:28:24 +00:00
Nick Mathewson
b6e60f26dd Merge branch 'maint-0.4.3' 2020-06-01 09:50:04 -04:00
Roger Dingledine
d6186c7435 Man page: MinUptimeHidServDirectoryV2 defaults to 96 hours
Bugfix on 0.2.6.3-alpha; fixes bug 34299.
2020-05-23 04:37:57 -04:00
George Kadianakis
3121e5c103 Merge branch 'tor-github/pr/1850' 2020-05-21 16:24:32 +03:00
teor
e2bd15b6f3 doc: Some tor features may not work with MiddleNodes
And fix a formatting issue in the MiddleNodes man page entry.

Part of 33226.
2020-05-11 17:06:43 +10:00
Daniel Pinto
cc169eb120 Add documentation about %include and seccomp sandbox limitations 2020-05-08 00:21:12 +01:00
David Goulet
cd2121a126
client: Revert setting PreferIPv6 on by default
This change broke torsocks that by default is expecting an IPv4 for hostname
resolution because it can't ask tor for a specific IP version with the SOCKS5
extension.

PreferIPv6 made it that sometimes the IPv6 could be returned to torsocks that
was expecting an IPv4.

Torsocks is probably a very unique case because the runtime flow is that it
hijacks DNS resolution (ex: getaddrinfo()), gets an IP and then sends it back
for the connect() to happen.

The libc has DNS resolution functions that allows the caller to request a
specific INET family but torsocks can't tell tor to resolve the hostname only
to an IPv4 or IPv6 and thus by default fallsback to IPv4.

Reverting this change into 0.4.3.x series but we'll keep it in the 0.4.4.x
series in the hope that we add this SOCKS5 extension to tor for DNS resolution
and then change torsocks to use that.

Fixes #33804

Signed-off-by: David Goulet <dgoulet@torproject.org>
2020-04-09 11:05:32 +10:00
Roger Dingledine
9bd73da7cf fix typos from #32542 2020-04-08 19:13:52 -04:00
David Goulet
dd25805152 man: Update tor.1 ExtendedErrors section with latest
Signed-off-by: David Goulet <dgoulet@torproject.org>
2020-04-08 18:15:21 +03:00
teor
065ccda4f6
Merge branch 'pr1838_squashed' 2020-04-07 17:36:17 +10:00
teor
7adf72f1b4
Merge branch 'maint-0.4.3' 2020-04-05 17:17:51 +10:00
teor
80a306c6e7
doc: Fix another man page typo
The default value of the option is "auto", not "default".
2020-04-05 17:17:03 +10:00
teor
5c35bb38df
Merge branch 'maint-0.4.3' 2020-04-05 17:12:11 +10:00
teor
613077229f
doc: Fix a typo in the man page
"proceeding" means starting an action.
"preceding" means the thing before this thing.

In this context, it's a bit ambiguous.
2020-04-05 17:10:37 +10:00
teor
c0fe88b236
doc: Also stop running practracker in hooks
When making a new maint branch, stop running practracker in hooks.
2020-04-03 22:10:01 +10:00
teor
6db2e59f20
doc: Minor restructure for Release Lifecycle
* make end and beginning of life into second-level sections
* write an intro for beginning
* tweak intro for end
2020-04-03 22:06:27 +10:00
teor
0f10ddaa29
Re-apply: doc: Replace "underline" with "## Section name".
Re-applying changes after merge.
2020-04-03 22:02:11 +10:00
teor
0efcdb8918
Merge remote-tracking branch 'tor-github/pr/1739'
Ignored conflicting style changes: they will be re-applied in
the next commit.
2020-04-03 21:59:19 +10:00
teor
442e0caea2
Merge branch 'maint-0.4.3' 2020-04-03 14:44:34 +10:00
teor
7d2b6cacee
doc: Rewrite the approved-routers man page entry
Obviously correct documentation changes.
2020-04-03 14:43:48 +10:00
Steven Engler
cc5319bf8e Updated the TestingTorNetwork man page options
Updated 'doc/tor.1.txt' to match 'src/app/config/testnet.inc'.
2020-04-01 01:00:09 -04:00