unbound/pythonmod/doc/modules/env.rst

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