parameters.go 79 KB

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