parameters.go 72 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607
  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 and server behaviors.
  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 or server to customize its
  25. parameters from both a config file and tactics data. Sane minimum values are
  26. enforced.
  27. Parameters may be read and updated concurrently. The read mechanism offers a
  28. snapshot so that related parameters, such as two Ints representing a range; or
  29. a more complex series of related parameters; may be read in an atomic and
  30. consistent way. For example:
  31. p := params.Get()
  32. min := p.Int("Min")
  33. max := p.Int("Max")
  34. p = nil
  35. For long-running operations, it is recommended to set any pointer to the
  36. snapshot to nil to allow garbage collection of old snaphots in cases where the
  37. parameters change.
  38. In general, parameters should be read as close to the point of use as possible
  39. to ensure that dynamic changes to the parameter values take effect.
  40. For duration parameters, time.ParseDuration-compatible string values are
  41. supported when applying new values. This allows specifying durations as, for
  42. example, "100ms" or "24h".
  43. Values read from the parameters are not deep copies and must be treated as
  44. read-only.
  45. */
  46. package parameters
  47. import (
  48. "encoding/json"
  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/errors"
  55. "github.com/Psiphon-Labs/psiphon-tunnel-core/psiphon/common/obfuscator"
  56. "github.com/Psiphon-Labs/psiphon-tunnel-core/psiphon/common/prng"
  57. "github.com/Psiphon-Labs/psiphon-tunnel-core/psiphon/common/protocol"
  58. "github.com/Psiphon-Labs/psiphon-tunnel-core/psiphon/common/transforms"
  59. "golang.org/x/net/bpf"
  60. )
  61. const (
  62. NetworkLatencyMultiplier = "NetworkLatencyMultiplier"
  63. NetworkLatencyMultiplierMin = "NetworkLatencyMultiplierMin"
  64. NetworkLatencyMultiplierMax = "NetworkLatencyMultiplierMax"
  65. NetworkLatencyMultiplierLambda = "NetworkLatencyMultiplierLambda"
  66. TacticsWaitPeriod = "TacticsWaitPeriod"
  67. TacticsRetryPeriod = "TacticsRetryPeriod"
  68. TacticsRetryPeriodJitter = "TacticsRetryPeriodJitter"
  69. TacticsTimeout = "TacticsTimeout"
  70. ConnectionWorkerPoolSize = "ConnectionWorkerPoolSize"
  71. TunnelPoolSize = "TunnelPoolSize"
  72. TunnelConnectTimeout = "TunnelConnectTimeout"
  73. EstablishTunnelTimeout = "EstablishTunnelTimeout"
  74. EstablishTunnelWorkTime = "EstablishTunnelWorkTime"
  75. EstablishTunnelPausePeriod = "EstablishTunnelPausePeriod"
  76. EstablishTunnelPausePeriodJitter = "EstablishTunnelPausePeriodJitter"
  77. EstablishTunnelServerAffinityGracePeriod = "EstablishTunnelServerAffinityGracePeriod"
  78. StaggerConnectionWorkersPeriod = "StaggerConnectionWorkersPeriod"
  79. StaggerConnectionWorkersJitter = "StaggerConnectionWorkersJitter"
  80. LimitIntensiveConnectionWorkers = "LimitIntensiveConnectionWorkers"
  81. UpstreamProxyErrorMinWaitDuration = "UpstreamProxyErrorMinWaitDuration"
  82. UpstreamProxyErrorMaxWaitDuration = "UpstreamProxyErrorMaxWaitDuration"
  83. IgnoreHandshakeStatsRegexps = "IgnoreHandshakeStatsRegexps"
  84. PrioritizeTunnelProtocolsProbability = "PrioritizeTunnelProtocolsProbability"
  85. PrioritizeTunnelProtocols = "PrioritizeTunnelProtocols"
  86. PrioritizeTunnelProtocolsCandidateCount = "PrioritizeTunnelProtocolsCandidateCount"
  87. InitialLimitTunnelProtocolsProbability = "InitialLimitTunnelProtocolsProbability"
  88. InitialLimitTunnelProtocols = "InitialLimitTunnelProtocols"
  89. InitialLimitTunnelProtocolsCandidateCount = "InitialLimitTunnelProtocolsCandidateCount"
  90. LimitTunnelProtocolsProbability = "LimitTunnelProtocolsProbability"
  91. LimitTunnelProtocols = "LimitTunnelProtocols"
  92. LimitTunnelDialPortNumbersProbability = "LimitTunnelDialPortNumbersProbability"
  93. LimitTunnelDialPortNumbers = "LimitTunnelDialPortNumbers"
  94. LimitTLSProfilesProbability = "LimitTLSProfilesProbability"
  95. LimitTLSProfiles = "LimitTLSProfiles"
  96. UseOnlyCustomTLSProfiles = "UseOnlyCustomTLSProfiles"
  97. CustomTLSProfiles = "CustomTLSProfiles"
  98. SelectRandomizedTLSProfileProbability = "SelectRandomizedTLSProfileProbability"
  99. NoDefaultTLSSessionIDProbability = "NoDefaultTLSSessionIDProbability"
  100. DisableFrontingProviderTLSProfiles = "DisableFrontingProviderTLSProfiles"
  101. LimitQUICVersionsProbability = "LimitQUICVersionsProbability"
  102. LimitQUICVersions = "LimitQUICVersions"
  103. DisableFrontingProviderQUICVersions = "DisableFrontingProviderQUICVersions"
  104. QUICDisableClientPathMTUDiscoveryProbability = "QUICDisableClientPathMTUDiscoveryProbability"
  105. FragmentorProbability = "FragmentorProbability"
  106. FragmentorLimitProtocols = "FragmentorLimitProtocols"
  107. FragmentorMinTotalBytes = "FragmentorMinTotalBytes"
  108. FragmentorMaxTotalBytes = "FragmentorMaxTotalBytes"
  109. FragmentorMinWriteBytes = "FragmentorMinWriteBytes"
  110. FragmentorMaxWriteBytes = "FragmentorMaxWriteBytes"
  111. FragmentorMinDelay = "FragmentorMinDelay"
  112. FragmentorMaxDelay = "FragmentorMaxDelay"
  113. FragmentorDownstreamProbability = "FragmentorDownstreamProbability"
  114. FragmentorDownstreamLimitProtocols = "FragmentorDownstreamLimitProtocols"
  115. FragmentorDownstreamMinTotalBytes = "FragmentorDownstreamMinTotalBytes"
  116. FragmentorDownstreamMaxTotalBytes = "FragmentorDownstreamMaxTotalBytes"
  117. FragmentorDownstreamMinWriteBytes = "FragmentorDownstreamMinWriteBytes"
  118. FragmentorDownstreamMaxWriteBytes = "FragmentorDownstreamMaxWriteBytes"
  119. FragmentorDownstreamMinDelay = "FragmentorDownstreamMinDelay"
  120. FragmentorDownstreamMaxDelay = "FragmentorDownstreamMaxDelay"
  121. ObfuscatedSSHMinPadding = "ObfuscatedSSHMinPadding"
  122. ObfuscatedSSHMaxPadding = "ObfuscatedSSHMaxPadding"
  123. TunnelOperateShutdownTimeout = "TunnelOperateShutdownTimeout"
  124. TunnelPortForwardDialTimeout = "TunnelPortForwardDialTimeout"
  125. PacketTunnelReadTimeout = "PacketTunnelReadTimeout"
  126. TunnelRateLimits = "TunnelRateLimits"
  127. AdditionalCustomHeaders = "AdditionalCustomHeaders"
  128. SpeedTestPaddingMinBytes = "SpeedTestPaddingMinBytes"
  129. SpeedTestPaddingMaxBytes = "SpeedTestPaddingMaxBytes"
  130. SpeedTestMaxSampleCount = "SpeedTestMaxSampleCount"
  131. SSHKeepAliveSpeedTestSampleProbability = "SSHKeepAliveSpeedTestSampleProbability"
  132. SSHKeepAlivePaddingMinBytes = "SSHKeepAlivePaddingMinBytes"
  133. SSHKeepAlivePaddingMaxBytes = "SSHKeepAlivePaddingMaxBytes"
  134. SSHKeepAlivePeriodMin = "SSHKeepAlivePeriodMin"
  135. SSHKeepAlivePeriodMax = "SSHKeepAlivePeriodMax"
  136. SSHKeepAlivePeriodicTimeout = "SSHKeepAlivePeriodicTimeout"
  137. SSHKeepAlivePeriodicInactivePeriod = "SSHKeepAlivePeriodicInactivePeriod"
  138. SSHKeepAliveProbeTimeout = "SSHKeepAliveProbeTimeout"
  139. SSHKeepAliveProbeInactivePeriod = "SSHKeepAliveProbeInactivePeriod"
  140. SSHKeepAliveNetworkConnectivityPollingPeriod = "SSHKeepAliveNetworkConnectivityPollingPeriod"
  141. SSHKeepAliveResetOnFailureProbability = "SSHKeepAliveResetOnFailureProbability"
  142. HTTPProxyOriginServerTimeout = "HTTPProxyOriginServerTimeout"
  143. HTTPProxyMaxIdleConnectionsPerHost = "HTTPProxyMaxIdleConnectionsPerHost"
  144. FetchRemoteServerListTimeout = "FetchRemoteServerListTimeout"
  145. FetchRemoteServerListRetryPeriod = "FetchRemoteServerListRetryPeriod"
  146. FetchRemoteServerListStalePeriod = "FetchRemoteServerListStalePeriod"
  147. RemoteServerListSignaturePublicKey = "RemoteServerListSignaturePublicKey"
  148. RemoteServerListURLs = "RemoteServerListURLs"
  149. ObfuscatedServerListRootURLs = "ObfuscatedServerListRootURLs"
  150. PsiphonAPIRequestTimeout = "PsiphonAPIRequestTimeout"
  151. PsiphonAPIStatusRequestPeriodMin = "PsiphonAPIStatusRequestPeriodMin"
  152. PsiphonAPIStatusRequestPeriodMax = "PsiphonAPIStatusRequestPeriodMax"
  153. PsiphonAPIStatusRequestShortPeriodMin = "PsiphonAPIStatusRequestShortPeriodMin"
  154. PsiphonAPIStatusRequestShortPeriodMax = "PsiphonAPIStatusRequestShortPeriodMax"
  155. PsiphonAPIStatusRequestPaddingMinBytes = "PsiphonAPIStatusRequestPaddingMinBytes"
  156. PsiphonAPIStatusRequestPaddingMaxBytes = "PsiphonAPIStatusRequestPaddingMaxBytes"
  157. PsiphonAPIPersistentStatsMaxCount = "PsiphonAPIPersistentStatsMaxCount"
  158. PsiphonAPIConnectedRequestPeriod = "PsiphonAPIConnectedRequestPeriod"
  159. PsiphonAPIConnectedRequestRetryPeriod = "PsiphonAPIConnectedRequestRetryPeriod"
  160. FetchSplitTunnelRoutesTimeout = "FetchSplitTunnelRoutesTimeout"
  161. SplitTunnelRoutesURLFormat = "SplitTunnelRoutesURLFormat"
  162. SplitTunnelRoutesSignaturePublicKey = "SplitTunnelRoutesSignaturePublicKey"
  163. SplitTunnelDNSServer = "SplitTunnelDNSServer"
  164. SplitTunnelClassificationTTL = "SplitTunnelClassificationTTL"
  165. SplitTunnelClassificationMaxEntries = "SplitTunnelClassificationMaxEntries"
  166. FetchUpgradeTimeout = "FetchUpgradeTimeout"
  167. FetchUpgradeRetryPeriod = "FetchUpgradeRetryPeriod"
  168. FetchUpgradeStalePeriod = "FetchUpgradeStalePeriod"
  169. UpgradeDownloadURLs = "UpgradeDownloadURLs"
  170. UpgradeDownloadClientVersionHeader = "UpgradeDownloadClientVersionHeader"
  171. TotalBytesTransferredNoticePeriod = "TotalBytesTransferredNoticePeriod"
  172. TotalBytesTransferredEmitMemoryMetrics = "TotalBytesTransferredEmitMemoryMetrics"
  173. MeekDialDomainsOnly = "MeekDialDomainsOnly"
  174. MeekLimitBufferSizes = "MeekLimitBufferSizes"
  175. MeekCookieMaxPadding = "MeekCookieMaxPadding"
  176. MeekFullReceiveBufferLength = "MeekFullReceiveBufferLength"
  177. MeekReadPayloadChunkLength = "MeekReadPayloadChunkLength"
  178. MeekLimitedFullReceiveBufferLength = "MeekLimitedFullReceiveBufferLength"
  179. MeekLimitedReadPayloadChunkLength = "MeekLimitedReadPayloadChunkLength"
  180. MeekMinPollInterval = "MeekMinPollInterval"
  181. MeekMinPollIntervalJitter = "MeekMinPollIntervalJitter"
  182. MeekMaxPollInterval = "MeekMaxPollInterval"
  183. MeekMaxPollIntervalJitter = "MeekMaxPollIntervalJitter"
  184. MeekPollIntervalMultiplier = "MeekPollIntervalMultiplier"
  185. MeekPollIntervalJitter = "MeekPollIntervalJitter"
  186. MeekApplyPollIntervalMultiplierProbability = "MeekApplyPollIntervalMultiplierProbability"
  187. MeekRoundTripRetryDeadline = "MeekRoundTripRetryDeadline"
  188. MeekRoundTripRetryMinDelay = "MeekRoundTripRetryMinDelay"
  189. MeekRoundTripRetryMaxDelay = "MeekRoundTripRetryMaxDelay"
  190. MeekRoundTripRetryMultiplier = "MeekRoundTripRetryMultiplier"
  191. MeekRoundTripTimeout = "MeekRoundTripTimeout"
  192. MeekTrafficShapingProbability = "MeekTrafficShapingProbability"
  193. MeekTrafficShapingLimitProtocols = "MeekTrafficShapingLimitProtocols"
  194. MeekMinTLSPadding = "MeekMinTLSPadding"
  195. MeekMaxTLSPadding = "MeekMaxTLSPadding"
  196. MeekMinLimitRequestPayloadLength = "MeekMinLimitRequestPayloadLength"
  197. MeekMaxLimitRequestPayloadLength = "MeekMaxLimitRequestPayloadLength"
  198. MeekRedialTLSProbability = "MeekRedialTLSProbability"
  199. MeekAlternateCookieNameProbability = "MeekAlternateCookieNameProbability"
  200. MeekAlternateContentTypeProbability = "MeekAlternateContentTypeProbability"
  201. TransformHostNameProbability = "TransformHostNameProbability"
  202. PickUserAgentProbability = "PickUserAgentProbability"
  203. LivenessTestMinUpstreamBytes = "LivenessTestMinUpstreamBytes"
  204. LivenessTestMaxUpstreamBytes = "LivenessTestMaxUpstreamBytes"
  205. LivenessTestMinDownstreamBytes = "LivenessTestMinDownstreamBytes"
  206. LivenessTestMaxDownstreamBytes = "LivenessTestMaxDownstreamBytes"
  207. ReplayCandidateCount = "ReplayCandidateCount"
  208. ReplayDialParametersTTL = "ReplayDialParametersTTL"
  209. ReplayTargetUpstreamBytes = "ReplayTargetUpstreamBytes"
  210. ReplayTargetDownstreamBytes = "ReplayTargetDownstreamBytes"
  211. ReplayTargetTunnelDuration = "ReplayTargetTunnelDuration"
  212. ReplayLaterRoundMoveToFrontProbability = "ReplayLaterRoundMoveToFrontProbability"
  213. ReplayRetainFailedProbability = "ReplayRetainFailedProbability"
  214. ReplayBPF = "ReplayBPF"
  215. ReplaySSH = "ReplaySSH"
  216. ReplayObfuscatorPadding = "ReplayObfuscatorPadding"
  217. ReplayFragmentor = "ReplayFragmentor"
  218. ReplayTLSProfile = "ReplayTLSProfile"
  219. ReplayRandomizedTLSProfile = "ReplayRandomizedTLSProfile"
  220. ReplayFronting = "ReplayFronting"
  221. ReplayHostname = "ReplayHostname"
  222. ReplayQUICVersion = "ReplayQUICVersion"
  223. ReplayObfuscatedQUIC = "ReplayObfuscatedQUIC"
  224. ReplayConjureRegistration = "ReplayConjureRegistration"
  225. ReplayConjureTransport = "ReplayConjureTransport"
  226. ReplayLivenessTest = "ReplayLivenessTest"
  227. ReplayUserAgent = "ReplayUserAgent"
  228. ReplayAPIRequestPadding = "ReplayAPIRequestPadding"
  229. ReplayHoldOffTunnel = "ReplayHoldOffTunnel"
  230. ReplayResolveParameters = "ReplayResolveParameters"
  231. ReplayHTTPTransformerParameters = "ReplayHTTPTransformerParameters"
  232. APIRequestUpstreamPaddingMinBytes = "APIRequestUpstreamPaddingMinBytes"
  233. APIRequestUpstreamPaddingMaxBytes = "APIRequestUpstreamPaddingMaxBytes"
  234. APIRequestDownstreamPaddingMinBytes = "APIRequestDownstreamPaddingMinBytes"
  235. APIRequestDownstreamPaddingMaxBytes = "APIRequestDownstreamPaddingMaxBytes"
  236. PersistentStatsMaxStoreRecords = "PersistentStatsMaxStoreRecords"
  237. PersistentStatsMaxSendBytes = "PersistentStatsMaxSendBytes"
  238. RecordRemoteServerListPersistentStatsProbability = "RecordRemoteServerListPersistentStatsProbability"
  239. RecordFailedTunnelPersistentStatsProbability = "RecordFailedTunnelPersistentStatsProbability"
  240. ServerEntryMinimumAgeForPruning = "ServerEntryMinimumAgeForPruning"
  241. ApplicationParametersProbability = "ApplicationParametersProbability"
  242. ApplicationParameters = "ApplicationParameters"
  243. BPFServerTCPProgram = "BPFServerTCPProgram"
  244. BPFServerTCPProbability = "BPFServerTCPProbability"
  245. BPFClientTCPProgram = "BPFClientTCPProgram"
  246. BPFClientTCPProbability = "BPFClientTCPProbability"
  247. ServerPacketManipulationSpecs = "ServerPacketManipulationSpecs"
  248. ServerProtocolPacketManipulations = "ServerProtocolPacketManipulations"
  249. ServerPacketManipulationProbability = "ServerPacketManipulationProbability"
  250. FeedbackUploadURLs = "FeedbackUploadURLs"
  251. FeedbackEncryptionPublicKey = "FeedbackEncryptionPublicKey"
  252. FeedbackTacticsWaitPeriod = "FeedbackTacticsWaitPeriod"
  253. FeedbackUploadMaxAttempts = "FeedbackUploadMaxAttempts"
  254. FeedbackUploadRetryMinDelaySeconds = "FeedbackUploadRetryMinDelaySeconds"
  255. FeedbackUploadRetryMaxDelaySeconds = "FeedbackUploadRetryMaxDelaySeconds"
  256. FeedbackUploadTimeoutSeconds = "FeedbackUploadTimeoutSeconds"
  257. ServerReplayPacketManipulation = "ServerReplayPacketManipulation"
  258. ServerReplayFragmentor = "ServerReplayFragmentor"
  259. ServerReplayUnknownGeoIP = "ServerReplayUnknownGeoIP"
  260. ServerReplayTTL = "ServerReplayTTL"
  261. ServerReplayTargetWaitDuration = "ServerReplayTargetWaitDuration"
  262. ServerReplayTargetTunnelDuration = "ServerReplayTargetTunnelDuration"
  263. ServerReplayTargetUpstreamBytes = "ServerReplayTargetUpstreamBytes"
  264. ServerReplayTargetDownstreamBytes = "ServerReplayTargetDownstreamBytes"
  265. ServerReplayFailedCountThreshold = "ServerReplayFailedCountThreshold"
  266. ServerBurstUpstreamDeadline = "ServerBurstUpstreamDeadline"
  267. ServerBurstUpstreamTargetBytes = "ServerBurstUpstreamTargetBytes"
  268. ServerBurstDownstreamDeadline = "ServerBurstDownstreamDeadline"
  269. ServerBurstDownstreamTargetBytes = "ServerBurstDownstreamTargetBytes"
  270. ClientBurstUpstreamDeadline = "ClientBurstUpstreamDeadline"
  271. ClientBurstUpstreamTargetBytes = "ClientBurstUpstreamTargetBytes"
  272. ClientBurstDownstreamDeadline = "ClientBurstDownstreamDeadline"
  273. ClientBurstDownstreamTargetBytes = "ClientBurstDownstreamTargetBytes"
  274. ConjureCachedRegistrationTTL = "ConjureCachedRegistrationTTL"
  275. ConjureAPIRegistrarURL = "ConjureAPIRegistrarURL"
  276. ConjureAPIRegistrarBidirectionalURL = "ConjureAPIRegistrarBidirectionalURL"
  277. ConjureAPIRegistrarFrontingSpecs = "ConjureAPIRegistrarFrontingSpecs"
  278. ConjureAPIRegistrarMinDelay = "ConjureAPIRegistrarMinDelay"
  279. ConjureAPIRegistrarMaxDelay = "ConjureAPIRegistrarMaxDelay"
  280. ConjureDecoyRegistrarProbability = "ConjureDecoyRegistrarProbability"
  281. ConjureDecoyRegistrarWidth = "ConjureDecoyRegistrarWidth"
  282. ConjureDecoyRegistrarMinDelay = "ConjureDecoyRegistrarMinDelay"
  283. ConjureDecoyRegistrarMaxDelay = "ConjureDecoyRegistrarMaxDelay"
  284. ConjureTransportObfs4Probability = "ConjureTransportObfs4Probability"
  285. CustomHostNameRegexes = "CustomHostNameRegexes"
  286. CustomHostNameProbability = "CustomHostNameProbability"
  287. CustomHostNameLimitProtocols = "CustomHostNameLimitProtocols"
  288. HoldOffTunnelMinDuration = "HoldOffTunnelMinDuration"
  289. HoldOffTunnelMaxDuration = "HoldOffTunnelMaxDuration"
  290. HoldOffTunnelProtocols = "HoldOffTunnelProtocols"
  291. HoldOffTunnelFrontingProviderIDs = "HoldOffTunnelFrontingProviderIDs"
  292. HoldOffTunnelProbability = "HoldOffTunnelProbability"
  293. RestrictFrontingProviderIDs = "RestrictFrontingProviderIDs"
  294. RestrictFrontingProviderIDsServerProbability = "RestrictFrontingProviderIDsServerProbability"
  295. RestrictFrontingProviderIDsClientProbability = "RestrictFrontingProviderIDsClientProbability"
  296. UpstreamProxyAllowAllServerEntrySources = "UpstreamProxyAllowAllServerEntrySources"
  297. DestinationBytesMetricsASN = "DestinationBytesMetricsASN"
  298. DNSResolverAttemptsPerServer = "DNSResolverAttemptsPerServer"
  299. DNSResolverAttemptsPerPreferredServer = "DNSResolverAttemptsPerPreferredServer"
  300. DNSResolverRequestTimeout = "DNSResolverRequestTimeout"
  301. DNSResolverAwaitTimeout = "DNSResolverAwaitTimeout"
  302. DNSResolverPreresolvedIPAddressCIDRs = "DNSResolverPreresolvedIPAddressCIDRs"
  303. DNSResolverPreresolvedIPAddressProbability = "DNSResolverPreresolvedIPAddressProbability"
  304. DNSResolverAlternateServers = "DNSResolverAlternateServers"
  305. DNSResolverPreferredAlternateServers = "DNSResolverPreferredAlternateServers"
  306. DNSResolverPreferAlternateServerProbability = "DNSResolverPreferAlternateServerProbability"
  307. DNSResolverProtocolTransformSpecs = "DNSResolverProtocolTransformSpecs"
  308. DNSResolverProtocolTransformScopedSpecNames = "DNSResolverProtocolTransformScopedSpecNames"
  309. DNSResolverProtocolTransformProbability = "DNSResolverProtocolTransformProbability"
  310. DNSResolverIncludeEDNS0Probability = "DNSResolverIncludeEDNS0Probability"
  311. DNSResolverCacheExtensionInitialTTL = "DNSResolverCacheExtensionInitialTTL"
  312. DNSResolverCacheExtensionVerifiedTTL = "DNSResolverCacheExtensionVerifiedTTL"
  313. AddFrontingProviderPsiphonFrontingHeader = "AddFrontingProviderPsiphonFrontingHeader"
  314. DirectHTTPProtocolTransformSpecs = "DirectHTTPProtocolTransformSpecs"
  315. DirectHTTPProtocolTransformScopedSpecNames = "DirectHTTPProtocolTransformScopedSpecNames"
  316. DirectHTTPProtocolTransformProbability = "DirectHTTPProtocolTransformProbability"
  317. FrontedHTTPProtocolTransformSpecs = "FrontedHTTPProtocolTransformSpecs"
  318. FrontedHTTPProtocolTransformScopedSpecNames = "FrontedHTTPProtocolTransformScopedSpecNames"
  319. FrontedHTTPProtocolTransformProbability = "FrontedHTTPProtocolTransformProbability"
  320. )
  321. const (
  322. useNetworkLatencyMultiplier = 1
  323. serverSideOnly = 2
  324. )
  325. // defaultParameters specifies the type, default value, and minimum value for
  326. // all dynamically configurable client and server parameters.
  327. //
  328. // Do not change the names or types of existing values, as that can break
  329. // client logic or cause parameters to not be applied.
  330. //
  331. // Minimum values are a fail-safe for cases where lower values would break the
  332. // client logic. For example, setting a ConnectionWorkerPoolSize of 0 would
  333. // make the client never connect.
  334. var defaultParameters = map[string]struct {
  335. value interface{}
  336. minimum interface{}
  337. flags int32
  338. }{
  339. // NetworkLatencyMultiplier defaults to 0, meaning off. But when set, it
  340. // must be a multiplier >= 1.
  341. NetworkLatencyMultiplier: {value: 0.0, minimum: 1.0},
  342. NetworkLatencyMultiplierMin: {value: 1.0, minimum: 1.0},
  343. NetworkLatencyMultiplierMax: {value: 3.0, minimum: 1.0},
  344. NetworkLatencyMultiplierLambda: {value: 2.0, minimum: 0.001},
  345. TacticsWaitPeriod: {value: 10 * time.Second, minimum: 0 * time.Second, flags: useNetworkLatencyMultiplier},
  346. TacticsRetryPeriod: {value: 5 * time.Second, minimum: 1 * time.Millisecond},
  347. TacticsRetryPeriodJitter: {value: 0.3, minimum: 0.0},
  348. TacticsTimeout: {value: 2 * time.Minute, minimum: 1 * time.Second, flags: useNetworkLatencyMultiplier},
  349. ConnectionWorkerPoolSize: {value: 10, minimum: 1},
  350. TunnelPoolSize: {value: 1, minimum: 1},
  351. TunnelConnectTimeout: {value: 20 * time.Second, minimum: 1 * time.Second, flags: useNetworkLatencyMultiplier},
  352. EstablishTunnelTimeout: {value: 300 * time.Second, minimum: time.Duration(0)},
  353. EstablishTunnelWorkTime: {value: 60 * time.Second, minimum: 1 * time.Second},
  354. EstablishTunnelPausePeriod: {value: 5 * time.Second, minimum: 1 * time.Millisecond},
  355. EstablishTunnelPausePeriodJitter: {value: 0.1, minimum: 0.0},
  356. EstablishTunnelServerAffinityGracePeriod: {value: 1 * time.Second, minimum: time.Duration(0), flags: useNetworkLatencyMultiplier},
  357. StaggerConnectionWorkersPeriod: {value: time.Duration(0), minimum: time.Duration(0)},
  358. StaggerConnectionWorkersJitter: {value: 0.1, minimum: 0.0},
  359. LimitIntensiveConnectionWorkers: {value: 0, minimum: 0},
  360. UpstreamProxyErrorMinWaitDuration: {value: 10 * time.Second, minimum: time.Duration(0)},
  361. UpstreamProxyErrorMaxWaitDuration: {value: 30 * time.Second, minimum: time.Duration(0)},
  362. IgnoreHandshakeStatsRegexps: {value: false},
  363. TunnelOperateShutdownTimeout: {value: 1 * time.Second, minimum: 1 * time.Millisecond, flags: useNetworkLatencyMultiplier},
  364. TunnelPortForwardDialTimeout: {value: 10 * time.Second, minimum: 1 * time.Millisecond, flags: useNetworkLatencyMultiplier},
  365. PacketTunnelReadTimeout: {value: 10 * time.Second, minimum: 1 * time.Millisecond, flags: useNetworkLatencyMultiplier},
  366. TunnelRateLimits: {value: common.RateLimits{}},
  367. // PrioritizeTunnelProtocols parameters are obsoleted by InitialLimitTunnelProtocols.
  368. // TODO: remove once no longer required for older clients.
  369. PrioritizeTunnelProtocolsProbability: {value: 1.0, minimum: 0.0},
  370. PrioritizeTunnelProtocols: {value: protocol.TunnelProtocols{}},
  371. PrioritizeTunnelProtocolsCandidateCount: {value: 10, minimum: 0},
  372. InitialLimitTunnelProtocolsProbability: {value: 1.0, minimum: 0.0},
  373. InitialLimitTunnelProtocols: {value: protocol.TunnelProtocols{}},
  374. InitialLimitTunnelProtocolsCandidateCount: {value: 0, minimum: 0},
  375. LimitTunnelProtocolsProbability: {value: 1.0, minimum: 0.0},
  376. LimitTunnelProtocols: {value: protocol.TunnelProtocols{}},
  377. LimitTunnelDialPortNumbersProbability: {value: 1.0, minimum: 0.0},
  378. LimitTunnelDialPortNumbers: {value: TunnelProtocolPortLists{}},
  379. LimitTLSProfilesProbability: {value: 1.0, minimum: 0.0},
  380. LimitTLSProfiles: {value: protocol.TLSProfiles{}},
  381. UseOnlyCustomTLSProfiles: {value: false},
  382. CustomTLSProfiles: {value: protocol.CustomTLSProfiles{}},
  383. SelectRandomizedTLSProfileProbability: {value: 0.25, minimum: 0.0},
  384. NoDefaultTLSSessionIDProbability: {value: 0.5, minimum: 0.0},
  385. DisableFrontingProviderTLSProfiles: {value: protocol.LabeledTLSProfiles{}},
  386. LimitQUICVersionsProbability: {value: 1.0, minimum: 0.0},
  387. LimitQUICVersions: {value: protocol.QUICVersions{}},
  388. DisableFrontingProviderQUICVersions: {value: protocol.LabeledQUICVersions{}},
  389. QUICDisableClientPathMTUDiscoveryProbability: {value: 0.0, minimum: 0.0},
  390. FragmentorProbability: {value: 0.5, minimum: 0.0},
  391. FragmentorLimitProtocols: {value: protocol.TunnelProtocols{}},
  392. FragmentorMinTotalBytes: {value: 0, minimum: 0},
  393. FragmentorMaxTotalBytes: {value: 0, minimum: 0},
  394. FragmentorMinWriteBytes: {value: 1, minimum: 1},
  395. FragmentorMaxWriteBytes: {value: 1500, minimum: 1},
  396. FragmentorMinDelay: {value: time.Duration(0), minimum: time.Duration(0)},
  397. FragmentorMaxDelay: {value: 10 * time.Millisecond, minimum: time.Duration(0)},
  398. FragmentorDownstreamProbability: {value: 0.5, minimum: 0.0, flags: serverSideOnly},
  399. FragmentorDownstreamLimitProtocols: {value: protocol.TunnelProtocols{}, flags: serverSideOnly},
  400. FragmentorDownstreamMinTotalBytes: {value: 0, minimum: 0, flags: serverSideOnly},
  401. FragmentorDownstreamMaxTotalBytes: {value: 0, minimum: 0, flags: serverSideOnly},
  402. FragmentorDownstreamMinWriteBytes: {value: 1, minimum: 1, flags: serverSideOnly},
  403. FragmentorDownstreamMaxWriteBytes: {value: 1500, minimum: 1, flags: serverSideOnly},
  404. FragmentorDownstreamMinDelay: {value: time.Duration(0), minimum: time.Duration(0), flags: serverSideOnly},
  405. FragmentorDownstreamMaxDelay: {value: 10 * time.Millisecond, minimum: time.Duration(0), flags: serverSideOnly},
  406. // The Psiphon server will reject obfuscated SSH seed messages with
  407. // padding greater than OBFUSCATE_MAX_PADDING.
  408. // obfuscator.NewClientObfuscator will ignore invalid min/max padding
  409. // configurations.
  410. ObfuscatedSSHMinPadding: {value: 0, minimum: 0},
  411. ObfuscatedSSHMaxPadding: {value: obfuscator.OBFUSCATE_MAX_PADDING, minimum: 0},
  412. AdditionalCustomHeaders: {value: make(http.Header)},
  413. // Speed test and SSH keep alive padding is intended to frustrate
  414. // fingerprinting and should not exceed ~1 IP packet size.
  415. //
  416. // Currently, each serialized speed test sample, populated with real
  417. // values, is approximately 100 bytes. All SpeedTestMaxSampleCount samples
  418. // are loaded into memory are sent as API inputs.
  419. SpeedTestPaddingMinBytes: {value: 0, minimum: 0},
  420. SpeedTestPaddingMaxBytes: {value: 256, minimum: 0},
  421. SpeedTestMaxSampleCount: {value: 5, minimum: 1},
  422. // The Psiphon server times out inactive tunnels after 5 minutes, so this
  423. // is a soft max for SSHKeepAlivePeriodMax.
  424. SSHKeepAliveSpeedTestSampleProbability: {value: 0.5, minimum: 0.0},
  425. SSHKeepAlivePaddingMinBytes: {value: 0, minimum: 0},
  426. SSHKeepAlivePaddingMaxBytes: {value: 256, minimum: 0},
  427. SSHKeepAlivePeriodMin: {value: 1 * time.Minute, minimum: 1 * time.Second},
  428. SSHKeepAlivePeriodMax: {value: 2 * time.Minute, minimum: 1 * time.Second},
  429. SSHKeepAlivePeriodicTimeout: {value: 30 * time.Second, minimum: 1 * time.Second, flags: useNetworkLatencyMultiplier},
  430. SSHKeepAlivePeriodicInactivePeriod: {value: 10 * time.Second, minimum: 1 * time.Second},
  431. SSHKeepAliveProbeTimeout: {value: 5 * time.Second, minimum: 1 * time.Second, flags: useNetworkLatencyMultiplier},
  432. SSHKeepAliveProbeInactivePeriod: {value: 10 * time.Second, minimum: 1 * time.Second},
  433. SSHKeepAliveNetworkConnectivityPollingPeriod: {value: 500 * time.Millisecond, minimum: 1 * time.Millisecond},
  434. SSHKeepAliveResetOnFailureProbability: {value: 0.0, minimum: 0.0},
  435. HTTPProxyOriginServerTimeout: {value: 15 * time.Second, minimum: time.Duration(0), flags: useNetworkLatencyMultiplier},
  436. HTTPProxyMaxIdleConnectionsPerHost: {value: 50, minimum: 0},
  437. FetchRemoteServerListTimeout: {value: 30 * time.Second, minimum: 1 * time.Second, flags: useNetworkLatencyMultiplier},
  438. FetchRemoteServerListRetryPeriod: {value: 30 * time.Second, minimum: 1 * time.Millisecond},
  439. FetchRemoteServerListStalePeriod: {value: 6 * time.Hour, minimum: 1 * time.Hour},
  440. RemoteServerListSignaturePublicKey: {value: ""},
  441. RemoteServerListURLs: {value: TransferURLs{}},
  442. ObfuscatedServerListRootURLs: {value: TransferURLs{}},
  443. PsiphonAPIRequestTimeout: {value: 20 * time.Second, minimum: 1 * time.Second, flags: useNetworkLatencyMultiplier},
  444. PsiphonAPIStatusRequestPeriodMin: {value: 5 * time.Minute, minimum: 1 * time.Second},
  445. PsiphonAPIStatusRequestPeriodMax: {value: 10 * time.Minute, minimum: 1 * time.Second},
  446. PsiphonAPIStatusRequestShortPeriodMin: {value: 5 * time.Second, minimum: 1 * time.Second},
  447. PsiphonAPIStatusRequestShortPeriodMax: {value: 10 * time.Second, minimum: 1 * time.Second},
  448. // PsiphonAPIPersistentStatsMaxCount parameter is obsoleted by PersistentStatsMaxSendBytes.
  449. // TODO: remove once no longer required for older clients.
  450. PsiphonAPIPersistentStatsMaxCount: {value: 100, minimum: 1},
  451. // PsiphonAPIStatusRequestPadding parameters are obsoleted by APIRequestUp/DownstreamPadding.
  452. // TODO: remove once no longer required for older clients.
  453. PsiphonAPIStatusRequestPaddingMinBytes: {value: 0, minimum: 0},
  454. PsiphonAPIStatusRequestPaddingMaxBytes: {value: 256, minimum: 0},
  455. PsiphonAPIConnectedRequestRetryPeriod: {value: 5 * time.Second, minimum: 1 * time.Millisecond},
  456. // FetchSplitTunnelRoutesTimeout, SplitTunnelRoutesURLFormat,
  457. // SplitTunnelRoutesSignaturePublicKey and SplitTunnelDNSServer are obsoleted
  458. // by the server-assisted split tunnel implementation.
  459. // TODO: remove once no longer required for older clients.
  460. FetchSplitTunnelRoutesTimeout: {value: 60 * time.Second, minimum: 1 * time.Second, flags: useNetworkLatencyMultiplier},
  461. SplitTunnelRoutesURLFormat: {value: ""},
  462. SplitTunnelRoutesSignaturePublicKey: {value: ""},
  463. SplitTunnelDNSServer: {value: ""},
  464. SplitTunnelClassificationTTL: {value: 24 * time.Hour, minimum: 0 * time.Second},
  465. SplitTunnelClassificationMaxEntries: {value: 65536, minimum: 0},
  466. FetchUpgradeTimeout: {value: 60 * time.Second, minimum: 1 * time.Second, flags: useNetworkLatencyMultiplier},
  467. FetchUpgradeRetryPeriod: {value: 30 * time.Second, minimum: 1 * time.Millisecond},
  468. FetchUpgradeStalePeriod: {value: 6 * time.Hour, minimum: 1 * time.Hour},
  469. UpgradeDownloadURLs: {value: TransferURLs{}},
  470. UpgradeDownloadClientVersionHeader: {value: ""},
  471. TotalBytesTransferredNoticePeriod: {value: 5 * time.Minute, minimum: 1 * time.Second},
  472. TotalBytesTransferredEmitMemoryMetrics: {value: true},
  473. // The meek server times out inactive sessions after 45 seconds, so this
  474. // is a soft max for MeekMaxPollInterval, MeekRoundTripTimeout, and
  475. // MeekRoundTripRetryDeadline.
  476. //
  477. // MeekCookieMaxPadding cannot exceed common.OBFUSCATE_SEED_LENGTH.
  478. //
  479. // MeekMinTLSPadding/MeekMaxTLSPadding are subject to TLS server limitations.
  480. //
  481. // MeekMinLimitRequestPayloadLength/MeekMaxLimitRequestPayloadLength
  482. // cannot exceed server.MEEK_MAX_REQUEST_PAYLOAD_LENGTH.
  483. MeekDialDomainsOnly: {value: false},
  484. MeekLimitBufferSizes: {value: false},
  485. MeekCookieMaxPadding: {value: 256, minimum: 0},
  486. MeekFullReceiveBufferLength: {value: 4194304, minimum: 1024},
  487. MeekReadPayloadChunkLength: {value: 65536, minimum: 1024},
  488. MeekLimitedFullReceiveBufferLength: {value: 131072, minimum: 1024},
  489. MeekLimitedReadPayloadChunkLength: {value: 4096, minimum: 1024},
  490. MeekMinPollInterval: {value: 100 * time.Millisecond, minimum: 1 * time.Millisecond},
  491. MeekMinPollIntervalJitter: {value: 0.3, minimum: 0.0},
  492. MeekMaxPollInterval: {value: 5 * time.Second, minimum: 1 * time.Millisecond},
  493. MeekMaxPollIntervalJitter: {value: 0.1, minimum: 0.0},
  494. MeekPollIntervalMultiplier: {value: 1.5, minimum: 0.0},
  495. MeekPollIntervalJitter: {value: 0.1, minimum: 0.0},
  496. MeekApplyPollIntervalMultiplierProbability: {value: 0.5},
  497. MeekRoundTripRetryDeadline: {value: 5 * time.Second, minimum: 1 * time.Millisecond, flags: useNetworkLatencyMultiplier},
  498. MeekRoundTripRetryMinDelay: {value: 50 * time.Millisecond, minimum: time.Duration(0)},
  499. MeekRoundTripRetryMaxDelay: {value: 1 * time.Second, minimum: time.Duration(0)},
  500. MeekRoundTripRetryMultiplier: {value: 2.0, minimum: 0.0},
  501. MeekRoundTripTimeout: {value: 20 * time.Second, minimum: 1 * time.Second, flags: useNetworkLatencyMultiplier},
  502. MeekTrafficShapingProbability: {value: 1.0, minimum: 0.0},
  503. MeekTrafficShapingLimitProtocols: {value: protocol.TunnelProtocols{}},
  504. MeekMinTLSPadding: {value: 0, minimum: 0},
  505. MeekMaxTLSPadding: {value: 0, minimum: 0},
  506. MeekMinLimitRequestPayloadLength: {value: 65536, minimum: 1},
  507. MeekMaxLimitRequestPayloadLength: {value: 65536, minimum: 1},
  508. MeekRedialTLSProbability: {value: 0.0, minimum: 0.0},
  509. MeekAlternateCookieNameProbability: {value: 0.5, minimum: 0.0},
  510. MeekAlternateContentTypeProbability: {value: 0.5, minimum: 0.0},
  511. TransformHostNameProbability: {value: 0.5, minimum: 0.0},
  512. PickUserAgentProbability: {value: 0.5, minimum: 0.0},
  513. LivenessTestMinUpstreamBytes: {value: 0, minimum: 0},
  514. LivenessTestMaxUpstreamBytes: {value: 0, minimum: 0},
  515. LivenessTestMinDownstreamBytes: {value: 0, minimum: 0},
  516. LivenessTestMaxDownstreamBytes: {value: 0, minimum: 0},
  517. ReplayCandidateCount: {value: 10, minimum: -1},
  518. ReplayDialParametersTTL: {value: 24 * time.Hour, minimum: time.Duration(0)},
  519. ReplayTargetUpstreamBytes: {value: 0, minimum: 0},
  520. ReplayTargetDownstreamBytes: {value: 0, minimum: 0},
  521. ReplayTargetTunnelDuration: {value: 1 * time.Second, minimum: time.Duration(0)},
  522. ReplayLaterRoundMoveToFrontProbability: {value: 0.0, minimum: 0.0},
  523. ReplayRetainFailedProbability: {value: 0.5, minimum: 0.0},
  524. ReplayBPF: {value: true},
  525. ReplaySSH: {value: true},
  526. ReplayObfuscatorPadding: {value: true},
  527. ReplayFragmentor: {value: true},
  528. ReplayTLSProfile: {value: true},
  529. ReplayRandomizedTLSProfile: {value: true},
  530. ReplayFronting: {value: true},
  531. ReplayHostname: {value: true},
  532. ReplayQUICVersion: {value: true},
  533. ReplayObfuscatedQUIC: {value: true},
  534. ReplayConjureRegistration: {value: true},
  535. ReplayConjureTransport: {value: true},
  536. ReplayLivenessTest: {value: true},
  537. ReplayUserAgent: {value: true},
  538. ReplayAPIRequestPadding: {value: true},
  539. ReplayHoldOffTunnel: {value: true},
  540. ReplayResolveParameters: {value: true},
  541. ReplayHTTPTransformerParameters: {value: true},
  542. APIRequestUpstreamPaddingMinBytes: {value: 0, minimum: 0},
  543. APIRequestUpstreamPaddingMaxBytes: {value: 1024, minimum: 0},
  544. APIRequestDownstreamPaddingMinBytes: {value: 0, minimum: 0},
  545. APIRequestDownstreamPaddingMaxBytes: {value: 1024, minimum: 0},
  546. PersistentStatsMaxStoreRecords: {value: 200, minimum: 1},
  547. PersistentStatsMaxSendBytes: {value: 65536, minimum: 1},
  548. RecordRemoteServerListPersistentStatsProbability: {value: 1.0, minimum: 0.0},
  549. RecordFailedTunnelPersistentStatsProbability: {value: 0.0, minimum: 0.0},
  550. ServerEntryMinimumAgeForPruning: {value: 7 * 24 * time.Hour, minimum: 24 * time.Hour},
  551. ApplicationParametersProbability: {value: 1.0, minimum: 0.0},
  552. ApplicationParameters: {value: KeyValues{}},
  553. BPFServerTCPProgram: {value: (*BPFProgramSpec)(nil), flags: serverSideOnly},
  554. BPFServerTCPProbability: {value: 0.5, minimum: 0.0, flags: serverSideOnly},
  555. BPFClientTCPProgram: {value: (*BPFProgramSpec)(nil)},
  556. BPFClientTCPProbability: {value: 0.5, minimum: 0.0},
  557. ServerPacketManipulationSpecs: {value: PacketManipulationSpecs{}, flags: serverSideOnly},
  558. ServerProtocolPacketManipulations: {value: make(ProtocolPacketManipulations), flags: serverSideOnly},
  559. ServerPacketManipulationProbability: {value: 0.5, minimum: 0.0, flags: serverSideOnly},
  560. FeedbackUploadURLs: {value: TransferURLs{}},
  561. FeedbackEncryptionPublicKey: {value: ""},
  562. FeedbackTacticsWaitPeriod: {value: 5 * time.Second, minimum: 0 * time.Second, flags: useNetworkLatencyMultiplier},
  563. FeedbackUploadMaxAttempts: {value: 5, minimum: 0},
  564. // TODO: rename -- remove "Seconds" suffix
  565. FeedbackUploadRetryMinDelaySeconds: {value: 1 * time.Minute, minimum: time.Duration(0), flags: useNetworkLatencyMultiplier},
  566. FeedbackUploadRetryMaxDelaySeconds: {value: 5 * time.Minute, minimum: 1 * time.Second, flags: useNetworkLatencyMultiplier},
  567. FeedbackUploadTimeoutSeconds: {value: 30 * time.Second, minimum: 0 * time.Second, flags: useNetworkLatencyMultiplier},
  568. ServerReplayPacketManipulation: {value: true, flags: serverSideOnly},
  569. ServerReplayFragmentor: {value: true, flags: serverSideOnly},
  570. ServerReplayUnknownGeoIP: {value: false, flags: serverSideOnly},
  571. ServerReplayTTL: {value: time.Duration(0), minimum: time.Duration(0), flags: serverSideOnly},
  572. ServerReplayTargetWaitDuration: {value: time.Duration(0), minimum: time.Duration(0), flags: serverSideOnly},
  573. ServerReplayTargetTunnelDuration: {value: time.Duration(0), minimum: time.Duration(0), flags: serverSideOnly},
  574. ServerReplayTargetUpstreamBytes: {value: 0, minimum: 0, flags: serverSideOnly},
  575. ServerReplayTargetDownstreamBytes: {value: 0, minimum: 0, flags: serverSideOnly},
  576. ServerReplayFailedCountThreshold: {value: 0, minimum: 0, flags: serverSideOnly},
  577. ServerBurstUpstreamTargetBytes: {value: 0, minimum: 0, flags: serverSideOnly},
  578. ServerBurstUpstreamDeadline: {value: time.Duration(0), minimum: time.Duration(0), flags: serverSideOnly},
  579. ServerBurstDownstreamTargetBytes: {value: 0, minimum: 0, flags: serverSideOnly},
  580. ServerBurstDownstreamDeadline: {value: time.Duration(0), minimum: time.Duration(0), flags: serverSideOnly},
  581. ClientBurstUpstreamTargetBytes: {value: 0, minimum: 0},
  582. ClientBurstUpstreamDeadline: {value: time.Duration(0), minimum: time.Duration(0)},
  583. ClientBurstDownstreamTargetBytes: {value: 0, minimum: 0},
  584. ClientBurstDownstreamDeadline: {value: time.Duration(0), minimum: time.Duration(0)},
  585. ConjureCachedRegistrationTTL: {value: time.Duration(0), minimum: time.Duration(0)},
  586. // ConjureAPIRegistrarURL parameter is obsoleted by ConjureAPIRegistrarBidirectionalURL.
  587. // TODO: remove once no longer required for older clients.
  588. ConjureAPIRegistrarURL: {value: ""},
  589. ConjureAPIRegistrarBidirectionalURL: {value: ""},
  590. ConjureAPIRegistrarFrontingSpecs: {value: FrontingSpecs{}},
  591. ConjureAPIRegistrarMinDelay: {value: time.Duration(0), minimum: time.Duration(0)},
  592. ConjureAPIRegistrarMaxDelay: {value: time.Duration(0), minimum: time.Duration(0)},
  593. ConjureDecoyRegistrarProbability: {value: 0.0, minimum: 0.0},
  594. ConjureDecoyRegistrarWidth: {value: 5, minimum: 0},
  595. ConjureDecoyRegistrarMinDelay: {value: time.Duration(0), minimum: time.Duration(0)},
  596. ConjureDecoyRegistrarMaxDelay: {value: time.Duration(0), minimum: time.Duration(0)},
  597. ConjureTransportObfs4Probability: {value: 0.0, minimum: 0.0},
  598. CustomHostNameRegexes: {value: RegexStrings{}},
  599. CustomHostNameProbability: {value: 0.0, minimum: 0.0},
  600. CustomHostNameLimitProtocols: {value: protocol.TunnelProtocols{}},
  601. HoldOffTunnelMinDuration: {value: time.Duration(0), minimum: time.Duration(0)},
  602. HoldOffTunnelMaxDuration: {value: time.Duration(0), minimum: time.Duration(0)},
  603. HoldOffTunnelProtocols: {value: protocol.TunnelProtocols{}},
  604. HoldOffTunnelFrontingProviderIDs: {value: []string{}},
  605. HoldOffTunnelProbability: {value: 0.0, minimum: 0.0},
  606. RestrictFrontingProviderIDs: {value: []string{}},
  607. RestrictFrontingProviderIDsServerProbability: {value: 0.0, minimum: 0.0, flags: serverSideOnly},
  608. RestrictFrontingProviderIDsClientProbability: {value: 0.0, minimum: 0.0},
  609. UpstreamProxyAllowAllServerEntrySources: {value: false},
  610. DestinationBytesMetricsASN: {value: "", flags: serverSideOnly},
  611. DNSResolverAttemptsPerServer: {value: 2, minimum: 1},
  612. DNSResolverAttemptsPerPreferredServer: {value: 1, minimum: 1},
  613. DNSResolverRequestTimeout: {value: 5 * time.Second, minimum: 100 * time.Millisecond, flags: useNetworkLatencyMultiplier},
  614. DNSResolverAwaitTimeout: {value: 10 * time.Millisecond, minimum: 1 * time.Millisecond, flags: useNetworkLatencyMultiplier},
  615. DNSResolverPreresolvedIPAddressCIDRs: {value: LabeledCIDRs{}},
  616. DNSResolverPreresolvedIPAddressProbability: {value: 0.0, minimum: 0.0},
  617. DNSResolverAlternateServers: {value: []string{}},
  618. DNSResolverPreferredAlternateServers: {value: []string{}},
  619. DNSResolverPreferAlternateServerProbability: {value: 0.0, minimum: 0.0},
  620. DNSResolverProtocolTransformSpecs: {value: transforms.Specs{}},
  621. DNSResolverProtocolTransformScopedSpecNames: {value: transforms.ScopedSpecNames{}},
  622. DNSResolverProtocolTransformProbability: {value: 0.0, minimum: 0.0},
  623. DNSResolverIncludeEDNS0Probability: {value: 0.0, minimum: 0.0},
  624. DNSResolverCacheExtensionInitialTTL: {value: time.Duration(0), minimum: time.Duration(0)},
  625. DNSResolverCacheExtensionVerifiedTTL: {value: time.Duration(0), minimum: time.Duration(0)},
  626. AddFrontingProviderPsiphonFrontingHeader: {value: protocol.LabeledTunnelProtocols{}},
  627. DirectHTTPProtocolTransformSpecs: {value: transforms.Specs{}},
  628. DirectHTTPProtocolTransformScopedSpecNames: {value: transforms.ScopedSpecNames{}},
  629. DirectHTTPProtocolTransformProbability: {value: 0.0, minimum: 0.0},
  630. FrontedHTTPProtocolTransformSpecs: {value: transforms.Specs{}},
  631. FrontedHTTPProtocolTransformScopedSpecNames: {value: transforms.ScopedSpecNames{}},
  632. FrontedHTTPProtocolTransformProbability: {value: 0.0, minimum: 0.0},
  633. }
  634. // IsServerSideOnly indicates if the parameter specified by name is used
  635. // server-side only.
  636. func IsServerSideOnly(name string) bool {
  637. defaultParameter, ok := defaultParameters[name]
  638. return ok && (defaultParameter.flags&serverSideOnly) != 0
  639. }
  640. // Parameters is a set of parameters. To use the parameters, call Get. To
  641. // apply new values to the parameters, call Set.
  642. type Parameters struct {
  643. getValueLogger func(error)
  644. snapshot atomic.Value
  645. }
  646. // NewParameters initializes a new Parameters with the default parameter
  647. // values.
  648. //
  649. // getValueLogger is optional, and is used to report runtime errors with
  650. // getValue; see comment in getValue.
  651. func NewParameters(
  652. getValueLogger func(error)) (*Parameters, error) {
  653. parameters := &Parameters{
  654. getValueLogger: getValueLogger,
  655. }
  656. _, err := parameters.Set("", false)
  657. if err != nil {
  658. return nil, errors.Trace(err)
  659. }
  660. return parameters, nil
  661. }
  662. func makeDefaultParameters() (map[string]interface{}, error) {
  663. parameters := make(map[string]interface{})
  664. for name, defaults := range defaultParameters {
  665. if defaults.value == nil {
  666. return nil, errors.Tracef("default parameter missing value: %s", name)
  667. }
  668. if defaults.minimum != nil &&
  669. reflect.TypeOf(defaults.value) != reflect.TypeOf(defaults.minimum) {
  670. return nil, errors.Tracef("default parameter value and minimum type mismatch: %s", name)
  671. }
  672. _, isDuration := defaults.value.(time.Duration)
  673. if defaults.flags&useNetworkLatencyMultiplier != 0 && !isDuration {
  674. return nil, errors.Tracef("default non-duration parameter uses multipler: %s", name)
  675. }
  676. parameters[name] = defaults.value
  677. }
  678. return parameters, nil
  679. }
  680. // Set replaces the current parameters. First, a set of parameters are
  681. // initialized using the default values. Then, each applyParameters is applied
  682. // in turn, with the later instances having precedence.
  683. //
  684. // When skipOnError is true, unknown or invalid parameters in any
  685. // applyParameters are skipped instead of aborting with an error.
  686. //
  687. // For protocol.TunnelProtocols and protocol.TLSProfiles type values, when
  688. // skipOnError is true the values are filtered instead of validated, so
  689. // only known tunnel protocols and TLS profiles are retained.
  690. //
  691. // When an error is returned, the previous parameters remain completely
  692. // unmodified.
  693. //
  694. // For use in logging, Set returns a count of the number of parameters applied
  695. // from each applyParameters.
  696. func (p *Parameters) Set(
  697. tag string, skipOnError bool, applyParameters ...map[string]interface{}) ([]int, error) {
  698. makeTypedValue := func(templateValue, value interface{}) (interface{}, error) {
  699. // Accept strings such as "1h" for duration parameters.
  700. switch templateValue.(type) {
  701. case time.Duration:
  702. if s, ok := value.(string); ok {
  703. if d, err := time.ParseDuration(s); err == nil {
  704. value = d
  705. }
  706. }
  707. }
  708. // A JSON remarshal resolves cases where applyParameters is a
  709. // result of unmarshal-into-interface, in which case non-scalar
  710. // values will not have the expected types; see:
  711. // https://golang.org/pkg/encoding/json/#Unmarshal. This remarshal
  712. // also results in a deep copy.
  713. marshaledValue, err := json.Marshal(value)
  714. if err != nil {
  715. return nil, errors.Trace(err)
  716. }
  717. newValuePtr := reflect.New(reflect.TypeOf(templateValue))
  718. err = json.Unmarshal(marshaledValue, newValuePtr.Interface())
  719. if err != nil {
  720. return nil, errors.Trace(err)
  721. }
  722. return newValuePtr.Elem().Interface(), nil
  723. }
  724. getAppliedValue := func(
  725. name string,
  726. parameters map[string]interface{},
  727. applyParameters []map[string]interface{}) (interface{}, error) {
  728. templateValue := parameters[name]
  729. if templateValue == nil {
  730. return nil, errors.Tracef("unknown parameter: %s", name)
  731. }
  732. value := templateValue
  733. for i := len(applyParameters) - 1; i >= 0; i-- {
  734. if v := applyParameters[i][name]; v != nil {
  735. value = v
  736. break
  737. }
  738. }
  739. return makeTypedValue(templateValue, value)
  740. }
  741. var counts []int
  742. parameters, err := makeDefaultParameters()
  743. if err != nil {
  744. return nil, errors.Trace(err)
  745. }
  746. // Special case: TLSProfiles/LabeledTLSProfiles may reference
  747. // CustomTLSProfiles names. Inspect the CustomTLSProfiles parameter and
  748. // extract its names. Do not call Get().CustomTLSProfilesNames() as
  749. // CustomTLSProfiles may not yet be validated.
  750. customTLSProfilesValue, err := getAppliedValue(
  751. CustomTLSProfiles, parameters, applyParameters)
  752. if err != nil {
  753. return nil, errors.Trace(err)
  754. }
  755. customTLSProfiles, _ := customTLSProfilesValue.(protocol.CustomTLSProfiles)
  756. customTLSProfileNames := make([]string, len(customTLSProfiles))
  757. for i, profile := range customTLSProfiles {
  758. customTLSProfileNames[i] = profile.Name
  759. }
  760. // Special case: PacketManipulations will reference PacketManipulationSpecs.
  761. serverPacketManipulationSpecsValue, err := getAppliedValue(
  762. ServerPacketManipulationSpecs, parameters, applyParameters)
  763. if err != nil {
  764. return nil, errors.Trace(err)
  765. }
  766. serverPacketManipulationSpecs, _ :=
  767. serverPacketManipulationSpecsValue.(PacketManipulationSpecs)
  768. // Special case: ProtocolTransformScopedSpecNames will reference
  769. // ProtocolTransformSpecs.
  770. dnsResolverProtocolTransformSpecsValue, err := getAppliedValue(
  771. DNSResolverProtocolTransformSpecs, parameters, applyParameters)
  772. if err != nil {
  773. return nil, errors.Trace(err)
  774. }
  775. dnsResolverProtocolTransformSpecs, _ :=
  776. dnsResolverProtocolTransformSpecsValue.(transforms.Specs)
  777. directHttpProtocolTransformSpecsValue, err := getAppliedValue(
  778. DirectHTTPProtocolTransformSpecs, parameters, applyParameters)
  779. if err != nil {
  780. return nil, errors.Trace(err)
  781. }
  782. directHttpProtocolTransformSpecs, _ :=
  783. directHttpProtocolTransformSpecsValue.(transforms.Specs)
  784. frontedHttpProtocolTransformSpecsValue, err := getAppliedValue(
  785. FrontedHTTPProtocolTransformSpecs, parameters, applyParameters)
  786. if err != nil {
  787. return nil, errors.Trace(err)
  788. }
  789. frontedHttpProtocolTransformSpecs, _ :=
  790. frontedHttpProtocolTransformSpecsValue.(transforms.Specs)
  791. for i := 0; i < len(applyParameters); i++ {
  792. count := 0
  793. for name, value := range applyParameters[i] {
  794. templateValue, ok := parameters[name]
  795. if !ok {
  796. if skipOnError {
  797. continue
  798. }
  799. return nil, errors.Tracef("unknown parameter: %s", name)
  800. }
  801. newValue, err := makeTypedValue(templateValue, value)
  802. if err != nil {
  803. if skipOnError {
  804. continue
  805. }
  806. return nil, errors.Tracef(
  807. "unmarshal parameter %s failed: %v", name, err)
  808. }
  809. // Perform type-specific validation for some cases.
  810. // TODO: require RemoteServerListSignaturePublicKey when
  811. // RemoteServerListURLs is set?
  812. switch v := newValue.(type) {
  813. case TransferURLs:
  814. err := v.DecodeAndValidate()
  815. if err != nil {
  816. if skipOnError {
  817. continue
  818. }
  819. return nil, errors.Trace(err)
  820. }
  821. case protocol.TunnelProtocols:
  822. if skipOnError {
  823. newValue = v.PruneInvalid()
  824. } else {
  825. err := v.Validate()
  826. if err != nil {
  827. return nil, errors.Trace(err)
  828. }
  829. }
  830. case protocol.LabeledTunnelProtocols:
  831. if skipOnError {
  832. newValue = v.PruneInvalid()
  833. } else {
  834. err := v.Validate()
  835. if err != nil {
  836. return nil, errors.Trace(err)
  837. }
  838. }
  839. case protocol.TLSProfiles:
  840. if skipOnError {
  841. newValue = v.PruneInvalid(customTLSProfileNames)
  842. } else {
  843. err := v.Validate(customTLSProfileNames)
  844. if err != nil {
  845. return nil, errors.Trace(err)
  846. }
  847. }
  848. case protocol.LabeledTLSProfiles:
  849. if skipOnError {
  850. newValue = v.PruneInvalid(customTLSProfileNames)
  851. } else {
  852. err := v.Validate(customTLSProfileNames)
  853. if err != nil {
  854. return nil, errors.Trace(err)
  855. }
  856. }
  857. case protocol.QUICVersions:
  858. if skipOnError {
  859. newValue = v.PruneInvalid()
  860. } else {
  861. err := v.Validate()
  862. if err != nil {
  863. return nil, errors.Trace(err)
  864. }
  865. }
  866. case protocol.LabeledQUICVersions:
  867. if skipOnError {
  868. newValue = v.PruneInvalid()
  869. } else {
  870. err := v.Validate()
  871. if err != nil {
  872. return nil, errors.Trace(err)
  873. }
  874. }
  875. case protocol.CustomTLSProfiles:
  876. err := v.Validate()
  877. if err != nil {
  878. if skipOnError {
  879. continue
  880. }
  881. return nil, errors.Trace(err)
  882. }
  883. case KeyValues:
  884. err := v.Validate()
  885. if err != nil {
  886. if skipOnError {
  887. continue
  888. }
  889. return nil, errors.Trace(err)
  890. }
  891. case *BPFProgramSpec:
  892. if v != nil {
  893. err := v.Validate()
  894. if err != nil {
  895. if skipOnError {
  896. continue
  897. }
  898. return nil, errors.Trace(err)
  899. }
  900. }
  901. case PacketManipulationSpecs:
  902. err := v.Validate()
  903. if err != nil {
  904. if skipOnError {
  905. continue
  906. }
  907. return nil, errors.Trace(err)
  908. }
  909. case ProtocolPacketManipulations:
  910. var packetManipulationSpecs PacketManipulationSpecs
  911. if name == ServerProtocolPacketManipulations {
  912. packetManipulationSpecs = serverPacketManipulationSpecs
  913. }
  914. err := v.Validate(packetManipulationSpecs)
  915. if err != nil {
  916. if skipOnError {
  917. continue
  918. }
  919. return nil, errors.Trace(err)
  920. }
  921. case RegexStrings:
  922. err := v.Validate()
  923. if err != nil {
  924. if skipOnError {
  925. continue
  926. }
  927. return nil, errors.Trace(err)
  928. }
  929. case FrontingSpecs:
  930. err := v.Validate()
  931. if err != nil {
  932. if skipOnError {
  933. continue
  934. }
  935. return nil, errors.Trace(err)
  936. }
  937. case TunnelProtocolPortLists:
  938. err := v.Validate()
  939. if err != nil {
  940. if skipOnError {
  941. continue
  942. }
  943. return nil, errors.Trace(err)
  944. }
  945. case LabeledCIDRs:
  946. err := v.Validate()
  947. if err != nil {
  948. if skipOnError {
  949. continue
  950. }
  951. return nil, errors.Trace(err)
  952. }
  953. case transforms.Specs:
  954. err := v.Validate()
  955. if err != nil {
  956. if skipOnError {
  957. continue
  958. }
  959. return nil, errors.Trace(err)
  960. }
  961. case transforms.ScopedSpecNames:
  962. var specs transforms.Specs
  963. if name == DNSResolverProtocolTransformScopedSpecNames {
  964. specs = dnsResolverProtocolTransformSpecs
  965. } else if name == DirectHTTPProtocolTransformScopedSpecNames {
  966. specs = directHttpProtocolTransformSpecs
  967. } else if name == FrontedHTTPProtocolTransformScopedSpecNames {
  968. specs = frontedHttpProtocolTransformSpecs
  969. }
  970. err := v.Validate(specs)
  971. if err != nil {
  972. if skipOnError {
  973. continue
  974. }
  975. return nil, errors.Trace(err)
  976. }
  977. }
  978. // Enforce any minimums. Assumes defaultParameters[name]
  979. // exists.
  980. if defaultParameters[name].minimum != nil {
  981. valid := true
  982. switch v := newValue.(type) {
  983. case int:
  984. m, ok := defaultParameters[name].minimum.(int)
  985. if !ok || v < m {
  986. valid = false
  987. }
  988. case float64:
  989. m, ok := defaultParameters[name].minimum.(float64)
  990. if !ok || v < m {
  991. valid = false
  992. }
  993. case time.Duration:
  994. m, ok := defaultParameters[name].minimum.(time.Duration)
  995. if !ok || v < m {
  996. valid = false
  997. }
  998. default:
  999. if skipOnError {
  1000. continue
  1001. }
  1002. return nil, errors.Tracef("unexpected parameter with minimum: %s", name)
  1003. }
  1004. if !valid {
  1005. if skipOnError {
  1006. continue
  1007. }
  1008. return nil, errors.Tracef("parameter below minimum: %s", name)
  1009. }
  1010. }
  1011. parameters[name] = newValue
  1012. count++
  1013. }
  1014. counts = append(counts, count)
  1015. }
  1016. snapshot := &parametersSnapshot{
  1017. getValueLogger: p.getValueLogger,
  1018. tag: tag,
  1019. parameters: parameters,
  1020. }
  1021. p.snapshot.Store(snapshot)
  1022. return counts, nil
  1023. }
  1024. // Get returns the current parameters.
  1025. //
  1026. // Values read from the current parameters are not deep copies and must be
  1027. // treated read-only.
  1028. //
  1029. // The returned ParametersAccessor may be used to read multiple related values
  1030. // atomically and consistently while the current set of values in Parameters
  1031. // may change concurrently.
  1032. //
  1033. // Get does not perform any heap allocations and is intended for repeated,
  1034. // direct, low-overhead invocations.
  1035. func (p *Parameters) Get() ParametersAccessor {
  1036. return ParametersAccessor{
  1037. snapshot: p.snapshot.Load().(*parametersSnapshot)}
  1038. }
  1039. // GetCustom returns the current parameters while also setting customizations
  1040. // for this instance.
  1041. //
  1042. // The properties of Get also apply to GetCustom: must be read-only; atomic
  1043. // and consisent view; no heap allocations.
  1044. //
  1045. // Customizations include:
  1046. //
  1047. // - customNetworkLatencyMultiplier, which overrides NetworkLatencyMultiplier
  1048. // for this instance only.
  1049. func (p *Parameters) GetCustom(
  1050. customNetworkLatencyMultiplier float64) ParametersAccessor {
  1051. return ParametersAccessor{
  1052. snapshot: p.snapshot.Load().(*parametersSnapshot),
  1053. customNetworkLatencyMultiplier: customNetworkLatencyMultiplier,
  1054. }
  1055. }
  1056. // parametersSnapshot is an atomic snapshot of the parameter values.
  1057. // Parameters.Get will return a snapshot which may be used to read multiple
  1058. // related values atomically and consistently while the current snapshot in
  1059. // Parameters may change concurrently.
  1060. type parametersSnapshot struct {
  1061. getValueLogger func(error)
  1062. tag string
  1063. parameters map[string]interface{}
  1064. }
  1065. // getValue sets target to the value of the named parameter.
  1066. //
  1067. // It is an error if the name is not found, target is not a pointer, or the
  1068. // type of target points to does not match the value.
  1069. //
  1070. // Any of these conditions would be a bug in the caller. getValue does not
  1071. // panic in these cases as clients are deployed as a library in various apps
  1072. // and the failure of Psiphon may not be a failure for the app process.
  1073. //
  1074. // Instead, errors are logged to the getValueLogger and getValue leaves the
  1075. // target unset, which will result in the caller getting and using a zero
  1076. // value of the requested type.
  1077. func (p *parametersSnapshot) getValue(name string, target interface{}) {
  1078. value, ok := p.parameters[name]
  1079. if !ok {
  1080. if p.getValueLogger != nil {
  1081. p.getValueLogger(errors.Tracef(
  1082. "value %s not found", name))
  1083. }
  1084. return
  1085. }
  1086. valueType := reflect.TypeOf(value)
  1087. if reflect.PtrTo(valueType) != reflect.TypeOf(target) {
  1088. if p.getValueLogger != nil {
  1089. p.getValueLogger(errors.Tracef(
  1090. "value %s has unexpected type %s", name, valueType.Name()))
  1091. }
  1092. return
  1093. }
  1094. // Note: there is no deep copy of parameter values; the returned value may
  1095. // share memory with the original and should not be modified.
  1096. targetValue := reflect.ValueOf(target)
  1097. if targetValue.Kind() != reflect.Ptr {
  1098. p.getValueLogger(errors.Tracef(
  1099. "target for value %s is not pointer", name))
  1100. return
  1101. }
  1102. targetValue.Elem().Set(reflect.ValueOf(value))
  1103. }
  1104. // ParametersAccessor provides consistent, atomic access to parameter values.
  1105. // Any customizations are applied transparently.
  1106. type ParametersAccessor struct {
  1107. snapshot *parametersSnapshot
  1108. customNetworkLatencyMultiplier float64
  1109. }
  1110. // MakeNilParametersAccessor produces a stub ParametersAccessor which returns
  1111. // true for IsNil. This may be used where a ParametersAccessor value is
  1112. // required, but Parameters.Get may not succeed. In contexts where
  1113. // MakeNilParametersAccessor may be used, calls to ParametersAccessor must
  1114. // first check IsNil before calling accessor functions.
  1115. func MakeNilParametersAccessor() ParametersAccessor {
  1116. return ParametersAccessor{}
  1117. }
  1118. // IsNil indicates that this ParametersAccessor is a stub and its accessor
  1119. // functions may not be called. A ParametersAccessor produced by
  1120. // Parameters.Get will never return true for IsNil and IsNil guards are not
  1121. // required for ParametersAccessors known to be produced by Parameters.Get.
  1122. func (p ParametersAccessor) IsNil() bool {
  1123. return p.snapshot == nil
  1124. }
  1125. // Close clears internal references to large memory objects, allowing them to
  1126. // be garbage collected. Call Close when done using a ParametersAccessor,
  1127. // where memory footprint is a concern, and where the ParametersAccessor is
  1128. // not immediately going out of scope. After Close is called, all other
  1129. // ParametersAccessor functions will panic if called.
  1130. func (p ParametersAccessor) Close() {
  1131. p.snapshot = nil
  1132. }
  1133. // Tag returns the tag associated with these parameters.
  1134. func (p ParametersAccessor) Tag() string {
  1135. return p.snapshot.tag
  1136. }
  1137. // String returns a string parameter value.
  1138. func (p ParametersAccessor) String(name string) string {
  1139. value := ""
  1140. p.snapshot.getValue(name, &value)
  1141. return value
  1142. }
  1143. func (p ParametersAccessor) Strings(name string) []string {
  1144. value := []string{}
  1145. p.snapshot.getValue(name, &value)
  1146. return value
  1147. }
  1148. // Int returns an int parameter value.
  1149. func (p ParametersAccessor) Int(name string) int {
  1150. value := int(0)
  1151. p.snapshot.getValue(name, &value)
  1152. return value
  1153. }
  1154. // Bool returns a bool parameter value.
  1155. func (p ParametersAccessor) Bool(name string) bool {
  1156. value := false
  1157. p.snapshot.getValue(name, &value)
  1158. return value
  1159. }
  1160. // Float returns a float64 parameter value.
  1161. func (p ParametersAccessor) Float(name string) float64 {
  1162. value := float64(0.0)
  1163. p.snapshot.getValue(name, &value)
  1164. return value
  1165. }
  1166. // WeightedCoinFlip returns the result of prng.FlipWeightedCoin using the
  1167. // specified float parameter as the probability input.
  1168. func (p ParametersAccessor) WeightedCoinFlip(name string) bool {
  1169. var value float64
  1170. p.snapshot.getValue(name, &value)
  1171. return prng.FlipWeightedCoin(value)
  1172. }
  1173. // Duration returns a time.Duration parameter value. When the duration
  1174. // parameter has the useNetworkLatencyMultiplier flag, the
  1175. // NetworkLatencyMultiplier is applied to the returned value.
  1176. func (p ParametersAccessor) Duration(name string) time.Duration {
  1177. value := time.Duration(0)
  1178. p.snapshot.getValue(name, &value)
  1179. defaultParameter, ok := defaultParameters[name]
  1180. if value > 0 && ok && defaultParameter.flags&useNetworkLatencyMultiplier != 0 {
  1181. multiplier := float64(0.0)
  1182. if p.customNetworkLatencyMultiplier != 0.0 {
  1183. multiplier = p.customNetworkLatencyMultiplier
  1184. } else {
  1185. p.snapshot.getValue(NetworkLatencyMultiplier, &multiplier)
  1186. }
  1187. if multiplier > 0.0 {
  1188. value = time.Duration(float64(value) * multiplier)
  1189. }
  1190. }
  1191. return value
  1192. }
  1193. // TunnelProtocols returns a protocol.TunnelProtocols parameter value.
  1194. // If there is a corresponding Probability value, a weighted coin flip
  1195. // will be performed and, depending on the result, the value or the
  1196. // parameter default will be returned.
  1197. func (p ParametersAccessor) TunnelProtocols(name string) protocol.TunnelProtocols {
  1198. probabilityName := name + "Probability"
  1199. _, ok := p.snapshot.parameters[probabilityName]
  1200. if ok {
  1201. probabilityValue := float64(1.0)
  1202. p.snapshot.getValue(probabilityName, &probabilityValue)
  1203. if !prng.FlipWeightedCoin(probabilityValue) {
  1204. defaultParameter, ok := defaultParameters[name]
  1205. if ok {
  1206. defaultValue, ok := defaultParameter.value.(protocol.TunnelProtocols)
  1207. if ok {
  1208. value := make(protocol.TunnelProtocols, len(defaultValue))
  1209. copy(value, defaultValue)
  1210. return value
  1211. }
  1212. }
  1213. }
  1214. }
  1215. value := protocol.TunnelProtocols{}
  1216. p.snapshot.getValue(name, &value)
  1217. return value
  1218. }
  1219. // LabeledTunnelProtocols returns a protocol.TunnelProtocols parameter value
  1220. // corresponding to the specified labeled set and label value. The return
  1221. // value is nil when no set is found.
  1222. func (p ParametersAccessor) LabeledTunnelProtocols(name, label string) protocol.TunnelProtocols {
  1223. var value protocol.LabeledTunnelProtocols
  1224. p.snapshot.getValue(name, &value)
  1225. return value[label]
  1226. }
  1227. // TLSProfiles returns a protocol.TLSProfiles parameter value.
  1228. // If there is a corresponding Probability value, a weighted coin flip
  1229. // will be performed and, depending on the result, the value or the
  1230. // parameter default will be returned.
  1231. func (p ParametersAccessor) TLSProfiles(name string) protocol.TLSProfiles {
  1232. probabilityName := name + "Probability"
  1233. _, ok := p.snapshot.parameters[probabilityName]
  1234. if ok {
  1235. probabilityValue := float64(1.0)
  1236. p.snapshot.getValue(probabilityName, &probabilityValue)
  1237. if !prng.FlipWeightedCoin(probabilityValue) {
  1238. defaultParameter, ok := defaultParameters[name]
  1239. if ok {
  1240. defaultValue, ok := defaultParameter.value.(protocol.TLSProfiles)
  1241. if ok {
  1242. value := make(protocol.TLSProfiles, len(defaultValue))
  1243. copy(value, defaultValue)
  1244. return value
  1245. }
  1246. }
  1247. }
  1248. }
  1249. value := protocol.TLSProfiles{}
  1250. p.snapshot.getValue(name, &value)
  1251. return value
  1252. }
  1253. // LabeledTLSProfiles returns a protocol.TLSProfiles parameter value
  1254. // corresponding to the specified labeled set and label value. The return
  1255. // value is nil when no set is found.
  1256. func (p ParametersAccessor) LabeledTLSProfiles(name, label string) protocol.TLSProfiles {
  1257. var value protocol.LabeledTLSProfiles
  1258. p.snapshot.getValue(name, &value)
  1259. return value[label]
  1260. }
  1261. // QUICVersions returns a protocol.QUICVersions parameter value.
  1262. // If there is a corresponding Probability value, a weighted coin flip
  1263. // will be performed and, depending on the result, the value or the
  1264. // parameter default will be returned.
  1265. func (p ParametersAccessor) QUICVersions(name string) protocol.QUICVersions {
  1266. probabilityName := name + "Probability"
  1267. _, ok := p.snapshot.parameters[probabilityName]
  1268. if ok {
  1269. probabilityValue := float64(1.0)
  1270. p.snapshot.getValue(probabilityName, &probabilityValue)
  1271. if !prng.FlipWeightedCoin(probabilityValue) {
  1272. defaultParameter, ok := defaultParameters[name]
  1273. if ok {
  1274. defaultValue, ok := defaultParameter.value.(protocol.QUICVersions)
  1275. if ok {
  1276. value := make(protocol.QUICVersions, len(defaultValue))
  1277. copy(value, defaultValue)
  1278. return value
  1279. }
  1280. }
  1281. }
  1282. }
  1283. value := protocol.QUICVersions{}
  1284. p.snapshot.getValue(name, &value)
  1285. return value
  1286. }
  1287. // LabeledQUICVersions returns a protocol.QUICVersions parameter value
  1288. // corresponding to the specified labeled set and label value. The return
  1289. // value is nil when no set is found.
  1290. func (p ParametersAccessor) LabeledQUICVersions(name, label string) protocol.QUICVersions {
  1291. value := protocol.LabeledQUICVersions{}
  1292. p.snapshot.getValue(name, &value)
  1293. return value[label]
  1294. }
  1295. // TransferURLs returns a TransferURLs parameter value.
  1296. func (p ParametersAccessor) TransferURLs(name string) TransferURLs {
  1297. value := TransferURLs{}
  1298. p.snapshot.getValue(name, &value)
  1299. return value
  1300. }
  1301. // RateLimits returns a common.RateLimits parameter value.
  1302. func (p ParametersAccessor) RateLimits(name string) common.RateLimits {
  1303. value := common.RateLimits{}
  1304. p.snapshot.getValue(name, &value)
  1305. return value
  1306. }
  1307. // HTTPHeaders returns an http.Header parameter value.
  1308. func (p ParametersAccessor) HTTPHeaders(name string) http.Header {
  1309. value := make(http.Header)
  1310. p.snapshot.getValue(name, &value)
  1311. return value
  1312. }
  1313. // CustomTLSProfileNames returns the CustomTLSProfile.Name fields for
  1314. // each profile in the CustomTLSProfiles parameter value.
  1315. func (p ParametersAccessor) CustomTLSProfileNames() []string {
  1316. value := protocol.CustomTLSProfiles{}
  1317. p.snapshot.getValue(CustomTLSProfiles, &value)
  1318. names := make([]string, len(value))
  1319. for i := 0; i < len(value); i++ {
  1320. names[i] = value[i].Name
  1321. }
  1322. return names
  1323. }
  1324. // CustomTLSProfile returns the CustomTLSProfile fields with the specified
  1325. // Name field if it exists in the CustomTLSProfiles parameter value.
  1326. // Returns nil if not found.
  1327. func (p ParametersAccessor) CustomTLSProfile(name string) *protocol.CustomTLSProfile {
  1328. value := protocol.CustomTLSProfiles{}
  1329. p.snapshot.getValue(CustomTLSProfiles, &value)
  1330. // Note: linear lookup -- assumes a short list
  1331. for i := 0; i < len(value); i++ {
  1332. if value[i].Name == name {
  1333. return value[i]
  1334. }
  1335. }
  1336. return nil
  1337. }
  1338. // KeyValues returns a KeyValues parameter value.
  1339. func (p ParametersAccessor) KeyValues(name string) KeyValues {
  1340. value := KeyValues{}
  1341. p.snapshot.getValue(name, &value)
  1342. return value
  1343. }
  1344. // BPFProgram returns an assembled BPF program corresponding to a
  1345. // BPFProgramSpec parameter value. Returns nil in the case of any empty
  1346. // program.
  1347. func (p ParametersAccessor) BPFProgram(name string) (bool, string, []bpf.RawInstruction) {
  1348. var value *BPFProgramSpec
  1349. p.snapshot.getValue(name, &value)
  1350. if value == nil {
  1351. return false, "", nil
  1352. }
  1353. // Validation checks that Assemble is successful.
  1354. rawInstructions, _ := value.Assemble()
  1355. return true, value.Name, rawInstructions
  1356. }
  1357. // PacketManipulationSpecs returns a PacketManipulationSpecs parameter value.
  1358. func (p ParametersAccessor) PacketManipulationSpecs(name string) PacketManipulationSpecs {
  1359. value := PacketManipulationSpecs{}
  1360. p.snapshot.getValue(name, &value)
  1361. return value
  1362. }
  1363. // ProtocolPacketManipulations returns a ProtocolPacketManipulations parameter value.
  1364. func (p ParametersAccessor) ProtocolPacketManipulations(name string) ProtocolPacketManipulations {
  1365. value := make(ProtocolPacketManipulations)
  1366. p.snapshot.getValue(name, &value)
  1367. return value
  1368. }
  1369. // RegexStrings returns a RegexStrings parameter value.
  1370. func (p ParametersAccessor) RegexStrings(name string) RegexStrings {
  1371. value := RegexStrings{}
  1372. p.snapshot.getValue(name, &value)
  1373. return value
  1374. }
  1375. // FrontingSpecs returns a FrontingSpecs parameter value.
  1376. func (p ParametersAccessor) FrontingSpecs(name string) FrontingSpecs {
  1377. value := FrontingSpecs{}
  1378. p.snapshot.getValue(name, &value)
  1379. return value
  1380. }
  1381. // TunnelProtocolPortLists returns a TunnelProtocolPortLists parameter value.
  1382. func (p ParametersAccessor) TunnelProtocolPortLists(name string) TunnelProtocolPortLists {
  1383. probabilityName := name + "Probability"
  1384. _, ok := p.snapshot.parameters[probabilityName]
  1385. if ok {
  1386. probabilityValue := float64(1.0)
  1387. p.snapshot.getValue(probabilityName, &probabilityValue)
  1388. if !prng.FlipWeightedCoin(probabilityValue) {
  1389. defaultParameter, ok := defaultParameters[name]
  1390. if ok {
  1391. defaultValue, ok := defaultParameter.value.(TunnelProtocolPortLists)
  1392. if ok {
  1393. value := make(TunnelProtocolPortLists)
  1394. for tunnelProtocol, portLists := range defaultValue {
  1395. value[tunnelProtocol] = portLists
  1396. }
  1397. return value
  1398. }
  1399. }
  1400. }
  1401. }
  1402. value := make(TunnelProtocolPortLists)
  1403. p.snapshot.getValue(name, &value)
  1404. return value
  1405. }
  1406. // LabeledCIDRs returns a CIDR string list parameter value corresponding to
  1407. // the specified labeled set and label value. The return value is nil when no
  1408. // set is found.
  1409. func (p ParametersAccessor) LabeledCIDRs(name, label string) []string {
  1410. value := LabeledCIDRs{}
  1411. p.snapshot.getValue(name, &value)
  1412. return value[label]
  1413. }
  1414. // ProtocolTransformSpecs returns a transforms.Specs parameter value.
  1415. func (p ParametersAccessor) ProtocolTransformSpecs(name string) transforms.Specs {
  1416. value := transforms.Specs{}
  1417. p.snapshot.getValue(name, &value)
  1418. return value
  1419. }
  1420. // ProtocolTransformScopedSpecNames returns a transforms.ScopedSpecNames
  1421. // parameter value.
  1422. func (p ParametersAccessor) ProtocolTransformScopedSpecNames(name string) transforms.ScopedSpecNames {
  1423. value := transforms.ScopedSpecNames{}
  1424. p.snapshot.getValue(name, &value)
  1425. return value
  1426. }