Blame view

node_modules/dns-packet/README.md 3.29 KB
aaac7fed   liuqimichale   add
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
  # dns-packet
  
  An [abstract-encoding](https://github.com/mafintosh/abstract-encoding) compliant module for encoding / decoding DNS packets.
  Lifted out of [multicast-dns](https://github.com/mafintosh/multicast-dns) as a separate module.
  
  ```
  npm install dns-packet
  ```
  
  [![build status](https://travis-ci.org/mafintosh/dns-packet.svg?branch=master)](https://travis-ci.org/mafintosh/dns-packet)
  
  ## Usage
  
  ``` js
  var packet = require('dns-packet')
  var dgram = require('dgram')
  
  var socket = dgram.createSocket('udp4')
  
  var buf = packet.encode({
    type: 'query',
    id: 1,
    flags: packet.RECURSION_DESIRED,
    questions: [{
      type: 'A',
      name: 'google.com'
    }]
  })
  
  socket.on('message', function (message) {
    console.log(packet.decode(message)) // prints out a response from google dns
  })
  
  socket.send(buf, 0, buf.length, 53, '8.8.8.8')
  ```
  
  ## API
  
  #### `var buf = packets.encode(packet, [buf], [offset])`
  
  Encodes a DNS packet into a buffer.
  
  #### `var packet = packets.decode(buf, [offset])`
  
  Decode a DNS packet from a buffer
  
  #### `var len = packets.encodingLength(packet)`
  
  Returns how many bytes are needed to encode the DNS packet
  
  ## Packets
  
  Packets look like this
  
  ``` js
  {
    type: 'query|response',
    id: optionalIdNumber,
    flags: optionalBitFlags,
    questions: [...],
    answers: [...],
    additionals: [...],
    authorities: [...]
  }
  ```
  
  The bit flags available are
  
  ``` js
  packet.RECURSION_DESIRED
  packet.RECURSION_AVAILABLE
  packet.TRUNCATED_RESPONSE
  packet.AUTHORITATIVE_ANSWER
  packet.AUTHENTIC_DATA
  packet.CHECKING_DISABLED
  ```
  
  To use more than one flag bitwise-or them together
  
  ``` js
  var flags = packet.RECURSION_DESIRED | packet.RECURSION_AVAILABLE
  ```
  
  And to check for a flag use bitwise-and
  
  ``` js
  var isRecursive = message.flags & packet.RECURSION_DESIRED
  ```
  
  A question looks like this
  
  ``` js
  {
    type: 'A', // or SRV, AAAA, etc
    name: 'google.com' // which record are you looking for
  }
  ```
  
  And an answers, additional, or authority looks like this
  
  ``` js
  {
    type: 'A', // or SRV, AAAA, etc
    name: 'google.com', // which name is this record for
    ttl: optionalTimeToLiveInSeconds,
    (record specific data, see below)
  }
  ```
  
  Currently the different available records are
  
  #### `A`
  
  ``` js
  {
    data: 'IPv4 address' // fx 127.0.0.1
  }
  ```
  
  #### `AAAA`
  
  ``` js
  {
    data: 'IPv6 address' // fx fe80::1
  }
  ```
  
  #### `TXT`
  
  ``` js
  {
    data: Buffer('some text')
  }
  ```
  
  #### `NS`
  
  ``` js
  {
    data: nameServer
  }
  ```
  
  #### `NULL`
  
  ``` js
  {
    data: Buffer('any binary data')
  }
  ```
  
  #### `SOA`
  
  ``` js
  {
    data:
      {
        mname: domainName,
        rname: mailbox,
        serial: zoneSerial,
        refresh: refreshInterval,
        retry: retryInterval,
        expire: expireInterval,
        minimum: minimumTTL
      }
  }
  ```
  
  #### `SRV`
  
  ``` js
  {
    data: {
      port: servicePort,
      target: serviceHostName,
      priority: optionalServicePriority,
      weight: optionalServiceWeight
    }
  }
  ```
  
  #### `HINFO`
  
  ``` js
  {
    data: {
      cpu: 'cpu info',
      os: 'os info'
    }
  }
  ```
  
  #### `PTR`
  
  ``` js
  {
    data: 'points.to.another.record'
  }
  ```
  
  #### `CNAME`
  
  ``` js
  {
    data: 'cname.to.another.record'
  }
  ```
  
  #### `DNAME`
  
  ``` js
  {
    data: 'dname.to.another.record'
  }
  ```
  
  #### `CAA`
  
  ``` js
  {
    flags: 128, // octet
    tag: 'issue|issuewild|iodef',
    value: 'ca.example.net'
  }
  ```
  
  If you need another one, open an issue and we'll try to add it.
  
  ## License
  
  MIT