Commit Graph

4244 Commits

Author SHA1 Message Date
Nick Mathewson
469051f650 Copy architectural documentation from tor-guts.git repository
I started this repository a while ago to work on documentation for
Tor's internals.  It needs substantial revision, but first, let's
get it copied into Tor's repository.

These files are copied, "warts and all", from the tor-guts.git repo,
commit de1e34259178b09861c0dea319c760fa80d0099a.

Part of 31819.
2019-09-24 19:26:04 -04:00
teor
102546f99f
doc: Document the signal-safe log behaviour in the tor man page
Part of 31389.
2019-09-24 15:03:17 +10:00
David Goulet
e5cf1423fd man: Entry for the HS intro DoS defenses
This also adds a "subsection" to the HIDDEN SERVICE OPTIONS section to
seperate per-service and per-instance options. It is a bit less messy this
way.

The HS DoS options are added to the per-service section.

Part of #30924

Signed-off-by: David Goulet <dgoulet@torproject.org>
2019-08-26 15:53:46 +03:00
Nick Mathewson
6ba05eea8e Merge remote-tracking branch 'tor-github/pr/1247' 2019-08-24 16:32:50 -04:00
Antoine Veuiller
3bf90e704c doc(hacking): update = to # on sections 2019-08-21 16:22:37 +02:00
Antoine Veuiller
0d6c8eed49 doc(hacking): enhance markdown style 2019-08-21 16:22:08 +02:00
teor
e87e34099c
Fix typos in HiddenServiceExportCircuitID
Closes bug 31418.
2019-08-15 18:58:10 +10:00
teor
f65f4b5c38
Merge remote-tracking branch 'tor-github/pr/1020' into maint-0.3.5 2019-08-12 09:49:53 +10:00
teor
a57e168caa
Merge remote-tracking branch 'tor-github/pr/741' into maint-0.3.5 2019-08-12 09:36:14 +10:00
rl1987
ffce19a9ec Make tor-print-ed-signing-cert output RFC1123 and unix timestamps as well 2019-07-10 11:36:26 +03:00
George Kadianakis
15e28af2d1 Merge remote-tracking branch 'dgoulet/ticket31008_035_01' 2019-07-02 13:19:40 +03:00
David Goulet
f446db59e1 man: Fix -help typo to --help
Signed-off-by: David Goulet <dgoulet@torproject.org>
2019-06-27 14:52:12 -04:00
David Goulet
c34a6b922f Merge branch 'tor-github/pr/1129' 2019-06-27 10:19:45 -04:00
teor
362afa8c4e doc: update the man page entries for DirAuthority and FallbackDir
Improve the documentation for the DirAuthority and FallbackDir torrc
options.

Closes ticket 30955.
2019-06-27 10:19:40 -04:00
teor
872b85e689
Merge branch 'bug30956_041' into bug30956_master 2019-06-24 19:47:34 +10:00
teor
8356cc5b51 stats: Always publish pluggable transports in extra info documents
Always publish bridge pluggable transport information in the extra info
descriptor, even if ExtraInfoStatistics is 0. This information is
needed by BridgeDB.

Fixes bug 30956; bugfix on 0.4.1.1-alpha.
2019-06-24 19:44:24 +10:00
rl1987
66a15013fa Allow excluding documentation from the build 2019-06-16 20:21:30 +03:00
George Kadianakis
7b3efc386f Merge branch 'tor-github/pr/1102' 2019-06-12 13:00:20 +03:00
David Goulet
8e112cecd8 Merge branch 'tor-github/pr/1031' 2019-06-11 11:46:38 -04:00
Nick Mathewson
4313f1cce8 Merge branch 'ticket28453_v2' into ticket28453_v2_merged 2019-06-11 10:22:37 -04:00
Nick Mathewson
765e4364d9 Merge remote-tracking branch 'tor-github/pr/1064' into maint-0.4.1 2019-06-10 09:37:17 -04:00
Nick Mathewson
4ceec4760c change some CI-substitute logic 2019-06-05 15:38:25 -04:00
rl1987
5d4b4f948a Mention Travis/Appveyor/Jenkins URLs in ReleasingTor.md 2019-05-31 09:35:19 +03:00
Nick Mathewson
d41427b054 A couple of suggestions from dgoulet on EndOfLife.md 2019-05-30 09:07:45 -04:00
Nick Mathewson
3ba2e04ee7 Minor tweaks on EOL process
First, clarify that this is for planned deprecations, not
security-related issues.

