1Global environment 2================== 3 4Global variables 5---------------- 6 7.. envvar:: mod_env 8 9 Module environment, it is the 'data' pointer for module-specific data 10 in :class:`pythonmod_env`. 11 It is initialized as a dictionary with the 'script' key pointing to the 12 module's python script. 13 It can be further populated during runtime for module-specific data. 14 15 16Predefined constants 17----------------------- 18 19Module extended state 20~~~~~~~~~~~~~~~~~~~~~~~ 21 22.. data:: module_state_initial 23 24 Initial state - new DNS query. 25 26.. data:: module_wait_reply 27 28 Waiting for reply to outgoing network query. 29 30.. data:: module_wait_module 31 32 Module is waiting for another module. 33 34.. data:: module_wait_subquery 35 36 Module is waiting for sub-query. 37 38.. data:: module_error 39 40 Module could not finish the query. 41 42.. data:: module_finished 43 44 Module is finished with query. 45 46Module event 47~~~~~~~~~~~~~ 48.. data:: module_event_new 49 50 New DNS query. 51 52.. data:: module_event_pass 53 54 Query passed by other module. 55 56.. data:: module_event_reply 57 58 Reply inbound from server. 59 60.. data:: module_event_noreply 61 62 No reply, timeout or other error. 63 64.. data:: module_event_capsfail 65 66 Reply is there, but capitalisation check failed. 67 68.. data:: module_event_moddone 69 70 Next module is done, and its reply is awaiting you. 71 72.. data:: module_event_error 73 74 Error occurred. 75 76Security status 77~~~~~~~~~~~~~~~~ 78 79.. data:: sec_status_unchecked 80 81 Means that object has yet to be validated. 82 83.. data:: sec_status_bogus 84 85 Means that the object *(RRset or message)* failed to validate 86 *(according to local policy)*, but should have validated. 87 88.. data:: sec_status_indeterminate 89 90 Means that the object is insecure, but not 91 authoritatively so. Generally this means that the RRset is not 92 below a configured trust anchor. 93 94.. data:: sec_status_insecure 95 96 Means that the object is authoritatively known to be 97 insecure. Generally this means that this RRset is below a trust 98 anchor, but also below a verified, insecure delegation. 99 100.. data:: sec_status_secure 101 102 Means that the object (RRset or message) validated according to local policy. 103 104Resource records (RR sets) 105~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 106 107The different RR classes. 108 109 .. data:: RR_CLASS_IN 110 111 Internet. 112 113 .. data:: RR_CLASS_CH 114 115 Chaos. 116 117 .. data:: RR_CLASS_HS 118 119 Hesiod (Dyer 87) 120 121 .. data:: RR_CLASS_NONE 122 123 None class, dynamic update. 124 125 .. data:: RR_CLASS_ANY 126 127 Any class. 128 129 130The different RR types. 131 132 133 .. data:: RR_TYPE_A 134 135 A host address. 136 137 .. data:: RR_TYPE_NS 138 139 An authoritative name server. 140 141 .. data:: RR_TYPE_MD 142 143 A mail destination (Obsolete - use MX). 144 145 .. data:: RR_TYPE_MF 146 147 A mail forwarder (Obsolete - use MX). 148 149 .. data:: RR_TYPE_CNAME 150 151 The canonical name for an alias. 152 153 .. data:: RR_TYPE_SOA 154 155 Marks the start of a zone of authority. 156 157 .. data:: RR_TYPE_MB 158 159 A mailbox domain name (EXPERIMENTAL). 160 161 .. data:: RR_TYPE_MG 162 163 A mail group member (EXPERIMENTAL). 164 165 .. data:: RR_TYPE_MR 166 167 A mail rename domain name (EXPERIMENTAL). 168 169 .. data:: RR_TYPE_NULL 170 171 A null RR (EXPERIMENTAL). 172 173 .. data:: RR_TYPE_WKS 174 175 A well known service description. 176 177 .. data:: RR_TYPE_PTR 178 179 A domain name pointer. 180 181 .. data:: RR_TYPE_HINFO 182 183 Host information. 184 185 .. data:: RR_TYPE_MINFO 186 187 Mailbox or mail list information. 188 189 .. data:: RR_TYPE_MX 190 191 Mail exchange. 192 193 .. data:: RR_TYPE_TXT 194 195 Text strings. 196 197 .. data:: RR_TYPE_RP 198 199 RFC1183. 200 201 .. data:: RR_TYPE_AFSDB 202 203 RFC1183. 204 205 .. data:: RR_TYPE_X25 206 207 RFC1183. 208 209 .. data:: RR_TYPE_ISDN 210 211 RFC1183. 212 213 .. data:: RR_TYPE_RT 214 215 RFC1183. 216 217 .. data:: RR_TYPE_NSAP 218 219 RFC1706. 220 221 .. data:: RR_TYPE_NSAP_PTR 222 223 RFC1348. 224 225 .. data:: RR_TYPE_SIG 226 227 2535typecode. 228 229 .. data:: RR_TYPE_KEY 230 231 2535typecode. 232 233 .. data:: RR_TYPE_PX 234 235 RFC2163. 236 237 .. data:: RR_TYPE_GPOS 238 239 RFC1712. 240 241 .. data:: RR_TYPE_AAAA 242 243 IPv6 address. 244 245 .. data:: RR_TYPE_LOC 246 247 LOC record RFC1876. 248 249 .. data:: RR_TYPE_NXT 250 251 2535typecode. 252 253 .. data:: RR_TYPE_EID 254 255 draft-ietf-nimrod-dns-01.txt. 256 257 .. data:: RR_TYPE_NIMLOC 258 259 draft-ietf-nimrod-dns-01.txt. 260 261 .. data:: RR_TYPE_SRV 262 263 SRV record RFC2782. 264 265 .. data:: RR_TYPE_ATMA 266 267 http://www.jhsoft.com/rfc/af-saa-0069.000.rtf. 268 269 .. data:: RR_TYPE_NAPTR 270 271 RFC2915. 272 273 .. data:: RR_TYPE_KX 274 275 RFC2230. 276 277 .. data:: RR_TYPE_CERT 278 279 RFC2538. 280 281 .. data:: RR_TYPE_A6 282 283 RFC2874. 284 285 .. data:: RR_TYPE_DNAME 286 287 RFC2672. 288 289 .. data:: RR_TYPE_SINK 290 291 dnsind-kitchen-sink-02.txt. 292 293 .. data:: RR_TYPE_OPT 294 295 Pseudo OPT record. 296 297 .. data:: RR_TYPE_APL 298 299 RFC3123. 300 301 .. data:: RR_TYPE_DS 302 303 draft-ietf-dnsext-delegation. 304 305 .. data:: RR_TYPE_SSHFP 306 307 SSH Key Fingerprint. 308 309 .. data:: RR_TYPE_IPSECKEY 310 311 draft-richardson-ipseckey-rr-11.txt. 312 313 .. data:: RR_TYPE_RRSIG 314 315 draft-ietf-dnsext-dnssec-25. 316 317 .. data:: RR_TYPE_NSEC 318 .. data:: RR_TYPE_DNSKEY 319 .. data:: RR_TYPE_DHCID 320 .. data:: RR_TYPE_NSEC3 321 .. data:: RR_TYPE_NSEC3PARAMS 322 .. data:: RR_TYPE_UINFO 323 .. data:: RR_TYPE_UID 324 .. data:: RR_TYPE_GID 325 .. data:: RR_TYPE_UNSPEC 326 .. data:: RR_TYPE_TSIG 327 .. data:: RR_TYPE_IXFR 328 .. data:: RR_TYPE_AXFR 329 .. data:: RR_TYPE_MAILB 330 331 A request for mailbox-related records (MB, MG or MR). 332 333 .. data:: RR_TYPE_MAILA 334 335 A request for mail agent RRs (Obsolete - see MX). 336 337 .. data:: RR_TYPE_ANY 338 339 Any type *(wildcard)*. 340 341 .. data:: RR_TYPE_DLV 342 343 RFC 4431, 5074, DNSSEC Lookaside Validation. 344 345Return codes 346~~~~~~~~~~~~ 347 348Return codes for packets. 349 350.. data:: RCODE_NOERROR 351.. data:: RCODE_FORMERR 352.. data:: RCODE_SERVFAIL 353.. data:: RCODE_NXDOMAIN 354.. data:: RCODE_NOTIMPL 355.. data:: RCODE_REFUSED 356.. data:: RCODE_YXDOMAIN 357.. data:: RCODE_YXRRSET 358.. data:: RCODE_NXRRSET 359.. data:: RCODE_NOTAUTH 360.. data:: RCODE_NOTZONE 361 362Packet data 363~~~~~~~~~~~~ 364 365.. data:: PKT_QR 366 367 Query - query flag. 368 369.. data:: PKT_AA 370 371 Authoritative Answer - server flag. 372 373.. data:: PKT_TC 374 375 Truncated - server flag. 376 377.. data:: PKT_RD 378 379 Recursion desired - query flag. 380 381.. data:: PKT_CD 382 383 Checking disabled - query flag. 384 385.. data:: PKT_RA 386 387 Recursion available - server flag. 388 389.. data:: PKT_AD 390 391 Authenticated data - server flag. 392 393 394Verbosity value 395~~~~~~~~~~~~~~~~ 396 397.. data:: NO_VERBOSE 398 399 No verbose messages. 400 401.. data:: VERB_OPS 402 403 Operational information. 404 405.. data:: VERB_DETAIL 406 407 Detailed information. 408 409.. data:: VERB_QUERY 410 411 Query level information. 412 413.. data:: VERB_ALGO 414 415 Algorithm level information. 416