1 /* Copyright (c) 2001 Matej Pfajfar.
2 * Copyright (c) 2001-2004, Roger Dingledine.
3 * Copyright (c) 2004-2006, Roger Dingledine, Nick Mathewson.
4 * Copyright (c) 2007-2009, The Tor Project, Inc. */
5 /* See LICENSE for licensing information */
9 * \brief Code to parse and interpret configuration files.
12 #define CONFIG_PRIVATE
19 /** Enumeration of types which option values can take */
20 typedef enum config_type_t
{
21 CONFIG_TYPE_STRING
= 0, /**< An arbitrary string. */
22 CONFIG_TYPE_FILENAME
, /**< A filename: some prefixes get expanded. */
23 CONFIG_TYPE_UINT
, /**< A non-negative integer less than MAX_INT */
24 CONFIG_TYPE_INTERVAL
, /**< A number of seconds, with optional units*/
25 CONFIG_TYPE_MEMUNIT
, /**< A number of bytes, with optional units*/
26 CONFIG_TYPE_DOUBLE
, /**< A floating-point value */
27 CONFIG_TYPE_BOOL
, /**< A boolean value, expressed as 0 or 1. */
28 CONFIG_TYPE_ISOTIME
, /**< An ISO-formatted time relative to GMT. */
29 CONFIG_TYPE_CSV
, /**< A list of strings, separated by commas and
30 * optional whitespace. */
31 CONFIG_TYPE_LINELIST
, /**< Uninterpreted config lines */
32 CONFIG_TYPE_LINELIST_S
, /**< Uninterpreted, context-sensitive config lines,
33 * mixed with other keywords. */
34 CONFIG_TYPE_LINELIST_V
, /**< Catch-all "virtual" option to summarize
35 * context-sensitive config lines when fetching.
37 CONFIG_TYPE_ROUTERSET
, /**< A list of router names, addrs, and fps,
38 * parsed into a routerset_t. */
39 CONFIG_TYPE_OBSOLETE
, /**< Obsolete (ignored) option. */
42 /** An abbreviation for a configuration option allowed on the command line. */
43 typedef struct config_abbrev_t
{
44 const char *abbreviated
;
50 /* Handy macro for declaring "In the config file or on the command line,
51 * you can abbreviate <b>tok</b>s as <b>tok</b>". */
52 #define PLURAL(tok) { #tok, #tok "s", 0, 0 }
54 /** A list of abbreviations and aliases to map command-line options, obsolete
55 * option names, or alternative option names, to their current values. */
56 static config_abbrev_t _option_abbrevs
[] = {
61 PLURAL(LongLivedPort
),
62 PLURAL(HiddenServiceNode
),
63 PLURAL(HiddenServiceExcludeNode
),
66 PLURAL(RendExcludeNode
),
67 PLURAL(StrictEntryNode
),
68 PLURAL(StrictExitNode
),
70 { "AllowUnverifiedNodes", "AllowInvalidNodes", 0, 0},
71 { "AutomapHostSuffixes", "AutomapHostsSuffixes", 0, 0},
72 { "AutomapHostOnResolve", "AutomapHostsOnResolve", 0, 0},
73 { "BandwidthRateBytes", "BandwidthRate", 0, 0},
74 { "BandwidthBurstBytes", "BandwidthBurst", 0, 0},
75 { "DirFetchPostPeriod", "StatusFetchPeriod", 0, 0},
76 { "MaxConn", "ConnLimit", 0, 1},
77 { "ORBindAddress", "ORListenAddress", 0, 0},
78 { "DirBindAddress", "DirListenAddress", 0, 0},
79 { "SocksBindAddress", "SocksListenAddress", 0, 0},
80 { "UseHelperNodes", "UseEntryGuards", 0, 0},
81 { "NumHelperNodes", "NumEntryGuards", 0, 0},
82 { "UseEntryNodes", "UseEntryGuards", 0, 0},
83 { "NumEntryNodes", "NumEntryGuards", 0, 0},
84 { "ResolvConf", "ServerDNSResolvConfFile", 0, 1},
85 { "SearchDomains", "ServerDNSSearchDomains", 0, 1},
86 { "ServerDNSAllowBrokenResolvConf", "ServerDNSAllowBrokenConfig", 0, 0 },
87 { "PreferTunnelledDirConns", "PreferTunneledDirConns", 0, 0},
88 { "BridgeAuthoritativeDirectory", "BridgeAuthoritativeDir", 0, 0},
89 { "HashedControlPassword", "__HashedControlSessionPassword", 1, 0},
93 /** A list of state-file "abbreviations," for compatibility. */
94 static config_abbrev_t _state_abbrevs
[] = {
95 { "AccountingBytesReadInterval", "AccountingBytesReadInInterval", 0, 0 },
96 { "HelperNode", "EntryGuard", 0, 0 },
97 { "HelperNodeDownSince", "EntryGuardDownSince", 0, 0 },
98 { "HelperNodeUnlistedSince", "EntryGuardUnlistedSince", 0, 0 },
99 { "EntryNode", "EntryGuard", 0, 0 },
100 { "EntryNodeDownSince", "EntryGuardDownSince", 0, 0 },
101 { "EntryNodeUnlistedSince", "EntryGuardUnlistedSince", 0, 0 },
106 /** A variable allowed in the configuration file or on the command line. */
107 typedef struct config_var_t
{
108 const char *name
; /**< The full keyword (case insensitive). */
109 config_type_t type
; /**< How to interpret the type and turn it into a
111 off_t var_offset
; /**< Offset of the corresponding member of or_options_t. */
112 const char *initvalue
; /**< String (or null) describing initial value. */
115 /** An entry for config_vars: "The option <b>name</b> has type
116 * CONFIG_TYPE_<b>conftype</b>, and corresponds to
117 * or_options_t.<b>member</b>"
119 #define VAR(name,conftype,member,initvalue) \
120 { name, CONFIG_TYPE_ ## conftype, STRUCT_OFFSET(or_options_t, member), \
122 /** As VAR, but the option name and member name are the same. */
123 #define V(member,conftype,initvalue) \
124 VAR(#member, conftype, member, initvalue)
125 /** An entry for config_vars: "The option <b>name</b> is obsolete." */
126 #define OBSOLETE(name) { name, CONFIG_TYPE_OBSOLETE, 0, NULL }
128 /** Array of configuration options. Until we disallow nonstandard
129 * abbreviations, order is significant, since the first matching option will
132 static config_var_t _option_vars
[] = {
133 OBSOLETE("AccountingMaxKB"),
134 V(AccountingMax
, MEMUNIT
, "0 bytes"),
135 V(AccountingStart
, STRING
, NULL
),
136 V(Address
, STRING
, NULL
),
137 V(AllowDotExit
, BOOL
, "0"),
138 V(AllowInvalidNodes
, CSV
, "middle,rendezvous"),
139 V(AllowNonRFC953Hostnames
, BOOL
, "0"),
140 V(AllowSingleHopCircuits
, BOOL
, "0"),
141 V(AllowSingleHopExits
, BOOL
, "0"),
142 V(AlternateBridgeAuthority
, LINELIST
, NULL
),
143 V(AlternateDirAuthority
, LINELIST
, NULL
),
144 V(AlternateHSAuthority
, LINELIST
, NULL
),
145 V(AssumeReachable
, BOOL
, "0"),
146 V(AuthDirBadDir
, LINELIST
, NULL
),
147 V(AuthDirBadExit
, LINELIST
, NULL
),
148 V(AuthDirInvalid
, LINELIST
, NULL
),
149 V(AuthDirReject
, LINELIST
, NULL
),
150 V(AuthDirRejectUnlisted
, BOOL
, "0"),
151 V(AuthDirListBadDirs
, BOOL
, "0"),
152 V(AuthDirListBadExits
, BOOL
, "0"),
153 V(AuthDirMaxServersPerAddr
, UINT
, "2"),
154 V(AuthDirMaxServersPerAuthAddr
,UINT
, "5"),
155 VAR("AuthoritativeDirectory", BOOL
, AuthoritativeDir
, "0"),
156 V(AutomapHostsOnResolve
, BOOL
, "0"),
157 V(AutomapHostsSuffixes
, CSV
, ".onion,.exit"),
158 V(AvoidDiskWrites
, BOOL
, "0"),
159 V(BandwidthBurst
, MEMUNIT
, "10 MB"),
160 V(BandwidthRate
, MEMUNIT
, "5 MB"),
161 V(BridgeAuthoritativeDir
, BOOL
, "0"),
162 VAR("Bridge", LINELIST
, Bridges
, NULL
),
163 V(BridgePassword
, STRING
, NULL
),
164 V(BridgeRecordUsageByCountry
, BOOL
, "1"),
165 V(BridgeRelay
, BOOL
, "0"),
166 V(CellStatistics
, BOOL
, "0"),
167 V(CircuitBuildTimeout
, INTERVAL
, "1 minute"),
168 V(CircuitIdleTimeout
, INTERVAL
, "1 hour"),
169 V(ClientDNSRejectInternalAddresses
, BOOL
,"1"),
170 V(ClientOnly
, BOOL
, "0"),
171 V(ConnLimit
, UINT
, "1000"),
172 V(ConstrainedSockets
, BOOL
, "0"),
173 V(ConstrainedSockSize
, MEMUNIT
, "8192"),
174 V(ContactInfo
, STRING
, NULL
),
175 V(ControlListenAddress
, LINELIST
, NULL
),
176 V(ControlPort
, UINT
, "0"),
177 V(ControlSocket
, LINELIST
, NULL
),
178 V(CookieAuthentication
, BOOL
, "0"),
179 V(CookieAuthFileGroupReadable
, BOOL
, "0"),
180 V(CookieAuthFile
, STRING
, NULL
),
181 V(DataDirectory
, FILENAME
, NULL
),
182 OBSOLETE("DebugLogFile"),
183 V(DirAllowPrivateAddresses
, BOOL
, NULL
),
184 V(TestingAuthDirTimeToLearnReachability
, INTERVAL
, "30 minutes"),
185 V(DirListenAddress
, LINELIST
, NULL
),
186 OBSOLETE("DirFetchPeriod"),
187 V(DirPolicy
, LINELIST
, NULL
),
188 V(DirPort
, UINT
, "0"),
189 V(DirPortFrontPage
, FILENAME
, NULL
),
190 OBSOLETE("DirPostPeriod"),
191 OBSOLETE("DirRecordUsageByCountry"),
192 OBSOLETE("DirRecordUsageGranularity"),
193 OBSOLETE("DirRecordUsageRetainIPs"),
194 OBSOLETE("DirRecordUsageSaveInterval"),
195 V(DirReqStatistics
, BOOL
, "0"),
196 VAR("DirServer", LINELIST
, DirServers
, NULL
),
197 V(DNSPort
, UINT
, "0"),
198 V(DNSListenAddress
, LINELIST
, NULL
),
199 V(DownloadExtraInfo
, BOOL
, "0"),
200 V(EnforceDistinctSubnets
, BOOL
, "1"),
201 V(EntryNodes
, ROUTERSET
, NULL
),
202 V(EntryStatistics
, BOOL
, "0"),
203 V(TestingEstimatedDescriptorPropagationTime
, INTERVAL
, "10 minutes"),
204 V(ExcludeNodes
, ROUTERSET
, NULL
),
205 V(ExcludeExitNodes
, ROUTERSET
, NULL
),
206 V(ExcludeSingleHopRelays
, BOOL
, "1"),
207 V(ExitNodes
, ROUTERSET
, NULL
),
208 V(ExitPolicy
, LINELIST
, NULL
),
209 V(ExitPolicyRejectPrivate
, BOOL
, "1"),
210 V(ExitPortStatistics
, BOOL
, "0"),
211 V(FallbackNetworkstatusFile
, FILENAME
,
212 SHARE_DATADIR PATH_SEPARATOR
"tor" PATH_SEPARATOR
"fallback-consensus"),
213 V(FascistFirewall
, BOOL
, "0"),
214 V(FirewallPorts
, CSV
, ""),
215 V(FastFirstHopPK
, BOOL
, "1"),
216 V(FetchDirInfoEarly
, BOOL
, "0"),
217 V(FetchDirInfoExtraEarly
, BOOL
, "0"),
218 V(FetchServerDescriptors
, BOOL
, "1"),
219 V(FetchHidServDescriptors
, BOOL
, "1"),
220 V(FetchUselessDescriptors
, BOOL
, "0"),
222 V(GeoIPFile
, FILENAME
, "<default>"),
224 V(GeoIPFile
, FILENAME
,
225 SHARE_DATADIR PATH_SEPARATOR
"tor" PATH_SEPARATOR
"geoip"),
228 V(HardwareAccel
, BOOL
, "0"),
229 V(AccelName
, STRING
, NULL
),
230 V(AccelDir
, FILENAME
, NULL
),
231 V(HashedControlPassword
, LINELIST
, NULL
),
232 V(HidServDirectoryV2
, BOOL
, "1"),
233 VAR("HiddenServiceDir", LINELIST_S
, RendConfigLines
, NULL
),
234 OBSOLETE("HiddenServiceExcludeNodes"),
235 OBSOLETE("HiddenServiceNodes"),
236 VAR("HiddenServiceOptions",LINELIST_V
, RendConfigLines
, NULL
),
237 VAR("HiddenServicePort", LINELIST_S
, RendConfigLines
, NULL
),
238 VAR("HiddenServiceVersion",LINELIST_S
, RendConfigLines
, NULL
),
239 VAR("HiddenServiceAuthorizeClient",LINELIST_S
,RendConfigLines
, NULL
),
240 V(HidServAuth
, LINELIST
, NULL
),
241 V(HSAuthoritativeDir
, BOOL
, "0"),
242 V(HSAuthorityRecordStats
, BOOL
, "0"),
243 V(HttpProxy
, STRING
, NULL
),
244 V(HttpProxyAuthenticator
, STRING
, NULL
),
245 V(HttpsProxy
, STRING
, NULL
),
246 V(HttpsProxyAuthenticator
, STRING
, NULL
),
247 OBSOLETE("IgnoreVersion"),
248 V(KeepalivePeriod
, INTERVAL
, "5 minutes"),
249 VAR("Log", LINELIST
, Logs
, NULL
),
250 OBSOLETE("LinkPadding"),
251 OBSOLETE("LogLevel"),
253 V(LongLivedPorts
, CSV
,
254 "21,22,706,1863,5050,5190,5222,5223,6667,6697,8300"),
255 VAR("MapAddress", LINELIST
, AddressMap
, NULL
),
256 V(MaxAdvertisedBandwidth
, MEMUNIT
, "1 GB"),
257 V(MaxCircuitDirtiness
, INTERVAL
, "10 minutes"),
258 V(MaxOnionsPending
, UINT
, "100"),
259 OBSOLETE("MonthlyAccountingStart"),
260 V(MyFamily
, STRING
, NULL
),
261 V(NewCircuitPeriod
, INTERVAL
, "30 seconds"),
262 VAR("NamingAuthoritativeDirectory",BOOL
, NamingAuthoritativeDir
, "0"),
263 V(NatdListenAddress
, LINELIST
, NULL
),
264 V(NatdPort
, UINT
, "0"),
265 V(Nickname
, STRING
, NULL
),
266 V(NoPublish
, BOOL
, "0"),
267 VAR("NodeFamily", LINELIST
, NodeFamilies
, NULL
),
268 V(NumCpus
, UINT
, "1"),
269 V(NumEntryGuards
, UINT
, "3"),
270 V(ORListenAddress
, LINELIST
, NULL
),
271 V(ORPort
, UINT
, "0"),
272 V(OutboundBindAddress
, STRING
, NULL
),
273 OBSOLETE("PathlenCoinWeight"),
274 V(PidFile
, STRING
, NULL
),
275 V(TestingTorNetwork
, BOOL
, "0"),
276 V(PreferTunneledDirConns
, BOOL
, "1"),
277 V(ProtocolWarnings
, BOOL
, "0"),
278 V(PublishServerDescriptor
, CSV
, "1"),
279 V(PublishHidServDescriptors
, BOOL
, "1"),
280 V(ReachableAddresses
, LINELIST
, NULL
),
281 V(ReachableDirAddresses
, LINELIST
, NULL
),
282 V(ReachableORAddresses
, LINELIST
, NULL
),
283 V(RecommendedVersions
, LINELIST
, NULL
),
284 V(RecommendedClientVersions
, LINELIST
, NULL
),
285 V(RecommendedServerVersions
, LINELIST
, NULL
),
286 OBSOLETE("RedirectExit"),
287 V(RejectPlaintextPorts
, CSV
, ""),
288 V(RelayBandwidthBurst
, MEMUNIT
, "0"),
289 V(RelayBandwidthRate
, MEMUNIT
, "0"),
290 OBSOLETE("RendExcludeNodes"),
291 OBSOLETE("RendNodes"),
292 V(RendPostPeriod
, INTERVAL
, "1 hour"),
293 V(RephistTrackTime
, INTERVAL
, "24 hours"),
294 OBSOLETE("RouterFile"),
295 V(RunAsDaemon
, BOOL
, "0"),
296 V(RunTesting
, BOOL
, "0"),
297 V(SafeLogging
, BOOL
, "1"),
298 V(SafeSocks
, BOOL
, "0"),
299 V(ServerDNSAllowBrokenConfig
, BOOL
, "1"),
300 V(ServerDNSAllowNonRFC953Hostnames
, BOOL
,"0"),
301 V(ServerDNSDetectHijacking
, BOOL
, "1"),
302 V(ServerDNSRandomizeCase
, BOOL
, "1"),
303 V(ServerDNSResolvConfFile
, STRING
, NULL
),
304 V(ServerDNSSearchDomains
, BOOL
, "0"),
305 V(ServerDNSTestAddresses
, CSV
,
306 "www.google.com,www.mit.edu,www.yahoo.com,www.slashdot.org"),
307 V(ShutdownWaitLength
, INTERVAL
, "30 seconds"),
308 V(SocksListenAddress
, LINELIST
, NULL
),
309 V(SocksPolicy
, LINELIST
, NULL
),
310 V(SocksPort
, UINT
, "9050"),
311 V(SocksTimeout
, INTERVAL
, "2 minutes"),
312 OBSOLETE("StatusFetchPeriod"),
313 V(StrictEntryNodes
, BOOL
, "0"),
314 V(StrictExitNodes
, BOOL
, "0"),
316 V(TestSocks
, BOOL
, "0"),
318 V(TrackHostExits
, CSV
, NULL
),
319 V(TrackHostExitsExpire
, INTERVAL
, "30 minutes"),
320 OBSOLETE("TrafficShaping"),
321 V(TransListenAddress
, LINELIST
, NULL
),
322 V(TransPort
, UINT
, "0"),
323 V(TunnelDirConns
, BOOL
, "1"),
324 V(UpdateBridgesFromAuthority
, BOOL
, "0"),
325 V(UseBridges
, BOOL
, "0"),
326 V(UseEntryGuards
, BOOL
, "1"),
327 V(User
, STRING
, NULL
),
328 VAR("V1AuthoritativeDirectory",BOOL
, V1AuthoritativeDir
, "0"),
329 VAR("V2AuthoritativeDirectory",BOOL
, V2AuthoritativeDir
, "0"),
330 VAR("V3AuthoritativeDirectory",BOOL
, V3AuthoritativeDir
, "0"),
331 V(TestingV3AuthInitialVotingInterval
, INTERVAL
, "30 minutes"),
332 V(TestingV3AuthInitialVoteDelay
, INTERVAL
, "5 minutes"),
333 V(TestingV3AuthInitialDistDelay
, INTERVAL
, "5 minutes"),
334 V(V3AuthVotingInterval
, INTERVAL
, "1 hour"),
335 V(V3AuthVoteDelay
, INTERVAL
, "5 minutes"),
336 V(V3AuthDistDelay
, INTERVAL
, "5 minutes"),
337 V(V3AuthNIntervalsValid
, UINT
, "3"),
338 V(V3AuthUseLegacyKey
, BOOL
, "0"),
339 VAR("VersioningAuthoritativeDirectory",BOOL
,VersioningAuthoritativeDir
, "0"),
340 V(VirtualAddrNetwork
, STRING
, "127.192.0.0/10"),
341 V(WarnPlaintextPorts
, CSV
, "23,109,110,143"),
342 VAR("__ReloadTorrcOnSIGHUP", BOOL
, ReloadTorrcOnSIGHUP
, "1"),
343 VAR("__AllDirActionsPrivate", BOOL
, AllDirActionsPrivate
, "0"),
344 VAR("__DisablePredictedCircuits",BOOL
,DisablePredictedCircuits
, "0"),
345 VAR("__LeaveStreamsUnattached",BOOL
, LeaveStreamsUnattached
, "0"),
346 VAR("__HashedControlSessionPassword", LINELIST
, HashedControlSessionPassword
,
348 V(MinUptimeHidServDirectoryV2
, INTERVAL
, "24 hours"),
349 { NULL
, CONFIG_TYPE_OBSOLETE
, 0, NULL
}
352 /** Override default values with these if the user sets the TestingTorNetwork
354 static config_var_t testing_tor_network_defaults
[] = {
355 V(ServerDNSAllowBrokenConfig
, BOOL
, "1"),
356 V(DirAllowPrivateAddresses
, BOOL
, "1"),
357 V(EnforceDistinctSubnets
, BOOL
, "0"),
358 V(AssumeReachable
, BOOL
, "1"),
359 V(AuthDirMaxServersPerAddr
, UINT
, "0"),
360 V(AuthDirMaxServersPerAuthAddr
,UINT
, "0"),
361 V(ClientDNSRejectInternalAddresses
, BOOL
,"0"),
362 V(ExitPolicyRejectPrivate
, BOOL
, "0"),
363 V(V3AuthVotingInterval
, INTERVAL
, "5 minutes"),
364 V(V3AuthVoteDelay
, INTERVAL
, "20 seconds"),
365 V(V3AuthDistDelay
, INTERVAL
, "20 seconds"),
366 V(TestingV3AuthInitialVotingInterval
, INTERVAL
, "5 minutes"),
367 V(TestingV3AuthInitialVoteDelay
, INTERVAL
, "20 seconds"),
368 V(TestingV3AuthInitialDistDelay
, INTERVAL
, "20 seconds"),
369 V(TestingAuthDirTimeToLearnReachability
, INTERVAL
, "0 minutes"),
370 V(TestingEstimatedDescriptorPropagationTime
, INTERVAL
, "0 minutes"),
371 { NULL
, CONFIG_TYPE_OBSOLETE
, 0, NULL
}
375 #define VAR(name,conftype,member,initvalue) \
376 { name, CONFIG_TYPE_ ## conftype, STRUCT_OFFSET(or_state_t, member), \
379 /** Array of "state" variables saved to the ~/.tor/state file. */
380 static config_var_t _state_vars
[] = {
381 V(AccountingBytesReadInInterval
, MEMUNIT
, NULL
),
382 V(AccountingBytesWrittenInInterval
, MEMUNIT
, NULL
),
383 V(AccountingExpectedUsage
, MEMUNIT
, NULL
),
384 V(AccountingIntervalStart
, ISOTIME
, NULL
),
385 V(AccountingSecondsActive
, INTERVAL
, NULL
),
387 VAR("EntryGuard", LINELIST_S
, EntryGuards
, NULL
),
388 VAR("EntryGuardDownSince", LINELIST_S
, EntryGuards
, NULL
),
389 VAR("EntryGuardUnlistedSince", LINELIST_S
, EntryGuards
, NULL
),
390 VAR("EntryGuardAddedBy", LINELIST_S
, EntryGuards
, NULL
),
391 V(EntryGuards
, LINELIST_V
, NULL
),
393 V(BWHistoryReadEnds
, ISOTIME
, NULL
),
394 V(BWHistoryReadInterval
, UINT
, "900"),
395 V(BWHistoryReadValues
, CSV
, ""),
396 V(BWHistoryWriteEnds
, ISOTIME
, NULL
),
397 V(BWHistoryWriteInterval
, UINT
, "900"),
398 V(BWHistoryWriteValues
, CSV
, ""),
400 V(TorVersion
, STRING
, NULL
),
402 V(LastRotatedOnionKey
, ISOTIME
, NULL
),
403 V(LastWritten
, ISOTIME
, NULL
),
405 { NULL
, CONFIG_TYPE_OBSOLETE
, 0, NULL
}
412 /** Represents an English description of a configuration variable; used when
413 * generating configuration file comments. */
414 typedef struct config_var_description_t
{
416 const char *description
;
417 } config_var_description_t
;
419 /** Descriptions of the configuration options, to be displayed by online
421 /* XXXX022 did anybody want this? at all? If not, kill it.*/
422 static config_var_description_t options_description
[] = {
423 /* ==== general options */
424 { "AvoidDiskWrites", "If non-zero, try to write to disk less frequently than"
425 " we would otherwise." },
426 { "BandwidthRate", "A token bucket limits the average incoming bandwidth on "
427 "this node to the specified number of bytes per second." },
428 { "BandwidthBurst", "Limit the maximum token buffer size (also known as "
429 "burst) to the given number of bytes." },
430 { "ConnLimit", "Minimum number of simultaneous sockets we must have." },
431 { "ConstrainedSockets", "Shrink tx and rx buffers for sockets to avoid "
432 "system limits on vservers and related environments. See man page for "
433 "more information regarding this option." },
434 { "ConstrainedSockSize", "Limit socket buffers to this size when "
435 "ConstrainedSockets is enabled." },
436 /* ControlListenAddress */
437 { "ControlPort", "If set, Tor will accept connections from the same machine "
438 "(localhost only) on this port, and allow those connections to control "
439 "the Tor process using the Tor Control Protocol (described in "
440 "control-spec.txt).", },
441 { "CookieAuthentication", "If this option is set to 1, don't allow any "
442 "connections to the control port except when the connecting process "
443 "can read a file that Tor creates in its data directory." },
444 { "DataDirectory", "Store working data, state, keys, and caches here." },
445 { "DirServer", "Tor only trusts directories signed with one of these "
446 "servers' keys. Used to override the standard list of directory "
448 /* { "FastFirstHopPK", "" }, */
449 /* FetchServerDescriptors, FetchHidServDescriptors,
450 * FetchUselessDescriptors */
451 { "HardwareAccel", "If set, Tor tries to use hardware crypto accelerators "
453 { "AccelName", "If set, try to use hardware crypto accelerator with this "
455 { "AccelDir", "If set, look in this directory for the dynamic hardware "
456 "engine in addition to OpenSSL default path." },
457 /* HashedControlPassword */
458 { "HTTPProxy", "Force Tor to make all HTTP directory requests through this "
459 "host:port (or host:80 if port is not set)." },
460 { "HTTPProxyAuthenticator", "A username:password pair to be used with "
462 { "HTTPSProxy", "Force Tor to make all TLS (SSL) connections through this "
463 "host:port (or host:80 if port is not set)." },
464 { "HTTPSProxyAuthenticator", "A username:password pair to be used with "
466 { "KeepalivePeriod", "Send a padding cell every N seconds to keep firewalls "
467 "from closing our connections while Tor is not in use." },
468 { "Log", "Where to send logging messages. Format is "
469 "minSeverity[-maxSeverity] (stderr|stdout|syslog|file FILENAME)." },
470 { "OutboundBindAddress", "Make all outbound connections originate from the "
471 "provided IP address (only useful for multiple network interfaces)." },
472 { "PIDFile", "On startup, write our PID to this file. On clean shutdown, "
473 "remove the file." },
474 { "PreferTunneledDirConns", "If non-zero, avoid directory servers that "
475 "don't support tunneled connections." },
476 /* PreferTunneledDirConns */
477 /* ProtocolWarnings */
478 /* RephistTrackTime */
479 { "RunAsDaemon", "If set, Tor forks and daemonizes to the background when "
480 "started. Unix only." },
481 { "SafeLogging", "If set to 0, Tor logs potentially sensitive strings "
482 "rather than replacing them with the string [scrubbed]." },
483 { "TunnelDirConns", "If non-zero, when a directory server we contact "
484 "supports it, we will build a one-hop circuit and make an encrypted "
485 "connection via its ORPort." },
486 { "User", "On startup, setuid to this user." },
488 /* ==== client options */
489 { "AllowInvalidNodes", "Where on our circuits should Tor allow servers "
490 "that the directory authorities haven't called \"valid\"?" },
491 { "AllowNonRFC953Hostnames", "If set to 1, we don't automatically reject "
492 "hostnames for having invalid characters." },
493 /* CircuitBuildTimeout, CircuitIdleTimeout */
494 { "ClientOnly", "If set to 1, Tor will under no circumstances run as a "
495 "server, even if ORPort is enabled." },
496 { "EntryNodes", "A list of preferred entry nodes to use for the first hop "
497 "in circuits, when possible." },
498 /* { "EnforceDistinctSubnets" , "" }, */
499 { "ExitNodes", "A list of preferred nodes to use for the last hop in "
500 "circuits, when possible." },
501 { "ExcludeNodes", "A list of nodes never to use when building a circuit." },
502 { "FascistFirewall", "If set, Tor will only create outgoing connections to "
503 "servers running on the ports listed in FirewallPorts." },
504 { "FirewallPorts", "A list of ports that we can connect to. Only used "
505 "when FascistFirewall is set." },
506 { "LongLivedPorts", "A list of ports for services that tend to require "
507 "high-uptime connections." },
508 { "MapAddress", "Force Tor to treat all requests for one address as if "
509 "they were for another." },
510 { "NewCircuitPeriod", "Force Tor to consider whether to build a new circuit "
511 "every NUM seconds." },
512 { "MaxCircuitDirtiness", "Do not attach new streams to a circuit that has "
513 "been used more than this many seconds ago." },
514 /* NatdPort, NatdListenAddress */
515 { "NodeFamily", "A list of servers that constitute a 'family' and should "
516 "never be used in the same circuit." },
517 { "NumEntryGuards", "How many entry guards should we keep at a time?" },
518 /* PathlenCoinWeight */
519 { "ReachableAddresses", "Addresses we can connect to, as IP/bits:port-port. "
520 "By default, we assume all addresses are reachable." },
521 /* reachablediraddresses, reachableoraddresses. */
523 { "SOCKSPort", "The port where we listen for SOCKS connections from "
525 { "SOCKSListenAddress", "Bind to this address to listen to connections from "
526 "SOCKS-speaking applications." },
527 { "SOCKSPolicy", "Set an entry policy to limit which addresses can connect "
528 "to the SOCKSPort." },
530 { "StrictExitNodes", "If set, Tor will fail to operate when none of the "
531 "configured ExitNodes can be used." },
532 { "StrictEntryNodes", "If set, Tor will fail to operate when none of the "
533 "configured EntryNodes can be used." },
535 { "TrackHostsExit", "Hosts and domains which should, if possible, be "
536 "accessed from the same exit node each time we connect to them." },
537 { "TrackHostsExitExpire", "Time after which we forget which exit we were "
538 "using to connect to hosts in TrackHostsExit." },
539 /* "TransPort", "TransListenAddress */
540 { "UseEntryGuards", "Set to 0 if we want to pick from the whole set of "
541 "servers for the first position in each circuit, rather than picking a "
542 "set of 'Guards' to prevent profiling attacks." },
544 /* === server options */
545 { "Address", "The advertised (external) address we should use." },
546 /* Accounting* options. */
547 /* AssumeReachable */
548 { "ContactInfo", "Administrative contact information to advertise for this "
550 { "ExitPolicy", "Address/port ranges for which to accept or reject outgoing "
551 "connections on behalf of Tor users." },
552 /* { "ExitPolicyRejectPrivate, "" }, */
553 { "MaxAdvertisedBandwidth", "If set, we will not advertise more than this "
554 "amount of bandwidth for our bandwidth rate, regardless of how much "
555 "bandwidth we actually detect." },
556 { "MaxOnionsPending", "Reject new attempts to extend circuits when we "
557 "already have this many pending." },
558 { "MyFamily", "Declare a list of other servers as belonging to the same "
559 "family as this one, so that clients will not use two from the same "
560 "family in the same circuit." },
561 { "Nickname", "Set the server nickname." },
562 { "NoPublish", "{DEPRECATED}" },
563 { "NumCPUs", "How many processes to use at once for public-key crypto." },
564 { "ORPort", "Advertise this port to listen for connections from Tor clients "
566 { "ORListenAddress", "Bind to this address to listen for connections from "
567 "clients and servers, instead of the default 0.0.0.0:ORPort." },
568 { "PublishServerDescriptor", "Set to 0 to keep the server from "
569 "uploading info to the directory authorities." },
570 /* ServerDNS: DetectHijacking, ResolvConfFile, SearchDomains */
571 { "ShutdownWaitLength", "Wait this long for clients to finish when "
572 "shutting down because of a SIGINT." },
574 /* === directory cache options */
575 { "DirPort", "Serve directory information from this port, and act as a "
576 "directory cache." },
577 { "DirPortFrontPage", "Serve a static html disclaimer on DirPort." },
578 { "DirListenAddress", "Bind to this address to listen for connections from "
579 "clients and servers, instead of the default 0.0.0.0:DirPort." },
580 { "DirPolicy", "Set a policy to limit who can connect to the directory "
583 /* Authority options: AuthDirBadExit, AuthDirInvalid, AuthDirReject,
584 * AuthDirRejectUnlisted, AuthDirListBadExits, AuthoritativeDirectory,
585 * DirAllowPrivateAddresses, HSAuthoritativeDir,
586 * NamingAuthoritativeDirectory, RecommendedVersions,
587 * RecommendedClientVersions, RecommendedServerVersions, RendPostPeriod,
588 * RunTesting, V1AuthoritativeDirectory, VersioningAuthoritativeDirectory, */
590 /* Hidden service options: HiddenService: dir,excludenodes, nodes,
591 * options, port. PublishHidServDescriptor */
593 /* Nonpersistent options: __LeaveStreamsUnattached, __AllDirActionsPrivate */
597 /** Online description of state variables. */
598 static config_var_description_t state_description
[] = {
599 { "AccountingBytesReadInInterval",
600 "How many bytes have we read in this accounting period?" },
601 { "AccountingBytesWrittenInInterval",
602 "How many bytes have we written in this accounting period?" },
603 { "AccountingExpectedUsage",
604 "How many bytes did we expect to use per minute? (0 for no estimate.)" },
605 { "AccountingIntervalStart", "When did this accounting period begin?" },
606 { "AccountingSecondsActive", "How long have we been awake in this period?" },
608 { "BWHistoryReadEnds", "When does the last-recorded read-interval end?" },
609 { "BWHistoryReadInterval", "How long is each read-interval (in seconds)?" },
610 { "BWHistoryReadValues", "Number of bytes read in each interval." },
611 { "BWHistoryWriteEnds", "When does the last-recorded write-interval end?" },
612 { "BWHistoryWriteInterval", "How long is each write-interval (in seconds)?"},
613 { "BWHistoryWriteValues", "Number of bytes written in each interval." },
615 { "EntryGuard", "One of the nodes we have chosen as a fixed entry" },
616 { "EntryGuardDownSince",
617 "The last entry guard has been unreachable since this time." },
618 { "EntryGuardUnlistedSince",
619 "The last entry guard has been unusable since this time." },
621 { "LastRotatedOnionKey",
622 "The last time at which we changed the medium-term private key used for "
623 "building circuits." },
624 { "LastWritten", "When was this state file last regenerated?" },
626 { "TorVersion", "Which version of Tor generated this state file?" },
630 /** Type of a callback to validate whether a given configuration is
631 * well-formed and consistent. See options_trial_assign() for documentation
633 typedef int (*validate_fn_t
)(void*,void*,int,char**);
635 /** Information on the keys, value types, key-to-struct-member mappings,
636 * variable descriptions, validation functions, and abbreviations for a
637 * configuration or storage format. */
639 size_t size
; /**< Size of the struct that everything gets parsed into. */
640 uint32_t magic
; /**< Required 'magic value' to make sure we have a struct
641 * of the right type. */
642 off_t magic_offset
; /**< Offset of the magic value within the struct. */
643 config_abbrev_t
*abbrevs
; /**< List of abbreviations that we expand when
644 * parsing this format. */
645 config_var_t
*vars
; /**< List of variables we recognize, their default
646 * values, and where we stick them in the structure. */
647 validate_fn_t validate_fn
; /**< Function to validate config. */
648 /** Documentation for configuration variables. */
649 config_var_description_t
*descriptions
;
650 /** If present, extra is a LINELIST variable for unrecognized
651 * lines. Otherwise, unrecognized lines are an error. */
655 /** Macro: assert that <b>cfg</b> has the right magic field for format
657 #define CHECK(fmt, cfg) STMT_BEGIN \
658 tor_assert(fmt && cfg); \
659 tor_assert((fmt)->magic == \
660 *(uint32_t*)STRUCT_VAR_P(cfg,fmt->magic_offset)); \
664 static char *get_windows_conf_root(void);
666 static void config_line_append(config_line_t
**lst
,
667 const char *key
, const char *val
);
668 static void option_clear(config_format_t
*fmt
, or_options_t
*options
,
670 static void option_reset(config_format_t
*fmt
, or_options_t
*options
,
671 config_var_t
*var
, int use_defaults
);
672 static void config_free(config_format_t
*fmt
, void *options
);
673 static int config_lines_eq(config_line_t
*a
, config_line_t
*b
);
674 static int option_is_same(config_format_t
*fmt
,
675 or_options_t
*o1
, or_options_t
*o2
,
677 static or_options_t
*options_dup(config_format_t
*fmt
, or_options_t
*old
);
678 static int options_validate(or_options_t
*old_options
, or_options_t
*options
,
679 int from_setconf
, char **msg
);
680 static int options_act_reversible(or_options_t
*old_options
, char **msg
);
681 static int options_act(or_options_t
*old_options
);
682 static int options_transition_allowed(or_options_t
*old
, or_options_t
*new,
684 static int options_transition_affects_workers(or_options_t
*old_options
,
685 or_options_t
*new_options
);
686 static int options_transition_affects_descriptor(or_options_t
*old_options
,
687 or_options_t
*new_options
);
688 static int check_nickname_list(const char *lst
, const char *name
, char **msg
);
689 static void config_register_addressmaps(or_options_t
*options
);
691 static int parse_bridge_line(const char *line
, int validate_only
);
692 static int parse_dir_server_line(const char *line
,
693 authority_type_t required_type
,
695 static int validate_data_directory(or_options_t
*options
);
696 static int write_configuration_file(const char *fname
, or_options_t
*options
);
697 static config_line_t
*get_assigned_option(config_format_t
*fmt
,
698 void *options
, const char *key
,
700 static void config_init(config_format_t
*fmt
, void *options
);
701 static int or_state_validate(or_state_t
*old_options
, or_state_t
*options
,
702 int from_setconf
, char **msg
);
703 static int or_state_load(void);
704 static int options_init_logs(or_options_t
*options
, int validate_only
);
706 static int is_listening_on_low_port(uint16_t port_option
,
707 const config_line_t
*listen_options
);
709 static uint64_t config_parse_memunit(const char *s
, int *ok
);
710 static int config_parse_interval(const char *s
, int *ok
);
711 static void init_libevent(void);
712 static int opt_streq(const char *s1
, const char *s2
);
714 /** Magic value for or_options_t. */
715 #define OR_OPTIONS_MAGIC 9090909
717 /** Configuration format for or_options_t. */
718 static config_format_t options_format
= {
719 sizeof(or_options_t
),
721 STRUCT_OFFSET(or_options_t
, _magic
),
724 (validate_fn_t
)options_validate
,
729 /** Magic value for or_state_t. */
730 #define OR_STATE_MAGIC 0x57A73f57
732 /** "Extra" variable in the state that receives lines we can't parse. This
733 * lets us preserve options from versions of Tor newer than us. */
734 static config_var_t state_extra_var
= {
735 "__extra", CONFIG_TYPE_LINELIST
, STRUCT_OFFSET(or_state_t
, ExtraLines
), NULL
738 /** Configuration format for or_state_t. */
739 static config_format_t state_format
= {
742 STRUCT_OFFSET(or_state_t
, _magic
),
745 (validate_fn_t
)or_state_validate
,
751 * Functions to read and write the global options pointer.
754 /** Command-line and config-file options. */
755 static or_options_t
*global_options
= NULL
;
756 /** Name of most recently read torrc file. */
757 static char *torrc_fname
= NULL
;
758 /** Persistent serialized state. */
759 static or_state_t
*global_state
= NULL
;
760 /** Configuration Options set by command line. */
761 static config_line_t
*global_cmdline_options
= NULL
;
762 /** Contents of most recently read DirPortFrontPage file. */
763 static char *global_dirfrontpagecontents
= NULL
;
765 /** Return the contents of our frontpage string, or NULL if not configured. */
767 get_dirportfrontpage(void)
769 return global_dirfrontpagecontents
;
772 /** Allocate an empty configuration object of a given format type. */
774 config_alloc(config_format_t
*fmt
)
776 void *opts
= tor_malloc_zero(fmt
->size
);
777 *(uint32_t*)STRUCT_VAR_P(opts
, fmt
->magic_offset
) = fmt
->magic
;
782 /** Return the currently configured options. */
786 tor_assert(global_options
);
787 return global_options
;
790 /** Change the current global options to contain <b>new_val</b> instead of
791 * their current value; take action based on the new value; free the old value
792 * as necessary. Returns 0 on success, -1 on failure.
795 set_options(or_options_t
*new_val
, char **msg
)
797 or_options_t
*old_options
= global_options
;
798 global_options
= new_val
;
799 /* Note that we pass the *old* options below, for comparison. It
800 * pulls the new options directly out of global_options. */
801 if (options_act_reversible(old_options
, msg
)<0) {
803 global_options
= old_options
;
806 if (options_act(old_options
) < 0) { /* acting on the options failed. die. */
808 "Acting on config options left us in a broken state. Dying.");
812 config_free(&options_format
, old_options
);
817 extern const char tor_svn_revision
[]; /* from tor_main.c */
819 /** The version of this Tor process, as parsed. */
820 static char *_version
= NULL
;
822 /** Return the current Tor version. */
826 if (_version
== NULL
) {
827 if (strlen(tor_svn_revision
)) {
828 size_t len
= strlen(VERSION
)+strlen(tor_svn_revision
)+8;
829 _version
= tor_malloc(len
);
830 tor_snprintf(_version
, len
, "%s (r%s)", VERSION
, tor_svn_revision
);
832 _version
= tor_strdup(VERSION
);
838 /** Release additional memory allocated in options
841 or_options_free(or_options_t
*options
)
843 if (options
->_ExcludeExitNodesUnion
)
844 routerset_free(options
->_ExcludeExitNodesUnion
);
845 config_free(&options_format
, options
);
848 /** Release all memory and resources held by global configuration structures.
851 config_free_all(void)
853 if (global_options
) {
854 or_options_free(global_options
);
855 global_options
= NULL
;
858 config_free(&state_format
, global_state
);
861 if (global_cmdline_options
) {
862 config_free_lines(global_cmdline_options
);
863 global_cmdline_options
= NULL
;
865 tor_free(torrc_fname
);
867 tor_free(global_dirfrontpagecontents
);
870 /** If options->SafeLogging is on, return a not very useful string,
871 * else return address.
874 safe_str(const char *address
)
877 if (get_options()->SafeLogging
)
883 /** Equivalent to escaped(safe_str(address)). See reentrancy note on
884 * escaped(): don't use this outside the main thread, or twice in the same
887 escaped_safe_str(const char *address
)
889 if (get_options()->SafeLogging
)
892 return escaped(address
);
895 /** Add the default directory authorities directly into the trusted dir list,
896 * but only add them insofar as they share bits with <b>type</b>. */
898 add_default_trusted_dir_authorities(authority_type_t type
)
901 const char *dirservers
[] = {
902 "moria1 v1 orport=9001 v3ident=E2A2AF570166665D738736D0DD58169CC61D8A8B "
903 "128.31.0.34:9031 FFCB 46DB 1339 DA84 674C 70D7 CB58 6434 C437 0441",
904 "moria2 v1 orport=9002 128.31.0.34:9032 "
905 "719B E45D E224 B607 C537 07D0 E214 3E2D 423E 74CF",
906 "tor26 v1 orport=443 v3ident=14C131DFC5C6F93646BE72FA1401C02A8DF2E8B4 "
907 "86.59.21.38:80 847B 1F85 0344 D787 6491 A548 92F9 0493 4E4E B85D",
908 "dizum orport=443 v3ident=E8A9C45EDE6D711294FADF8E7951F4DE6CA56B58 "
909 "194.109.206.212:80 7EA6 EAD6 FD83 083C 538F 4403 8BBF A077 587D D755",
910 "Tonga orport=443 bridge no-v2 82.94.251.206:80 "
911 "4A0C CD2D DC79 9508 3D73 F5D6 6710 0C8A 5831 F16D",
912 "ides orport=9090 no-v2 v3ident=27B6B5996C426270A5C95488AA5BCEB6BCC86956 "
913 "216.224.124.114:9030 F397 038A DC51 3361 35E7 B80B D99C A384 4360 292B",
914 "gabelmoo orport=443 no-v2 "
915 "v3ident=81349FC1F2DBA2C2C11B45CB9706637D480AB913 "
916 "80.190.246.100:80 6833 3D07 61BC F397 A587 A0C0 B963 E4A9 E99E C4D3",
917 "dannenberg orport=443 no-v2 "
918 "v3ident=585769C78764D58426B8B52B6651A5A71137189A "
919 "213.73.91.31:80 7BE6 83E6 5D48 1413 21C5 ED92 F075 C553 64AC 7123",
920 "urras orport=80 no-v2 v3ident=80550987E1D626E3EBA5E5E75A458DE0626D088C "
921 "208.83.223.34:443 0AD3 FA88 4D18 F89E EA2D 89C0 1937 9E0E 7FD9 4417",
924 for (i
=0; dirservers
[i
]; i
++) {
925 if (parse_dir_server_line(dirservers
[i
], type
, 0)<0) {
926 log_err(LD_BUG
, "Couldn't parse internal dirserver line %s",
932 /** Look at all the config options for using alternate directory
933 * authorities, and make sure none of them are broken. Also, warn the
934 * user if we changed any dangerous ones.
937 validate_dir_authorities(or_options_t
*options
, or_options_t
*old_options
)
941 if (options
->DirServers
&&
942 (options
->AlternateDirAuthority
|| options
->AlternateBridgeAuthority
||
943 options
->AlternateHSAuthority
)) {
945 "You cannot set both DirServers and Alternate*Authority.");
949 /* do we want to complain to the user about being partitionable? */
950 if ((options
->DirServers
&&
952 !config_lines_eq(options
->DirServers
, old_options
->DirServers
))) ||
953 (options
->AlternateDirAuthority
&&
955 !config_lines_eq(options
->AlternateDirAuthority
,
956 old_options
->AlternateDirAuthority
)))) {
958 "You have used DirServer or AlternateDirAuthority to "
959 "specify alternate directory authorities in "
960 "your configuration. This is potentially dangerous: it can "
961 "make you look different from all other Tor users, and hurt "
962 "your anonymity. Even if you've specified the same "
963 "authorities as Tor uses by default, the defaults could "
964 "change in the future. Be sure you know what you're doing.");
967 /* Now go through the four ways you can configure an alternate
968 * set of directory authorities, and make sure none are broken. */
969 for (cl
= options
->DirServers
; cl
; cl
= cl
->next
)
970 if (parse_dir_server_line(cl
->value
, NO_AUTHORITY
, 1)<0)
972 for (cl
= options
->AlternateBridgeAuthority
; cl
; cl
= cl
->next
)
973 if (parse_dir_server_line(cl
->value
, NO_AUTHORITY
, 1)<0)
975 for (cl
= options
->AlternateDirAuthority
; cl
; cl
= cl
->next
)
976 if (parse_dir_server_line(cl
->value
, NO_AUTHORITY
, 1)<0)
978 for (cl
= options
->AlternateHSAuthority
; cl
; cl
= cl
->next
)
979 if (parse_dir_server_line(cl
->value
, NO_AUTHORITY
, 1)<0)
984 /** Look at all the config options and assign new dir authorities
988 consider_adding_dir_authorities(or_options_t
*options
,
989 or_options_t
*old_options
)
993 !smartlist_len(router_get_trusted_dir_servers()) || !old_options
||
994 !config_lines_eq(options
->DirServers
, old_options
->DirServers
) ||
995 !config_lines_eq(options
->AlternateBridgeAuthority
,
996 old_options
->AlternateBridgeAuthority
) ||
997 !config_lines_eq(options
->AlternateDirAuthority
,
998 old_options
->AlternateDirAuthority
) ||
999 !config_lines_eq(options
->AlternateHSAuthority
,
1000 old_options
->AlternateHSAuthority
);
1002 if (!need_to_update
)
1003 return 0; /* all done */
1005 /* Start from a clean slate. */
1006 clear_trusted_dir_servers();
1008 if (!options
->DirServers
) {
1009 /* then we may want some of the defaults */
1010 authority_type_t type
= NO_AUTHORITY
;
1011 if (!options
->AlternateBridgeAuthority
)
1012 type
|= BRIDGE_AUTHORITY
;
1013 if (!options
->AlternateDirAuthority
)
1014 type
|= V1_AUTHORITY
| V2_AUTHORITY
| V3_AUTHORITY
;
1015 if (!options
->AlternateHSAuthority
)
1016 type
|= HIDSERV_AUTHORITY
;
1017 add_default_trusted_dir_authorities(type
);
1020 for (cl
= options
->DirServers
; cl
; cl
= cl
->next
)
1021 if (parse_dir_server_line(cl
->value
, NO_AUTHORITY
, 0)<0)
1023 for (cl
= options
->AlternateBridgeAuthority
; cl
; cl
= cl
->next
)
1024 if (parse_dir_server_line(cl
->value
, NO_AUTHORITY
, 0)<0)
1026 for (cl
= options
->AlternateDirAuthority
; cl
; cl
= cl
->next
)
1027 if (parse_dir_server_line(cl
->value
, NO_AUTHORITY
, 0)<0)
1029 for (cl
= options
->AlternateHSAuthority
; cl
; cl
= cl
->next
)
1030 if (parse_dir_server_line(cl
->value
, NO_AUTHORITY
, 0)<0)
1035 /** Fetch the active option list, and take actions based on it. All of the
1036 * things we do should survive being done repeatedly. If present,
1037 * <b>old_options</b> contains the previous value of the options.
1039 * Return 0 if all goes well, return -1 if things went badly.
1042 options_act_reversible(or_options_t
*old_options
, char **msg
)
1044 smartlist_t
*new_listeners
= smartlist_create();
1045 smartlist_t
*replaced_listeners
= smartlist_create();
1046 static int libevent_initialized
= 0;
1047 or_options_t
*options
= get_options();
1048 int running_tor
= options
->command
== CMD_RUN_TOR
;
1049 int set_conn_limit
= 0;
1051 int logs_marked
= 0;
1053 /* Daemonize _first_, since we only want to open most of this stuff in
1054 * the subprocess. Libevent bases can't be reliably inherited across
1056 if (running_tor
&& options
->RunAsDaemon
) {
1057 /* No need to roll back, since you can't change the value. */
1061 #ifndef HAVE_SYS_UN_H
1062 if (options
->ControlSocket
) {
1063 *msg
= tor_strdup("Unix domain sockets (ControlSocket) not supported"
1064 " on this OS/with this build.");
1070 /* We need to set the connection limit before we can open the listeners. */
1071 if (set_max_file_descriptors((unsigned)options
->ConnLimit
,
1072 &options
->_ConnLimit
) < 0) {
1073 *msg
= tor_strdup("Problem with ConnLimit value. See logs for details.");
1078 /* Set up libevent. (We need to do this before we can register the
1079 * listeners as listeners.) */
1080 if (running_tor
&& !libevent_initialized
) {
1082 libevent_initialized
= 1;
1085 /* Launch the listeners. (We do this before we setuid, so we can bind to
1086 * ports under 1024.) */
1087 if (retry_all_listeners(replaced_listeners
, new_listeners
) < 0) {
1088 *msg
= tor_strdup("Failed to bind one of the listener ports.");
1093 #if defined(HAVE_NET_IF_H) && defined(HAVE_NET_PFVAR_H)
1094 /* Open /dev/pf before dropping privileges. */
1095 if (options
->TransPort
) {
1096 if (get_pf_socket() < 0) {
1097 *msg
= tor_strdup("Unable to open /dev/pf for transparent proxy.");
1103 /* Setuid/setgid as appropriate */
1104 if (options
->User
) {
1105 if (switch_id(options
->User
) != 0) {
1106 /* No need to roll back, since you can't change the value. */
1107 *msg
= tor_strdup("Problem with User value. See logs for details.");
1112 /* Ensure data directory is private; create if possible. */
1113 if (check_private_dir(options
->DataDirectory
,
1114 running_tor
? CPD_CREATE
: CPD_CHECK
)<0) {
1116 int tmp
= tor_snprintf(buf
, sizeof(buf
),
1117 "Couldn't access/create private data directory \"%s\"",
1118 options
->DataDirectory
);
1119 *msg
= tor_strdup(tmp
>= 0 ? buf
: "internal error");
1121 /* No need to roll back, since you can't change the value. */
1124 if (directory_caches_v2_dir_info(options
)) {
1125 size_t len
= strlen(options
->DataDirectory
)+32;
1126 char *fn
= tor_malloc(len
);
1127 tor_snprintf(fn
, len
, "%s"PATH_SEPARATOR
"cached-status",
1128 options
->DataDirectory
);
1129 if (check_private_dir(fn
, running_tor
? CPD_CREATE
: CPD_CHECK
) < 0) {
1131 int tmp
= tor_snprintf(buf
, sizeof(buf
),
1132 "Couldn't access/create private data directory \"%s\"", fn
);
1133 *msg
= tor_strdup(tmp
>= 0 ? buf
: "internal error");
1140 /* Bail out at this point if we're not going to be a client or server:
1141 * we don't run Tor itself. */
1145 mark_logs_temp(); /* Close current logs once new logs are open. */
1147 if (options_init_logs(options
, 0)<0) { /* Configure the log(s) */
1148 *msg
= tor_strdup("Failed to init Log options. See logs for details.");
1155 log_severity_list_t
*severity
=
1156 tor_malloc_zero(sizeof(log_severity_list_t
));
1158 add_callback_log(severity
, control_event_logmsg
);
1159 control_adjust_event_log_severity();
1162 SMARTLIST_FOREACH(replaced_listeners
, connection_t
*, conn
,
1164 log_notice(LD_NET
, "Closing old %s on %s:%d",
1165 conn_type_to_string(conn
->type
), conn
->address
, conn
->port
);
1166 connection_close_immediate(conn
);
1167 connection_mark_for_close(conn
);
1176 rollback_log_changes();
1177 control_adjust_event_log_severity();
1180 if (set_conn_limit
&& old_options
)
1181 set_max_file_descriptors((unsigned)old_options
->ConnLimit
,
1182 &options
->_ConnLimit
);
1184 SMARTLIST_FOREACH(new_listeners
, connection_t
*, conn
,
1186 log_notice(LD_NET
, "Closing partially-constructed listener %s on %s:%d",
1187 conn_type_to_string(conn
->type
), conn
->address
, conn
->port
);
1188 connection_close_immediate(conn
);
1189 connection_mark_for_close(conn
);
1193 smartlist_free(new_listeners
);
1194 smartlist_free(replaced_listeners
);
1198 /** If we need to have a GEOIP ip-to-country map to run with our configured
1199 * options, return 1 and set *<b>reason_out</b> to a description of why. */
1201 options_need_geoip_info(or_options_t
*options
, const char **reason_out
)
1204 options
->BridgeRelay
&& options
->BridgeRecordUsageByCountry
;
1205 int routerset_usage
=
1206 routerset_needs_geoip(options
->EntryNodes
) ||
1207 routerset_needs_geoip(options
->ExitNodes
) ||
1208 routerset_needs_geoip(options
->ExcludeExitNodes
) ||
1209 routerset_needs_geoip(options
->ExcludeNodes
);
1211 if (routerset_usage
&& reason_out
) {
1212 *reason_out
= "We've been configured to use (or avoid) nodes in certain "
1213 "countries, and we need GEOIP information to figure out which ones they "
1215 } else if (bridge_usage
&& reason_out
) {
1216 *reason_out
= "We've been configured to see which countries can access "
1217 "us as a bridge, and we need GEOIP information to tell which countries "
1220 return bridge_usage
|| routerset_usage
;
1223 /** Return the bandwidthrate that we are going to report to the authorities
1224 * based on the config options. */
1226 get_effective_bwrate(or_options_t
*options
)
1228 uint64_t bw
= options
->BandwidthRate
;
1229 if (bw
> options
->MaxAdvertisedBandwidth
)
1230 bw
= options
->MaxAdvertisedBandwidth
;
1231 if (options
->RelayBandwidthRate
> 0 && bw
> options
->RelayBandwidthRate
)
1232 bw
= options
->RelayBandwidthRate
;
1233 /* ensure_bandwidth_cap() makes sure that this cast can't overflow. */
1234 return (uint32_t)bw
;
1237 /** Return the bandwidthburst that we are going to report to the authorities
1238 * based on the config options. */
1240 get_effective_bwburst(or_options_t
*options
)
1242 uint64_t bw
= options
->BandwidthBurst
;
1243 if (options
->RelayBandwidthBurst
> 0 && bw
> options
->RelayBandwidthBurst
)
1244 bw
= options
->RelayBandwidthBurst
;
1245 /* ensure_bandwidth_cap() makes sure that this cast can't overflow. */
1246 return (uint32_t)bw
;
1249 /** Fetch the active option list, and take actions based on it. All of the
1250 * things we do should survive being done repeatedly. If present,
1251 * <b>old_options</b> contains the previous value of the options.
1253 * Return 0 if all goes well, return -1 if it's time to die.
1255 * Note: We haven't moved all the "act on new configuration" logic
1256 * here yet. Some is still in do_hup() and other places.
1259 options_act(or_options_t
*old_options
)
1262 or_options_t
*options
= get_options();
1263 int running_tor
= options
->command
== CMD_RUN_TOR
;
1266 if (running_tor
&& !have_lockfile()) {
1267 if (try_locking(options
, 1) < 0)
1271 if (consider_adding_dir_authorities(options
, old_options
) < 0)
1274 if (options
->Bridges
) {
1275 clear_bridge_list();
1276 for (cl
= options
->Bridges
; cl
; cl
= cl
->next
) {
1277 if (parse_bridge_line(cl
->value
, 0)<0) {
1279 "Previously validated Bridge line could not be added!");
1285 if (running_tor
&& rend_config_services(options
, 0)<0) {
1287 "Previously validated hidden services line could not be added!");
1291 if (running_tor
&& rend_parse_service_authorization(options
, 0) < 0) {
1292 log_warn(LD_BUG
, "Previously validated client authorization for "
1293 "hidden services could not be added!");
1298 if (! global_state
&& running_tor
) {
1299 if (or_state_load())
1301 rep_hist_load_mtbf_data(time(NULL
));
1304 /* Bail out at this point if we're not going to be a client or server:
1305 * we want to not fork, and to log stuff to stderr. */
1309 /* Finish backgrounding the process */
1310 if (options
->RunAsDaemon
) {
1311 /* We may be calling this for the n'th time (on SIGHUP), but it's safe. */
1312 finish_daemon(options
->DataDirectory
);
1315 /* Write our PID to the PID file. If we do not have write permissions we
1316 * will log a warning */
1317 if (options
->PidFile
)
1318 write_pidfile(options
->PidFile
);
1320 /* Register addressmap directives */
1321 config_register_addressmaps(options
);
1322 parse_virtual_addr_network(options
->VirtualAddrNetwork
, 0, &msg
);
1324 /* Update address policies. */
1325 if (policies_parse_from_options(options
) < 0) {
1326 /* This should be impossible, but let's be sure. */
1327 log_warn(LD_BUG
,"Error parsing already-validated policy options.");
1331 if (init_cookie_authentication(options
->CookieAuthentication
) < 0) {
1332 log_warn(LD_CONFIG
,"Error creating cookie authentication file.");
1336 /* reload keys as needed for rendezvous services. */
1337 if (rend_service_load_keys()<0) {
1338 log_warn(LD_GENERAL
,"Error loading rendezvous service keys");
1342 /* Set up accounting */
1343 if (accounting_parse_options(options
, 0)<0) {
1344 log_warn(LD_CONFIG
,"Error in accounting options");
1347 if (accounting_is_enabled(options
))
1348 configure_accounting(time(NULL
));
1350 /* Check for transitions that need action. */
1352 if (options
->UseEntryGuards
&& !old_options
->UseEntryGuards
) {
1354 "Switching to entry guards; abandoning previous circuits");
1355 circuit_mark_all_unused_circs();
1356 circuit_expire_all_dirty_circs();
1359 if (! bool_eq(options
->BridgeRelay
, old_options
->BridgeRelay
)) {
1360 log_info(LD_GENERAL
, "Bridge status changed. Forgetting GeoIP stats.");
1361 geoip_remove_old_clients(time(NULL
)+(2*60*60));
1364 if (options_transition_affects_workers(old_options
, options
)) {
1365 log_info(LD_GENERAL
,
1366 "Worker-related options changed. Rotating workers.");
1367 if (server_mode(options
) && !server_mode(old_options
)) {
1368 if (init_keys() < 0) {
1369 log_warn(LD_BUG
,"Error initializing keys; exiting");
1372 ip_address_changed(0);
1373 if (has_completed_circuit
|| !any_predicted_circuits(time(NULL
)))
1374 inform_testing_reachability();
1376 cpuworkers_rotate();
1384 if (options
->V3AuthoritativeDir
&& !old_options
->V3AuthoritativeDir
)
1388 /* Maybe load geoip file */
1389 if (options
->GeoIPFile
&&
1390 ((!old_options
|| !opt_streq(old_options
->GeoIPFile
, options
->GeoIPFile
))
1391 || !geoip_is_loaded())) {
1392 /* XXXX Don't use this "<default>" junk; make our filename options
1393 * understand prefixes somehow. -NM */
1394 /* XXXX021 Reload GeoIPFile on SIGHUP. -NM */
1395 char *actual_fname
= tor_strdup(options
->GeoIPFile
);
1397 if (!strcmp(actual_fname
, "<default>")) {
1398 const char *conf_root
= get_windows_conf_root();
1399 size_t len
= strlen(conf_root
)+16;
1400 tor_free(actual_fname
);
1401 actual_fname
= tor_malloc(len
+1);
1402 tor_snprintf(actual_fname
, len
, "%s\\geoip", conf_root
);
1405 geoip_load_file(actual_fname
, options
);
1406 tor_free(actual_fname
);
1409 if (options
->DirReqStatistics
) {
1410 /* Check if GeoIP database could be loaded. */
1411 if (!geoip_is_loaded()) {
1412 log_warn(LD_CONFIG
, "Configured to measure directory request "
1413 "statistics, but no GeoIP database found!");
1416 log_notice(LD_CONFIG
, "Configured to count directory requests by "
1417 "country and write aggregate statistics to disk. Check the "
1418 "dirreq-stats file in your data directory that will first "
1419 "be written in 24 hours from now.");
1422 if (options
->ExitPortStatistics
)
1423 log_notice(LD_CONFIG
, "Configured to measure exit port statistics. "
1424 "Look for the exit-stats file that will first be written to "
1425 "the data directory in 24 hours from now.");
1427 #ifdef ENABLE_BUFFER_STATS
1428 if (options
->CellStatistics
)
1429 log_notice(LD_CONFIG
, "Configured to measure cell statistics. Look "
1430 "for the buffer-stats file that will first be written to "
1431 "the data directory in 24 hours from now.");
1433 if (options
->CellStatistics
)
1434 log_warn(LD_CONFIG
, "CellStatistics enabled, but Tor was built "
1435 "without cell statistics support.");
1438 if (options
->EntryStatistics
) {
1439 if (should_record_bridge_info(options
)) {
1440 /* Don't allow measuring statistics on entry guards when configured
1442 log_warn(LD_CONFIG
, "Bridges cannot be configured to measure "
1443 "additional GeoIP statistics as entry guards.");
1445 } else if (!geoip_is_loaded()) {
1446 /* Check if GeoIP database could be loaded. */
1447 log_warn(LD_CONFIG
, "Configured to measure entry node statistics, "
1448 "but no GeoIP database found!");
1451 log_notice(LD_CONFIG
, "Configured to measure entry node "
1452 "statistics. Look for the entry-stats file that will "
1453 "first be written to the data directory in 24 hours "
1457 /* Check if we need to parse and add the EntryNodes config option. */
1458 if (options
->EntryNodes
&&
1460 (!routerset_equal(old_options
->EntryNodes
,options
->EntryNodes
))))
1461 entry_nodes_should_be_added();
1463 /* Since our options changed, we might need to regenerate and upload our
1464 * server descriptor.
1467 options_transition_affects_descriptor(old_options
, options
))
1468 mark_my_descriptor_dirty();
1470 /* We may need to reschedule some directory stuff if our status changed. */
1472 if (authdir_mode_v3(options
) && !authdir_mode_v3(old_options
))
1473 dirvote_recalculate_timing(options
, time(NULL
));
1474 if (!bool_eq(directory_fetches_dir_info_early(options
),
1475 directory_fetches_dir_info_early(old_options
)) ||
1476 !bool_eq(directory_fetches_dir_info_later(options
),
1477 directory_fetches_dir_info_later(old_options
))) {
1478 /* Make sure update_router_have_min_dir_info gets called. */
1479 router_dir_info_changed();
1480 /* We might need to download a new consensus status later or sooner than
1481 * we had expected. */
1482 update_consensus_networkstatus_fetch_time(time(NULL
));
1486 /* Load the webpage we're going to serve every time someone asks for '/' on
1488 tor_free(global_dirfrontpagecontents
);
1489 if (options
->DirPortFrontPage
) {
1490 global_dirfrontpagecontents
=
1491 read_file_to_str(options
->DirPortFrontPage
, 0, NULL
);
1492 if (!global_dirfrontpagecontents
) {
1494 "DirPortFrontPage file '%s' not found. Continuing anyway.",
1495 options
->DirPortFrontPage
);
1503 * Functions to parse config options
1506 /** If <b>option</b> is an official abbreviation for a longer option,
1507 * return the longer option. Otherwise return <b>option</b>.
1508 * If <b>command_line</b> is set, apply all abbreviations. Otherwise, only
1509 * apply abbreviations that work for the config file and the command line.
1510 * If <b>warn_obsolete</b> is set, warn about deprecated names. */
1512 expand_abbrev(config_format_t
*fmt
, const char *option
, int command_line
,
1518 for (i
=0; fmt
->abbrevs
[i
].abbreviated
; ++i
) {
1519 /* Abbreviations are case insensitive. */
1520 if (!strcasecmp(option
,fmt
->abbrevs
[i
].abbreviated
) &&
1521 (command_line
|| !fmt
->abbrevs
[i
].commandline_only
)) {
1522 if (warn_obsolete
&& fmt
->abbrevs
[i
].warn
) {
1524 "The configuration option '%s' is deprecated; "
1525 "use '%s' instead.",
1526 fmt
->abbrevs
[i
].abbreviated
,
1527 fmt
->abbrevs
[i
].full
);
1529 return fmt
->abbrevs
[i
].full
;
1535 /** Helper: Read a list of configuration options from the command line.
1536 * If successful, put them in *<b>result</b> and return 0, and return
1537 * -1 and leave *<b>result</b> alone. */
1539 config_get_commandlines(int argc
, char **argv
, config_line_t
**result
)
1541 config_line_t
*front
= NULL
;
1542 config_line_t
**new = &front
;
1547 if (!strcmp(argv
[i
],"-f") ||
1548 !strcmp(argv
[i
],"--hash-password")) {
1549 i
+= 2; /* command-line option with argument. ignore them. */
1551 } else if (!strcmp(argv
[i
],"--list-fingerprint") ||
1552 !strcmp(argv
[i
],"--verify-config") ||
1553 !strcmp(argv
[i
],"--ignore-missing-torrc") ||
1554 !strcmp(argv
[i
],"--quiet") ||
1555 !strcmp(argv
[i
],"--hush")) {
1556 i
+= 1; /* command-line option. ignore it. */
1558 } else if (!strcmp(argv
[i
],"--nt-service") ||
1559 !strcmp(argv
[i
],"-nt-service")) {
1565 log_warn(LD_CONFIG
,"Command-line option '%s' with no value. Failing.",
1567 config_free_lines(front
);
1571 *new = tor_malloc_zero(sizeof(config_line_t
));
1577 (*new)->key
= tor_strdup(expand_abbrev(&options_format
, s
, 1, 1));
1578 (*new)->value
= tor_strdup(argv
[i
+1]);
1579 (*new)->next
= NULL
;
1580 log(LOG_DEBUG
, LD_CONFIG
, "command line: parsed keyword '%s', value '%s'",
1581 (*new)->key
, (*new)->value
);
1583 new = &((*new)->next
);
1590 /** Helper: allocate a new configuration option mapping 'key' to 'val',
1591 * append it to *<b>lst</b>. */
1593 config_line_append(config_line_t
**lst
,
1597 config_line_t
*newline
;
1599 newline
= tor_malloc(sizeof(config_line_t
));
1600 newline
->key
= tor_strdup(key
);
1601 newline
->value
= tor_strdup(val
);
1602 newline
->next
= NULL
;
1604 lst
= &((*lst
)->next
);
1609 /** Helper: parse the config string and strdup into key/value
1610 * strings. Set *result to the list, or NULL if parsing the string
1611 * failed. Return 0 on success, -1 on failure. Warn and ignore any
1612 * misformatted lines. */
1614 config_get_lines(const char *string
, config_line_t
**result
)
1616 config_line_t
*list
= NULL
, **next
;
1622 string
= parse_config_line_from_str(string
, &k
, &v
);
1624 config_free_lines(list
);
1630 /* This list can get long, so we keep a pointer to the end of it
1631 * rather than using config_line_append over and over and getting
1632 * n^2 performance. */
1633 *next
= tor_malloc(sizeof(config_line_t
));
1636 (*next
)->next
= NULL
;
1637 next
= &((*next
)->next
);
1649 * Free all the configuration lines on the linked list <b>front</b>.
1652 config_free_lines(config_line_t
*front
)
1661 tor_free(tmp
->value
);
1666 /** Return the description for a given configuration variable, or NULL if no
1667 * description exists. */
1669 config_find_description(config_format_t
*fmt
, const char *name
)
1672 for (i
=0; fmt
->descriptions
[i
].name
; ++i
) {
1673 if (!strcasecmp(name
, fmt
->descriptions
[i
].name
))
1674 return fmt
->descriptions
[i
].description
;
1679 /** If <b>key</b> is a configuration option, return the corresponding
1680 * config_var_t. Otherwise, if <b>key</b> is a non-standard abbreviation,
1681 * warn, and return the corresponding config_var_t. Otherwise return NULL.
1683 static config_var_t
*
1684 config_find_option(config_format_t
*fmt
, const char *key
)
1687 size_t keylen
= strlen(key
);
1689 return NULL
; /* if they say "--" on the command line, it's not an option */
1690 /* First, check for an exact (case-insensitive) match */
1691 for (i
=0; fmt
->vars
[i
].name
; ++i
) {
1692 if (!strcasecmp(key
, fmt
->vars
[i
].name
)) {
1693 return &fmt
->vars
[i
];
1696 /* If none, check for an abbreviated match */
1697 for (i
=0; fmt
->vars
[i
].name
; ++i
) {
1698 if (!strncasecmp(key
, fmt
->vars
[i
].name
, keylen
)) {
1699 log_warn(LD_CONFIG
, "The abbreviation '%s' is deprecated. "
1700 "Please use '%s' instead",
1701 key
, fmt
->vars
[i
].name
);
1702 return &fmt
->vars
[i
];
1705 /* Okay, unrecognized option */
1710 * Functions to assign config options.
1713 /** <b>c</b>-\>key is known to be a real key. Update <b>options</b>
1714 * with <b>c</b>-\>value and return 0, or return -1 if bad value.
1716 * Called from config_assign_line() and option_reset().
1719 config_assign_value(config_format_t
*fmt
, or_options_t
*options
,
1720 config_line_t
*c
, char **msg
)
1727 CHECK(fmt
, options
);
1729 var
= config_find_option(fmt
, c
->key
);
1732 lvalue
= STRUCT_VAR_P(options
, var
->var_offset
);
1734 switch (var
->type
) {
1736 case CONFIG_TYPE_UINT
:
1737 i
= (int)tor_parse_long(c
->value
, 10, 0, INT_MAX
, &ok
, NULL
);
1739 r
= tor_snprintf(buf
, sizeof(buf
),
1740 "Int keyword '%s %s' is malformed or out of bounds.",
1742 *msg
= tor_strdup(r
>= 0 ? buf
: "internal error");
1748 case CONFIG_TYPE_INTERVAL
: {
1749 i
= config_parse_interval(c
->value
, &ok
);
1751 r
= tor_snprintf(buf
, sizeof(buf
),
1752 "Interval '%s %s' is malformed or out of bounds.",
1754 *msg
= tor_strdup(r
>= 0 ? buf
: "internal error");
1761 case CONFIG_TYPE_MEMUNIT
: {
1762 uint64_t u64
= config_parse_memunit(c
->value
, &ok
);
1764 r
= tor_snprintf(buf
, sizeof(buf
),
1765 "Value '%s %s' is malformed or out of bounds.",
1767 *msg
= tor_strdup(r
>= 0 ? buf
: "internal error");
1770 *(uint64_t *)lvalue
= u64
;
1774 case CONFIG_TYPE_BOOL
:
1775 i
= (int)tor_parse_long(c
->value
, 10, 0, 1, &ok
, NULL
);
1777 r
= tor_snprintf(buf
, sizeof(buf
),
1778 "Boolean '%s %s' expects 0 or 1.",
1780 *msg
= tor_strdup(r
>= 0 ? buf
: "internal error");
1786 case CONFIG_TYPE_STRING
:
1787 case CONFIG_TYPE_FILENAME
:
1788 tor_free(*(char **)lvalue
);
1789 *(char **)lvalue
= tor_strdup(c
->value
);
1792 case CONFIG_TYPE_DOUBLE
:
1793 *(double *)lvalue
= atof(c
->value
);
1796 case CONFIG_TYPE_ISOTIME
:
1797 if (parse_iso_time(c
->value
, (time_t *)lvalue
)) {
1798 r
= tor_snprintf(buf
, sizeof(buf
),
1799 "Invalid time '%s' for keyword '%s'", c
->value
, c
->key
);
1800 *msg
= tor_strdup(r
>= 0 ? buf
: "internal error");
1805 case CONFIG_TYPE_ROUTERSET
:
1806 if (*(routerset_t
**)lvalue
) {
1807 routerset_free(*(routerset_t
**)lvalue
);
1809 *(routerset_t
**)lvalue
= routerset_new();
1810 if (routerset_parse(*(routerset_t
**)lvalue
, c
->value
, c
->key
)<0) {
1811 tor_snprintf(buf
, sizeof(buf
), "Invalid exit list '%s' for option '%s'",
1813 *msg
= tor_strdup(buf
);
1818 case CONFIG_TYPE_CSV
:
1819 if (*(smartlist_t
**)lvalue
) {
1820 SMARTLIST_FOREACH(*(smartlist_t
**)lvalue
, char *, cp
, tor_free(cp
));
1821 smartlist_clear(*(smartlist_t
**)lvalue
);
1823 *(smartlist_t
**)lvalue
= smartlist_create();
1826 smartlist_split_string(*(smartlist_t
**)lvalue
, c
->value
, ",",
1827 SPLIT_SKIP_SPACE
|SPLIT_IGNORE_BLANK
, 0);
1830 case CONFIG_TYPE_LINELIST
:
1831 case CONFIG_TYPE_LINELIST_S
:
1832 config_line_append((config_line_t
**)lvalue
, c
->key
, c
->value
);
1834 case CONFIG_TYPE_OBSOLETE
:
1835 log_warn(LD_CONFIG
, "Skipping obsolete configuration option '%s'", c
->key
);
1837 case CONFIG_TYPE_LINELIST_V
:
1838 r
= tor_snprintf(buf
, sizeof(buf
),
1839 "You may not provide a value for virtual option '%s'", c
->key
);
1840 *msg
= tor_strdup(r
>= 0 ? buf
: "internal error");
1849 /** If <b>c</b> is a syntactically valid configuration line, update
1850 * <b>options</b> with its value and return 0. Otherwise return -1 for bad
1851 * key, -2 for bad value.
1853 * If <b>clear_first</b> is set, clear the value first. Then if
1854 * <b>use_defaults</b> is set, set the value to the default.
1856 * Called from config_assign().
1859 config_assign_line(config_format_t
*fmt
, or_options_t
*options
,
1860 config_line_t
*c
, int use_defaults
,
1861 int clear_first
, char **msg
)
1865 CHECK(fmt
, options
);
1867 var
= config_find_option(fmt
, c
->key
);
1870 void *lvalue
= STRUCT_VAR_P(options
, fmt
->extra
->var_offset
);
1872 "Found unrecognized option '%s'; saving it.", c
->key
);
1873 config_line_append((config_line_t
**)lvalue
, c
->key
, c
->value
);
1877 int tmp
= tor_snprintf(buf
, sizeof(buf
),
1878 "Unknown option '%s'. Failing.", c
->key
);
1879 *msg
= tor_strdup(tmp
>= 0 ? buf
: "internal error");
1883 /* Put keyword into canonical case. */
1884 if (strcmp(var
->name
, c
->key
)) {
1886 c
->key
= tor_strdup(var
->name
);
1889 if (!strlen(c
->value
)) {
1890 /* reset or clear it, then return */
1892 if (var
->type
== CONFIG_TYPE_LINELIST
||
1893 var
->type
== CONFIG_TYPE_LINELIST_S
) {
1894 /* We got an empty linelist from the torrc or command line.
1895 As a special case, call this an error. Warn and ignore. */
1897 "Linelist option '%s' has no value. Skipping.", c
->key
);
1898 } else { /* not already cleared */
1899 option_reset(fmt
, options
, var
, use_defaults
);
1905 if (config_assign_value(fmt
, options
, c
, msg
) < 0)
1910 /** Restore the option named <b>key</b> in options to its default value.
1911 * Called from config_assign(). */
1913 config_reset_line(config_format_t
*fmt
, or_options_t
*options
,
1914 const char *key
, int use_defaults
)
1918 CHECK(fmt
, options
);
1920 var
= config_find_option(fmt
, key
);
1922 return; /* give error on next pass. */
1924 option_reset(fmt
, options
, var
, use_defaults
);
1927 /** Return true iff key is a valid configuration option. */
1929 option_is_recognized(const char *key
)
1931 config_var_t
*var
= config_find_option(&options_format
, key
);
1932 return (var
!= NULL
);
1935 /** Return the canonical name of a configuration option, or NULL
1936 * if no such option exists. */
1938 option_get_canonical_name(const char *key
)
1940 config_var_t
*var
= config_find_option(&options_format
, key
);
1941 return var
? var
->name
: NULL
;
1944 /** Return a canonical list of the options assigned for key.
1947 option_get_assignment(or_options_t
*options
, const char *key
)
1949 return get_assigned_option(&options_format
, options
, key
, 1);
1952 /** Return true iff value needs to be quoted and escaped to be used in
1953 * a configuration file. */
1955 config_value_needs_escape(const char *value
)
1965 /* Note: quotes and backspaces need special handling when we are using
1966 * quotes, not otherwise, so they don't trigger escaping on their
1970 if (!TOR_ISPRINT(*value
))
1978 /** Return a newly allocated deep copy of the lines in <b>inp</b>. */
1979 static config_line_t
*
1980 config_lines_dup(const config_line_t
*inp
)
1982 config_line_t
*result
= NULL
;
1983 config_line_t
**next_out
= &result
;
1985 *next_out
= tor_malloc(sizeof(config_line_t
));
1986 (*next_out
)->key
= tor_strdup(inp
->key
);
1987 (*next_out
)->value
= tor_strdup(inp
->value
);
1989 next_out
= &((*next_out
)->next
);
1995 /** Return newly allocated line or lines corresponding to <b>key</b> in the
1996 * configuration <b>options</b>. If <b>escape_val</b> is true and a
1997 * value needs to be quoted before it's put in a config file, quote and
1998 * escape that value. Return NULL if no such key exists. */
1999 static config_line_t
*
2000 get_assigned_option(config_format_t
*fmt
, void *options
,
2001 const char *key
, int escape_val
)
2006 config_line_t
*result
;
2007 tor_assert(options
&& key
);
2009 CHECK(fmt
, options
);
2011 var
= config_find_option(fmt
, key
);
2013 log_warn(LD_CONFIG
, "Unknown option '%s'. Failing.", key
);
2016 value
= STRUCT_VAR_P(options
, var
->var_offset
);
2018 result
= tor_malloc_zero(sizeof(config_line_t
));
2019 result
->key
= tor_strdup(var
->name
);
2022 case CONFIG_TYPE_STRING
:
2023 case CONFIG_TYPE_FILENAME
:
2024 if (*(char**)value
) {
2025 result
->value
= tor_strdup(*(char**)value
);
2027 tor_free(result
->key
);
2032 case CONFIG_TYPE_ISOTIME
:
2033 if (*(time_t*)value
) {
2034 result
->value
= tor_malloc(ISO_TIME_LEN
+1);
2035 format_iso_time(result
->value
, *(time_t*)value
);
2037 tor_free(result
->key
);
2040 escape_val
= 0; /* Can't need escape. */
2042 case CONFIG_TYPE_INTERVAL
:
2043 case CONFIG_TYPE_UINT
:
2044 /* This means every or_options_t uint or bool element
2045 * needs to be an int. Not, say, a uint16_t or char. */
2046 tor_snprintf(buf
, sizeof(buf
), "%d", *(int*)value
);
2047 result
->value
= tor_strdup(buf
);
2048 escape_val
= 0; /* Can't need escape. */
2050 case CONFIG_TYPE_MEMUNIT
:
2051 tor_snprintf(buf
, sizeof(buf
), U64_FORMAT
,
2052 U64_PRINTF_ARG(*(uint64_t*)value
));
2053 result
->value
= tor_strdup(buf
);
2054 escape_val
= 0; /* Can't need escape. */
2056 case CONFIG_TYPE_DOUBLE
:
2057 tor_snprintf(buf
, sizeof(buf
), "%f", *(double*)value
);
2058 result
->value
= tor_strdup(buf
);
2059 escape_val
= 0; /* Can't need escape. */
2061 case CONFIG_TYPE_BOOL
:
2062 result
->value
= tor_strdup(*(int*)value
? "1" : "0");
2063 escape_val
= 0; /* Can't need escape. */
2065 case CONFIG_TYPE_ROUTERSET
:
2066 result
->value
= routerset_to_string(*(routerset_t
**)value
);
2068 case CONFIG_TYPE_CSV
:
2069 if (*(smartlist_t
**)value
)
2071 smartlist_join_strings(*(smartlist_t
**)value
, ",", 0, NULL
);
2073 result
->value
= tor_strdup("");
2075 case CONFIG_TYPE_OBSOLETE
:
2076 log_fn(LOG_PROTOCOL_WARN
, LD_CONFIG
,
2077 "You asked me for the value of an obsolete config option '%s'.",
2079 tor_free(result
->key
);
2082 case CONFIG_TYPE_LINELIST_S
:
2084 "Can't return context-sensitive '%s' on its own", key
);
2085 tor_free(result
->key
);
2088 case CONFIG_TYPE_LINELIST
:
2089 case CONFIG_TYPE_LINELIST_V
:
2090 tor_free(result
->key
);
2092 result
= config_lines_dup(*(const config_line_t
**)value
);
2095 tor_free(result
->key
);
2097 log_warn(LD_BUG
,"Unknown type %d for known key '%s'",
2103 config_line_t
*line
;
2104 for (line
= result
; line
; line
= line
->next
) {
2105 if (line
->value
&& config_value_needs_escape(line
->value
)) {
2106 char *newval
= esc_for_log(line
->value
);
2107 tor_free(line
->value
);
2108 line
->value
= newval
;
2116 /** Iterate through the linked list of requested options <b>list</b>.
2117 * For each item, convert as appropriate and assign to <b>options</b>.
2118 * If an item is unrecognized, set *msg and return -1 immediately,
2119 * else return 0 for success.
2121 * If <b>clear_first</b>, interpret config options as replacing (not
2122 * extending) their previous values. If <b>clear_first</b> is set,
2123 * then <b>use_defaults</b> to decide if you set to defaults after
2124 * clearing, or make the value 0 or NULL.
2126 * Here are the use cases:
2127 * 1. A non-empty AllowInvalid line in your torrc. Appends to current
2128 * if linelist, replaces current if csv.
2129 * 2. An empty AllowInvalid line in your torrc. Should clear it.
2130 * 3. "RESETCONF AllowInvalid" sets it to default.
2131 * 4. "SETCONF AllowInvalid" makes it NULL.
2132 * 5. "SETCONF AllowInvalid=foo" clears it and sets it to "foo".
2134 * Use_defaults Clear_first
2136 * 1 0 undefined, don't use
2137 * 0 1 "set to null first"
2138 * 1 1 "set to defaults first"
2139 * Return 0 on success, -1 on bad key, -2 on bad value.
2141 * As an additional special case, if a LINELIST config option has
2142 * no value and clear_first is 0, then warn and ignore it.
2146 There are three call cases for config_assign() currently.
2148 Case one: Torrc entry
2149 options_init_from_torrc() calls config_assign(0, 0)
2150 calls config_assign_line(0, 0).
2151 if value is empty, calls option_reset(0) and returns.
2152 calls config_assign_value(), appends.
2155 options_trial_assign() calls config_assign(0, 1)
2156 calls config_reset_line(0)
2157 calls option_reset(0)
2158 calls option_clear().
2159 calls config_assign_line(0, 1).
2160 if value is empty, returns.
2161 calls config_assign_value(), appends.
2163 Case three: resetconf
2164 options_trial_assign() calls config_assign(1, 1)
2165 calls config_reset_line(1)
2166 calls option_reset(1)
2167 calls option_clear().
2168 calls config_assign_value(default)
2169 calls config_assign_line(1, 1).
2173 config_assign(config_format_t
*fmt
, void *options
, config_line_t
*list
,
2174 int use_defaults
, int clear_first
, char **msg
)
2178 CHECK(fmt
, options
);
2180 /* pass 1: normalize keys */
2181 for (p
= list
; p
; p
= p
->next
) {
2182 const char *full
= expand_abbrev(fmt
, p
->key
, 0, 1);
2183 if (strcmp(full
,p
->key
)) {
2185 p
->key
= tor_strdup(full
);
2189 /* pass 2: if we're reading from a resetting source, clear all
2190 * mentioned config options, and maybe set to their defaults. */
2192 for (p
= list
; p
; p
= p
->next
)
2193 config_reset_line(fmt
, options
, p
->key
, use_defaults
);
2196 /* pass 3: assign. */
2199 if ((r
=config_assign_line(fmt
, options
, list
, use_defaults
,
2207 /** Try assigning <b>list</b> to the global options. You do this by duping
2208 * options, assigning list to the new one, then validating it. If it's
2209 * ok, then throw out the old one and stick with the new one. Else,
2210 * revert to old and return failure. Return SETOPT_OK on success, or
2211 * a setopt_err_t on failure.
2213 * If not success, point *<b>msg</b> to a newly allocated string describing
2217 options_trial_assign(config_line_t
*list
, int use_defaults
,
2218 int clear_first
, char **msg
)
2221 or_options_t
*trial_options
= options_dup(&options_format
, get_options());
2223 if ((r
=config_assign(&options_format
, trial_options
,
2224 list
, use_defaults
, clear_first
, msg
)) < 0) {
2225 config_free(&options_format
, trial_options
);
2229 if (options_validate(get_options(), trial_options
, 1, msg
) < 0) {
2230 config_free(&options_format
, trial_options
);
2231 return SETOPT_ERR_PARSE
; /*XXX make this a separate return value. */
2234 if (options_transition_allowed(get_options(), trial_options
, msg
) < 0) {
2235 config_free(&options_format
, trial_options
);
2236 return SETOPT_ERR_TRANSITION
;
2239 if (set_options(trial_options
, msg
)<0) {
2240 config_free(&options_format
, trial_options
);
2241 return SETOPT_ERR_SETTING
;
2244 /* we liked it. put it in place. */
2248 /** Reset config option <b>var</b> to 0, 0.0, NULL, or the equivalent.
2249 * Called from option_reset() and config_free(). */
2251 option_clear(config_format_t
*fmt
, or_options_t
*options
, config_var_t
*var
)
2253 void *lvalue
= STRUCT_VAR_P(options
, var
->var_offset
);
2254 (void)fmt
; /* unused */
2255 switch (var
->type
) {
2256 case CONFIG_TYPE_STRING
:
2257 case CONFIG_TYPE_FILENAME
:
2258 tor_free(*(char**)lvalue
);
2260 case CONFIG_TYPE_DOUBLE
:
2261 *(double*)lvalue
= 0.0;
2263 case CONFIG_TYPE_ISOTIME
:
2264 *(time_t*)lvalue
= 0;
2265 case CONFIG_TYPE_INTERVAL
:
2266 case CONFIG_TYPE_UINT
:
2267 case CONFIG_TYPE_BOOL
:
2270 case CONFIG_TYPE_MEMUNIT
:
2271 *(uint64_t*)lvalue
= 0;
2273 case CONFIG_TYPE_ROUTERSET
:
2274 if (*(routerset_t
**)lvalue
) {
2275 routerset_free(*(routerset_t
**)lvalue
);
2276 *(routerset_t
**)lvalue
= NULL
;
2278 case CONFIG_TYPE_CSV
:
2279 if (*(smartlist_t
**)lvalue
) {
2280 SMARTLIST_FOREACH(*(smartlist_t
**)lvalue
, char *, cp
, tor_free(cp
));
2281 smartlist_free(*(smartlist_t
**)lvalue
);
2282 *(smartlist_t
**)lvalue
= NULL
;
2285 case CONFIG_TYPE_LINELIST
:
2286 case CONFIG_TYPE_LINELIST_S
:
2287 config_free_lines(*(config_line_t
**)lvalue
);
2288 *(config_line_t
**)lvalue
= NULL
;
2290 case CONFIG_TYPE_LINELIST_V
:
2291 /* handled by linelist_s. */
2293 case CONFIG_TYPE_OBSOLETE
:
2298 /** Clear the option indexed by <b>var</b> in <b>options</b>. Then if
2299 * <b>use_defaults</b>, set it to its default value.
2300 * Called by config_init() and option_reset_line() and option_assign_line(). */
2302 option_reset(config_format_t
*fmt
, or_options_t
*options
,
2303 config_var_t
*var
, int use_defaults
)
2307 CHECK(fmt
, options
);
2308 option_clear(fmt
, options
, var
); /* clear it first */
2310 return; /* all done */
2311 if (var
->initvalue
) {
2312 c
= tor_malloc_zero(sizeof(config_line_t
));
2313 c
->key
= tor_strdup(var
->name
);
2314 c
->value
= tor_strdup(var
->initvalue
);
2315 if (config_assign_value(fmt
, options
, c
, &msg
) < 0) {
2316 log_warn(LD_BUG
, "Failed to assign default: %s", msg
);
2317 tor_free(msg
); /* if this happens it's a bug */
2319 config_free_lines(c
);
2323 /** Print a usage message for tor. */
2328 "Copyright (c) 2001-2004, Roger Dingledine\n"
2329 "Copyright (c) 2004-2006, Roger Dingledine, Nick Mathewson\n"
2330 "Copyright (c) 2007-2009, The Tor Project, Inc.\n\n"
2331 "tor -f <torrc> [args]\n"
2332 "See man page for options, or https://www.torproject.org/ for "
2333 "documentation.\n");
2336 /** Print all non-obsolete torrc options. */
2338 list_torrc_options(void)
2341 smartlist_t
*lines
= smartlist_create();
2342 for (i
= 0; _option_vars
[i
].name
; ++i
) {
2343 config_var_t
*var
= &_option_vars
[i
];
2345 if (var
->type
== CONFIG_TYPE_OBSOLETE
||
2346 var
->type
== CONFIG_TYPE_LINELIST_V
)
2348 desc
= config_find_description(&options_format
, var
->name
);
2349 printf("%s\n", var
->name
);
2351 wrap_string(lines
, desc
, 76, " ", " ");
2352 SMARTLIST_FOREACH(lines
, char *, cp
, {
2356 smartlist_clear(lines
);
2359 smartlist_free(lines
);
2362 /** Last value actually set by resolve_my_address. */
2363 static uint32_t last_resolved_addr
= 0;
2365 * Based on <b>options-\>Address</b>, guess our public IP address and put it
2366 * (in host order) into *<b>addr_out</b>. If <b>hostname_out</b> is provided,
2367 * set *<b>hostname_out</b> to a new string holding the hostname we used to
2368 * get the address. Return 0 if all is well, or -1 if we can't find a suitable
2369 * public IP address.
2372 resolve_my_address(int warn_severity
, or_options_t
*options
,
2373 uint32_t *addr_out
, char **hostname_out
)
2376 struct hostent
*rent
;
2379 int explicit_hostname
=1;
2380 int from_interface
=0;
2381 char tmpbuf
[INET_NTOA_BUF_LEN
];
2382 const char *address
= options
->Address
;
2383 int notice_severity
= warn_severity
<= LOG_NOTICE
?
2384 LOG_NOTICE
: warn_severity
;
2386 tor_assert(addr_out
);
2388 if (address
&& *address
) {
2389 strlcpy(hostname
, address
, sizeof(hostname
));
2390 } else { /* then we need to guess our address */
2391 explicit_ip
= 0; /* it's implicit */
2392 explicit_hostname
= 0; /* it's implicit */
2394 if (gethostname(hostname
, sizeof(hostname
)) < 0) {
2395 log_fn(warn_severity
, LD_NET
,"Error obtaining local hostname");
2398 log_debug(LD_CONFIG
,"Guessed local host name as '%s'",hostname
);
2401 /* now we know hostname. resolve it and keep only the IP address */
2403 if (tor_inet_aton(hostname
, &in
) == 0) {
2404 /* then we have to resolve it */
2406 rent
= (struct hostent
*)gethostbyname(hostname
);
2408 uint32_t interface_ip
;
2410 if (explicit_hostname
) {
2411 log_fn(warn_severity
, LD_CONFIG
,
2412 "Could not resolve local Address '%s'. Failing.", hostname
);
2415 log_fn(notice_severity
, LD_CONFIG
,
2416 "Could not resolve guessed local hostname '%s'. "
2417 "Trying something else.", hostname
);
2418 if (get_interface_address(warn_severity
, &interface_ip
)) {
2419 log_fn(warn_severity
, LD_CONFIG
,
2420 "Could not get local interface IP address. Failing.");
2424 in
.s_addr
= htonl(interface_ip
);
2425 tor_inet_ntoa(&in
,tmpbuf
,sizeof(tmpbuf
));
2426 log_fn(notice_severity
, LD_CONFIG
, "Learned IP address '%s' for "
2427 "local interface. Using that.", tmpbuf
);
2428 strlcpy(hostname
, "<guessed from interfaces>", sizeof(hostname
));
2430 tor_assert(rent
->h_length
== 4);
2431 memcpy(&in
.s_addr
, rent
->h_addr
, rent
->h_length
);
2433 if (!explicit_hostname
&&
2434 is_internal_IP(ntohl(in
.s_addr
), 0)) {
2435 uint32_t interface_ip
;
2437 tor_inet_ntoa(&in
,tmpbuf
,sizeof(tmpbuf
));
2438 log_fn(notice_severity
, LD_CONFIG
, "Guessed local hostname '%s' "
2439 "resolves to a private IP address (%s). Trying something "
2440 "else.", hostname
, tmpbuf
);
2442 if (get_interface_address(warn_severity
, &interface_ip
)) {
2443 log_fn(warn_severity
, LD_CONFIG
,
2444 "Could not get local interface IP address. Too bad.");
2445 } else if (is_internal_IP(interface_ip
, 0)) {
2447 in2
.s_addr
= htonl(interface_ip
);
2448 tor_inet_ntoa(&in2
,tmpbuf
,sizeof(tmpbuf
));
2449 log_fn(notice_severity
, LD_CONFIG
,
2450 "Interface IP address '%s' is a private address too. "
2451 "Ignoring.", tmpbuf
);
2454 in
.s_addr
= htonl(interface_ip
);
2455 tor_inet_ntoa(&in
,tmpbuf
,sizeof(tmpbuf
));
2456 log_fn(notice_severity
, LD_CONFIG
,
2457 "Learned IP address '%s' for local interface."
2458 " Using that.", tmpbuf
);
2459 strlcpy(hostname
, "<guessed from interfaces>", sizeof(hostname
));
2465 tor_inet_ntoa(&in
,tmpbuf
,sizeof(tmpbuf
));
2466 if (is_internal_IP(ntohl(in
.s_addr
), 0) &&
2467 options
->_PublishServerDescriptor
) {
2468 /* make sure we're ok with publishing an internal IP */
2469 if (!options
->DirServers
&& !options
->AlternateDirAuthority
) {
2470 /* if they are using the default dirservers, disallow internal IPs
2472 log_fn(warn_severity
, LD_CONFIG
,
2473 "Address '%s' resolves to private IP address '%s'. "
2474 "Tor servers that use the default DirServers must have public "
2475 "IP addresses.", hostname
, tmpbuf
);
2479 /* even if they've set their own dirservers, require an explicit IP if
2480 * they're using an internal address. */
2481 log_fn(warn_severity
, LD_CONFIG
, "Address '%s' resolves to private "
2482 "IP address '%s'. Please set the Address config option to be "
2483 "the IP address you want to use.", hostname
, tmpbuf
);
2488 log_debug(LD_CONFIG
, "Resolved Address to '%s'.", tmpbuf
);
2489 *addr_out
= ntohl(in
.s_addr
);
2490 if (last_resolved_addr
&& last_resolved_addr
!= *addr_out
) {
2491 /* Leave this as a notice, regardless of the requested severity,
2492 * at least until dynamic IP address support becomes bulletproof. */
2494 "Your IP address seems to have changed to %s. Updating.",
2496 ip_address_changed(0);
2498 if (last_resolved_addr
!= *addr_out
) {
2500 const char *h
= hostname
;
2502 method
= "CONFIGURED";
2504 } else if (explicit_hostname
) {
2505 method
= "RESOLVED";
2506 } else if (from_interface
) {
2507 method
= "INTERFACE";
2510 method
= "GETHOSTNAME";
2512 control_event_server_status(LOG_NOTICE
,
2513 "EXTERNAL_ADDRESS ADDRESS=%s METHOD=%s %s%s",
2514 tmpbuf
, method
, h
?"HOSTNAME=":"", h
);
2516 last_resolved_addr
= *addr_out
;
2518 *hostname_out
= tor_strdup(hostname
);
2522 /** Return true iff <b>addr</b> is judged to be on the same network as us, or
2523 * on a private network.
2526 is_local_addr(const tor_addr_t
*addr
)
2528 if (tor_addr_is_internal(addr
, 0))
2530 /* Check whether ip is on the same /24 as we are. */
2531 if (get_options()->EnforceDistinctSubnets
== 0)
2533 if (tor_addr_family(addr
) == AF_INET
) {
2534 /*XXXX022 IP6 what corresponds to an /24? */
2535 uint32_t ip
= tor_addr_to_ipv4h(addr
);
2537 /* It's possible that this next check will hit before the first time
2538 * resolve_my_address actually succeeds. (For clients, it is likely that
2539 * resolve_my_address will never be called at all). In those cases,
2540 * last_resolved_addr will be 0, and so checking to see whether ip is on
2541 * the same /24 as last_resolved_addr will be the same as checking whether
2542 * it was on net 0, which is already done by is_internal_IP.
2544 if ((last_resolved_addr
& 0xffffff00ul
) == (ip
& 0xffffff00ul
))
2550 /** Called when we don't have a nickname set. Try to guess a good nickname
2551 * based on the hostname, and return it in a newly allocated string. If we
2552 * can't, return NULL and let the caller warn if it wants to. */
2554 get_default_nickname(void)
2556 static const char * const bad_default_nicknames
[] = {
2560 char localhostname
[256];
2561 char *cp
, *out
, *outp
;
2564 if (gethostname(localhostname
, sizeof(localhostname
)) < 0)
2567 /* Put it in lowercase; stop at the first dot. */
2568 if ((cp
= strchr(localhostname
, '.')))
2570 tor_strlower(localhostname
);
2572 /* Strip invalid characters. */
2574 out
= outp
= tor_malloc(strlen(localhostname
) + 1);
2576 if (strchr(LEGAL_NICKNAME_CHARACTERS
, *cp
))
2583 /* Enforce length. */
2584 if (strlen(out
) > MAX_NICKNAME_LEN
)
2585 out
[MAX_NICKNAME_LEN
]='\0';
2587 /* Check for dumb names. */
2588 for (i
= 0; bad_default_nicknames
[i
]; ++i
) {
2589 if (!strcmp(out
, bad_default_nicknames
[i
])) {
2598 /** Release storage held by <b>options</b>. */
2600 config_free(config_format_t
*fmt
, void *options
)
2604 tor_assert(options
);
2606 for (i
=0; fmt
->vars
[i
].name
; ++i
)
2607 option_clear(fmt
, options
, &(fmt
->vars
[i
]));
2609 config_line_t
**linep
= STRUCT_VAR_P(options
, fmt
->extra
->var_offset
);
2610 config_free_lines(*linep
);
2616 /** Return true iff a and b contain identical keys and values in identical
2619 config_lines_eq(config_line_t
*a
, config_line_t
*b
)
2622 if (strcasecmp(a
->key
, b
->key
) || strcmp(a
->value
, b
->value
))
2632 /** Return true iff the option <b>name</b> has the same value in <b>o1</b>
2633 * and <b>o2</b>. Must not be called for LINELIST_S or OBSOLETE options.
2636 option_is_same(config_format_t
*fmt
,
2637 or_options_t
*o1
, or_options_t
*o2
, const char *name
)
2639 config_line_t
*c1
, *c2
;
2644 c1
= get_assigned_option(fmt
, o1
, name
, 0);
2645 c2
= get_assigned_option(fmt
, o2
, name
, 0);
2646 r
= config_lines_eq(c1
, c2
);
2647 config_free_lines(c1
);
2648 config_free_lines(c2
);
2652 /** Copy storage held by <b>old</b> into a new or_options_t and return it. */
2653 static or_options_t
*
2654 options_dup(config_format_t
*fmt
, or_options_t
*old
)
2656 or_options_t
*newopts
;
2658 config_line_t
*line
;
2660 newopts
= config_alloc(fmt
);
2661 for (i
=0; fmt
->vars
[i
].name
; ++i
) {
2662 if (fmt
->vars
[i
].type
== CONFIG_TYPE_LINELIST_S
)
2664 if (fmt
->vars
[i
].type
== CONFIG_TYPE_OBSOLETE
)
2666 line
= get_assigned_option(fmt
, old
, fmt
->vars
[i
].name
, 0);
2669 if (config_assign(fmt
, newopts
, line
, 0, 0, &msg
) < 0) {
2670 log_err(LD_BUG
, "Config_get_assigned_option() generated "
2671 "something we couldn't config_assign(): %s", msg
);
2676 config_free_lines(line
);
2681 /** Return a new empty or_options_t. Used for testing. */
2685 return config_alloc(&options_format
);
2688 /** Set <b>options</b> to hold reasonable defaults for most options.
2689 * Each option defaults to zero. */
2691 options_init(or_options_t
*options
)
2693 config_init(&options_format
, options
);
2696 /* Check if the port number given in <b>port_option</b> in combination with
2697 * the specified port in <b>listen_options</b> will result in Tor actually
2698 * opening a low port (meaning a port lower than 1024). Return 1 if
2699 * it is, or 0 if it isn't or the concept of a low port isn't applicable for
2700 * the platform we're on. */
2702 is_listening_on_low_port(uint16_t port_option
,
2703 const config_line_t
*listen_options
)
2706 return 0; /* No port is too low for windows. */
2708 const config_line_t
*l
;
2710 if (port_option
== 0)
2711 return 0; /* We're not listening */
2712 if (listen_options
== NULL
)
2713 return (port_option
< 1024);
2715 for (l
= listen_options
; l
; l
= l
->next
) {
2716 parse_addr_port(LOG_WARN
, l
->value
, NULL
, NULL
, &p
);
2725 /** Set all vars in the configuration object <b>options</b> to their default
2728 config_init(config_format_t
*fmt
, void *options
)
2732 CHECK(fmt
, options
);
2734 for (i
=0; fmt
->vars
[i
].name
; ++i
) {
2735 var
= &fmt
->vars
[i
];
2736 if (!var
->initvalue
)
2737 continue; /* defaults to NULL or 0 */
2738 option_reset(fmt
, options
, var
, 1);
2742 /** Allocate and return a new string holding the written-out values of the vars
2743 * in 'options'. If 'minimal', do not write out any default-valued vars.
2744 * Else, if comment_defaults, write default values as comments.
2747 config_dump(config_format_t
*fmt
, void *options
, int minimal
,
2748 int comment_defaults
)
2750 smartlist_t
*elements
;
2751 or_options_t
*defaults
;
2752 config_line_t
*line
, *assigned
;
2758 defaults
= config_alloc(fmt
);
2759 config_init(fmt
, defaults
);
2761 /* XXX use a 1 here so we don't add a new log line while dumping */
2762 if (fmt
->validate_fn(NULL
,defaults
, 1, &msg
) < 0) {
2763 log_err(LD_BUG
, "Failed to validate default config.");
2768 elements
= smartlist_create();
2769 for (i
=0; fmt
->vars
[i
].name
; ++i
) {
2770 int comment_option
= 0;
2771 if (fmt
->vars
[i
].type
== CONFIG_TYPE_OBSOLETE
||
2772 fmt
->vars
[i
].type
== CONFIG_TYPE_LINELIST_S
)
2774 /* Don't save 'hidden' control variables. */
2775 if (!strcmpstart(fmt
->vars
[i
].name
, "__"))
2777 if (minimal
&& option_is_same(fmt
, options
, defaults
, fmt
->vars
[i
].name
))
2779 else if (comment_defaults
&&
2780 option_is_same(fmt
, options
, defaults
, fmt
->vars
[i
].name
))
2783 desc
= config_find_description(fmt
, fmt
->vars
[i
].name
);
2784 line
= assigned
= get_assigned_option(fmt
, options
, fmt
->vars
[i
].name
, 1);
2787 /* Only dump the description if there's something to describe. */
2788 wrap_string(elements
, desc
, 78, "# ", "# ");
2791 for (; line
; line
= line
->next
) {
2792 size_t len
= strlen(line
->key
) + strlen(line
->value
) + 5;
2794 tmp
= tor_malloc(len
);
2795 if (tor_snprintf(tmp
, len
, "%s%s %s\n",
2796 comment_option
? "# " : "",
2797 line
->key
, line
->value
)<0) {
2798 log_err(LD_BUG
,"Internal error writing option value");
2801 smartlist_add(elements
, tmp
);
2803 config_free_lines(assigned
);
2807 line
= *(config_line_t
**)STRUCT_VAR_P(options
, fmt
->extra
->var_offset
);
2808 for (; line
; line
= line
->next
) {
2809 size_t len
= strlen(line
->key
) + strlen(line
->value
) + 3;
2811 tmp
= tor_malloc(len
);
2812 if (tor_snprintf(tmp
, len
, "%s %s\n", line
->key
, line
->value
)<0) {
2813 log_err(LD_BUG
,"Internal error writing option value");
2816 smartlist_add(elements
, tmp
);
2820 result
= smartlist_join_strings(elements
, "", 0, NULL
);
2821 SMARTLIST_FOREACH(elements
, char *, cp
, tor_free(cp
));
2822 smartlist_free(elements
);
2823 config_free(fmt
, defaults
);
2827 /** Return a string containing a possible configuration file that would give
2828 * the configuration in <b>options</b>. If <b>minimal</b> is true, do not
2829 * include options that are the same as Tor's defaults.
2832 options_dump(or_options_t
*options
, int minimal
)
2834 return config_dump(&options_format
, options
, minimal
, 0);
2837 /** Return 0 if every element of sl is a string holding a decimal
2838 * representation of a port number, or if sl is NULL.
2839 * Otherwise set *msg and return -1. */
2841 validate_ports_csv(smartlist_t
*sl
, const char *name
, char **msg
)
2850 SMARTLIST_FOREACH(sl
, const char *, cp
,
2853 if (i
< 1 || i
> 65535) {
2854 int r
= tor_snprintf(buf
, sizeof(buf
),
2855 "Port '%s' out of range in %s", cp
, name
);
2856 *msg
= tor_strdup(r
>= 0 ? buf
: "internal error");
2863 /** If <b>value</b> exceeds ROUTER_MAX_DECLARED_BANDWIDTH, write
2864 * a complaint into *<b>msg</b> using string <b>desc</b>, and return -1.
2868 ensure_bandwidth_cap(uint64_t *value
, const char *desc
, char **msg
)
2872 if (*value
> ROUTER_MAX_DECLARED_BANDWIDTH
) {
2873 /* This handles an understandable special case where somebody says "2gb"
2874 * whereas our actual maximum is 2gb-1 (INT_MAX) */
2877 if (*value
> ROUTER_MAX_DECLARED_BANDWIDTH
) {
2878 r
= tor_snprintf(buf
, sizeof(buf
), "%s ("U64_FORMAT
") must be at most %d",
2879 desc
, U64_PRINTF_ARG(*value
),
2880 ROUTER_MAX_DECLARED_BANDWIDTH
);
2881 *msg
= tor_strdup(r
>= 0 ? buf
: "internal error");
2887 /** Parse an authority type from <b>options</b>-\>PublishServerDescriptor
2888 * and write it to <b>options</b>-\>_PublishServerDescriptor. Treat "1"
2889 * as "v2,v3" unless BridgeRelay is 1, in which case treat it as "bridge".
2891 * Return 0 on success or -1 if not a recognized authority type (in which
2892 * case the value of _PublishServerDescriptor is undefined). */
2894 compute_publishserverdescriptor(or_options_t
*options
)
2896 smartlist_t
*list
= options
->PublishServerDescriptor
;
2897 authority_type_t
*auth
= &options
->_PublishServerDescriptor
;
2898 *auth
= NO_AUTHORITY
;
2899 if (!list
) /* empty list, answer is none */
2901 SMARTLIST_FOREACH(list
, const char *, string
, {
2902 if (!strcasecmp(string
, "v1"))
2903 *auth
|= V1_AUTHORITY
;
2904 else if (!strcmp(string
, "1"))
2905 if (options
->BridgeRelay
)
2906 *auth
|= BRIDGE_AUTHORITY
;
2908 *auth
|= V2_AUTHORITY
| V3_AUTHORITY
;
2909 else if (!strcasecmp(string
, "v2"))
2910 *auth
|= V2_AUTHORITY
;
2911 else if (!strcasecmp(string
, "v3"))
2912 *auth
|= V3_AUTHORITY
;
2913 else if (!strcasecmp(string
, "bridge"))
2914 *auth
|= BRIDGE_AUTHORITY
;
2915 else if (!strcasecmp(string
, "hidserv"))
2916 *auth
|= HIDSERV_AUTHORITY
;
2917 else if (!strcasecmp(string
, "") || !strcmp(string
, "0"))
2925 /** Lowest allowable value for RendPostPeriod; if this is too low, hidden
2926 * services can overload the directory system. */
2927 #define MIN_REND_POST_PERIOD (10*60)
2929 /** Highest allowable value for RendPostPeriod. */
2930 #define MAX_DIR_PERIOD (MIN_ONION_KEY_LIFETIME/2)
2932 /** Lowest allowable value for CircuitBuildTimeout; values too low will
2933 * increase network load because of failing connections being retried, and
2934 * might prevent users from connecting to the network at all. */
2935 #define MIN_CIRCUIT_BUILD_TIMEOUT 30
2937 /** Lowest allowable value for MaxCircuitDirtiness; if this is too low, Tor
2938 * will generate too many circuits and potentially overload the network. */
2939 #define MIN_MAX_CIRCUIT_DIRTINESS 10
2941 /** Return 0 if every setting in <b>options</b> is reasonable, and a
2942 * permissible transition from <b>old_options</b>. Else return -1.
2943 * Should have no side effects, except for normalizing the contents of
2946 * On error, tor_strdup an error explanation into *<b>msg</b>.
2949 * If <b>from_setconf</b>, we were called by the controller, and our
2950 * Log line should stay empty. If it's 0, then give us a default log
2951 * if there are no logs defined.
2954 options_validate(or_options_t
*old_options
, or_options_t
*options
,
2955 int from_setconf
, char **msg
)
2959 const char *uname
= get_uname();
2961 #define REJECT(arg) \
2962 STMT_BEGIN *msg = tor_strdup(arg); return -1; STMT_END
2963 #define COMPLAIN(arg) STMT_BEGIN log(LOG_WARN, LD_CONFIG, arg); STMT_END
2968 if (options
->ORPort
< 0 || options
->ORPort
> 65535)
2969 REJECT("ORPort option out of bounds.");
2971 if (server_mode(options
) &&
2972 (!strcmpstart(uname
, "Windows 95") ||
2973 !strcmpstart(uname
, "Windows 98") ||
2974 !strcmpstart(uname
, "Windows Me"))) {
2975 log(LOG_WARN
, LD_CONFIG
, "Tor is running as a server, but you are "
2976 "running %s; this probably won't work. See "
2977 "https://wiki.torproject.org/TheOnionRouter/TorFAQ#ServerOS "
2978 "for details.", uname
);
2981 if (options
->ORPort
== 0 && options
->ORListenAddress
!= NULL
)
2982 REJECT("ORPort must be defined if ORListenAddress is defined.");
2984 if (options
->DirPort
== 0 && options
->DirListenAddress
!= NULL
)
2985 REJECT("DirPort must be defined if DirListenAddress is defined.");
2987 if (options
->DNSPort
== 0 && options
->DNSListenAddress
!= NULL
)
2988 REJECT("DNSPort must be defined if DNSListenAddress is defined.");
2990 if (options
->ControlPort
== 0 && options
->ControlListenAddress
!= NULL
)
2991 REJECT("ControlPort must be defined if ControlListenAddress is defined.");
2993 if (options
->TransPort
== 0 && options
->TransListenAddress
!= NULL
)
2994 REJECT("TransPort must be defined if TransListenAddress is defined.");
2996 if (options
->NatdPort
== 0 && options
->NatdListenAddress
!= NULL
)
2997 REJECT("NatdPort must be defined if NatdListenAddress is defined.");
2999 /* Don't gripe about SocksPort 0 with SocksListenAddress set; a standard
3000 * configuration does this. */
3002 for (i
= 0; i
< 3; ++i
) {
3003 int is_socks
= i
==0;
3004 int is_trans
= i
==1;
3005 config_line_t
*line
, *opt
, *old
;
3008 opt
= options
->SocksListenAddress
;
3009 old
= old_options
? old_options
->SocksListenAddress
: NULL
;
3011 } else if (is_trans
) {
3012 opt
= options
->TransListenAddress
;
3013 old
= old_options
? old_options
->TransListenAddress
: NULL
;
3014 tp
= "transparent proxy";
3016 opt
= options
->NatdListenAddress
;
3017 old
= old_options
? old_options
->NatdListenAddress
: NULL
;
3021 for (line
= opt
; line
; line
= line
->next
) {
3022 char *address
= NULL
;
3025 if (parse_addr_port(LOG_WARN
, line
->value
, &address
, &addr
, &port
)<0)
3026 continue; /* We'll warn about this later. */
3027 if (!is_internal_IP(addr
, 1) &&
3028 (!old_options
|| !config_lines_eq(old
, opt
))) {
3030 "You specified a public address '%s' for a %s. Other "
3031 "people on the Internet might find your computer and use it as "
3032 "an open %s. Please don't allow this unless you have "
3033 "a good reason.", address
, tp
, tp
);
3039 if (validate_data_directory(options
)<0)
3040 REJECT("Invalid DataDirectory");
3042 if (options
->Nickname
== NULL
) {
3043 if (server_mode(options
)) {
3044 if (!(options
->Nickname
= get_default_nickname())) {
3045 log_notice(LD_CONFIG
, "Couldn't pick a nickname based on "
3046 "our hostname; using %s instead.", UNNAMED_ROUTER_NICKNAME
);
3047 options
->Nickname
= tor_strdup(UNNAMED_ROUTER_NICKNAME
);
3049 log_notice(LD_CONFIG
, "Choosing default nickname '%s'",
3054 if (!is_legal_nickname(options
->Nickname
)) {
3055 r
= tor_snprintf(buf
, sizeof(buf
),
3056 "Nickname '%s' is wrong length or contains illegal characters.",
3058 *msg
= tor_strdup(r
>= 0 ? buf
: "internal error");
3063 if (server_mode(options
) && !options
->ContactInfo
)
3064 log(LOG_NOTICE
, LD_CONFIG
, "Your ContactInfo config option is not set. "
3065 "Please consider setting it, so we can contact you if your server is "
3066 "misconfigured or something else goes wrong.");
3068 /* Special case on first boot if no Log options are given. */
3069 if (!options
->Logs
&& !options
->RunAsDaemon
&& !from_setconf
)
3070 config_line_append(&options
->Logs
, "Log", "notice stdout");
3072 if (options_init_logs(options
, 1)<0) /* Validate the log(s) */
3073 REJECT("Failed to validate Log options. See logs for details.");
3075 if (options
->NoPublish
) {
3076 log(LOG_WARN
, LD_CONFIG
,
3077 "NoPublish is obsolete. Use PublishServerDescriptor instead.");
3078 SMARTLIST_FOREACH(options
->PublishServerDescriptor
, char *, s
,
3080 smartlist_clear(options
->PublishServerDescriptor
);
3083 if (authdir_mode(options
)) {
3084 /* confirm that our address isn't broken, so we can complain now */
3086 if (resolve_my_address(LOG_WARN
, options
, &tmp
, NULL
) < 0)
3087 REJECT("Failed to resolve/guess local address. See logs for details.");
3091 if (options
->RunAsDaemon
&& torrc_fname
&& path_is_relative(torrc_fname
))
3092 REJECT("Can't use a relative path to torrc when RunAsDaemon is set.");
3095 if (options
->SocksPort
< 0 || options
->SocksPort
> 65535)
3096 REJECT("SocksPort option out of bounds.");
3098 if (options
->DNSPort
< 0 || options
->DNSPort
> 65535)
3099 REJECT("DNSPort option out of bounds.");
3101 if (options
->TransPort
< 0 || options
->TransPort
> 65535)
3102 REJECT("TransPort option out of bounds.");
3104 if (options
->NatdPort
< 0 || options
->NatdPort
> 65535)
3105 REJECT("NatdPort option out of bounds.");
3107 if (options
->SocksPort
== 0 && options
->TransPort
== 0 &&
3108 options
->NatdPort
== 0 && options
->ORPort
== 0 &&
3109 options
->DNSPort
== 0 && !options
->RendConfigLines
)
3110 log(LOG_WARN
, LD_CONFIG
,
3111 "SocksPort, TransPort, NatdPort, DNSPort, and ORPort are all "
3112 "undefined, and there aren't any hidden services configured. "
3113 "Tor will still run, but probably won't do anything.");
3115 if (options
->ControlPort
< 0 || options
->ControlPort
> 65535)
3116 REJECT("ControlPort option out of bounds.");
3118 if (options
->DirPort
< 0 || options
->DirPort
> 65535)
3119 REJECT("DirPort option out of bounds.");
3121 #ifndef USE_TRANSPARENT
3122 if (options
->TransPort
|| options
->TransListenAddress
)
3123 REJECT("TransPort and TransListenAddress are disabled in this build.");
3126 if (options
->AccountingMax
&&
3127 (is_listening_on_low_port(options
->ORPort
, options
->ORListenAddress
) ||
3128 is_listening_on_low_port(options
->DirPort
, options
->DirListenAddress
)))
3130 log(LOG_WARN
, LD_CONFIG
,
3131 "You have set AccountingMax to use hibernation. You have also "
3132 "chosen a low DirPort or OrPort. This combination can make Tor stop "
3133 "working when it tries to re-attach the port after a period of "
3134 "hibernation. Please choose a different port or turn off "
3135 "hibernation unless you know this combination will work on your "
3139 if (options
->ExcludeExitNodes
|| options
->ExcludeNodes
) {
3140 options
->_ExcludeExitNodesUnion
= routerset_new();
3141 routerset_union(options
->_ExcludeExitNodesUnion
,options
->ExcludeExitNodes
);
3142 routerset_union(options
->_ExcludeExitNodesUnion
,options
->ExcludeNodes
);
3145 if (options
->StrictExitNodes
&&
3146 (!options
->ExitNodes
) &&
3148 (old_options
->StrictExitNodes
!= options
->StrictExitNodes
) ||
3149 (!routerset_equal(old_options
->ExitNodes
,options
->ExitNodes
))))
3150 COMPLAIN("StrictExitNodes set, but no ExitNodes listed.");
3152 if (options
->StrictEntryNodes
&&
3153 (!options
->EntryNodes
) &&
3155 (old_options
->StrictEntryNodes
!= options
->StrictEntryNodes
) ||
3156 (!routerset_equal(old_options
->EntryNodes
,options
->EntryNodes
))))
3157 COMPLAIN("StrictEntryNodes set, but no EntryNodes listed.");
3159 if (options
->EntryNodes
&& !routerset_is_list(options
->EntryNodes
)) {
3160 /* XXXX fix this; see entry_guards_prepend_from_config(). */
3161 REJECT("IPs or countries are not yet supported in EntryNodes.");
3164 if (options
->AuthoritativeDir
) {
3165 if (!options
->ContactInfo
&& !options
->TestingTorNetwork
)
3166 REJECT("Authoritative directory servers must set ContactInfo");
3167 if (options
->V1AuthoritativeDir
&& !options
->RecommendedVersions
)
3168 REJECT("V1 authoritative dir servers must set RecommendedVersions.");
3169 if (!options
->RecommendedClientVersions
)
3170 options
->RecommendedClientVersions
=
3171 config_lines_dup(options
->RecommendedVersions
);
3172 if (!options
->RecommendedServerVersions
)
3173 options
->RecommendedServerVersions
=
3174 config_lines_dup(options
->RecommendedVersions
);
3175 if (options
->VersioningAuthoritativeDir
&&
3176 (!options
->RecommendedClientVersions
||
3177 !options
->RecommendedServerVersions
))
3178 REJECT("Versioning authoritative dir servers must set "
3179 "Recommended*Versions.");
3180 if (options
->UseEntryGuards
) {
3181 log_info(LD_CONFIG
, "Authoritative directory servers can't set "
3182 "UseEntryGuards. Disabling.");
3183 options
->UseEntryGuards
= 0;
3185 if (!options
->DownloadExtraInfo
&& authdir_mode_any_main(options
)) {
3186 log_info(LD_CONFIG
, "Authoritative directories always try to download "
3187 "extra-info documents. Setting DownloadExtraInfo.");
3188 options
->DownloadExtraInfo
= 1;
3190 if (!(options
->BridgeAuthoritativeDir
|| options
->HSAuthoritativeDir
||
3191 options
->V1AuthoritativeDir
|| options
->V2AuthoritativeDir
||
3192 options
->V3AuthoritativeDir
))
3193 REJECT("AuthoritativeDir is set, but none of "
3194 "(Bridge/HS/V1/V2/V3)AuthoritativeDir is set.");
3197 if (options
->AuthoritativeDir
&& !options
->DirPort
)
3198 REJECT("Running as authoritative directory, but no DirPort set.");
3200 if (options
->AuthoritativeDir
&& !options
->ORPort
)
3201 REJECT("Running as authoritative directory, but no ORPort set.");
3203 if (options
->AuthoritativeDir
&& options
->ClientOnly
)
3204 REJECT("Running as authoritative directory, but ClientOnly also set.");
3206 if (options
->HSAuthorityRecordStats
&& !options
->HSAuthoritativeDir
)
3207 REJECT("HSAuthorityRecordStats is set but we're not running as "
3208 "a hidden service authority.");
3210 if (options
->FetchDirInfoExtraEarly
&& !options
->FetchDirInfoEarly
)
3211 REJECT("FetchDirInfoExtraEarly requires that you also set "
3212 "FetchDirInfoEarly");
3214 if (options
->ConnLimit
<= 0) {
3215 r
= tor_snprintf(buf
, sizeof(buf
),
3216 "ConnLimit must be greater than 0, but was set to %d",
3217 options
->ConnLimit
);
3218 *msg
= tor_strdup(r
>= 0 ? buf
: "internal error");
3222 if (validate_ports_csv(options
->FirewallPorts
, "FirewallPorts", msg
) < 0)
3225 if (validate_ports_csv(options
->LongLivedPorts
, "LongLivedPorts", msg
) < 0)
3228 if (validate_ports_csv(options
->RejectPlaintextPorts
,
3229 "RejectPlaintextPorts", msg
) < 0)
3232 if (validate_ports_csv(options
->WarnPlaintextPorts
,
3233 "WarnPlaintextPorts", msg
) < 0)
3236 if (options
->FascistFirewall
&& !options
->ReachableAddresses
) {
3237 if (options
->FirewallPorts
&& smartlist_len(options
->FirewallPorts
)) {
3238 /* We already have firewall ports set, so migrate them to
3239 * ReachableAddresses, which will set ReachableORAddresses and
3240 * ReachableDirAddresses if they aren't set explicitly. */
3241 smartlist_t
*instead
= smartlist_create();
3242 config_line_t
*new_line
= tor_malloc_zero(sizeof(config_line_t
));
3243 new_line
->key
= tor_strdup("ReachableAddresses");
3244 /* If we're configured with the old format, we need to prepend some
3246 SMARTLIST_FOREACH(options
->FirewallPorts
, const char *, portno
,
3248 int p
= atoi(portno
);
3252 tor_snprintf(s
, 16, "*:%d", p
);
3253 smartlist_add(instead
, s
);
3255 new_line
->value
= smartlist_join_strings(instead
,",",0,NULL
);
3256 /* These have been deprecated since 0.1.1.5-alpha-cvs */
3257 log(LOG_NOTICE
, LD_CONFIG
,
3258 "Converting FascistFirewall and FirewallPorts "
3259 "config options to new format: \"ReachableAddresses %s\"",
3261 options
->ReachableAddresses
= new_line
;
3262 SMARTLIST_FOREACH(instead
, char *, cp
, tor_free(cp
));
3263 smartlist_free(instead
);
3265 /* We do not have FirewallPorts set, so add 80 to
3266 * ReachableDirAddresses, and 443 to ReachableORAddresses. */
3267 if (!options
->ReachableDirAddresses
) {
3268 config_line_t
*new_line
= tor_malloc_zero(sizeof(config_line_t
));
3269 new_line
->key
= tor_strdup("ReachableDirAddresses");
3270 new_line
->value
= tor_strdup("*:80");
3271 options
->ReachableDirAddresses
= new_line
;
3272 log(LOG_NOTICE
, LD_CONFIG
, "Converting FascistFirewall config option "
3273 "to new format: \"ReachableDirAddresses *:80\"");
3275 if (!options
->ReachableORAddresses
) {
3276 config_line_t
*new_line
= tor_malloc_zero(sizeof(config_line_t
));
3277 new_line
->key
= tor_strdup("ReachableORAddresses");
3278 new_line
->value
= tor_strdup("*:443");
3279 options
->ReachableORAddresses
= new_line
;
3280 log(LOG_NOTICE
, LD_CONFIG
, "Converting FascistFirewall config option "
3281 "to new format: \"ReachableORAddresses *:443\"");
3286 for (i
=0; i
<3; i
++) {
3287 config_line_t
**linep
=
3288 (i
==0) ? &options
->ReachableAddresses
:
3289 (i
==1) ? &options
->ReachableORAddresses
:
3290 &options
->ReachableDirAddresses
;
3293 /* We need to end with a reject *:*, not an implicit accept *:* */
3295 if (!strcmp((*linep
)->value
, "reject *:*")) /* already there */
3297 linep
= &((*linep
)->next
);
3299 *linep
= tor_malloc_zero(sizeof(config_line_t
));
3300 (*linep
)->key
= tor_strdup(
3301 (i
==0) ? "ReachableAddresses" :
3302 (i
==1) ? "ReachableORAddresses" :
3303 "ReachableDirAddresses");
3304 (*linep
)->value
= tor_strdup("reject *:*");
3310 if ((options
->ReachableAddresses
||
3311 options
->ReachableORAddresses
||
3312 options
->ReachableDirAddresses
) &&
3313 server_mode(options
))
3314 REJECT("Servers must be able to freely connect to the rest "
3315 "of the Internet, so they must not set Reachable*Addresses "
3316 "or FascistFirewall.");
3318 if (options
->UseBridges
&&
3319 server_mode(options
))
3320 REJECT("Servers must be able to freely connect to the rest "
3321 "of the Internet, so they must not set UseBridges.");
3323 options
->_AllowInvalid
= 0;
3324 if (options
->AllowInvalidNodes
) {
3325 SMARTLIST_FOREACH(options
->AllowInvalidNodes
, const char *, cp
, {
3326 if (!strcasecmp(cp
, "entry"))
3327 options
->_AllowInvalid
|= ALLOW_INVALID_ENTRY
;
3328 else if (!strcasecmp(cp
, "exit"))
3329 options
->_AllowInvalid
|= ALLOW_INVALID_EXIT
;
3330 else if (!strcasecmp(cp
, "middle"))
3331 options
->_AllowInvalid
|= ALLOW_INVALID_MIDDLE
;
3332 else if (!strcasecmp(cp
, "introduction"))
3333 options
->_AllowInvalid
|= ALLOW_INVALID_INTRODUCTION
;
3334 else if (!strcasecmp(cp
, "rendezvous"))
3335 options
->_AllowInvalid
|= ALLOW_INVALID_RENDEZVOUS
;
3337 r
= tor_snprintf(buf
, sizeof(buf
),
3338 "Unrecognized value '%s' in AllowInvalidNodes", cp
);
3339 *msg
= tor_strdup(r
>= 0 ? buf
: "internal error");
3345 if (compute_publishserverdescriptor(options
) < 0) {
3346 r
= tor_snprintf(buf
, sizeof(buf
),
3347 "Unrecognized value in PublishServerDescriptor");
3348 *msg
= tor_strdup(r
>= 0 ? buf
: "internal error");
3352 if ((options
->BridgeRelay
3353 || options
->_PublishServerDescriptor
& BRIDGE_AUTHORITY
)
3354 && (options
->_PublishServerDescriptor
3355 & (V1_AUTHORITY
|V2_AUTHORITY
|V3_AUTHORITY
))) {
3356 REJECT("Bridges are not supposed to publish router descriptors to the "
3357 "directory authorities. Please correct your "
3358 "PublishServerDescriptor line.");
3361 if (options
->MinUptimeHidServDirectoryV2
< 0) {
3362 log_warn(LD_CONFIG
, "MinUptimeHidServDirectoryV2 option must be at "
3363 "least 0 seconds. Changing to 0.");
3364 options
->MinUptimeHidServDirectoryV2
= 0;
3367 if (options
->RendPostPeriod
< MIN_REND_POST_PERIOD
) {
3368 log(LOG_WARN
,LD_CONFIG
,"RendPostPeriod option is too short; "
3369 "raising to %d seconds.", MIN_REND_POST_PERIOD
);
3370 options
->RendPostPeriod
= MIN_REND_POST_PERIOD
;
3373 if (options
->RendPostPeriod
> MAX_DIR_PERIOD
) {
3374 log(LOG_WARN
, LD_CONFIG
, "RendPostPeriod is too large; clipping to %ds.",
3376 options
->RendPostPeriod
= MAX_DIR_PERIOD
;
3379 if (options
->CircuitBuildTimeout
< MIN_CIRCUIT_BUILD_TIMEOUT
) {
3380 log(LOG_WARN
, LD_CONFIG
, "CircuitBuildTimeout option is too short; "
3381 "raising to %d seconds.", MIN_CIRCUIT_BUILD_TIMEOUT
);
3382 options
->CircuitBuildTimeout
= MIN_CIRCUIT_BUILD_TIMEOUT
;
3385 if (options
->MaxCircuitDirtiness
< MIN_MAX_CIRCUIT_DIRTINESS
) {
3386 log(LOG_WARN
, LD_CONFIG
, "MaxCircuitDirtiness option is too short; "
3387 "raising to %d seconds.", MIN_MAX_CIRCUIT_DIRTINESS
);
3388 options
->MaxCircuitDirtiness
= MIN_MAX_CIRCUIT_DIRTINESS
;
3391 if (options
->KeepalivePeriod
< 1)
3392 REJECT("KeepalivePeriod option must be positive.");
3394 if (ensure_bandwidth_cap(&options
->BandwidthRate
,
3395 "BandwidthRate", msg
) < 0)
3397 if (ensure_bandwidth_cap(&options
->BandwidthBurst
,
3398 "BandwidthBurst", msg
) < 0)
3400 if (ensure_bandwidth_cap(&options
->MaxAdvertisedBandwidth
,
3401 "MaxAdvertisedBandwidth", msg
) < 0)
3403 if (ensure_bandwidth_cap(&options
->RelayBandwidthRate
,
3404 "RelayBandwidthRate", msg
) < 0)
3406 if (ensure_bandwidth_cap(&options
->RelayBandwidthBurst
,
3407 "RelayBandwidthBurst", msg
) < 0)
3410 if (server_mode(options
)) {
3411 if (options
->BandwidthRate
< ROUTER_REQUIRED_MIN_BANDWIDTH
) {
3412 r
= tor_snprintf(buf
, sizeof(buf
),
3413 "BandwidthRate is set to %d bytes/second. "
3414 "For servers, it must be at least %d.",
3415 (int)options
->BandwidthRate
,
3416 ROUTER_REQUIRED_MIN_BANDWIDTH
);
3417 *msg
= tor_strdup(r
>= 0 ? buf
: "internal error");
3419 } else if (options
->MaxAdvertisedBandwidth
<
3420 ROUTER_REQUIRED_MIN_BANDWIDTH
/2) {
3421 r
= tor_snprintf(buf
, sizeof(buf
),
3422 "MaxAdvertisedBandwidth is set to %d bytes/second. "
3423 "For servers, it must be at least %d.",
3424 (int)options
->MaxAdvertisedBandwidth
,
3425 ROUTER_REQUIRED_MIN_BANDWIDTH
/2);
3426 *msg
= tor_strdup(r
>= 0 ? buf
: "internal error");
3429 if (options
->RelayBandwidthRate
&&
3430 options
->RelayBandwidthRate
< ROUTER_REQUIRED_MIN_BANDWIDTH
) {
3431 r
= tor_snprintf(buf
, sizeof(buf
),
3432 "RelayBandwidthRate is set to %d bytes/second. "
3433 "For servers, it must be at least %d.",
3434 (int)options
->RelayBandwidthRate
,
3435 ROUTER_REQUIRED_MIN_BANDWIDTH
);
3436 *msg
= tor_strdup(r
>= 0 ? buf
: "internal error");
3441 if (options
->RelayBandwidthRate
&& !options
->RelayBandwidthBurst
)
3442 options
->RelayBandwidthBurst
= options
->RelayBandwidthRate
;
3444 if (options
->RelayBandwidthRate
> options
->RelayBandwidthBurst
)
3445 REJECT("RelayBandwidthBurst must be at least equal "
3446 "to RelayBandwidthRate.");
3448 if (options
->BandwidthRate
> options
->BandwidthBurst
)
3449 REJECT("BandwidthBurst must be at least equal to BandwidthRate.");
3451 /* if they set relaybandwidth* really high but left bandwidth*
3452 * at the default, raise the defaults. */
3453 if (options
->RelayBandwidthRate
> options
->BandwidthRate
)
3454 options
->BandwidthRate
= options
->RelayBandwidthRate
;
3455 if (options
->RelayBandwidthBurst
> options
->BandwidthBurst
)
3456 options
->BandwidthBurst
= options
->RelayBandwidthBurst
;
3458 if (accounting_parse_options(options
, 1)<0)
3459 REJECT("Failed to parse accounting options. See logs for details.");
3461 if (options
->HttpProxy
) { /* parse it now */
3462 if (parse_addr_port(LOG_WARN
, options
->HttpProxy
, NULL
,
3463 &options
->HttpProxyAddr
, &options
->HttpProxyPort
) < 0)
3464 REJECT("HttpProxy failed to parse or resolve. Please fix.");
3465 if (options
->HttpProxyPort
== 0) { /* give it a default */
3466 options
->HttpProxyPort
= 80;
3470 if (options
->HttpProxyAuthenticator
) {
3471 if (strlen(options
->HttpProxyAuthenticator
) >= 48)
3472 REJECT("HttpProxyAuthenticator is too long (>= 48 chars).");
3475 if (options
->HttpsProxy
) { /* parse it now */
3476 if (parse_addr_port(LOG_WARN
, options
->HttpsProxy
, NULL
,
3477 &options
->HttpsProxyAddr
, &options
->HttpsProxyPort
) <0)
3478 REJECT("HttpsProxy failed to parse or resolve. Please fix.");
3479 if (options
->HttpsProxyPort
== 0) { /* give it a default */
3480 options
->HttpsProxyPort
= 443;
3484 if (options
->HttpsProxyAuthenticator
) {
3485 if (strlen(options
->HttpsProxyAuthenticator
) >= 48)
3486 REJECT("HttpsProxyAuthenticator is too long (>= 48 chars).");
3489 if (options
->HashedControlPassword
) {
3490 smartlist_t
*sl
= decode_hashed_passwords(options
->HashedControlPassword
);
3492 REJECT("Bad HashedControlPassword: wrong length or bad encoding");
3494 SMARTLIST_FOREACH(sl
, char*, cp
, tor_free(cp
));
3499 if (options
->HashedControlSessionPassword
) {
3500 smartlist_t
*sl
= decode_hashed_passwords(
3501 options
->HashedControlSessionPassword
);
3503 REJECT("Bad HashedControlSessionPassword: wrong length or bad encoding");
3505 SMARTLIST_FOREACH(sl
, char*, cp
, tor_free(cp
));
3510 if (options
->ControlListenAddress
) {
3511 int all_are_local
= 1;
3513 for (ln
= options
->ControlListenAddress
; ln
; ln
= ln
->next
) {
3514 if (strcmpstart(ln
->value
, "127."))
3517 if (!all_are_local
) {
3518 if (!options
->HashedControlPassword
&&
3519 !options
->HashedControlSessionPassword
&&
3520 !options
->CookieAuthentication
) {
3522 "You have a ControlListenAddress set to accept "
3523 "unauthenticated connections from a non-local address. "
3524 "This means that programs not running on your computer "
3525 "can reconfigure your Tor, without even having to guess a "
3526 "password. That's so bad that I'm closing your ControlPort "
3527 "for you. If you need to control your Tor remotely, try "
3528 "enabling authentication and using a tool like stunnel or "
3529 "ssh to encrypt remote access.");
3530 options
->ControlPort
= 0;
3532 log_warn(LD_CONFIG
, "You have a ControlListenAddress set to accept "
3533 "connections from a non-local address. This means that "
3534 "programs not running on your computer can reconfigure your "
3535 "Tor. That's pretty bad, since the controller "
3536 "protocol isn't encrypted! Maybe you should just listen on "
3537 "127.0.0.1 and use a tool like stunnel or ssh to encrypt "
3538 "remote connections to your control port.");
3543 if (options
->ControlPort
&& !options
->HashedControlPassword
&&
3544 !options
->HashedControlSessionPassword
&&
3545 !options
->CookieAuthentication
) {
3546 log_warn(LD_CONFIG
, "ControlPort is open, but no authentication method "
3547 "has been configured. This means that any program on your "
3548 "computer can reconfigure your Tor. That's bad! You should "
3549 "upgrade your Tor controller as soon as possible.");
3552 if (options
->UseEntryGuards
&& ! options
->NumEntryGuards
)
3553 REJECT("Cannot enable UseEntryGuards with NumEntryGuards set to 0");
3555 if (check_nickname_list(options
->MyFamily
, "MyFamily", msg
))
3557 for (cl
= options
->NodeFamilies
; cl
; cl
= cl
->next
) {
3558 if (check_nickname_list(cl
->value
, "NodeFamily", msg
))
3562 if (validate_addr_policies(options
, msg
) < 0)
3565 if (validate_dir_authorities(options
, old_options
) < 0)
3566 REJECT("Directory authority line did not parse. See logs for details.");
3568 if (options
->UseBridges
&& !options
->Bridges
)
3569 REJECT("If you set UseBridges, you must specify at least one bridge.");
3570 if (options
->UseBridges
&& !options
->TunnelDirConns
)
3571 REJECT("If you set UseBridges, you must set TunnelDirConns.");
3572 if (options
->Bridges
) {
3573 for (cl
= options
->Bridges
; cl
; cl
= cl
->next
) {
3574 if (parse_bridge_line(cl
->value
, 1)<0)
3575 REJECT("Bridge line did not parse. See logs for details.");
3579 if (options
->ConstrainedSockets
) {
3580 /* If the user wants to constrain socket buffer use, make sure the desired
3581 * limit is between MIN|MAX_TCPSOCK_BUFFER in k increments. */
3582 if (options
->ConstrainedSockSize
< MIN_CONSTRAINED_TCP_BUFFER
||
3583 options
->ConstrainedSockSize
> MAX_CONSTRAINED_TCP_BUFFER
||
3584 options
->ConstrainedSockSize
% 1024) {
3585 r
= tor_snprintf(buf
, sizeof(buf
),
3586 "ConstrainedSockSize is invalid. Must be a value between %d and %d "
3587 "in 1024 byte increments.",
3588 MIN_CONSTRAINED_TCP_BUFFER
, MAX_CONSTRAINED_TCP_BUFFER
);
3589 *msg
= tor_strdup(r
>= 0 ? buf
: "internal error");
3592 if (options
->DirPort
) {
3593 /* Providing cached directory entries while system TCP buffers are scarce
3594 * will exacerbate the socket errors. Suggest that this be disabled. */
3595 COMPLAIN("You have requested constrained socket buffers while also "
3596 "serving directory entries via DirPort. It is strongly "
3597 "suggested that you disable serving directory requests when "
3598 "system TCP buffer resources are scarce.");
3602 if (options
->V3AuthVoteDelay
+ options
->V3AuthDistDelay
>=
3603 options
->V3AuthVotingInterval
/2) {
3604 REJECT("V3AuthVoteDelay plus V3AuthDistDelay must be less than half "
3605 "V3AuthVotingInterval");
3607 if (options
->V3AuthVoteDelay
< MIN_VOTE_SECONDS
)
3608 REJECT("V3AuthVoteDelay is way too low.");
3609 if (options
->V3AuthDistDelay
< MIN_DIST_SECONDS
)
3610 REJECT("V3AuthDistDelay is way too low.");
3612 if (options
->V3AuthNIntervalsValid
< 2)
3613 REJECT("V3AuthNIntervalsValid must be at least 2.");
3615 if (options
->V3AuthVotingInterval
< MIN_VOTE_INTERVAL
) {
3616 REJECT("V3AuthVotingInterval is insanely low.");
3617 } else if (options
->V3AuthVotingInterval
> 24*60*60) {
3618 REJECT("V3AuthVotingInterval is insanely high.");
3619 } else if (((24*60*60) % options
->V3AuthVotingInterval
) != 0) {
3620 COMPLAIN("V3AuthVotingInterval does not divide evenly into 24 hours.");
3623 if (rend_config_services(options
, 1) < 0)
3624 REJECT("Failed to configure rendezvous options. See logs for details.");
3626 /* Parse client-side authorization for hidden services. */
3627 if (rend_parse_service_authorization(options
, 1) < 0)
3628 REJECT("Failed to configure client authorization for hidden services. "
3629 "See logs for details.");
3631 if (parse_virtual_addr_network(options
->VirtualAddrNetwork
, 1, NULL
)<0)
3634 if (options
->PreferTunneledDirConns
&& !options
->TunnelDirConns
)
3635 REJECT("Must set TunnelDirConns if PreferTunneledDirConns is set.");
3637 if (options
->AutomapHostsSuffixes
) {
3638 SMARTLIST_FOREACH(options
->AutomapHostsSuffixes
, char *, suf
,
3640 size_t len
= strlen(suf
);
3641 if (len
&& suf
[len
-1] == '.')
3646 if (options
->TestingTorNetwork
&& !options
->DirServers
) {
3647 REJECT("TestingTorNetwork may only be configured in combination with "
3648 "a non-default set of DirServers.");
3651 /*XXXX022 checking for defaults manually like this is a bit fragile.*/
3653 /* Keep changes to hard-coded values synchronous to man page and default
3655 if (options
->TestingV3AuthInitialVotingInterval
!= 30*60 &&
3656 !options
->TestingTorNetwork
) {
3657 REJECT("TestingV3AuthInitialVotingInterval may only be changed in testing "
3659 } else if (options
->TestingV3AuthInitialVotingInterval
< MIN_VOTE_INTERVAL
) {
3660 REJECT("TestingV3AuthInitialVotingInterval is insanely low.");
3661 } else if (((30*60) % options
->TestingV3AuthInitialVotingInterval
) != 0) {
3662 REJECT("TestingV3AuthInitialVotingInterval does not divide evenly into "
3666 if (options
->TestingV3AuthInitialVoteDelay
!= 5*60 &&
3667 !options
->TestingTorNetwork
) {
3668 REJECT("TestingV3AuthInitialVoteDelay may only be changed in testing "
3670 } else if (options
->TestingV3AuthInitialVoteDelay
< MIN_VOTE_SECONDS
) {
3671 REJECT("TestingV3AuthInitialVoteDelay is way too low.");
3674 if (options
->TestingV3AuthInitialDistDelay
!= 5*60 &&
3675 !options
->TestingTorNetwork
) {
3676 REJECT("TestingV3AuthInitialDistDelay may only be changed in testing "
3678 } else if (options
->TestingV3AuthInitialDistDelay
< MIN_DIST_SECONDS
) {
3679 REJECT("TestingV3AuthInitialDistDelay is way too low.");
3682 if (options
->TestingV3AuthInitialVoteDelay
+
3683 options
->TestingV3AuthInitialDistDelay
>=
3684 options
->TestingV3AuthInitialVotingInterval
/2) {
3685 REJECT("TestingV3AuthInitialVoteDelay plus TestingV3AuthInitialDistDelay "
3686 "must be less than half TestingV3AuthInitialVotingInterval");
3689 if (options
->TestingAuthDirTimeToLearnReachability
!= 30*60 &&
3690 !options
->TestingTorNetwork
) {
3691 REJECT("TestingAuthDirTimeToLearnReachability may only be changed in "
3692 "testing Tor networks!");
3693 } else if (options
->TestingAuthDirTimeToLearnReachability
< 0) {
3694 REJECT("TestingAuthDirTimeToLearnReachability must be non-negative.");
3695 } else if (options
->TestingAuthDirTimeToLearnReachability
> 2*60*60) {
3696 COMPLAIN("TestingAuthDirTimeToLearnReachability is insanely high.");
3699 if (options
->TestingEstimatedDescriptorPropagationTime
!= 10*60 &&
3700 !options
->TestingTorNetwork
) {
3701 REJECT("TestingEstimatedDescriptorPropagationTime may only be changed in "
3702 "testing Tor networks!");
3703 } else if (options
->TestingEstimatedDescriptorPropagationTime
< 0) {
3704 REJECT("TestingEstimatedDescriptorPropagationTime must be non-negative.");
3705 } else if (options
->TestingEstimatedDescriptorPropagationTime
> 60*60) {
3706 COMPLAIN("TestingEstimatedDescriptorPropagationTime is insanely high.");
3709 if (options
->TestingTorNetwork
) {
3710 log_warn(LD_CONFIG
, "TestingTorNetwork is set. This will make your node "
3711 "almost unusable in the public Tor network, and is "
3712 "therefore only advised if you are building a "
3713 "testing Tor network!");
3716 if (options
->AccelName
&& !options
->HardwareAccel
)
3717 options
->HardwareAccel
= 1;
3718 if (options
->AccelDir
&& !options
->AccelName
)
3719 REJECT("Can't use hardware crypto accelerator dir without engine name.");
3726 /** Helper: return true iff s1 and s2 are both NULL, or both non-NULL
3729 opt_streq(const char *s1
, const char *s2
)
3733 else if (s1
&& s2
&& !strcmp(s1
,s2
))
3739 /** Check if any of the previous options have changed but aren't allowed to. */
3741 options_transition_allowed(or_options_t
*old
, or_options_t
*new_val
,
3747 if (!opt_streq(old
->PidFile
, new_val
->PidFile
)) {
3748 *msg
= tor_strdup("PidFile is not allowed to change.");
3752 if (old
->RunAsDaemon
!= new_val
->RunAsDaemon
) {
3753 *msg
= tor_strdup("While Tor is running, changing RunAsDaemon "
3758 if (strcmp(old
->DataDirectory
,new_val
->DataDirectory
)!=0) {
3760 int r
= tor_snprintf(buf
, sizeof(buf
),
3761 "While Tor is running, changing DataDirectory "
3762 "(\"%s\"->\"%s\") is not allowed.",
3763 old
->DataDirectory
, new_val
->DataDirectory
);
3764 *msg
= tor_strdup(r
>= 0 ? buf
: "internal error");
3768 if (!opt_streq(old
->User
, new_val
->User
)) {
3769 *msg
= tor_strdup("While Tor is running, changing User is not allowed.");
3773 if (!opt_streq(old
->Group
, new_val
->Group
)) {
3774 *msg
= tor_strdup("While Tor is running, changing Group is not allowed.");
3778 if ((old
->HardwareAccel
!= new_val
->HardwareAccel
)
3779 || !opt_streq(old
->AccelName
, new_val
->AccelName
)
3780 || !opt_streq(old
->AccelDir
, new_val
->AccelDir
)) {
3781 *msg
= tor_strdup("While Tor is running, changing OpenSSL hardware "
3782 "acceleration engine is not allowed.");
3786 if (old
->TestingTorNetwork
!= new_val
->TestingTorNetwork
) {
3787 *msg
= tor_strdup("While Tor is running, changing TestingTorNetwork "
3795 /** Return 1 if any change from <b>old_options</b> to <b>new_options</b>
3796 * will require us to rotate the CPU and DNS workers; else return 0. */
3798 options_transition_affects_workers(or_options_t
*old_options
,
3799 or_options_t
*new_options
)
3801 if (!opt_streq(old_options
->DataDirectory
, new_options
->DataDirectory
) ||
3802 old_options
->NumCpus
!= new_options
->NumCpus
||
3803 old_options
->ORPort
!= new_options
->ORPort
||
3804 old_options
->ServerDNSSearchDomains
!=
3805 new_options
->ServerDNSSearchDomains
||
3806 old_options
->SafeLogging
!= new_options
->SafeLogging
||
3807 old_options
->ClientOnly
!= new_options
->ClientOnly
||
3808 !config_lines_eq(old_options
->Logs
, new_options
->Logs
))
3811 /* Check whether log options match. */
3813 /* Nothing that changed matters. */
3817 /** Return 1 if any change from <b>old_options</b> to <b>new_options</b>
3818 * will require us to generate a new descriptor; else return 0. */
3820 options_transition_affects_descriptor(or_options_t
*old_options
,
3821 or_options_t
*new_options
)
3823 /* XXX We can be smarter here. If your DirPort isn't being
3824 * published and you just turned it off, no need to republish. Etc. */
3825 if (!opt_streq(old_options
->DataDirectory
, new_options
->DataDirectory
) ||
3826 !opt_streq(old_options
->Nickname
,new_options
->Nickname
) ||
3827 !opt_streq(old_options
->Address
,new_options
->Address
) ||
3828 !config_lines_eq(old_options
->ExitPolicy
,new_options
->ExitPolicy
) ||
3829 old_options
->ExitPolicyRejectPrivate
!=
3830 new_options
->ExitPolicyRejectPrivate
||
3831 old_options
->ORPort
!= new_options
->ORPort
||
3832 old_options
->DirPort
!= new_options
->DirPort
||
3833 old_options
->ClientOnly
!= new_options
->ClientOnly
||
3834 old_options
->NoPublish
!= new_options
->NoPublish
||
3835 old_options
->_PublishServerDescriptor
!=
3836 new_options
->_PublishServerDescriptor
||
3837 get_effective_bwrate(old_options
) != get_effective_bwrate(new_options
) ||
3838 get_effective_bwburst(old_options
) !=
3839 get_effective_bwburst(new_options
) ||
3840 !opt_streq(old_options
->ContactInfo
, new_options
->ContactInfo
) ||
3841 !opt_streq(old_options
->MyFamily
, new_options
->MyFamily
) ||
3842 !opt_streq(old_options
->AccountingStart
, new_options
->AccountingStart
) ||
3843 old_options
->AccountingMax
!= new_options
->AccountingMax
)
3850 /** Return the directory on windows where we expect to find our application
3853 get_windows_conf_root(void)
3855 static int is_set
= 0;
3856 static char path
[MAX_PATH
+1];
3865 /* Find X:\documents and settings\username\application data\ .
3866 * We would use SHGetSpecialFolder path, but that wasn't added until IE4.
3868 #ifdef ENABLE_LOCAL_APPDATA
3869 #define APPDATA_PATH CSIDL_LOCAL_APPDATA
3871 #define APPDATA_PATH CSIDL_APPDATA
3873 if (!SUCCEEDED(SHGetSpecialFolderLocation(NULL
, APPDATA_PATH
, &idl
))) {
3874 GetCurrentDirectory(MAX_PATH
, path
);
3877 "I couldn't find your application data folder: are you "
3878 "running an ancient version of Windows 95? Defaulting to \"%s\"",
3882 /* Convert the path from an "ID List" (whatever that is!) to a path. */
3883 result
= SHGetPathFromIDList(idl
, path
);
3884 /* Now we need to free the */
3887 m
->lpVtbl
->Free(m
, idl
);
3888 m
->lpVtbl
->Release(m
);
3890 if (!SUCCEEDED(result
)) {
3893 strlcat(path
,"\\tor",MAX_PATH
);
3899 /** Return the default location for our torrc file. */
3901 get_default_conf_file(void)
3904 static char path
[MAX_PATH
+1];
3905 strlcpy(path
, get_windows_conf_root(), MAX_PATH
);
3906 strlcat(path
,"\\torrc",MAX_PATH
);
3909 return (CONFDIR
"/torrc");
3913 /** Verify whether lst is a string containing valid-looking comma-separated
3914 * nicknames, or NULL. Return 0 on success. Warn and return -1 on failure.
3917 check_nickname_list(const char *lst
, const char *name
, char **msg
)
3924 sl
= smartlist_create();
3926 smartlist_split_string(sl
, lst
, ",",
3927 SPLIT_SKIP_SPACE
|SPLIT_IGNORE_BLANK
|SPLIT_STRIP_SPACE
, 0);
3929 SMARTLIST_FOREACH(sl
, const char *, s
,
3931 if (!is_legal_nickname_or_hexdigest(s
)) {
3933 int tmp
= tor_snprintf(buf
, sizeof(buf
),
3934 "Invalid nickname '%s' in %s line", s
, name
);
3935 *msg
= tor_strdup(tmp
>= 0 ? buf
: "internal error");
3940 SMARTLIST_FOREACH(sl
, char *, s
, tor_free(s
));
3945 /** Learn config file name from command line arguments, or use the default */
3947 find_torrc_filename(int argc
, char **argv
,
3948 int *using_default_torrc
, int *ignore_missing_torrc
)
3953 for (i
= 1; i
< argc
; ++i
) {
3954 if (i
< argc
-1 && !strcmp(argv
[i
],"-f")) {
3956 log(LOG_WARN
, LD_CONFIG
, "Duplicate -f options on command line.");
3960 /* XXX one day we might want to extend expand_filename to work
3961 * under Windows as well. */
3962 fname
= tor_strdup(argv
[i
+1]);
3964 fname
= expand_filename(argv
[i
+1]);
3966 *using_default_torrc
= 0;
3968 } else if (!strcmp(argv
[i
],"--ignore-missing-torrc")) {
3969 *ignore_missing_torrc
= 1;
3973 if (*using_default_torrc
) {
3974 /* didn't find one, try CONFDIR */
3975 const char *dflt
= get_default_conf_file();
3976 if (dflt
&& file_status(dflt
) == FN_FILE
) {
3977 fname
= tor_strdup(dflt
);
3981 fn
= expand_filename("~/.torrc");
3982 if (fn
&& file_status(fn
) == FN_FILE
) {
3986 fname
= tor_strdup(dflt
);
3989 fname
= tor_strdup(dflt
);
3996 /** Load torrc from disk, setting torrc_fname if successful */
3998 load_torrc_from_disk(int argc
, char **argv
)
4002 int using_default_torrc
= 1;
4003 int ignore_missing_torrc
= 0;
4005 fname
= find_torrc_filename(argc
, argv
,
4006 &using_default_torrc
, &ignore_missing_torrc
);
4008 log(LOG_DEBUG
, LD_CONFIG
, "Opening config file \"%s\"", fname
);
4010 tor_free(torrc_fname
);
4011 torrc_fname
= fname
;
4013 /* Open config file */
4014 if (file_status(fname
) != FN_FILE
||
4015 !(cf
= read_file_to_str(fname
,0,NULL
))) {
4016 if (using_default_torrc
== 1 || ignore_missing_torrc
) {
4017 log(LOG_NOTICE
, LD_CONFIG
, "Configuration file \"%s\" not present, "
4018 "using reasonable defaults.", fname
);
4019 tor_free(fname
); /* sets fname to NULL */
4021 cf
= tor_strdup("");
4023 log(LOG_WARN
, LD_CONFIG
,
4024 "Unable to open configuration file \"%s\".", fname
);
4036 /** Read a configuration file into <b>options</b>, finding the configuration
4037 * file location based on the command line. After loading the file
4038 * call options_init_from_string() to load the config.
4039 * Return 0 if success, -1 if failure. */
4041 options_init_from_torrc(int argc
, char **argv
)
4044 int i
, retval
, command
;
4045 static char **backup_argv
;
4046 static int backup_argc
;
4047 char *command_arg
= NULL
;
4050 if (argv
) { /* first time we're called. save command line args */
4053 } else { /* we're reloading. need to clean up old options first. */
4057 if (argc
> 1 && (!strcmp(argv
[1], "-h") || !strcmp(argv
[1],"--help"))) {
4061 if (argc
> 1 && !strcmp(argv
[1], "--list-torrc-options")) {
4062 /* For documenting validating whether we've documented everything. */
4063 list_torrc_options();
4067 if (argc
> 1 && (!strcmp(argv
[1],"--version"))) {
4068 printf("Tor version %s.\n",get_version());
4071 if (argc
> 1 && (!strcmp(argv
[1],"--digests"))) {
4072 printf("Tor version %s.\n",get_version());
4073 printf("%s", libor_get_digests());
4074 printf("%s", tor_get_digests());
4078 /* Go through command-line variables */
4079 if (!global_cmdline_options
) {
4080 /* Or we could redo the list every time we pass this place.
4081 * It does not really matter */
4082 if (config_get_commandlines(argc
, argv
, &global_cmdline_options
) < 0) {
4087 command
= CMD_RUN_TOR
;
4088 for (i
= 1; i
< argc
; ++i
) {
4089 if (!strcmp(argv
[i
],"--list-fingerprint")) {
4090 command
= CMD_LIST_FINGERPRINT
;
4091 } else if (!strcmp(argv
[i
],"--hash-password")) {
4092 command
= CMD_HASH_PASSWORD
;
4093 command_arg
= tor_strdup( (i
< argc
-1) ? argv
[i
+1] : "");
4095 } else if (!strcmp(argv
[i
],"--verify-config")) {
4096 command
= CMD_VERIFY_CONFIG
;
4100 if (command
== CMD_HASH_PASSWORD
) {
4101 cf
= tor_strdup("");
4103 cf
= load_torrc_from_disk(argc
, argv
);
4108 retval
= options_init_from_string(cf
, command
, command_arg
, &errmsg
);
4117 log(LOG_WARN
,LD_CONFIG
,"%s", errmsg
);
4123 /** Load the options from the configuration in <b>cf</b>, validate
4124 * them for consistency and take actions based on them.
4126 * Return 0 if success, negative on error:
4127 * * -1 for general errors.
4128 * * -2 for failure to parse/validate,
4129 * * -3 for transition not allowed
4130 * * -4 for error while setting the new options
4133 options_init_from_string(const char *cf
,
4134 int command
, const char *command_arg
,
4137 or_options_t
*oldoptions
, *newoptions
;
4140 setopt_err_t err
= SETOPT_ERR_MISC
;
4143 oldoptions
= global_options
; /* get_options unfortunately asserts if
4144 this is the first time we run*/
4146 newoptions
= tor_malloc_zero(sizeof(or_options_t
));
4147 newoptions
->_magic
= OR_OPTIONS_MAGIC
;
4148 options_init(newoptions
);
4149 newoptions
->command
= command
;
4150 newoptions
->command_arg
= command_arg
;
4152 /* get config lines, assign them */
4153 retval
= config_get_lines(cf
, &cl
);
4155 err
= SETOPT_ERR_PARSE
;
4158 retval
= config_assign(&options_format
, newoptions
, cl
, 0, 0, msg
);
4159 config_free_lines(cl
);
4161 err
= SETOPT_ERR_PARSE
;
4165 /* Go through command-line variables too */
4166 retval
= config_assign(&options_format
, newoptions
,
4167 global_cmdline_options
, 0, 0, msg
);
4169 err
= SETOPT_ERR_PARSE
;
4173 /* If this is a testing network configuration, change defaults
4174 * for a list of dependent config options, re-initialize newoptions
4175 * with the new defaults, and assign all options to it second time. */
4176 if (newoptions
->TestingTorNetwork
) {
4177 /* XXXX this is a bit of a kludge. perhaps there's a better way to do
4178 * this? We could, for example, make the parsing algorithm do two passes
4179 * over the configuration. If it finds any "suite" options like
4180 * TestingTorNetwork, it could change the defaults before its second pass.
4181 * Not urgent so long as this seems to work, but at any sign of trouble,
4182 * let's clean it up. -NM */
4184 /* Change defaults. */
4186 for (i
= 0; testing_tor_network_defaults
[i
].name
; ++i
) {
4187 config_var_t
*new_var
= &testing_tor_network_defaults
[i
];
4188 config_var_t
*old_var
=
4189 config_find_option(&options_format
, new_var
->name
);
4190 tor_assert(new_var
);
4191 tor_assert(old_var
);
4192 old_var
->initvalue
= new_var
->initvalue
;
4195 /* Clear newoptions and re-initialize them with new defaults. */
4196 config_free(&options_format
, newoptions
);
4197 newoptions
= tor_malloc_zero(sizeof(or_options_t
));
4198 newoptions
->_magic
= OR_OPTIONS_MAGIC
;
4199 options_init(newoptions
);
4200 newoptions
->command
= command
;
4201 newoptions
->command_arg
= command_arg
;
4203 /* Assign all options a second time. */
4204 retval
= config_get_lines(cf
, &cl
);
4206 err
= SETOPT_ERR_PARSE
;
4209 retval
= config_assign(&options_format
, newoptions
, cl
, 0, 0, msg
);
4210 config_free_lines(cl
);
4212 err
= SETOPT_ERR_PARSE
;
4215 retval
= config_assign(&options_format
, newoptions
,
4216 global_cmdline_options
, 0, 0, msg
);
4218 err
= SETOPT_ERR_PARSE
;
4223 /* Validate newoptions */
4224 if (options_validate(oldoptions
, newoptions
, 0, msg
) < 0) {
4225 err
= SETOPT_ERR_PARSE
; /*XXX make this a separate return value.*/
4229 if (options_transition_allowed(oldoptions
, newoptions
, msg
) < 0) {
4230 err
= SETOPT_ERR_TRANSITION
;
4234 if (set_options(newoptions
, msg
)) {
4235 err
= SETOPT_ERR_SETTING
;
4236 goto err
; /* frees and replaces old options */
4242 config_free(&options_format
, newoptions
);
4244 int len
= strlen(*msg
)+256;
4245 char *newmsg
= tor_malloc(len
);
4247 tor_snprintf(newmsg
, len
, "Failed to parse/validate config: %s", *msg
);
4254 /** Return the location for our configuration file.
4257 get_torrc_fname(void)
4262 return get_default_conf_file();
4265 /** Adjust the address map based on the MapAddress elements in the
4266 * configuration <b>options</b>
4269 config_register_addressmaps(or_options_t
*options
)
4275 addressmap_clear_configured();
4276 elts
= smartlist_create();
4277 for (opt
= options
->AddressMap
; opt
; opt
= opt
->next
) {
4278 smartlist_split_string(elts
, opt
->value
, NULL
,
4279 SPLIT_SKIP_SPACE
|SPLIT_IGNORE_BLANK
, 2);
4280 if (smartlist_len(elts
) >= 2) {
4281 from
= smartlist_get(elts
,0);
4282 to
= smartlist_get(elts
,1);
4283 if (address_is_invalid_destination(to
, 1)) {
4285 "Skipping invalid argument '%s' to MapAddress", to
);
4287 addressmap_register(from
, tor_strdup(to
), 0, ADDRMAPSRC_TORRC
);
4288 if (smartlist_len(elts
)>2) {
4289 log_warn(LD_CONFIG
,"Ignoring extra arguments to MapAddress.");
4293 log_warn(LD_CONFIG
,"MapAddress '%s' has too few arguments. Ignoring.",
4296 SMARTLIST_FOREACH(elts
, char*, cp
, tor_free(cp
));
4297 smartlist_clear(elts
);
4299 smartlist_free(elts
);
4303 * Initialize the logs based on the configuration file.
4306 options_init_logs(or_options_t
*options
, int validate_only
)
4315 options
->RunAsDaemon
;
4319 elts
= smartlist_create();
4321 for (opt
= options
->Logs
; opt
; opt
= opt
->next
) {
4322 log_severity_list_t
*severity
;
4323 const char *cfg
= opt
->value
;
4324 severity
= tor_malloc_zero(sizeof(log_severity_list_t
));
4325 if (parse_log_severity_config(&cfg
, severity
) < 0) {
4326 log_warn(LD_CONFIG
, "Couldn't parse log levels in Log option 'Log %s'",
4328 ok
= 0; goto cleanup
;
4331 smartlist_split_string(elts
, cfg
, NULL
,
4332 SPLIT_SKIP_SPACE
|SPLIT_IGNORE_BLANK
, 2);
4334 if (smartlist_len(elts
) == 0)
4335 smartlist_add(elts
, tor_strdup("stdout"));
4337 if (smartlist_len(elts
) == 1 &&
4338 (!strcasecmp(smartlist_get(elts
,0), "stdout") ||
4339 !strcasecmp(smartlist_get(elts
,0), "stderr"))) {
4340 int err
= smartlist_len(elts
) &&
4341 !strcasecmp(smartlist_get(elts
,0), "stderr");
4342 if (!validate_only
) {
4345 "Can't log to %s with RunAsDaemon set; skipping stdout",
4346 err
?"stderr":"stdout");
4348 add_stream_log(severity
, err
?"<stderr>":"<stdout>",
4349 fileno(err
?stderr
:stdout
));
4354 if (smartlist_len(elts
) == 1 &&
4355 !strcasecmp(smartlist_get(elts
,0), "syslog")) {
4356 #ifdef HAVE_SYSLOG_H
4357 if (!validate_only
) {
4358 add_syslog_log(severity
);
4361 log_warn(LD_CONFIG
, "Syslog is not supported on this system. Sorry.");
4366 if (smartlist_len(elts
) == 2 &&
4367 !strcasecmp(smartlist_get(elts
,0), "file")) {
4368 if (!validate_only
) {
4369 if (add_file_log(severity
, smartlist_get(elts
, 1)) < 0) {
4370 log_warn(LD_CONFIG
, "Couldn't open file for 'Log %s': %s",
4371 opt
->value
, strerror(errno
));
4378 log_warn(LD_CONFIG
, "Bad syntax on file Log option 'Log %s'",
4380 ok
= 0; goto cleanup
;
4383 SMARTLIST_FOREACH(elts
, char*, cp
, tor_free(cp
));
4384 smartlist_clear(elts
);
4387 smartlist_free(elts
);
4392 /** Read the contents of a Bridge line from <b>line</b>. Return 0
4393 * if the line is well-formed, and -1 if it isn't. If
4394 * <b>validate_only</b> is 0, and the line is well-formed, then add
4395 * the bridge described in the line to our internal bridge list. */
4397 parse_bridge_line(const char *line
, int validate_only
)
4399 smartlist_t
*items
= NULL
;
4401 char *addrport
=NULL
, *fingerprint
=NULL
;
4404 char digest
[DIGEST_LEN
];
4406 items
= smartlist_create();
4407 smartlist_split_string(items
, line
, NULL
,
4408 SPLIT_SKIP_SPACE
|SPLIT_IGNORE_BLANK
, -1);
4409 if (smartlist_len(items
) < 1) {
4410 log_warn(LD_CONFIG
, "Too few arguments to Bridge line.");
4413 addrport
= smartlist_get(items
, 0);
4414 smartlist_del_keeporder(items
, 0);
4415 if (tor_addr_port_parse(addrport
, &addr
, &port
)<0) {
4416 log_warn(LD_CONFIG
, "Error parsing Bridge address '%s'", addrport
);
4421 "Bridge address '%s' has no port; using default port 443.",
4426 if (smartlist_len(items
)) {
4427 fingerprint
= smartlist_join_strings(items
, "", 0, NULL
);
4428 if (strlen(fingerprint
) != HEX_DIGEST_LEN
) {
4429 log_warn(LD_CONFIG
, "Key digest for Bridge is wrong length.");
4432 if (base16_decode(digest
, DIGEST_LEN
, fingerprint
, HEX_DIGEST_LEN
)<0) {
4433 log_warn(LD_CONFIG
, "Unable to decode Bridge key digest.");
4438 if (!validate_only
) {
4439 log_debug(LD_DIR
, "Bridge at %s:%d (%s)", fmt_addr(&addr
),
4441 fingerprint
? fingerprint
: "no key listed");
4442 bridge_add_from_config(&addr
, port
, fingerprint
? digest
: NULL
);
4452 SMARTLIST_FOREACH(items
, char*, s
, tor_free(s
));
4453 smartlist_free(items
);
4455 tor_free(fingerprint
);
4459 /** Read the contents of a DirServer line from <b>line</b>. If
4460 * <b>validate_only</b> is 0, and the line is well-formed, and it
4461 * shares any bits with <b>required_type</b> or <b>required_type</b>
4462 * is 0, then add the dirserver described in the line (minus whatever
4463 * bits it's missing) as a valid authority. Return 0 on success,
4464 * or -1 if the line isn't well-formed or if we can't add it. */
4466 parse_dir_server_line(const char *line
, authority_type_t required_type
,
4469 smartlist_t
*items
= NULL
;
4471 char *addrport
=NULL
, *address
=NULL
, *nickname
=NULL
, *fingerprint
=NULL
;
4472 uint16_t dir_port
= 0, or_port
= 0;
4473 char digest
[DIGEST_LEN
];
4474 char v3_digest
[DIGEST_LEN
];
4475 authority_type_t type
= V2_AUTHORITY
;
4476 int is_not_hidserv_authority
= 0, is_not_v2_authority
= 0;
4478 items
= smartlist_create();
4479 smartlist_split_string(items
, line
, NULL
,
4480 SPLIT_SKIP_SPACE
|SPLIT_IGNORE_BLANK
, -1);
4481 if (smartlist_len(items
) < 1) {
4482 log_warn(LD_CONFIG
, "No arguments on DirServer line.");
4486 if (is_legal_nickname(smartlist_get(items
, 0))) {
4487 nickname
= smartlist_get(items
, 0);
4488 smartlist_del_keeporder(items
, 0);
4491 while (smartlist_len(items
)) {
4492 char *flag
= smartlist_get(items
, 0);
4493 if (TOR_ISDIGIT(flag
[0]))
4495 if (!strcasecmp(flag
, "v1")) {
4496 type
|= (V1_AUTHORITY
| HIDSERV_AUTHORITY
);
4497 } else if (!strcasecmp(flag
, "hs")) {
4498 type
|= HIDSERV_AUTHORITY
;
4499 } else if (!strcasecmp(flag
, "no-hs")) {
4500 is_not_hidserv_authority
= 1;
4501 } else if (!strcasecmp(flag
, "bridge")) {
4502 type
|= BRIDGE_AUTHORITY
;
4503 } else if (!strcasecmp(flag
, "no-v2")) {
4504 is_not_v2_authority
= 1;
4505 } else if (!strcasecmpstart(flag
, "orport=")) {
4507 char *portstring
= flag
+ strlen("orport=");
4508 or_port
= (uint16_t) tor_parse_long(portstring
, 10, 1, 65535, &ok
, NULL
);
4510 log_warn(LD_CONFIG
, "Invalid orport '%s' on DirServer line.",
4512 } else if (!strcasecmpstart(flag
, "v3ident=")) {
4513 char *idstr
= flag
+ strlen("v3ident=");
4514 if (strlen(idstr
) != HEX_DIGEST_LEN
||
4515 base16_decode(v3_digest
, DIGEST_LEN
, idstr
, HEX_DIGEST_LEN
)<0) {
4516 log_warn(LD_CONFIG
, "Bad v3 identity digest '%s' on DirServer line",
4519 type
|= V3_AUTHORITY
;
4522 log_warn(LD_CONFIG
, "Unrecognized flag '%s' on DirServer line",
4526 smartlist_del_keeporder(items
, 0);
4528 if (is_not_hidserv_authority
)
4529 type
&= ~HIDSERV_AUTHORITY
;
4530 if (is_not_v2_authority
)
4531 type
&= ~V2_AUTHORITY
;
4533 if (smartlist_len(items
) < 2) {
4534 log_warn(LD_CONFIG
, "Too few arguments to DirServer line.");
4537 addrport
= smartlist_get(items
, 0);
4538 smartlist_del_keeporder(items
, 0);
4539 if (parse_addr_port(LOG_WARN
, addrport
, &address
, NULL
, &dir_port
)<0) {
4540 log_warn(LD_CONFIG
, "Error parsing DirServer address '%s'", addrport
);
4544 log_warn(LD_CONFIG
, "Missing port in DirServer address '%s'",addrport
);
4548 fingerprint
= smartlist_join_strings(items
, "", 0, NULL
);
4549 if (strlen(fingerprint
) != HEX_DIGEST_LEN
) {
4550 log_warn(LD_CONFIG
, "Key digest for DirServer is wrong length %d.",
4551 (int)strlen(fingerprint
));
4554 if (!strcmp(fingerprint
, "E623F7625FBE0C87820F11EC5F6D5377ED816294")) {
4555 /* a known bad fingerprint. refuse to use it. We can remove this
4556 * clause once Tor 0.1.2.17 is obsolete. */
4557 log_warn(LD_CONFIG
, "Dangerous dirserver line. To correct, erase your "
4558 "torrc file (%s), or reinstall Tor and use the default torrc.",
4562 if (base16_decode(digest
, DIGEST_LEN
, fingerprint
, HEX_DIGEST_LEN
)<0) {
4563 log_warn(LD_CONFIG
, "Unable to decode DirServer key digest.");
4567 if (!validate_only
&& (!required_type
|| required_type
& type
)) {
4569 type
&= required_type
; /* pare down what we think of them as an
4571 log_debug(LD_DIR
, "Trusted %d dirserver at %s:%d (%s)", (int)type
,
4572 address
, (int)dir_port
, (char*)smartlist_get(items
,0));
4573 if (!add_trusted_dir_server(nickname
, address
, dir_port
, or_port
,
4574 digest
, v3_digest
, type
))
4585 SMARTLIST_FOREACH(items
, char*, s
, tor_free(s
));
4586 smartlist_free(items
);
4590 tor_free(fingerprint
);
4594 /** Adjust the value of options->DataDirectory, or fill it in if it's
4595 * absent. Return 0 on success, -1 on failure. */
4597 normalize_data_directory(or_options_t
*options
)
4601 if (options
->DataDirectory
)
4602 return 0; /* all set */
4603 p
= tor_malloc(MAX_PATH
);
4604 strlcpy(p
,get_windows_conf_root(),MAX_PATH
);
4605 options
->DataDirectory
= p
;
4608 const char *d
= options
->DataDirectory
;
4612 if (strncmp(d
,"~/",2) == 0) {
4613 char *fn
= expand_filename(d
);
4615 log_warn(LD_CONFIG
,"Failed to expand filename \"%s\".", d
);
4618 if (!options
->DataDirectory
&& !strcmp(fn
,"/.tor")) {
4619 /* If our homedir is /, we probably don't want to use it. */
4620 /* Default to LOCALSTATEDIR/tor which is probably closer to what we
4623 "Default DataDirectory is \"~/.tor\". This expands to "
4624 "\"%s\", which is probably not what you want. Using "
4625 "\"%s"PATH_SEPARATOR
"tor\" instead
", fn, LOCALSTATEDIR);
4627 fn = tor_strdup(LOCALSTATEDIR PATH_SEPARATOR "tor
");
4629 tor_free(options->DataDirectory);
4630 options->DataDirectory = fn;
4636 /** Check and normalize the value of options->DataDirectory; return 0 if it
4637 * sane, -1 otherwise. */
4639 validate_data_directory(or_options_t *options)
4641 if (normalize_data_directory(options) < 0)
4643 tor_assert(options->DataDirectory);
4644 if (strlen(options->DataDirectory) > (512-128)) {
4645 log_warn(LD_CONFIG, "DataDirectory is too
long.");
4651 /** This string must remain the same forevermore. It is how we
4652 * recognize that the torrc file doesn't need to be backed up. */
4653 #define GENERATED_FILE_PREFIX "# This file was generated by Tor; " \
4654 "if you edit it, comments will not be preserved"
4655 /** This string can change; it tries to give the reader an idea
4656 * that editing this file by hand is not a good plan. */
4657 #define GENERATED_FILE_COMMENT "# The old torrc file was renamed " \
4658 "to torrc.orig.1 or similar, and Tor will ignore it"
4660 /** Save a configuration file for the configuration in <b>options</b>
4661 * into the file <b>fname</b>. If the file already exists, and
4662 * doesn't begin with GENERATED_FILE_PREFIX, rename it. Otherwise
4663 * replace it. Return 0 on success, -1 on failure. */
4665 write_configuration_file(const char *fname, or_options_t *options)
4667 char *old_val=NULL, *new_val=NULL, *new_conf=NULL;
4668 int rename_old = 0, r;
4673 switch (file_status(fname)) {
4675 old_val = read_file_to_str(fname, 0, NULL);
4676 if (strcmpstart(old_val, GENERATED_FILE_PREFIX)) {
4687 "Config file \"%s\" is not a file? Failing.", fname);
4691 if (!(new_conf = options_dump(options, 1))) {
4692 log_warn(LD_BUG, "Couldn't get configuration string");
4696 len = strlen(new_conf)+256;
4697 new_val = tor_malloc(len);
4698 tor_snprintf(new_val, len, "%s\n%s\n\n%s",
4699 GENERATED_FILE_PREFIX, GENERATED_FILE_COMMENT, new_conf);
4703 size_t fn_tmp_len = strlen(fname)+32;
4705 tor_assert(fn_tmp_len > strlen(fname)); /*check for overflow*/
4706 fn_tmp = tor_malloc(fn_tmp_len);
4708 if (tor_snprintf(fn_tmp, fn_tmp_len, "%s.orig.%d", fname, i)<0) {
4709 log_warn(LD_BUG, "tor_snprintf failed inexplicably");
4713 if (file_status(fn_tmp) == FN_NOENT)
4717 log_notice(LD_CONFIG, "Renaming old configuration file to \"%s\"", fn_tmp);
4718 if (rename(fname, fn_tmp) < 0) {
4720 "Couldn't rename configuration file \"%s\" to \"%s\": %s",
4721 fname, fn_tmp, strerror(errno));
4728 if (write_str_to_file(fname, new_val, 0) < 0)
4742 * Save the current configuration file value to disk. Return 0 on
4743 * success, -1 on failure.
4746 options_save_current(void)
4749 /* This fails if we can't write to our configuration file.
4751 * If we try falling back to datadirectory or something, we have a better
4752 * chance of saving the configuration, but a better chance of doing
4753 * something the user never expected. Let's just warn instead. */
4754 return write_configuration_file(torrc_fname, get_options());
4756 return write_configuration_file(get_default_conf_file(), get_options());
4759 /** Mapping from a unit name to a multiplier for converting that unit into a
4761 struct unit_table_t {
4763 uint64_t multiplier;
4766 /** Table to map the names of memory units to the number of bytes they
4768 static struct unit_table_t memory_units[] = {
4775 { "kbytes", 1<<10 },
4776 { "kilobyte", 1<<10 },
4777 { "kilobytes", 1<<10 },
4781 { "mbytes", 1<<20 },
4782 { "megabyte", 1<<20 },
4783 { "megabytes", 1<<20 },
4786 { "gbytes", 1<<30 },
4787 { "gigabyte", 1<<30 },
4788 { "gigabytes", 1<<30 },
4789 { "tb", U64_LITERAL(1)<<40 },
4790 { "terabyte", U64_LITERAL(1)<<40 },
4791 { "terabytes", U64_LITERAL(1)<<40 },
4795 /** Table to map the names of time units to the number of seconds they
4797 static struct unit_table_t time_units[] = {
4805 { "day", 24*60*60 },
4806 { "days", 24*60*60 },
4807 { "week", 7*24*60*60 },
4808 { "weeks", 7*24*60*60 },
4812 /** Parse a string <b>val</b> containing a number, zero or more
4813 * spaces, and an optional unit string. If the unit appears in the
4814 * table <b>u</b>, then multiply the number by the unit multiplier.
4815 * On success, set *<b>ok</b> to 1 and return this product.
4816 * Otherwise, set *<b>ok</b> to 0.
4819 config_parse_units(const char *val, struct unit_table_t *u, int *ok)
4828 sl = smartlist_create();
4829 smartlist_split_string(sl, val, NULL,
4830 SPLIT_SKIP_SPACE|SPLIT_IGNORE_BLANK, 3);
4832 if (smartlist_len(sl) < 1 || smartlist_len(sl) > 2) {
4837 v = tor_parse_uint64(smartlist_get(sl,0), 10, 0, UINT64_MAX, ok, NULL);
4839 int r = sscanf(smartlist_get(sl,0), "%lf", &d);
4840 if (r == 0 || d < 0)
4845 if (smartlist_len(sl) == 1) {
4847 v = use_float ? DBL_TO_U64(d) : v;
4851 for ( ;u->unit;++u) {
4852 if (!strcasecmp(u->unit, smartlist_get(sl,1))) {
4854 v = u->multiplier * d;
4861 log_warn(LD_CONFIG, "Unknown unit '%s'.", (char*)smartlist_get(sl,1));
4864 SMARTLIST_FOREACH(sl, char *, cp, tor_free(cp));
4873 /** Parse a string in the format "number unit", where unit is a unit of
4874 * information (byte, KB, M, etc). On success, set *<b>ok</b> to true
4875 * and return the number of bytes specified. Otherwise, set
4876 * *<b>ok</b> to false and return 0. */
4878 config_parse_memunit(const char *s, int *ok)
4880 return config_parse_units(s, memory_units, ok);
4883 /** Parse a string in the format "number unit", where unit is a unit of time.
4884 * On success, set *<b>ok</b> to true and return the number of seconds in
4885 * the provided interval. Otherwise, set *<b>ok</b> to 0 and return -1.
4888 config_parse_interval(const char *s, int *ok)
4891 r = config_parse_units(s, time_units, ok);
4895 log_warn(LD_CONFIG, "Interval '%s' is too long", s);
4903 * Initialize the libevent library.
4908 const char *badness=NULL;
4910 configure_libevent_logging();
4911 /* If the kernel complains that some method (say, epoll) doesn't
4912 * exist, we don't care about it, since libevent will cope.
4914 suppress_libevent_log_msg("Function not implemented");
4916 tor_check_libevent_header_compatibility();
4918 tor_libevent_initialize();
4920 suppress_libevent_log_msg(NULL);
4922 tor_check_libevent_version(tor_libevent_get_method(),
4923 get_options()->ORPort != 0,
4926 const char *v = tor_libevent_get_version_str();
4927 const char *m = tor_libevent_get_method();
4928 control_event_general_status(LOG_WARN,
4929 "BAD_LIBEVENT VERSION=%s METHOD=%s BADNESS=%s RECOVERED=NO",
4934 /** Return the persistent state struct for this Tor. */
4938 tor_assert(global_state);
4939 return global_state;
4942 /** Return a newly allocated string holding a filename relative to the data
4943 * directory. If <b>sub1</b> is present, it is the first path component after
4944 * the data directory. If <b>sub2</b> is also present, it is the second path
4945 * component after the data directory. If <b>suffix</b> is present, it
4946 * is appended to the filename.
4949 * get_datadir_fname2_suffix("a", NULL, NULL) -> $DATADIR/a
4950 * get_datadir_fname2_suffix("a", NULL, ".tmp") -> $DATADIR/a.tmp
4951 * get_datadir_fname2_suffix("a", "b", ".tmp") -> $DATADIR/a/b/.tmp
4952 * get_datadir_fname2_suffix("a", "b", NULL) -> $DATADIR/a/b
4954 * Note: Consider using the get_datadir_fname* macros in or.h.
4957 options_get_datadir_fname2_suffix(or_options_t *options,
4958 const char *sub1, const char *sub2,
4963 tor_assert(options);
4964 tor_assert(options->DataDirectory);
4965 tor_assert(sub1 || !sub2); /* If sub2 is present, sub1 must be present. */
4966 len = strlen(options->DataDirectory);
4968 len += strlen(sub1)+1;
4970 len += strlen(sub2)+1;
4973 len += strlen(suffix);
4975 fname = tor_malloc(len);
4978 tor_snprintf(fname, len, "%s"PATH_SEPARATOR"%s"PATH_SEPARATOR"%s",
4979 options->DataDirectory, sub1, sub2);
4981 tor_snprintf(fname, len, "%s"PATH_SEPARATOR"%s",
4982 options->DataDirectory, sub1);
4985 strlcpy(fname, options->DataDirectory, len);
4988 strlcat(fname, suffix, len);
4992 /** Return 0 if every setting in <b>state</b> is reasonable, and a
4993 * permissible transition from <b>old_state</b>. Else warn and return -1.
4994 * Should have no side effects, except for normalizing the contents of
4997 /* XXX from_setconf is here because of bug 238 */
4999 or_state_validate(or_state_t *old_state, or_state_t *state,
5000 int from_setconf, char **msg)
5002 /* We don't use these; only options do. Still, we need to match that
5004 (void) from_setconf;
5007 if (entry_guards_parse_state(state, 0, msg)<0)
5013 /** Replace the current persistent state with <b>new_state</b> */
5015 or_state_set(or_state_t *new_state)
5018 tor_assert(new_state);
5020 config_free(&state_format, global_state);
5021 global_state = new_state;
5022 if (entry_guards_parse_state(global_state, 1, &err)<0) {
5023 log_warn(LD_GENERAL,"%s",err);
5026 if (rep_hist_load_state(global_state, &err)<0) {
5027 log_warn(LD_GENERAL,"Unparseable bandwidth history state: %s",err);
5032 /** Reload the persistent state from disk, generating a new state as needed.
5033 * Return 0 on success, less than 0 on failure.
5038 or_state_t *new_state = NULL;
5039 char *contents = NULL, *fname;
5040 char *errmsg = NULL;
5041 int r = -1, badstate = 0;
5043 fname = get_datadir_fname("state");
5044 switch (file_status(fname)) {
5046 if (!(contents = read_file_to_str(fname, 0, NULL))) {
5047 log_warn(LD_FS, "Unable to read state file \"%s\"", fname);
5056 log_warn(LD_GENERAL,"State file \"%s\" is not a file? Failing.", fname);
5059 new_state = tor_malloc_zero(sizeof(or_state_t));
5060 new_state->_magic = OR_STATE_MAGIC;
5061 config_init(&state_format, new_state);
5063 config_line_t *lines=NULL;
5065 if (config_get_lines(contents, &lines)<0)
5067 assign_retval = config_assign(&state_format, new_state,
5068 lines, 0, 0, &errmsg);
5069 config_free_lines(lines);
5070 if (assign_retval<0)
5073 log_warn(LD_GENERAL, "%s", errmsg);
5078 if (!badstate && or_state_validate(NULL, new_state, 1, &errmsg) < 0)
5082 log_warn(LD_GENERAL, "%s", errmsg);
5086 if (badstate && !contents) {
5087 log_warn(LD_BUG, "Uh oh. We couldn't even validate our own default state."
5088 " This is a bug in Tor.");
5090 } else if (badstate && contents) {
5092 file_status_t status;
5093 size_t len = strlen(fname)+16;
5094 char *fname2 = tor_malloc(len);
5095 for (i = 0; i < 100; ++i) {
5096 tor_snprintf(fname2, len, "%s.%d", fname, i);
5097 status = file_status(fname2);
5098 if (status == FN_NOENT)
5102 log_warn(LD_BUG, "Unable to parse state in \"%s\"; too many saved bad "
5103 "state files to move aside. Discarding the old state file.",
5107 log_warn(LD_BUG, "Unable to parse state in \"%s\". Moving it aside "
5108 "to \"%s\". This could be a bug in Tor; please tell "
5109 "the developers.", fname, fname2);
5110 if (rename(fname, fname2) < 0) {
5111 log_warn(LD_BUG, "Weirdly, I couldn't even move the state aside. The "
5112 "OS gave an error of %s", strerror(errno));
5117 config_free(&state_format, new_state);
5119 new_state = tor_malloc_zero(sizeof(or_state_t));
5120 new_state->_magic = OR_STATE_MAGIC;
5121 config_init(&state_format, new_state);
5122 } else if (contents) {
5123 log_info(LD_GENERAL, "Loaded state from \"%s\"", fname);
5125 log_info(LD_GENERAL, "Initialized state");
5127 or_state_set(new_state);
5130 global_state->next_write = 0;
5131 or_state_save(time(NULL));
5139 config_free(&state_format, new_state);
5144 /** Write the persistent state to disk. Return 0 for success, <0 on failure. */
5146 or_state_save(time_t now)
5148 char *state, *contents;
5149 char tbuf[ISO_TIME_LEN+1];
5153 tor_assert(global_state);
5155 if (global_state->next_write > now)
5158 /* Call everything else that might dirty the state even more, in order
5159 * to avoid redundant writes. */
5160 entry_guards_update_state(global_state);
5161 rep_hist_update_state(global_state);
5162 if (accounting_is_enabled(get_options()))
5163 accounting_run_housekeeping(now);
5165 global_state->LastWritten = time(NULL);
5166 tor_free(global_state->TorVersion);
5167 len = strlen(get_version())+8;
5168 global_state->TorVersion = tor_malloc(len);
5169 tor_snprintf(global_state->TorVersion, len, "Tor %s", get_version());
5171 state = config_dump(&state_format, global_state, 1, 0);
5172 len = strlen(state)+256;
5173 contents = tor_malloc(len);
5174 format_local_iso_time(tbuf, time(NULL));
5175 tor_snprintf(contents, len,
5176 "# Tor state file last generated on %s local time\n"
5177 "# Other times below are in GMT\n"
5178 "# You *do not* need to edit this file.\n\n%s",
5181 fname = get_datadir_fname("state");
5182 if (write_str_to_file(fname, contents, 0)<0) {
5183 log_warn(LD_FS, "Unable to write state to file \"%s\"", fname);
5188 log_info(LD_GENERAL, "Saved state to \"%s\"", fname);
5192 global_state->next_write = TIME_MAX;
5196 /** Given a file name check to see whether the file exists but has not been
5197 * modified for a very long time. If so, remove it. */
5199 remove_file_if_very_old(const char *fname, time_t now)
5201 #define VERY_OLD_FILE_AGE (28*24*60*60)
5204 if (stat(fname, &st)==0 && st.st_mtime < now-VERY_OLD_FILE_AGE) {
5205 char buf[ISO_TIME_LEN+1];
5206 format_local_iso_time(buf, st.st_mtime);
5207 log_notice(LD_GENERAL, "Obsolete file %s hasn't been modified since %s. "
5208 "Removing it.", fname, buf);
5213 /** Helper to implement GETINFO functions about configuration variables (not
5214 * their values). Given a "config/names" question, set *<b>answer</b> to a
5215 * new string describing the supported configuration variables and their
5218 getinfo_helper_config(control_connection_t *conn,
5219 const char *question, char **answer)
5222 if (!strcmp(question, "config/names")) {
5223 smartlist_t *sl = smartlist_create();
5225 for (i = 0; _option_vars[i].name; ++i) {
5226 config_var_t *var = &_option_vars[i];
5227 const char *type, *desc;
5230 desc = config_find_description(&options_format, var->name);
5231 switch (var->type) {
5232 case CONFIG_TYPE_STRING: type = "String"; break;
5233 case CONFIG_TYPE_FILENAME: type = "Filename"; break;
5234 case CONFIG_TYPE_UINT: type = "Integer"; break;
5235 case CONFIG_TYPE_INTERVAL: type = "TimeInterval"; break;
5236 case CONFIG_TYPE_MEMUNIT: type = "DataSize"; break;
5237 case CONFIG_TYPE_DOUBLE: type = "Float"; break;
5238 case CONFIG_TYPE_BOOL: type = "Boolean"; break;
5239 case CONFIG_TYPE_ISOTIME: type = "Time"; break;
5240 case CONFIG_TYPE_ROUTERSET: type = "RouterList"; break;
5241 case CONFIG_TYPE_CSV: type = "CommaList"; break;
5242 case CONFIG_TYPE_LINELIST: type = "LineList"; break;
5243 case CONFIG_TYPE_LINELIST_S: type = "Dependant"; break;
5244 case CONFIG_TYPE_LINELIST_V: type = "Virtual"; break;
5246 case CONFIG_TYPE_OBSOLETE:
5251 len = strlen(var->name)+strlen(type)+16;
5253 len += strlen(desc);
5254 line = tor_malloc(len);
5256 tor_snprintf(line, len, "%s %s %s\n",var->name,type,desc);
5258 tor_snprintf(line, len, "%s %s\n",var->name,type);
5259 smartlist_add(sl, line);
5261 *answer = smartlist_join_strings(sl, "", 0, NULL);
5262 SMARTLIST_FOREACH(sl, char *, c, tor_free(c));