Second, we actually _don't_ want to remove the versions from the
approved list before the EOL date, or people will start getting
warnings too early.
2019-05-30 09:05:35 -04:00
teor
6263d9e13f doc: Add End of Life Tor instructions
Closes 28453.
2019-05-30 09:02:13 -04:00
teor
c390f1dd7e doc: Add a new Travis CI cron job when there's a new maint branch
Part of 28453.
2019-05-30 09:02:13 -04:00
Iain R. Learmonth
58cb98af32 Prop 301: No longer vote on RecommendedPackages
This is the first half of implementing proposal 301. The
RecommendedPackages torrc option is marked as obsolete and
the test cases for the option removed. Additionally, the code relating
to generating and formatting package lines in votes is removed.

These lines may still appear in votes from other directory authorities
running earlier versions of the code and so consensuses may still
contain package lines. A new consensus method will be needed to stop
including package lines in consensuses.

Fixes: #28465
2019-05-16 13:31:54 +01:00
Nick Mathewson
1c95bdb83b Merge branch 'ticket30452_035_v3' into ticket30452_041_v3 2019-05-14 19:20:53 -04:00
Nick Mathewson
1b16fcb70c Add a --list-modules command
Closes ticket 30452.
2019-05-14 19:19:53 -04:00
Nick Mathewson
9ad2eb8f73 Merge branch 'bug28683_30173_29203_squashed' 2019-05-13 14:33:31 -04:00
Mike Perry
621ea2315b Bug 29203: Provide ReducedCircuitPadding torrc and consensus params 2019-05-13 14:30:35 -04:00
Mike Perry
f4064d6ce2 Bug 28693: Provide Torrc option to disable circuit padding. 2019-05-13 14:30:35 -04:00
Nick Mathewson
c8c64caf37 Merge remote-tracking branch 'tor-github/pr/923' 2019-05-06 17:16:37 -04:00
Nick Mathewson
d20cfc00ce Note how to update the new website in the ReleasingTor.md instructions 2019-05-03 08:51:28 -04:00
Nick Mathewson
44e6663b8a Merge remote-tracking branch 'tor-github/pr/972' 2019-04-29 13:36:35 -04:00
teor
ac5753d3ca
Coding Standards: Document how to find git commits
Document how to find git commits and tags for bug fixes in
CodingStandards.md.

And update some changes file documentation.

Closes ticket 30261.
2019-04-23 10:03:18 +10:00
teor
231036a110
Merge branch 'maint-0.3.4' into maint-0.3.5 2019-04-19 12:00:41 +10:00
teor
b1762f8d12
Merge remote-tracking branch 'tor-github/pr/638' into maint-0.3.4 2019-04-19 11:44:38 +10:00
Neel Chauhan
caa55a6d37 Grammar fixes for IPv6Exit in tor.1.txt 2019-04-17 21:41:31 -04:00
Neel Chauhan
cfada969a9 Update tor.1 man page for IPv6Exit 2019-04-17 07:26:55 -04:00
Nick Mathewson
f8dc935fb7 Merge remote-tracking branch 'tor-github/pr/741' 2019-04-11 14:27:06 -04:00
teor
8cfab3b7c3
doc: Improve the documentation for MapAddress .exit
Fixes bug 30109; bugfix on 0.1.0.1-rc.
2019-04-10 17:43:59 +10:00
teor
3d45079c27
Merge branch 'maint-0.4.0' 2019-04-09 11:36:59 +10:00
teor
2dab7a1078
Merge remote-tracking branch 'tor-github/pr/862' 2019-04-09 11:36:12 +10:00
rl1987
61e6b217c5
manpage: Clarify that Tor does stream isolation between *Port listeners by default
cherry-pick of tor-github/pr/841 to maint-0.4.0.
2019-04-09 11:34:51 +10:00
George Kadianakis
574c207670 Merge branch 'maint-0.4.0' 2019-04-05 14:51:33 +03:00
Nick Mathewson
d194f6bedf Implement an DormantCanceledByStartup option
Closes ticket 29357, and comes with appropriate notions of caution.
2019-04-04 11:48:36 -04:00
Elichai Turkel
0ebe290198 Removed the use of expect from CodingStandardsRust 2019-04-03 08:32:10 -04:00
rl1987
283ee0ba0a Fix SC2086 warnings in asciidoc-helper.sh 2019-03-27 19:27:57 +02:00
Nick Mathewson
a47b61f329 Merge branch 'messaging_v3' into messaging_v3_merged 2019-03-26 20:13:49 -04:00
George Kadianakis
d11976b8bd Merge branch 'tor-github/pr/709' 2019-03-26 15:34:54 +02:00
Nick Mathewson
0944500a8e Add MESG as a new log domain. 2019-03-25 16:35:33 -04:00
Nick Mathewson
17ff69a268 Merge branch 'bug29221_more_squashed' 2019-03-13 09:30:02 -04:00
Nick Mathewson
e2512950b6 Improve failure message from check-best-practices 2019-03-13 09:27:29 -04:00
rl1987
27eec50527 manpage: fix formatting of example on quoting options with spaces 2019-03-03 11:51:08 +02:00
teor
9b7cdd23de
doc: update the man page and sample torrc for ExitRelay
We changed the default of ExitRelay in #21530 in 0.3.5.1-alpha, but
forgot to update the documentation.

