Repository navigation
Expand file tree
/
Copy pathDnsResponseCode.cs
More file actions
429 lines (371 loc) · 15.7 KB
/
Copy pathDnsResponseCode.cs
File metadata and controls
429 lines (371 loc) · 15.7 KB
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
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
// Copyright 2024 Michael Conrad.
// Licensed under the Apache License, Version 2.0.
// See LICENSE file for details.
using System;
using System.Collections.Generic;
namespace DnsClient
{
/*
* Reference RFC6895#section-2.3
*/
/// <summary>
/// 4 bit response codes of the <see cref="IDnsQueryResponse"/>'s header.
/// </summary>
/// <seealso href="https://tools.ietf.org/html/rfc6895#section-2.3">RFC 6895</seealso>
public enum DnsHeaderResponseCode : short
{
/// <summary>
/// No error condition
/// </summary>
/// <seealso href="https://tools.ietf.org/html/rfc1035">RFC 1035</seealso>
NoError = 0,
/// <summary>
/// Format error. The name server was unable to interpret the query.
/// </summary>
/// <seealso href="https://tools.ietf.org/html/rfc1035">RFC 1035</seealso>
FormatError = 1,
/// <summary>
/// Server failure. The name server was unable to process this query due to a problem with the name server.
/// </summary>
/// <seealso href="https://tools.ietf.org/html/rfc1035">RFC 1035</seealso>
ServerFailure = 2,
/// <summary>
/// Name Error. Meaningful only for responses from an authoritative name server,
/// this code signifies that the domain name referenced in the query does not exist.
/// </summary>
/// <seealso href="https://tools.ietf.org/html/rfc1035">RFC 1035</seealso>
NotExistentDomain = 3,
/// <summary>
/// Not Implemented. The name server does not support the requested kind of query.
/// </summary>
/// <seealso href="https://tools.ietf.org/html/rfc1035">RFC 1035</seealso>
NotImplemented = 4,
/// <summary>
/// Refused. The name server refuses to perform the specified operation for policy reasons.
/// For example, a name server may not wish to provide the information to the particular requester,
/// or a name server may not wish to perform a particular operation (e.g., zone transfer) for particular data.
/// </summary>
/// <seealso href="https://tools.ietf.org/html/rfc1035">RFC 1035</seealso>
Refused = 5,
/// <summary>
/// Name Exists when it should not.
/// </summary>
/// <seealso href="https://tools.ietf.org/html/rfc2136">RFC 2136</seealso>
ExistingDomain = 6,
/// <summary>
/// Resource record set exists when it should not.
/// </summary>
/// <seealso href="https://tools.ietf.org/html/rfc2136">RFC 2136</seealso>
ExistingResourceRecordSet = 7,
/// <summary>
/// Resource record set that should exist but does not.
/// </summary>
/// <seealso href="https://tools.ietf.org/html/rfc2136">RFC 2136</seealso>
MissingResourceRecordSet = 8,
/// <summary>
/// Server Not Authoritative for zone / Not Authorized.
/// </summary>
/// <seealso href="https://tools.ietf.org/html/rfc2136">RFC 2136</seealso>
/// <seealso href="https://tools.ietf.org/html/rfc2845">RFC 2845</seealso>
NotAuthorized = 9,
/// <summary>
/// Name not contained in zone.
/// </summary>
/// <seealso href="https://tools.ietf.org/html/rfc2136">RFC 2136</seealso>
NotZone = 10,
/// <summary>
/// Unassigned value
/// </summary>
Unassinged11 = 11,
/// <summary>
/// Unassigned value
/// </summary>
Unassinged12 = 12,
/// <summary>
/// Unassigned value
/// </summary>
Unassinged13 = 13,
/// <summary>
/// Unassigned value
/// </summary>
Unassinged14 = 14,
/// <summary>
/// Unassigned value
/// </summary>
Unassinged15 = 15
}
/// <summary>
/// Extended response codes of the <see cref="IDnsQueryResponse"/> with OPT.
/// </summary>
/// <seealso href="https://tools.ietf.org/html/rfc6895#section-2.3">RFC 6895</seealso>
public enum DnsResponseCode
{
/// <summary>
/// No error condition
/// </summary>
/// <seealso href="https://tools.ietf.org/html/rfc1035">RFC 1035</seealso>
NoError = 0,
/// <summary>
/// Format error. The name server was unable to interpret the query.
/// </summary>
/// <seealso href="https://tools.ietf.org/html/rfc1035">RFC 1035</seealso>
FormatError = 1,
/// <summary>
/// Server failure. The name server was unable to process this query due to a problem with the name server.
/// </summary>
/// <seealso href="https://tools.ietf.org/html/rfc1035">RFC 1035</seealso>
ServerFailure = 2,
/// <summary>
/// Name Error. Meaningful only for responses from an authoritative name server,
/// this code signifies that the domain name referenced in the query does not exist.
/// </summary>
/// <seealso href="https://tools.ietf.org/html/rfc1035">RFC 1035</seealso>
NotExistentDomain = 3,
/// <summary>
/// Not Implemented. The name server does not support the requested kind of query.
/// </summary>
/// <seealso href="https://tools.ietf.org/html/rfc1035">RFC 1035</seealso>
NotImplemented = 4,
/// <summary>
/// Refused. The name server refuses to perform the specified operation for policy reasons.
/// For example, a name server may not wish to provide the information to the particular requester,
/// or a name server may not wish to perform a particular operation (e.g., zone transfer) for particular data.
/// </summary>
/// <seealso href="https://tools.ietf.org/html/rfc1035">RFC 1035</seealso>
Refused = 5,
/// <summary>
/// Name Exists when it should not.
/// </summary>
/// <seealso href="https://tools.ietf.org/html/rfc2136">RFC 2136</seealso>
ExistingDomain = 6,
/// <summary>
/// Resource record set exists when it should not.
/// </summary>
/// <seealso href="https://tools.ietf.org/html/rfc2136">RFC 2136</seealso>
ExistingResourceRecordSet = 7,
/// <summary>
/// Resource record set that should exist but does not.
/// </summary>
/// <seealso href="https://tools.ietf.org/html/rfc2136">RFC 2136</seealso>
MissingResourceRecordSet = 8,
/// <summary>
/// Server Not Authoritative for zone / Not Authorized.
/// </summary>
/// <seealso href="https://tools.ietf.org/html/rfc2136">RFC 2136</seealso>
/// <seealso href="https://tools.ietf.org/html/rfc2845">RFC 2845</seealso>
NotAuthorized = 9,
/// <summary>
/// Name not contained in zone.
/// </summary>
/// <seealso href="https://tools.ietf.org/html/rfc2136">RFC 2136</seealso>
NotZone = 10,
/// <summary>
/// Unassigned value
/// </summary>
Unassinged11 = 11,
/// <summary>
/// Unassigned value
/// </summary>
Unassinged12 = 12,
/// <summary>
/// Unassigned value
/// </summary>
Unassinged13 = 13,
/// <summary>
/// Unassigned value
/// </summary>
Unassinged14 = 14,
/// <summary>
/// Unassigned value
/// </summary>
Unassinged15 = 15,
/// <summary>
/// Bad OPT Version or TSIG Signature Failure.
/// </summary>
/// <seealso href="https://tools.ietf.org/html/rfc2671">RFC 2671</seealso>
/// <seealso href="https://tools.ietf.org/html/rfc2845">RFC 2845</seealso>
BadVersionOrBadSignature = 16,
/// <summary>
/// Key not recognized.
/// </summary>
/// <seealso href="https://tools.ietf.org/html/rfc2845">RFC 2845</seealso>
BadKey = 17,
/// <summary>
/// Signature out of time window.
/// </summary>
/// <seealso href="https://tools.ietf.org/html/rfc2845">RFC 2845</seealso>
BadTime = 18,
/// <summary>
/// Bad TKEY Mode.
/// </summary>
/// <seealso href="https://tools.ietf.org/html/rfc2930">RFC 2930</seealso>
BadMode = 19,
/// <summary>
/// Duplicate key name.
/// </summary>
/// <seealso href="https://tools.ietf.org/html/rfc2930">RFC 2930</seealso>
BadName = 20,
/// <summary>
/// Algorithm not supported.
/// </summary>
/// <seealso href="https://tools.ietf.org/html/rfc2930">RFC 2930</seealso>
BadAlgorithm = 21,
/// <summary>
/// Bad Truncation.
/// </summary>
/// <seealso href="https://tools.ietf.org/html/rfc4635">RFC 4635</seealso>
BadTruncation = 22,
/// <summary>
/// Bad/missing Server Cookie
/// </summary>
/// <seealso href="https://tools.ietf.org/html/rfc7873">RFC 7873</seealso>
BadCookie = 23,
/// <summary>
/// Unknown error.
/// </summary>
Unassigned = 666,
/// <summary>
/// Indicates a timeout error. Connection to the remote server couldn't be established.
/// </summary>
ConnectionTimeout = 999
}
/// <summary>
/// A DnsClient specific exception transporting additional information about the query causing this exception.
/// </summary>
/// <seealso cref="Exception" />
[Serializable]
public class DnsResponseException : Exception
{
/// <summary>
/// Gets the response code.
/// </summary>
/// <value>
/// The response code.
/// </value>
public DnsResponseCode Code { get; }
/// <summary>
/// Gets the audit trail if <see cref="DnsQueryOptions.EnableAuditTrail"/>. as set to <c>true</c>, <c>null</c> otherwise.
/// </summary>
/// <value>
/// The audit trail.
/// </value>
public string AuditTrail { get; internal set; }
/// <summary>
/// Gets a human readable error message.
/// </summary>
/// <value>
/// The error message.
/// </value>
public string DnsError { get; }
/// <summary>
/// Initializes a new instance of the <see cref="DnsResponseException"/> class
/// with <see cref="Code"/> set to <see cref="DnsResponseCode.Unassigned"/>.
/// </summary>
public DnsResponseException() : base(DnsResponseCodeText.Unassigned)
{
Code = DnsResponseCode.Unassigned;
DnsError = DnsResponseCodeText.GetErrorText(Code);
}
/// <summary>
/// Initializes a new instance of the <see cref="DnsResponseException"/> class
/// with <see cref="Code"/> set to <see cref="DnsResponseCode.Unassigned"/>
/// and a custom <paramref name="message"/>.
/// </summary>
public DnsResponseException(string message) : base(message)
{
Code = DnsResponseCode.Unassigned;
DnsError = DnsResponseCodeText.GetErrorText(Code);
}
/// <summary>
/// Initializes a new instance of the <see cref="DnsResponseException"/> class
/// with the standard error text for the given <paramref name="code"/>.
/// </summary>
public DnsResponseException(DnsResponseCode code) : base(DnsResponseCodeText.GetErrorText(code))
{
Code = code;
DnsError = DnsResponseCodeText.GetErrorText(Code);
}
/// <summary>
/// Initializes a new instance of the <see cref="DnsResponseException"/> class
/// with <see cref="Code"/> set to <see cref="DnsResponseCode.Unassigned"/>
/// and a custom <paramref name="message"/> and inner <see cref="Exception"/>.
/// </summary>
public DnsResponseException(string message, Exception innerException) : base(message, innerException)
{
Code = DnsResponseCode.Unassigned;
DnsError = DnsResponseCodeText.GetErrorText(Code);
}
/// <summary>
/// Initializes a new instance of the <see cref="DnsResponseException"/> class
/// with a custom <paramref name="message"/> and the given <paramref name="code"/>.
/// </summary>
public DnsResponseException(DnsResponseCode code, string message) : base(message)
{
Code = code;
DnsError = DnsResponseCodeText.GetErrorText(Code);
}
/// <summary>
/// Initializes a new instance of the <see cref="DnsResponseException"/> class
/// with a custom <paramref name="message"/> and the given <paramref name="code"/>.
/// </summary>
public DnsResponseException(DnsResponseCode code, string message, Exception innerException) : base(message, innerException)
{
Code = code;
DnsError = DnsResponseCodeText.GetErrorText(Code);
}
}
internal static class DnsResponseCodeText
{
internal const string BADALG = "Algorithm not supported";
internal const string BADCOOKIE = "Bad/missing Server Cookie";
internal const string BADKEY = "Key not recognized";
internal const string BADMODE = "Bad TKEY Mode";
internal const string BADNAME = "Duplicate key name";
internal const string BADSIG = "TSIG Signature Failure";
internal const string BADTIME = "Signature out of time window";
internal const string BADTRUNC = "Bad Truncation";
internal const string BADVERS = "Bad OPT Version";
internal const string FormErr = "Format Error";
internal const string NoError = "No Error";
internal const string NotAuth = "Server Not Authoritative for zone or Not Authorized";
internal const string NotImp = "Not Implemented";
internal const string NotZone = "Name not contained in zone";
internal const string NXDomain = "Non-Existent Domain";
internal const string NXRRSet = "RR Set that should exist does not";
internal const string Refused = "Query Refused";
internal const string ServFail = "Server Failure";
internal const string Unassigned = "Unknown Error";
internal const string YXDomain = "Name Exists when it should not";
internal const string YXRRSet = "RR Set Exists when it should not";
private static readonly Dictionary<DnsResponseCode, string> s_errors = new Dictionary<DnsResponseCode, string>()
{
{ DnsResponseCode.NoError, NoError },
{ DnsResponseCode.FormatError, FormErr },
{ DnsResponseCode.ServerFailure, ServFail },
{ DnsResponseCode.NotExistentDomain, NXDomain },
{ DnsResponseCode.NotImplemented, NotImp },
{ DnsResponseCode.Refused, Refused },
{ DnsResponseCode.ExistingDomain, YXDomain },
{ DnsResponseCode.ExistingResourceRecordSet, YXRRSet },
{ DnsResponseCode.MissingResourceRecordSet, NXRRSet },
{ DnsResponseCode.NotAuthorized, NotAuth },
{ DnsResponseCode.NotZone, NotZone },
{ DnsResponseCode.BadVersionOrBadSignature, BADVERS },
{ DnsResponseCode.BadKey, BADKEY },
{ DnsResponseCode.BadTime, BADTIME },
{ DnsResponseCode.BadMode, BADMODE },
{ DnsResponseCode.BadName, BADNAME },
{ DnsResponseCode.BadAlgorithm, BADALG },
{ DnsResponseCode.BadTruncation, BADTRUNC },
{ DnsResponseCode.BadCookie, BADCOOKIE },
};
public static string GetErrorText(DnsResponseCode code)
{
if (!s_errors.TryGetValue(code, out var value))
{
return Unassigned;
}
return value;
}
}
}