summaryrefslogtreecommitdiff
path: root/pythonmod/doc/modules/env.rst
blob: 42dbbd1cfa3bd5199e27d29001c13ea499958849 (plain) (blame)
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
Global environment
==================

Global variables
----------------

.. envvar:: mod_env

   Module environment, contains data pointer for module-specific data.
   See :class:`pythonmod_env`.


Predefined constants
-----------------------

Module extended state
~~~~~~~~~~~~~~~~~~~~~~~

.. data:: module_state_initial

   Initial state - new DNS query.

.. data:: module_wait_reply

   Waiting for reply to outgoing network query.

.. data:: module_wait_module

   Module is waiting for another module.
   
.. data:: module_wait_subquery

   Module is waiting for sub-query.
   
.. data:: module_error

   Module could not finish the query.
   
.. data:: module_finished

   Module is finished with query.

Module event
~~~~~~~~~~~~~
.. data:: module_event_new

   New DNS query.
   
.. data:: module_event_pass

   Query passed by other module.
   
.. data:: module_event_reply

   Reply inbound from server.
   
.. data:: module_event_noreply

   No reply, timeout or other error.
   
.. data:: module_event_capsfail

   Reply is there, but capitalisation check failed.
   
.. data:: module_event_moddone

   Next module is done, and its reply is awaiting you.
   
.. data:: module_event_error

   Error occured.

Security status
~~~~~~~~~~~~~~~~

.. data:: sec_status_unchecked

   Means that object has yet to be validated.

.. data:: sec_status_bogus

   Means that the object *(RRset or message)* failed to validate
   *(according to local policy)*, but should have validated.
   
.. data:: sec_status_indeterminate

   Means that the object is insecure, but not 
   authoritatively so. Generally this means that the RRset is not 
   below a configured trust anchor.
   
.. data:: sec_status_insecure

   Means that the object is authoritatively known to be 
   insecure. Generally this means that this RRset is below a trust 
   anchor, but also below a verified, insecure delegation.

.. data:: sec_status_secure

   Means that the object (RRset or message) validated according to local policy.

Resource records (RR sets)
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

The different RR classes.

   .. data:: RR_CLASS_IN
   
      Internet.
      
   .. data:: RR_CLASS_CH
   
      Chaos.
      
   .. data:: RR_CLASS_HS
   
      Hesiod (Dyer 87)
      
   .. data:: RR_CLASS_NONE
   
      None class, dynamic update.
      
   .. data:: RR_CLASS_ANY
      
      Any class.
   

