clientParameters.go 29 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706
  1. /*
  2. * Copyright (c) 2018, Psiphon Inc.
  3. * All rights reserved.
  4. *
  5. * This program is free software: you can redistribute it and/or modify
  6. * it under the terms of the GNU General Public License as published by
  7. * the Free Software Foundation, either version 3 of the License, or
  8. * (at your option) any later version.
  9. *
  10. * This program is distributed in the hope that it will be useful,
  11. * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12. * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  13. * GNU General Public License for more details.
  14. *
  15. * You should have received a copy of the GNU General Public License
  16. * along with this program. If not, see <http://www.gnu.org/licenses/>.
  17. *
  18. */
  19. /*
  20. Package parameters implements dynamic, concurrency-safe parameters that
  21. determine Psiphon client behavior.
  22. Parameters include network timeouts, probabilities for actions, lists of
  23. protocols, etc. Parameters are initialized with reasonable defaults. New
  24. values may be applied, allowing the client to customized its parameters from
  25. both a config file and tactics data. Sane minimum values are enforced.
  26. Parameters may be read and updated concurrently. The read mechanism offers a
  27. snapshot so that related parameters, such as two Ints representing a range; or
  28. a more complex series of related parameters; may be read in an atomic and
  29. consistent way. For example:
  30. p := clientParameters.Get()
  31. min := p.Int("Min")
  32. max := p.Int("Max")
  33. p = nil
  34. For long-running operations, it is recommended to set any pointer to the
  35. snapshot to nil to allow garbage collection of old snaphots in cases where the
  36. parameters change.
  37. In general, client parameters should be read as close to the point of use as
  38. possible to ensure that dynamic changes to the parameter values take effect.
  39. For duration parameters, time.ParseDuration-compatible string values are
  40. supported when applying new values. This allows specifying durations as, for
  41. example, "100ms" or "24h".
  42. Values read from the parameters are not deep copies and must be treated as
  43. read-only.
  44. */
  45. package parameters
  46. import (
  47. "encoding/json"
  48. "fmt"
  49. "net/http"
  50. "reflect"
  51. "sync/atomic"
  52. "time"
  53. "github.com/Psiphon-Labs/psiphon-tunnel-core/psiphon/common"
  54. "github.com/Psiphon-Labs/psiphon-tunnel-core/psiphon/common/obfuscator"
  55. "github.com/Psiphon-Labs/psiphon-tunnel-core/psiphon/common/protocol"
  56. )
  57. const (
  58. NetworkLatencyMultiplier = "NetworkLatencyMultiplier"
  59. TacticsWaitPeriod = "TacticsWaitPeriod"
  60. TacticsRetryPeriod = "TacticsRetryPeriod"
  61. TacticsRetryPeriodJitter = "TacticsRetryPeriodJitter"
  62. TacticsTimeout = "TacticsTimeout"
  63. ConnectionWorkerPoolSize = "ConnectionWorkerPoolSize"
  64. TunnelConnectTimeout = "TunnelConnectTimeout"
  65. EstablishTunnelTimeout = "EstablishTunnelTimeout"
  66. EstablishTunnelWorkTime = "EstablishTunnelWorkTime"
  67. EstablishTunnelPausePeriod = "EstablishTunnelPausePeriod"
  68. EstablishTunnelPausePeriodJitter = "EstablishTunnelPausePeriodJitter"
  69. EstablishTunnelServerAffinityGracePeriod = "EstablishTunnelServerAffinityGracePeriod"
  70. StaggerConnectionWorkersPeriod = "StaggerConnectionWorkersPeriod"
  71. StaggerConnectionWorkersJitter = "StaggerConnectionWorkersJitter"
  72. LimitMeekConnectionWorkers = "LimitMeekConnectionWorkers"
  73. IgnoreHandshakeStatsRegexps = "IgnoreHandshakeStatsRegexps"
  74. PrioritizeTunnelProtocols = "PrioritizeTunnelProtocols"
  75. PrioritizeTunnelProtocolsCandidateCount = "PrioritizeTunnelProtocolsCandidateCount"
  76. LimitTunnelProtocols = "LimitTunnelProtocols"
  77. LimitTLSProfiles = "LimitTLSProfiles"
  78. FragmentorProbability = "FragmentorProbability"
  79. FragmentorLimitProtocols = "FragmentorLimitProtocols"
  80. FragmentorMinTotalBytes = "FragmentorMinTotalBytes"
  81. FragmentorMaxTotalBytes = "FragmentorMaxTotalBytes"
  82. FragmentorMinWriteBytes = "FragmentorMinWriteBytes"
  83. FragmentorMaxWriteBytes = "FragmentorMaxWriteBytes"
  84. FragmentorMinDelay = "FragmentorMinDelay"
  85. FragmentorMaxDelay = "FragmentorMaxDelay"
  86. ObfuscatedSSHMinPadding = "ObfuscatedSSHMinPadding"
  87. ObfuscatedSSHMaxPadding = "ObfuscatedSSHMaxPadding"
  88. TunnelOperateShutdownTimeout = "TunnelOperateShutdownTimeout"
  89. TunnelPortForwardDialTimeout = "TunnelPortForwardDialTimeout"
  90. TunnelRateLimits = "TunnelRateLimits"
  91. AdditionalCustomHeaders = "AdditionalCustomHeaders"
  92. SpeedTestPaddingMinBytes = "SpeedTestPaddingMinBytes"
  93. SpeedTestPaddingMaxBytes = "SpeedTestPaddingMaxBytes"
  94. SpeedTestMaxSampleCount = "SpeedTestMaxSampleCount"
  95. SSHKeepAliveSpeedTestSampleProbability = "SSHKeepAliveSpeedTestSampleProbability"
  96. SSHKeepAlivePaddingMinBytes = "SSHKeepAlivePaddingMinBytes"
  97. SSHKeepAlivePaddingMaxBytes = "SSHKeepAlivePaddingMaxBytes"
  98. SSHKeepAlivePeriodMin = "SSHKeepAlivePeriodMin"
  99. SSHKeepAlivePeriodMax = "SSHKeepAlivePeriodMax"
  100. SSHKeepAlivePeriodicTimeout = "SSHKeepAlivePeriodicTimeout"
  101. SSHKeepAlivePeriodicInactivePeriod = "SSHKeepAlivePeriodicInactivePeriod"
  102. SSHKeepAliveProbeTimeout = "SSHKeepAliveProbeTimeout"
  103. SSHKeepAliveProbeInactivePeriod = "SSHKeepAliveProbeInactivePeriod"
  104. HTTPProxyOriginServerTimeout = "HTTPProxyOriginServerTimeout"
  105. HTTPProxyMaxIdleConnectionsPerHost = "HTTPProxyMaxIdleConnectionsPerHost"
  106. FetchRemoteServerListTimeout = "FetchRemoteServerListTimeout"
  107. FetchRemoteServerListRetryPeriod = "FetchRemoteServerListRetryPeriod"
  108. FetchRemoteServerListStalePeriod = "FetchRemoteServerListStalePeriod"
  109. RemoteServerListSignaturePublicKey = "RemoteServerListSignaturePublicKey"
  110. RemoteServerListURLs = "RemoteServerListURLs"
  111. ObfuscatedServerListRootURLs = "ObfuscatedServerListRootURLs"
  112. PsiphonAPIRequestTimeout = "PsiphonAPIRequestTimeout"
  113. PsiphonAPIStatusRequestPeriodMin = "PsiphonAPIStatusRequestPeriodMin"
  114. PsiphonAPIStatusRequestPeriodMax = "PsiphonAPIStatusRequestPeriodMax"
  115. PsiphonAPIStatusRequestShortPeriodMin = "PsiphonAPIStatusRequestShortPeriodMin"
  116. PsiphonAPIStatusRequestShortPeriodMax = "PsiphonAPIStatusRequestShortPeriodMax"
  117. PsiphonAPIStatusRequestPaddingMinBytes = "PsiphonAPIStatusRequestPaddingMinBytes"
  118. PsiphonAPIStatusRequestPaddingMaxBytes = "PsiphonAPIStatusRequestPaddingMaxBytes"
  119. PsiphonAPIPersistentStatsMaxCount = "PsiphonAPIPersistentStatsMaxCount"
  120. PsiphonAPIConnectedRequestPeriod = "PsiphonAPIConnectedRequestPeriod"
  121. PsiphonAPIConnectedRequestRetryPeriod = "PsiphonAPIConnectedRequestRetryPeriod"
  122. FetchSplitTunnelRoutesTimeout = "FetchSplitTunnelRoutesTimeout"
  123. SplitTunnelRoutesURLFormat = "SplitTunnelRoutesURLFormat"
  124. SplitTunnelRoutesSignaturePublicKey = "SplitTunnelRoutesSignaturePublicKey"
  125. SplitTunnelDNSServer = "SplitTunnelDNSServer"
  126. FetchUpgradeTimeout = "FetchUpgradeTimeout"
  127. FetchUpgradeRetryPeriod = "FetchUpgradeRetryPeriod"
  128. FetchUpgradeStalePeriod = "FetchUpgradeStalePeriod"
  129. UpgradeDownloadURLs = "UpgradeDownloadURLs"
  130. UpgradeDownloadClientVersionHeader = "UpgradeDownloadClientVersionHeader"
  131. ImpairedProtocolClassificationDuration = "ImpairedProtocolClassificationDuration"
  132. ImpairedProtocolClassificationThreshold = "ImpairedProtocolClassificationThreshold"
  133. TotalBytesTransferredNoticePeriod = "TotalBytesTransferredNoticePeriod"
  134. MeekDialDomainsOnly = "MeekDialDomainsOnly"
  135. MeekLimitBufferSizes = "MeekLimitBufferSizes"
  136. MeekCookieMaxPadding = "MeekCookieMaxPadding"
  137. MeekFullReceiveBufferLength = "MeekFullReceiveBufferLength"
  138. MeekReadPayloadChunkLength = "MeekReadPayloadChunkLength"
  139. MeekLimitedFullReceiveBufferLength = "MeekLimitedFullReceiveBufferLength"
  140. MeekLimitedReadPayloadChunkLength = "MeekLimitedReadPayloadChunkLength"
  141. MeekMinPollInterval = "MeekMinPollInterval"
  142. MeekMinPollIntervalJitter = "MeekMinPollIntervalJitter"
  143. MeekMaxPollInterval = "MeekMaxPollInterval"
  144. MeekMaxPollIntervalJitter = "MeekMaxPollIntervalJitter"
  145. MeekPollIntervalMultiplier = "MeekPollIntervalMultiplier"
  146. MeekPollIntervalJitter = "MeekPollIntervalJitter"
  147. MeekApplyPollIntervalMultiplierProbability = "MeekApplyPollIntervalMultiplierProbability"
  148. MeekRoundTripRetryDeadline = "MeekRoundTripRetryDeadline"
  149. MeekRoundTripRetryMinDelay = "MeekRoundTripRetryMinDelay"
  150. MeekRoundTripRetryMaxDelay = "MeekRoundTripRetryMaxDelay"
  151. MeekRoundTripRetryMultiplier = "MeekRoundTripRetryMultiplier"
  152. MeekRoundTripTimeout = "MeekRoundTripTimeout"
  153. TransformHostNameProbability = "TransformHostNameProbability"
  154. PickUserAgentProbability = "PickUserAgentProbability"
  155. )
  156. const (
  157. useNetworkLatencyMultiplier = 1
  158. )
  159. // defaultClientParameters specifies the type, default value, and minimum
  160. // value for all dynamically configurable client parameters.
  161. //
  162. // Do not change the names or types of existing values, as that can break
  163. // client logic or cause parameters to not be applied.
  164. //
  165. // Minimum values are a fail-safe for cases where lower values would break the
  166. // client logic. For example, setting a ConnectionWorkerPoolSize of 0 would
  167. // make the client never connect.
  168. var defaultClientParameters = map[string]struct {
  169. value interface{}
  170. minimum interface{}
  171. flags int32
  172. }{
  173. // NetworkLatencyMultiplier defaults to 0, meaning off. But when set, it
  174. // must be a multiplier >= 1.
  175. NetworkLatencyMultiplier: {value: 0.0, minimum: 1.0},
  176. TacticsWaitPeriod: {value: 10 * time.Second, minimum: 0 * time.Second, flags: useNetworkLatencyMultiplier},
  177. TacticsRetryPeriod: {value: 5 * time.Second, minimum: 1 * time.Millisecond},
  178. TacticsRetryPeriodJitter: {value: 0.3, minimum: 0.0},
  179. TacticsTimeout: {value: 2 * time.Minute, minimum: 1 * time.Second, flags: useNetworkLatencyMultiplier},
  180. ConnectionWorkerPoolSize: {value: 10, minimum: 1},
  181. TunnelConnectTimeout: {value: 20 * time.Second, minimum: 1 * time.Second, flags: useNetworkLatencyMultiplier},
  182. EstablishTunnelTimeout: {value: 300 * time.Second, minimum: time.Duration(0)},
  183. EstablishTunnelWorkTime: {value: 60 * time.Second, minimum: 1 * time.Second},
  184. EstablishTunnelPausePeriod: {value: 5 * time.Second, minimum: 1 * time.Millisecond},
  185. EstablishTunnelPausePeriodJitter: {value: 0.1, minimum: 0.0},
  186. EstablishTunnelServerAffinityGracePeriod: {value: 1 * time.Second, minimum: time.Duration(0), flags: useNetworkLatencyMultiplier},
  187. StaggerConnectionWorkersPeriod: {value: time.Duration(0), minimum: time.Duration(0)},
  188. StaggerConnectionWorkersJitter: {value: 0.1, minimum: 0.0},
  189. LimitMeekConnectionWorkers: {value: 0, minimum: 0},
  190. IgnoreHandshakeStatsRegexps: {value: false},
  191. TunnelOperateShutdownTimeout: {value: 1 * time.Second, minimum: 1 * time.Millisecond, flags: useNetworkLatencyMultiplier},
  192. TunnelPortForwardDialTimeout: {value: 10 * time.Second, minimum: 1 * time.Millisecond, flags: useNetworkLatencyMultiplier},
  193. TunnelRateLimits: {value: common.RateLimits{}},
  194. // PrioritizeTunnelProtocolsCandidateCount should be set to at least
  195. // ConnectionWorkerPoolSize in order to use only priotitized protocols in
  196. // the first establishment round. Even then, this will only happen if the
  197. // client has sufficient candidates supporting the prioritized protocols.
  198. PrioritizeTunnelProtocols: {value: protocol.TunnelProtocols{}},
  199. PrioritizeTunnelProtocolsCandidateCount: {value: 10, minimum: 0},
  200. LimitTunnelProtocols: {value: protocol.TunnelProtocols{}},
  201. LimitTLSProfiles: {value: protocol.TLSProfiles{}},
  202. FragmentorProbability: {value: 0.5, minimum: 0.0},
  203. FragmentorLimitProtocols: {value: protocol.TunnelProtocols{}},
  204. FragmentorMinTotalBytes: {value: 0, minimum: 0},
  205. FragmentorMaxTotalBytes: {value: 0, minimum: 0},
  206. FragmentorMinWriteBytes: {value: 1, minimum: 1},
  207. FragmentorMaxWriteBytes: {value: 1500, minimum: 1},
  208. FragmentorMinDelay: {value: time.Duration(0), minimum: time.Duration(0)},
  209. FragmentorMaxDelay: {value: 10 * time.Millisecond, minimum: time.Duration(0)},
  210. // The Psiphon server will reject obfuscated SSH seed messages with
  211. // padding greater than OBFUSCATE_MAX_PADDING.
  212. // obfuscator.NewClientObfuscator will ignore invalid min/max padding
  213. // configurations.
  214. ObfuscatedSSHMinPadding: {value: 0, minimum: 0},
  215. ObfuscatedSSHMaxPadding: {value: obfuscator.OBFUSCATE_MAX_PADDING, minimum: 0},
  216. AdditionalCustomHeaders: {value: make(http.Header)},
  217. // Speed test and SSH keep alive padding is intended to frustrate
  218. // fingerprinting and should not exceed ~1 IP packet size.
  219. //
  220. // Currently, each serialized speed test sample, populated with real
  221. // values, is approximately 100 bytes. All SpeedTestMaxSampleCount samples
  222. // are loaded into memory are sent as API inputs.
  223. SpeedTestPaddingMinBytes: {value: 0, minimum: 0},
  224. SpeedTestPaddingMaxBytes: {value: 256, minimum: 0},
  225. SpeedTestMaxSampleCount: {value: 25, minimum: 1},
  226. // The Psiphon server times out inactive tunnels after 5 minutes, so this
  227. // is a soft max for SSHKeepAlivePeriodMax.
  228. SSHKeepAliveSpeedTestSampleProbability: {value: 0.5, minimum: 0.0},
  229. SSHKeepAlivePaddingMinBytes: {value: 0, minimum: 0},
  230. SSHKeepAlivePaddingMaxBytes: {value: 256, minimum: 0},
  231. SSHKeepAlivePeriodMin: {value: 1 * time.Minute, minimum: 1 * time.Second},
  232. SSHKeepAlivePeriodMax: {value: 2 * time.Minute, minimum: 1 * time.Second},
  233. SSHKeepAlivePeriodicTimeout: {value: 30 * time.Second, minimum: 1 * time.Second, flags: useNetworkLatencyMultiplier},
  234. SSHKeepAlivePeriodicInactivePeriod: {value: 10 * time.Second, minimum: 1 * time.Second},
  235. SSHKeepAliveProbeTimeout: {value: 30 * time.Second, minimum: 1 * time.Second, flags: useNetworkLatencyMultiplier},
  236. SSHKeepAliveProbeInactivePeriod: {value: 10 * time.Second, minimum: 1 * time.Second},
  237. HTTPProxyOriginServerTimeout: {value: 15 * time.Second, minimum: time.Duration(0), flags: useNetworkLatencyMultiplier},
  238. HTTPProxyMaxIdleConnectionsPerHost: {value: 50, minimum: 0},
  239. FetchRemoteServerListTimeout: {value: 30 * time.Second, minimum: 1 * time.Second, flags: useNetworkLatencyMultiplier},
  240. FetchRemoteServerListRetryPeriod: {value: 30 * time.Second, minimum: 1 * time.Millisecond},
  241. FetchRemoteServerListStalePeriod: {value: 6 * time.Hour, minimum: 1 * time.Hour},
  242. RemoteServerListSignaturePublicKey: {value: ""},
  243. RemoteServerListURLs: {value: DownloadURLs{}},
  244. ObfuscatedServerListRootURLs: {value: DownloadURLs{}},
  245. PsiphonAPIRequestTimeout: {value: 20 * time.Second, minimum: 1 * time.Second, flags: useNetworkLatencyMultiplier},
  246. PsiphonAPIStatusRequestPeriodMin: {value: 5 * time.Minute, minimum: 1 * time.Second},
  247. PsiphonAPIStatusRequestPeriodMax: {value: 10 * time.Minute, minimum: 1 * time.Second},
  248. PsiphonAPIStatusRequestShortPeriodMin: {value: 5 * time.Second, minimum: 1 * time.Second},
  249. PsiphonAPIStatusRequestShortPeriodMax: {value: 10 * time.Second, minimum: 1 * time.Second},
  250. PsiphonAPIStatusRequestPaddingMinBytes: {value: 0, minimum: 0},
  251. PsiphonAPIStatusRequestPaddingMaxBytes: {value: 256, minimum: 0},
  252. PsiphonAPIPersistentStatsMaxCount: {value: 100, minimum: 1},
  253. PsiphonAPIConnectedRequestRetryPeriod: {value: 5 * time.Second, minimum: 1 * time.Millisecond},
  254. FetchSplitTunnelRoutesTimeout: {value: 60 * time.Second, minimum: 1 * time.Second, flags: useNetworkLatencyMultiplier},
  255. SplitTunnelRoutesURLFormat: {value: ""},
  256. SplitTunnelRoutesSignaturePublicKey: {value: ""},
  257. SplitTunnelDNSServer: {value: ""},
  258. FetchUpgradeTimeout: {value: 60 * time.Second, minimum: 1 * time.Second, flags: useNetworkLatencyMultiplier},
  259. FetchUpgradeRetryPeriod: {value: 30 * time.Second, minimum: 1 * time.Millisecond},
  260. FetchUpgradeStalePeriod: {value: 6 * time.Hour, minimum: 1 * time.Hour},
  261. UpgradeDownloadURLs: {value: DownloadURLs{}},
  262. UpgradeDownloadClientVersionHeader: {value: ""},
  263. ImpairedProtocolClassificationDuration: {value: 2 * time.Minute, minimum: 1 * time.Millisecond, flags: useNetworkLatencyMultiplier},
  264. ImpairedProtocolClassificationThreshold: {value: 3, minimum: 1},
  265. TotalBytesTransferredNoticePeriod: {value: 5 * time.Minute, minimum: 1 * time.Second},
  266. // The meek server times out inactive sessions after 45 seconds, so this
  267. // is a soft max for MeekMaxPollInterval, MeekRoundTripTimeout, and
  268. // MeekRoundTripRetryDeadline. MeekCookieMaxPadding cannot exceed
  269. // common.OBFUSCATE_SEED_LENGTH.
  270. MeekDialDomainsOnly: {value: false},
  271. MeekLimitBufferSizes: {value: false},
  272. MeekCookieMaxPadding: {value: 256, minimum: 0},
  273. MeekFullReceiveBufferLength: {value: 4194304, minimum: 1024},
  274. MeekReadPayloadChunkLength: {value: 65536, minimum: 1024},
  275. MeekLimitedFullReceiveBufferLength: {value: 131072, minimum: 1024},
  276. MeekLimitedReadPayloadChunkLength: {value: 4096, minimum: 1024},
  277. MeekMinPollInterval: {value: 100 * time.Millisecond, minimum: 1 * time.Millisecond},
  278. MeekMinPollIntervalJitter: {value: 0.3, minimum: 0.0},
  279. MeekMaxPollInterval: {value: 5 * time.Second, minimum: 1 * time.Millisecond},
  280. MeekMaxPollIntervalJitter: {value: 0.1, minimum: 0.0},
  281. MeekPollIntervalMultiplier: {value: 1.5, minimum: 0.0},
  282. MeekPollIntervalJitter: {value: 0.1, minimum: 0.0},
  283. MeekApplyPollIntervalMultiplierProbability: {value: 0.5},
  284. MeekRoundTripRetryDeadline: {value: 5 * time.Second, minimum: 1 * time.Millisecond, flags: useNetworkLatencyMultiplier},
  285. MeekRoundTripRetryMinDelay: {value: 50 * time.Millisecond, minimum: time.Duration(0)},
  286. MeekRoundTripRetryMaxDelay: {value: 1 * time.Second, minimum: time.Duration(0)},
  287. MeekRoundTripRetryMultiplier: {value: 2.0, minimum: 0.0},
  288. MeekRoundTripTimeout: {value: 20 * time.Second, minimum: 1 * time.Second, flags: useNetworkLatencyMultiplier},
  289. TransformHostNameProbability: {value: 0.5, minimum: 0.0},
  290. PickUserAgentProbability: {value: 0.5, minimum: 0.0},
  291. }
  292. // ClientParameters is a set of client parameters. To use the parameters, call
  293. // Get. To apply new values to the parameters, call Set.
  294. type ClientParameters struct {
  295. getValueLogger func(error)
  296. snapshot atomic.Value
  297. }
  298. // ClientParametersSnapshot is an atomic snapshot of the client parameter
  299. // values. ClientParameters.Get will return a snapshot which may be used to
  300. // read multiple related values atomically and consistently while the current
  301. // snapshot in ClientParameters may change concurrently.
  302. type ClientParametersSnapshot struct {
  303. getValueLogger func(error)
  304. tag string
  305. parameters map[string]interface{}
  306. }
  307. // NewClientParameters initializes a new ClientParameters with the default
  308. // parameter values.
  309. //
  310. // getValueLogger is optional, and is used to report runtime errors with
  311. // getValue; see comment in getValue.
  312. func NewClientParameters(
  313. getValueLogger func(error)) (*ClientParameters, error) {
  314. clientParameters := &ClientParameters{
  315. getValueLogger: getValueLogger,
  316. }
  317. _, err := clientParameters.Set("", false)
  318. if err != nil {
  319. return nil, common.ContextError(err)
  320. }
  321. return clientParameters, nil
  322. }
  323. func makeDefaultParameters() (map[string]interface{}, error) {
  324. parameters := make(map[string]interface{})
  325. for name, defaults := range defaultClientParameters {
  326. if defaults.value == nil {
  327. return nil, common.ContextError(fmt.Errorf("default parameter missing value: %s", name))
  328. }
  329. if defaults.minimum != nil &&
  330. reflect.TypeOf(defaults.value) != reflect.TypeOf(defaults.minimum) {
  331. return nil, common.ContextError(fmt.Errorf("default parameter value and minimum type mismatch: %s", name))
  332. }
  333. _, isDuration := defaults.value.(time.Duration)
  334. if defaults.flags&useNetworkLatencyMultiplier != 0 && !isDuration {
  335. return nil, common.ContextError(fmt.Errorf("default non-duration parameter uses multipler: %s", name))
  336. }
  337. parameters[name] = defaults.value
  338. }
  339. return parameters, nil
  340. }
  341. // Set replaces the current parameters. First, a set of parameters are
  342. // initialized using the default values. Then, each applyParameters is applied
  343. // in turn, with the later instances having precedence.
  344. //
  345. // When skipOnError is true, unknown or invalid parameters in any
  346. // applyParameters are skipped instead of aborting with an error.
  347. //
  348. // When an error is returned, the previous parameters remain completely
  349. // unmodified.
  350. //
  351. // For use in logging, Set returns a count of the number of parameters applied
  352. // from each applyParameters.
  353. func (p *ClientParameters) Set(
  354. tag string, skipOnError bool, applyParameters ...map[string]interface{}) ([]int, error) {
  355. var counts []int
  356. parameters, err := makeDefaultParameters()
  357. if err != nil {
  358. return nil, common.ContextError(err)
  359. }
  360. for i := 0; i < len(applyParameters); i++ {
  361. count := 0
  362. for name, value := range applyParameters[i] {
  363. existingValue, ok := parameters[name]
  364. if !ok {
  365. if skipOnError {
  366. continue
  367. }
  368. return nil, common.ContextError(fmt.Errorf("unknown parameter: %s", name))
  369. }
  370. // Accept strings such as "1h" for duration parameters.
  371. switch existingValue.(type) {
  372. case time.Duration:
  373. if s, ok := value.(string); ok {
  374. if d, err := time.ParseDuration(s); err == nil {
  375. value = d
  376. }
  377. }
  378. }
  379. // A JSON remarshal resolves cases where applyParameters is a
  380. // result of unmarshal-into-interface, in which case non-scalar
  381. // values will not have the expected types; see:
  382. // https://golang.org/pkg/encoding/json/#Unmarshal. This remarshal
  383. // also results in a deep copy.
  384. marshaledValue, err := json.Marshal(value)
  385. if err != nil {
  386. continue
  387. }
  388. newValuePtr := reflect.New(reflect.TypeOf(existingValue))
  389. err = json.Unmarshal(marshaledValue, newValuePtr.Interface())
  390. if err != nil {
  391. if skipOnError {
  392. continue
  393. }
  394. return nil, common.ContextError(fmt.Errorf("unmarshal parameter %s failed: %s", name, err))
  395. }
  396. newValue := newValuePtr.Elem().Interface()
  397. // Perform type-specific validation for some cases.
  398. // TODO: require RemoteServerListSignaturePublicKey when
  399. // RemoteServerListURLs is set?
  400. switch v := newValue.(type) {
  401. case DownloadURLs:
  402. err := v.DecodeAndValidate()
  403. if err != nil {
  404. if skipOnError {
  405. continue
  406. }
  407. return nil, common.ContextError(err)
  408. }
  409. case protocol.TunnelProtocols:
  410. err := v.Validate()
  411. if err != nil {
  412. if skipOnError {
  413. continue
  414. }
  415. return nil, common.ContextError(err)
  416. }
  417. case protocol.TLSProfiles:
  418. err := v.Validate()
  419. if err != nil {
  420. if skipOnError {
  421. continue
  422. }
  423. return nil, common.ContextError(err)
  424. }
  425. }
  426. // Enforce any minimums. Assumes defaultClientParameters[name]
  427. // exists.
  428. if defaultClientParameters[name].minimum != nil {
  429. valid := true
  430. switch v := newValue.(type) {
  431. case int:
  432. m, ok := defaultClientParameters[name].minimum.(int)
  433. if !ok || v < m {
  434. valid = false
  435. }
  436. case float64:
  437. m, ok := defaultClientParameters[name].minimum.(float64)
  438. if !ok || v < m {
  439. valid = false
  440. }
  441. case time.Duration:
  442. m, ok := defaultClientParameters[name].minimum.(time.Duration)
  443. if !ok || v < m {
  444. valid = false
  445. }
  446. default:
  447. if skipOnError {
  448. continue
  449. }
  450. return nil, common.ContextError(fmt.Errorf("unexpected parameter with minimum: %s", name))
  451. }
  452. if !valid {
  453. if skipOnError {
  454. continue
  455. }
  456. return nil, common.ContextError(fmt.Errorf("parameter below minimum: %s", name))
  457. }
  458. }
  459. parameters[name] = newValue
  460. count++
  461. }
  462. counts = append(counts, count)
  463. }
  464. snapshot := &ClientParametersSnapshot{
  465. getValueLogger: p.getValueLogger,
  466. tag: tag,
  467. parameters: parameters,
  468. }
  469. p.snapshot.Store(snapshot)
  470. return counts, nil
  471. }
  472. // Get returns the current parameters. Values read from the current parameters
  473. // are not deep copies and must be treated read-only.
  474. func (p *ClientParameters) Get() *ClientParametersSnapshot {
  475. return p.snapshot.Load().(*ClientParametersSnapshot)
  476. }
  477. // Tag returns the tag associated with these parameters.
  478. func (p *ClientParametersSnapshot) Tag() string {
  479. return p.tag
  480. }
  481. // getValue sets target to the value of the named parameter.
  482. //
  483. // It is an error if the name is not found, target is not a pointer, or the
  484. // type of target points to does not match the value.
  485. //
  486. // Any of these conditions would be a bug in the caller. getValue does not
  487. // panic in these cases as the client is deployed as a library in various apps
  488. // and the failure of Psiphon may not be a failure for the app process.
  489. //
  490. // Instead, errors are logged to the getValueLogger and getValue leaves the
  491. // target unset, which will result in the caller getting and using a zero
  492. // value of the requested type.
  493. func (p *ClientParametersSnapshot) getValue(name string, target interface{}) {
  494. value, ok := p.parameters[name]
  495. if !ok {
  496. if p.getValueLogger != nil {
  497. p.getValueLogger(common.ContextError(fmt.Errorf(
  498. "value %s not found", name)))
  499. }
  500. return
  501. }
  502. valueType := reflect.TypeOf(value)
  503. if reflect.PtrTo(valueType) != reflect.TypeOf(target) {
  504. if p.getValueLogger != nil {
  505. p.getValueLogger(common.ContextError(fmt.Errorf(
  506. "value %s has unexpected type %s", name, valueType.Name())))
  507. }
  508. return
  509. }
  510. // Note: there is no deep copy of parameter values; the returned value may
  511. // share memory with the original and should not be modified.
  512. targetValue := reflect.ValueOf(target)
  513. if targetValue.Kind() != reflect.Ptr {
  514. p.getValueLogger(common.ContextError(fmt.Errorf(
  515. "target for value %s is not pointer", name)))
  516. return
  517. }
  518. targetValue.Elem().Set(reflect.ValueOf(value))
  519. }
  520. // String returns a string parameter value.
  521. func (p *ClientParametersSnapshot) String(name string) string {
  522. value := ""
  523. p.getValue(name, &value)
  524. return value
  525. }
  526. // Strings returns a []string parameter value.
  527. func (p *ClientParametersSnapshot) Strings(name string) []string {
  528. value := []string{}
  529. p.getValue(name, &value)
  530. return value
  531. }
  532. // Int returns an int parameter value.
  533. func (p *ClientParametersSnapshot) Int(name string) int {
  534. value := int(0)
  535. p.getValue(name, &value)
  536. return value
  537. }
  538. // Bool returns a bool parameter value.
  539. func (p *ClientParametersSnapshot) Bool(name string) bool {
  540. value := false
  541. p.getValue(name, &value)
  542. return value
  543. }
  544. // Float returns a float64 parameter value.
  545. func (p *ClientParametersSnapshot) Float(name string) float64 {
  546. value := float64(0.0)
  547. p.getValue(name, &value)
  548. return value
  549. }
  550. // WeightedCoinFlip returns the result of common.FlipWeightedCoin using the
  551. // specified float parameter as the probability input.
  552. func (p *ClientParametersSnapshot) WeightedCoinFlip(name string) bool {
  553. var value float64
  554. p.getValue(name, &value)
  555. return common.FlipWeightedCoin(value)
  556. }
  557. // Duration returns a time.Duration parameter value. When the duration
  558. // parameter has the useNetworkLatencyMultiplier flag, the
  559. // NetworkLatencyMultiplier is applied to the returned value.
  560. func (p *ClientParametersSnapshot) Duration(name string) time.Duration {
  561. value := time.Duration(0)
  562. p.getValue(name, &value)
  563. defaultParameter, ok := defaultClientParameters[name]
  564. if value > 0 && ok && defaultParameter.flags&useNetworkLatencyMultiplier != 0 {
  565. multiplier := float64(0.0)
  566. p.getValue(NetworkLatencyMultiplier, &multiplier)
  567. if multiplier > 0.0 {
  568. value = time.Duration(float64(value) * multiplier)
  569. }
  570. }
  571. return value
  572. }
  573. // TunnelProtocols returns a protocol.TunnelProtocols parameter value.
  574. func (p *ClientParametersSnapshot) TunnelProtocols(name string) protocol.TunnelProtocols {
  575. value := protocol.TunnelProtocols{}
  576. p.getValue(name, &value)
  577. return value
  578. }
  579. // TLSProfiles returns a protocol.TLSProfiles parameter value.
  580. func (p *ClientParametersSnapshot) TLSProfiles(name string) protocol.TLSProfiles {
  581. value := protocol.TLSProfiles{}
  582. p.getValue(name, &value)
  583. return value
  584. }
  585. // DownloadURLs returns a DownloadURLs parameter value.
  586. func (p *ClientParametersSnapshot) DownloadURLs(name string) DownloadURLs {
  587. value := DownloadURLs{}
  588. p.getValue(name, &value)
  589. return value
  590. }
  591. // RateLimits returns a common.RateLimits parameter value.
  592. func (p *ClientParametersSnapshot) RateLimits(name string) common.RateLimits {
  593. value := common.RateLimits{}
  594. p.getValue(name, &value)
  595. return value
  596. }
  597. // HTTPHeaders returns an http.Header parameter value.
  598. func (p *ClientParametersSnapshot) HTTPHeaders(name string) http.Header {
  599. value := make(http.Header)
  600. p.getValue(name, &value)
  601. return value
  602. }