netwerk/docs/dns/trr-skip-reasons.md

   1 # TRRSkippedReasons
   2
   3 These values are defined in [TRRSkippedReason.h](https://searchfox.org/mozilla-central/source/netwerk/dns/nsITRRSkipReason.idl) and are recorded on _nsHostRecord_ for each resolution.
   4 We normally use them for telemetry or to determine the cause of a TRR failure.
   5
   6
   7 ## TRR_UNSET
   8
   9 Value: 0
  10
  11 This reason is set on _nsHostRecord_ before we attempt to resolve the domain.
  12 Normally we should not report this value into telemetry - if we do that means there's a bug in the code.
  13
  14
  15 ## TRR_OK
  16
  17 Value: 1
  18
  19 This reason is set when we got a positive TRR result. That means we used TRR for the DNS resolution, the HTTPS request got a 200 response, the response was properly decoded as a DNS packet and that packet contained relevant answers.
  20
  21
  22 ## TRR_NO_GSERVICE
  23
  24 Value: 2
  25
  26 This reason is only set if there is no TRR service instance when trying to compute the TRR mode for a request. It indicates a bug in the implementation.
  27
  28
  29 ## TRR_PARENTAL_CONTROL
  30
  31 Value: 3
  32
  33 This reason is set when we have detected system level parental controls are enabled. In this case we will not be using TRR for any requests.
  34
  35
  36 ## TRR_OFF_EXPLICIT
  37
  38 Value: 4
  39
  40 This reason is set when DNS over HTTPS has been explicitly disabled by the user (by setting _network.trr.mode_ to _5_). In this case we will not be using TRR for any requests.
  41
  42
  43 ## TRR_REQ_MODE_DISABLED
  44
  45 Value: 5
  46
  47 The request had the _nsIRequest::TRRMode_ set to _TRR\_DISABLED\_MODE_. That is usually the case for request that should not use TRR, such as the TRRServiceChannel, captive portal and connectivity checks, DoHHeuristics checks, requests originating from PAC scripts, etc.
  48
  49
  50 ## TRR_MODE_NOT_ENABLED
  51
  52 Value: 6
  53
  54 This reason is set when the TRRService is not enabled. The only way we would end up reporting this to telemetry would be if the TRRService was enabled when the request was dispatched, but by the time it was processed the TRRService was disabled.
  55
  56
  57 ## TRR_FAILED
  58
  59 Value: 7
  60
  61 The TRR request failed for an unknown reason.
  62
  63
  64 ## TRR_MODE_UNHANDLED_DEFAULT
  65
  66 Value: 8
  67
  68 This reason is no longer used. This value may be recycled to mean something else in the future.
  69
  70
  71 ## TRR_MODE_UNHANDLED_DISABLED
  72
  73 Value: 9
  74
  75 This reason is no longer used. This value may be recycled to mean something else in the future.
  76
  77
  78 ## TRR_DISABLED_FLAG
  79
  80 Value: 10
  81
  82 This reason is used when retrying failed connections, sync DNS resolves on the main thread, or requests coming from webextensions that choose to skip TRR.
  83
  84
  85 ## TRR_TIMEOUT
  86
  87 Value: 11
  88
  89 The TRR request timed out.
  90
  91 ## TRR_CHANNEL_DNS_FAIL
  92
  93 Value: 12
  94
  95 This reason is set when we fail to resolve the name of the DNS over HTTPS server.
  96
  97
  98 ## TRR_IS_OFFLINE
  99
 100 Value: 13
 101
 102 This reason is recorded when the TRR request fails and the browser is offline (no active interfaces).
 103
 104
 105 ## TRR_NOT_CONFIRMED
 106
 107 Value: 14
 108
 109 This reason is recorded when the TRR Service is not yet confirmed to work. Confirmation is only enabled when _Do53_ fallback is enabled.
 110
 111
 112 ## TRR_DID_NOT_MAKE_QUERY
 113
 114 Value: 15
 115
 116 This reason is sent when _TrrLookup_ exited without doing a TRR query. It may be set during shutdown, or may indicate an implementation bug.
 117
 118
 119 ## TRR_UNKNOWN_CHANNEL_FAILURE
 120
 121 Value: 16
 122
 123 The TRR request failed with an unknown channel failure reason.
 124
 125
 126 ## TRR_HOST_BLOCKED_TEMPORARY
 127
 128 Value: 17
 129
 130 The reason is recorded when the host is temporarily blocked. This happens when a previous attempt to resolve it with TRR failed, but fallback to _Do53_ succeeded.
 131
 132
 133 ## TRR_SEND_FAILED
 134
 135 Value: 18
 136
 137 The call to TRR::SendHTTPRequest failed.
 138
 139
 140 ## TRR_NET_RESET
 141
 142 Value: 19
 143
 144 The request failed because the connection to the TRR server was reset.
 145
 146
 147 ## TRR_NET_TIMEOUT
 148
 149 Value: 20
 150
 151 The request failed because the connection to the TRR server timed out.
 152
 153
 154 ## TRR_NET_REFUSED
 155
 156 Value: 21
 157
 158 The request failed because the connection to the TRR server was refused.
 159
 160
 161 ## TRR_NET_INTERRUPT
 162
 163 Value: 22
 164
 165 The request failed because the connection to the TRR server was interrupted.
 166
 167
 168 ## TRR_NET_INADEQ_SEQURITY
 169
 170 Value: 23
 171
 172 The request failed because the connection to the TRR server used an invalid TLS configuration.
 173
 174
 175 ## TRR_NO_ANSWERS
 176
 177 Value: 24
 178
 179 The TRR request succeeded but the encoded DNS packet contained no answers.
 180
 181
 182 ## TRR_DECODE_FAILED
 183
 184 Value: 25
 185
 186 The TRR request succeeded but decoding the DNS packet failed.
 187
 188
 189 ## TRR_EXCLUDED
 190
 191 Value: 26
 192
 193 This reason is set when the domain being resolved is excluded from TRR, either via the _network.trr.excluded-domains_ pref or because it was covered by the DNS Suffix of the user's network.
 194
 195
 196 ## TRR_SERVER_RESPONSE_ERR
 197
 198 Value: 27
 199
 200 The server responded with non-200 code.
 201
 202
 203 ## TRR_RCODE_FAIL
 204
 205 Value: 28
 206
 207 The decoded DNS packet contains an rcode that is different from NOERROR.
 208
 209
 210 ## TRR_NO_CONNECTIVITY
 211
 212 Value: 29
 213
 214 This reason is set when the browser has no connectivity.
 215
 216
 217 ## TRR_NXDOMAIN
 218
 219 Value: 30
 220
 221 This reason is set when the DNS response contains NXDOMAIN rcode (0x03).
 222
 223
 224 ## TRR_REQ_CANCELLED
 225
 226 Value: 31
 227
 228 This reason is set when the request was cancelled prior to completion.
 229
 230 ## ODOH_KEY_NOT_USABLE
 231
 232 Value: 32
 233
 234 This reason is set when we don't have a valid ODoHConfig to use.
 235
 236 ## ODOH_UPDATE_KEY_FAILED
 237
 238 Value: 33
 239
 240 This reason is set when we failed to update the ODoHConfigs.
 241
 242 ## ODOH_KEY_NOT_AVAILABLE
 243
 244 Value: 34
 245
 246 This reason is set when ODoH requests timeout because of no key.
 247
 248 ## ODOH_ENCRYPTION_FAILED
 249
 250 Value: 35
 251
 252 This reason is set when we failed to encrypt DNS packets.
 253
 254 ## ODOH_DECRYPTION_FAILED
 255
 256 Value: 36
 257
 258 This reason is set when we failed to decrypt DNS packets.
 259
 260 ## TRR_HEURISTIC_TRIPPED_GOOGLE_SAFESEARCH
 261
 262 Value: 37
 263
 264 This reason is set when the google safesearch heuristic was tripped.
 265
 266 ## TRR_HEURISTIC_TRIPPED_YOUTUBE_SAFESEARCH
 267
 268 Value: 38
 269
 270 This reason is set when the youtube safesearch heuristic was tripped.
 271
 272 ## TRR_HEURISTIC_TRIPPED_ZSCALER_CANARY
 273
 274 Value: 39
 275
 276 This reason is set when the zscaler canary heuristic was tripped.
 277
 278 ## TRR_HEURISTIC_TRIPPED_CANARY
 279
 280 Value: 40
 281
 282 This reason is set when the global canary heuristic was tripped.
 283
 284 ## TRR_HEURISTIC_TRIPPED_MODIFIED_ROOTS
 285
 286 Value: 41
 287
 288 This reason is set when the modified roots (enterprise_roots cert pref) heuristic was tripped.
 289
 290 ## TRR_HEURISTIC_TRIPPED_PARENTAL_CONTROLS
 291
 292 Value: 42
 293
 294 This reason is set when parental controls are detected.
 295
 296 ## TRR_HEURISTIC_TRIPPED_THIRD_PARTY_ROOTS
 297
 298 Value: 43
 299
 300 This reason is set when the third party roots heuristic was tripped.
 301
 302 ## TRR_HEURISTIC_TRIPPED_ENTERPRISE_POLICY
 303
 304 Value: 44
 305
 306 This reason is set when enterprise policy heuristic was tripped.
 307
 308 ## TRR_HEURISTIC_TRIPPED_VPN
 309
 310 Value: 45
 311
 312 This reason is set when the heuristic was tripped by a vpn being detected.
 313
 314 ## TRR_HEURISTIC_TRIPPED_PROXY
 315
 316 Value: 46
 317
 318 This reason is set when the heuristic was tripped by a proxy being detected.
 319
 320 ## TRR_HEURISTIC_TRIPPED_NRPT
 321
 322 Value: 47
 323
 324 This reason is set when the heuristic was tripped by a NRPT being detected.