parameters.go 80 KB

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