Closes 29612.
2019-02-28 11:22:20 +10:00
David Goulet
a5dd41b9af Merge branch 'tor-github/pr/638' into maint-0.4.0 2019-02-26 11:24:43 -05:00
teor
a798bd40fb stats: Stop reporting statistics when ExtraInfoStatistics is 0
When ExtraInfoStatistics is 0, stop including bandwidth usage statistics,
GeoIPFile hashes, ServerTransportPlugin lines, and bridge statistics
by country in extra-info documents.

Fixes bug 29018; bugfix on 0.2.4.1-alpha (and earlier versions).
2019-02-19 19:01:44 +10:00
teor
361738c964 Merge branch 'bug29017-033' into bug29017-master-merge 2019-02-19 18:59:16 +10:00
Roger Dingledine
5dcd44cbe2 fix some of the typos in Maintaining.md 2019-02-17 16:55:55 -05:00
rl1987
58cbe51708 Use RFC5737-compliant example IP addresses in manpage when describing MapAddress 2019-01-30 17:13:40 +02:00
Nick Mathewson
0ce4d23af5 Merge branch 'maint-0.3.5' 2019-01-22 08:04:55 -05:00
Nick Mathewson
7c6a8c674b Fix documentation for ClientAuth on HSv3.
The manpage erroneously said "privkey" when "public-key" would have
been correct.  Reported by "Felixix" as ticket 28979. Bugfix on
0.3.5.1-alpha.
2019-01-16 16:10:20 -05:00
Nick Mathewson
b169c8c14f Merge remote-tracking branch 'asn-github/adaptive_padding-final' 2019-01-14 14:48:00 -05:00
George Kadianakis
2b29bccb85 Misc trivial improvements around circpadding code. 2019-01-10 13:06:08 +02:00
teor
85c598cbc2 stats: Make PaddingStatistics depend on ExtraInfoStatistics
When ExtraInfoStatistics is 0, stop including PaddingStatistics in
relay and bridge extra-info documents.

Fixes bug 29017; bugfix on 0.3.1.1-alpha.
2019-01-08 18:21:10 +10:00
Mike Perry
8ad497bb57 Config option to specify specific MiddleNodes.
Hope is this will make it easier to test on the live tor network.

Does not need to be merged if we don't want to, but will come in handy
for researchers.

Co-authored-by: George Kadianakis <desnacked@riseup.net>
2019-01-02 15:25:55 +02:00
rl1987
8eadfad71d Tweak ControlPort description in manpage 2018-12-23 19:58:25 +02:00
Taylor Yu
b0f974633a Add LD_BTRACK log domain for bootstrap tracker
Part of ticket 27167.
2018-12-20 18:46:17 -06:00
Nick Mathewson
0e6e902cbc Merge branch 'document_--version' 2018-12-20 11:50:48 -05:00
Nick Mathewson
4d9b55907c Even more clarify on --version. 2018-12-20 11:50:40 -05:00
Nick Mathewson
508837b62b Document the output of --version
Closes 28889
2018-12-17 17:54:01 -05:00
Nick Mathewson
e969d9c6b4 Merge branch 'ticket28179_squashed' into ticket28179_squashed_merged 2018-12-17 16:41:01 -05:00
Alexander Færøy
ad4cc89c5d Add "PT" log domain.
See: https://bugs.torproject.org/28179
2018-12-17 16:39:28 -05:00
Nick Mathewson
69264f96f3 Merge branch 'dormant_persist_squashed' 2018-12-13 08:26:10 -05:00
David Goulet
53855d72b7 man: Add that "GETINFO address" won't work with "Sandbox 1"
Patch by "wagon".

Closes #28538

