[tor-bugs] #31189 [Core Tor/Tor]: potential docs update needed for GuardLifetime?

[Tor Bug Tracker & Wiki]

#31189: potential docs update needed for GuardLifetime?
---------------------------------+------------------------------
 Reporter:  cypherpunks          |          Owner:  (none)
     Type:  defect               |         Status:  new
 Priority:  Medium               |      Component:  Core Tor/Tor
  Version:                       |       Severity:  Normal
 Keywords:  docs, guardlifetime  |  Actual Points:
Parent ID:                       |         Points:
 Reviewer:                       |        Sponsor:
---------------------------------+------------------------------
 The documentation for the GuardLifetime torrc option says:

 {{{
 If nonzero, and UseEntryGuards is set, minimum time to keep a guard before
     picking a new one. If zero, we use the GuardLifetime parameter from
 the
     consensus directory.  No value here may  be less than 1 month or
 greater
     than 5 years; out-of-range values are clamped. (Default: 0)
 }}}

 In commit hash 385602e9826e79dbf0d8b51abfd925e59f275708 it appears that
 there was a behavior change which allows guard lifetimes of 1 day or
 greater (grep for `get_options()->GuardLifetime >= 86400`). `git blame`
 indicated the docs for the `GuardLifetime` option haven't been touched in
 6-7 years, so I think they need an update after this change.

 Is the expected behavior that setting `UseEntryGuards 1` and
 `GuardLifetime 1 day` will result in guards being used for no longer than
 one day?

--
Ticket URL: <https://trac.torproject.org/projects/tor/ticket/31189>
Tor Bug Tracker & Wiki <https://trac.torproject.org/>
The Tor Project: anonymity online