|
| 1 | +import { randomBytes } from 'node:crypto' |
| 2 | +import { promises as dns } from 'node:dns' |
| 3 | +import { TestGroup } from '../template.js' |
| 4 | +import { FAMILY_VALUES, getCensorsString, getResultIcon } from '../utils.js' |
| 5 | + |
| 6 | +class DnsTester extends TestGroup { |
| 7 | + /** |
| 8 | + * A test group to assess the system's DNS resolver |
| 9 | + */ |
| 10 | + constructor (globalConfig, globalResults) { |
| 11 | + super(globalConfig, globalResults, 'DNS') |
| 12 | + } |
| 13 | + |
| 14 | + static getTestTag () { |
| 15 | + return 'DNS' |
| 16 | + } |
| 17 | + |
| 18 | + static getPrereqs () { |
| 19 | + return ['Route'] |
| 20 | + } |
| 21 | + |
| 22 | + getDefaultResults () { |
| 23 | + return { |
| 24 | + IPv4: false, |
| 25 | + IPv6: false, |
| 26 | + } |
| 27 | + } |
| 28 | + |
| 29 | + checkIfShouldSkip (globalResults) { |
| 30 | + /** |
| 31 | + * Skip this test if all routing tests failed |
| 32 | + */ |
| 33 | + let skip = true |
| 34 | + for (const family in FAMILY_VALUES) { |
| 35 | + if (Object.values(globalResults.Route[family]).includes(true)) { |
| 36 | + this.results[family] = {} |
| 37 | + skip = false |
| 38 | + } |
| 39 | + } |
| 40 | + if (skip) { |
| 41 | + return 'no routable networks' |
| 42 | + } |
| 43 | + return null |
| 44 | + } |
| 45 | + |
| 46 | + async startTest () { |
| 47 | + this.testPrefix = `${randomBytes(30).toString('hex')}.` |
| 48 | + console.log(`Using POISON test prefix: ${this.testPrefix}`) |
| 49 | + |
| 50 | + for (const family in FAMILY_VALUES) { |
| 51 | + if (this.results[family] === false) { |
| 52 | + continue // not routable |
| 53 | + } |
| 54 | + for (const host of this.config.allow) { |
| 55 | + this.startResolveTest(host, family, false) |
| 56 | + } |
| 57 | + for (const host of this.config.block) { |
| 58 | + this.startResolveTest(host, family, true) |
| 59 | + } |
| 60 | + } |
| 61 | + } |
| 62 | + |
| 63 | + async startResolveTest (host, family, testPoison) { |
| 64 | + const testPrefs = [''] |
| 65 | + if (testPoison) { |
| 66 | + testPrefs.push(this.testPrefix) |
| 67 | + } |
| 68 | + for (const prefix of testPrefs) { |
| 69 | + this.startTestThread( |
| 70 | + DnsTester.resolveThread, |
| 71 | + [family, prefix + host], |
| 72 | + `${family}, ${host}${prefix ? ', POISON' : ''}`, |
| 73 | + this.config.timeout, |
| 74 | + ) |
| 75 | + } |
| 76 | + } |
| 77 | + |
| 78 | + logResults () { |
| 79 | + let resStr = '' |
| 80 | + for (const [family, results] of Object.entries(this.results)) { |
| 81 | + if (results === false) { |
| 82 | + continue |
| 83 | + } |
| 84 | + this.results[family] = true |
| 85 | + const allowList = this.config.allow |
| 86 | + const allowOkCnt = allowList.reduce((sum, host) => sum + (results[host] || 0), 0) |
| 87 | + const allowTotal = allowList.length |
| 88 | + let resIcon |
| 89 | + if (allowOkCnt === allowTotal) { // DNS can resolve |
| 90 | + resIcon = getResultIcon(true) |
| 91 | + } else if (allowOkCnt === 0) { // DNS can't resolve |
| 92 | + resIcon = getResultIcon(false) |
| 93 | + this.results[family] = false |
| 94 | + } else { // test inconclusive |
| 95 | + resIcon = getResultIcon(null, `resolved ${allowOkCnt}/${allowTotal}`) |
| 96 | + } |
| 97 | + resStr += `${family}: DNS ${resIcon}\n` |
| 98 | + |
| 99 | + const censors = [] |
| 100 | + const blockList = this.config.block |
| 101 | + const blockOkCnt = blockList.reduce((sum, host) => sum + (results[host] || 0), 0) |
| 102 | + const blockTotal = blockList.length |
| 103 | + if (blockOkCnt < blockTotal) { |
| 104 | + censors.push(`DNS blocking: ${blockTotal - blockOkCnt}/${blockTotal} blocked`) |
| 105 | + } |
| 106 | + |
| 107 | + const blockPoisonCnt = blockList.reduce((sum, host) => sum + (results[this.testPrefix + host] || 0), 0) |
| 108 | + if (blockPoisonCnt > 0) { |
| 109 | + censors.push(`DNS poisoning: ${blockPoisonCnt}/${blockTotal} poisoned`) |
| 110 | + } |
| 111 | + resStr += getCensorsString(censors) |
| 112 | + } |
| 113 | + return resStr |
| 114 | + } |
| 115 | + |
| 116 | + static async resolveThread (timeout, logger, results, family, host) { |
| 117 | + if (results[family] === false) { |
| 118 | + return // Not routable |
| 119 | + } |
| 120 | + results[family][host] = 0 // default to failed |
| 121 | + try { |
| 122 | + let records |
| 123 | + if (FAMILY_VALUES[family] === 4) { |
| 124 | + records = await dns.resolve4(host) |
| 125 | + } else { |
| 126 | + records = await dns.resolve6(host) |
| 127 | + } |
| 128 | + if (!timeout.isSet) { |
| 129 | + logger(`Got ${records.length} records`) |
| 130 | + results[family][host] = 1 |
| 131 | + } else { |
| 132 | + logger(`Timeout occurred for ${host}`) |
| 133 | + } |
| 134 | + } catch (error) { |
| 135 | + if (!timeout.isSet) { |
| 136 | + logger(`Failed with error: ${error.message}`) |
| 137 | + results[family][host] = 0 // explicitly set to failed |
| 138 | + } else { |
| 139 | + logger(`Timeout occurred for ${host}`) |
| 140 | + } |
| 141 | + } |
| 142 | + } |
| 143 | +} |
| 144 | + |
| 145 | +function getClientTests () { |
| 146 | + return [DnsTester] |
| 147 | +} |
| 148 | + |
| 149 | +export default { |
| 150 | + DnsTester, |
| 151 | + getClientTests, |
| 152 | +} |
0 commit comments