Signed-off-by: David Goulet <dgoulet@torproject.org>
2018-12-12 13:23:46 -05:00
Nick Mathewson
b915b6cd21 Merge remote-tracking branch 'github/prop297' 2018-12-11 09:44:57 -05:00
Nick Mathewson
4002a84ffe Merge remote-tracking branch 'tor-github/pr/561' 2018-12-05 08:29:41 -05:00
Nick Mathewson
df70bc3a88 Merge branch 'ticket28479_squashed' 2018-12-05 07:59:44 -05:00
Nick Mathewson
1f6d7bc4af Update ReleasingTor.md to reflect current practice
See #28479.
2018-12-05 07:58:53 -05:00
David Goulet
8506dcdeb7 Merge branch 'maint-0.3.5' 2018-12-04 12:55:02 -05:00
Nick Mathewson
4f55884315 Add an option to start tor in dormant mode for the first time. 2018-12-04 12:08:24 -05:00
David Goulet
0906dde9d5 man: Document HSv3 client authorization revocation
Removing a ".auth" file revokes a client access to the service but the
rendezvous circuit is not closed service side because the service simply
doesn't know which circuit is for which client.

This commit notes in the man page that to fully revoke a client access to the
service, the tor process should be restarted.

Closes #28275

Signed-off-by: David Goulet <dgoulet@torproject.org>
2018-12-04 18:49:19 +02:00
rl1987
894d207f84 manpage: Mention that adding new HS is unsupported if Sandbox is enabled 2018-12-03 15:23:01 +02:00
Nick Mathewson
8221b5d587 Merge remote-tracking branch 'tor-github/pr/559' 2018-12-02 19:38:40 -05:00
teor
90ce8d0a58
doc: remove cached-routers from the man page
cached-routers was removed from the code a long time ago
2018-12-03 10:22:49 +10:00
Nick Mathewson
2b2b97484a Merge branch 'ticket27490a_squashed' 2018-12-01 20:32:18 -05:00
Neel Chauhan
822cb93cab Add new option ClientAutoIPv6ORPort to switch between IPv4 and IPv6 OR ports 2018-12-01 14:55:57 -05:00
Alexander Færøy
2b41b857bd Add LD_PROCESS as log domain.
See: https://bugs.torproject.org/28179
2018-11-27 19:31:08 +01:00
Nick Mathewson
7d8e0cc9ab Merge branch 'dormant_v2_squashed' 2018-11-26 16:33:31 -05:00
Nick Mathewson
3743f79695 Add options to control dormant-client feature.
The DormantClientTimeout option controls how long Tor will wait before
going dormant.  It also provides a way to disable the feature by setting
DormantClientTimeout to e.g. "50 years".

The DormantTimeoutDisabledByIdleStreams option controls whether open but
inactive streams count as "client activity".  To implement it, I had to
make it so that reading or writing on a client stream *always* counts as
activity.

Closes ticket 28429.
2018-11-26 16:32:40 -05:00
David Goulet
2b9a907bdc Merge branch 'maint-0.3.5' 2018-11-26 14:59:24 -05:00
Nick Mathewson
b16d6453ad Rewrite updateVersions script in Python, add datestamp functionality.
This updateVersions.pl script was one of the only essential perl
scripts left in out maint system, and was the only one that used
autoconf to fill in the script.

This script adds a feature to define an APPROX_RELEASE_DATE macro
that is updated when the version changes.  We'll use this to
implement prop297, so that we have an accurate view of when a
release date happens.
2018-11-24 20:44:37 -05:00
Nick Mathewson
63312e0299 Merge branch 'maint-0.3.3' into maint-0.3.4 2018-11-15 16:47:25 -05:00
David Goulet
f41bec1290 man: ClientOnionAuthDir can't be reloaded with Sandbox 1
By adding a file to the ClientOnionAuthDir and sending a HUP signal, tor would
load the new file and use it. However, that doesn't work with the Sandbox
since post initilization, nothing can be changed.

Document in the manpage that limitation within the Sandbox description.

Closes #28128

Signed-off-by: David Goulet <dgoulet@torproject.org>
2018-11-15 14:36:39 -05:00
Nick Mathewson
586c3a7c90 Merge branch 'maint-0.3.5' 2018-11-14 07:42:56 -05:00
teor
c793cf338b
doc: Remove an outdated sentence from KeepalivePeriod in the man page 2018-11-14 18:05:56 +10:00
David Goulet
1c5c3f353a Merge branch 'maint-0.3.5' 2018-10-30 11:29:30 -04:00
Mike Tigas
d023de945a tweak manpage bits about v3 onion svc client auth
make a couple things more explicit, like not needing to set "HiddenServiceAuthorizeClient" & etc
2018-10-30 11:25:24 -04:00