The different RR types.


   .. data:: RR_TYPE_A 
   
      A host address.
      
   .. data:: RR_TYPE_NS
   
      An authoritative name server.
      
   .. data:: RR_TYPE_MD 
      
      A mail destination (Obsolete - use MX).
      
   .. data:: RR_TYPE_MF 
   
      A mail forwarder (Obsolete - use MX).
      
   .. data:: RR_TYPE_CNAME 
      
      The canonical name for an alias.
      
   .. data:: RR_TYPE_SOA 
      
      Marks the start of a zone of authority.
      
   .. data:: RR_TYPE_MB 
      
      A mailbox domain name (EXPERIMENTAL).
      
   .. data:: RR_TYPE_MG 
      
      A mail group member (EXPERIMENTAL).
      
   .. data:: RR_TYPE_MR 
      
      A mail rename domain name (EXPERIMENTAL).
      
   .. data:: RR_TYPE_NULL
      
      A null RR (EXPERIMENTAL).
      
   .. data:: RR_TYPE_WKS
      
      A well known service description.
      
   .. data:: RR_TYPE_PTR
   
      A domain name pointer.
      
   .. data:: RR_TYPE_HINFO
   
      Host information.
      
   .. data:: RR_TYPE_MINFO
   
      Mailbox or mail list information.
      
   .. data:: RR_TYPE_MX
   
      Mail exchange.
      
   .. data:: RR_TYPE_TXT
   
      Text strings.
   
   .. data:: RR_TYPE_RP
   
      RFC1183.
      
   .. data:: RR_TYPE_AFSDB
      
      RFC1183.
      
   .. data:: RR_TYPE_X25
      
      RFC1183.
      
   .. data:: RR_TYPE_ISDN
   
      RFC1183.
      
   .. data:: RR_TYPE_RT
      
      RFC1183.
      
   .. data:: RR_TYPE_NSAP
      
      RFC1706.
      
   .. data:: RR_TYPE_NSAP_PTR
      
      RFC1348.
      
   .. data:: RR_TYPE_SIG
      
      2535typecode.
      
   .. data:: RR_TYPE_KEY
      
      2535typecode.
      
   .. data:: RR_TYPE_PX
      
      RFC2163.
      
   .. data:: RR_TYPE_GPOS
      
      RFC1712.
      
   .. data:: RR_TYPE_AAAA
      
      IPv6 address.
      
   .. data:: RR_TYPE_LOC
      
      LOC record  RFC1876.
      
   .. data:: RR_TYPE_NXT
      
      2535typecode.
      
   .. data:: RR_TYPE_EID
      
      draft-ietf-nimrod-dns-01.txt.
      
   .. data:: RR_TYPE_NIMLOC
      
      draft-ietf-nimrod-dns-01.txt.
      
   .. data:: RR_TYPE_SRV
      
      SRV record RFC2782.
      
   .. data:: RR_TYPE_ATMA
   
      http://www.jhsoft.com/rfc/af-saa-0069.000.rtf.
      
   .. data:: RR_TYPE_NAPTR
      
      RFC2915.
      
   .. data:: RR_TYPE_KX
      
      RFC2230.
      
   .. data:: RR_TYPE_CERT
      
      RFC2538.
      
   .. data:: RR_TYPE_A6
      
      RFC2874.
      
   .. data:: RR_TYPE_DNAME
      
      RFC2672.
      
   .. data:: RR_TYPE_SINK
      
      dnsind-kitchen-sink-02.txt.
      
   .. data:: RR_TYPE_OPT
      
      Pseudo OPT record.
      
   .. data:: RR_TYPE_APL
      
      RFC3123.
      
   .. data:: RR_TYPE_DS
      
      draft-ietf-dnsext-delegation.
      
   .. data:: RR_TYPE_SSHFP
      
      SSH Key Fingerprint.
   
   .. data:: RR_TYPE_IPSECKEY
      
      draft-richardson-ipseckey-rr-11.txt.
      
   .. data:: RR_TYPE_RRSIG
      
      draft-ietf-dnsext-dnssec-25.
      
   .. data:: RR_TYPE_NSEC      
   .. data:: RR_TYPE_DNSKEY
   .. data:: RR_TYPE_DHCID
   .. data:: RR_TYPE_NSEC3
   .. data:: RR_TYPE_NSEC3PARAMS
   .. data:: RR_TYPE_UINFO
   .. data:: RR_TYPE_UID
   .. data:: RR_TYPE_GID
   .. data:: RR_TYPE_UNSPEC
   .. data:: RR_TYPE_TSIG
   .. data:: RR_TYPE_IXFR
   .. data:: RR_TYPE_AXFR
   .. data:: RR_TYPE_MAILB
      
      A request for mailbox-related records (MB, MG or MR).
      
   .. data:: RR_TYPE_MAILA
      
      A request for mail agent RRs (Obsolete - see MX).
      
   .. data:: RR_TYPE_ANY
      
      Any type *(wildcard)*.
   
   .. data:: RR_TYPE_DLV
      
      RFC 4431, 5074, DNSSEC Lookaside Validation.
   
Return codes
~~~~~~~~~~~~

Return codes for packets.

.. data:: RCODE_NOERROR
.. data:: RCODE_FORMERR
.. data:: RCODE_SERVFAIL
.. data:: RCODE_NXDOMAIN
.. data:: RCODE_NOTIMPL
.. data:: RCODE_REFUSED
.. data:: RCODE_YXDOMAIN
.. data:: RCODE_YXRRSET
.. data:: RCODE_NXRRSET
.. data:: RCODE_NOTAUTH
.. data:: RCODE_NOTZONE
   
Packet data
~~~~~~~~~~~~

.. data:: PKT_QR

   Query - query flag.
   
.. data:: PKT_AA

   Authoritative Answer - server flag.
   
.. data:: PKT_TC
   
   Truncated - server flag.
   
.. data:: PKT_RD
   
   Recursion desired - query flag.
   
.. data:: PKT_CD

   Checking disabled - query flag.
   
.. data:: PKT_RA
   
   Recursion available - server flag.
   
.. data:: PKT_AD
   
   Authenticated data - server flag.


Verbosity value
~~~~~~~~~~~~~~~~

.. data:: NO_VERBOSE

   No verbose messages.
   
.. data:: VERB_OPS

   Operational information.
   
.. data:: VERB_DETAIL

   Detailed information.
   
.. data:: VERB_QUERY

   Query level information.
   
.. data:: VERB_ALGO

   Algorithm level information.