/usr/share/tcltk/tcllib1.16/dns/dns.tcl is in tcllib 1.16-dfsg-2.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 | # dns.tcl - Copyright (C) 2002 Pat Thoyts <patthoyts@users.sourceforge.net>
#
# Provide a Tcl only Domain Name Service client. See RFC 1034 and RFC 1035
# for information about the DNS protocol. This should insulate Tcl scripts
# from problems with using the system library resolver for slow name servers.
#
# This implementation uses TCP only for DNS queries. The protocol reccommends
# that UDP be used in these cases but Tcl does not include UDP sockets by
# default. The package should be simple to extend to use a TclUDP extension
# in the future.
#
# Support for SPF (http://spf.pobox.com/rfcs.html) will need updating
# if or when the proposed draft becomes accepted.
#
# Support added for RFC1886 - DNS Extensions to support IP version 6
# Support added for RFC2782 - DNS RR for specifying the location of services
# Support added for RFC1995 - Incremental Zone Transfer in DNS
#
# TODO:
# - When using tcp we should make better use of the open connection and
# send multiple queries along the same connection.
#
# - We must switch to using TCP for truncated UDP packets.
#
# - Read RFC 2136 - dynamic updating of DNS
#
# -------------------------------------------------------------------------
# See the file "license.terms" for information on usage and redistribution
# of this file, and for a DISCLAIMER OF ALL WARRANTIES.
# -------------------------------------------------------------------------
#
# $Id: dns.tcl,v 1.36 2008/11/22 12:28:54 mic42 Exp $
package require Tcl 8.2; # tcl minimum version
package require logger; # tcllib 1.3
package require uri; # tcllib 1.1
package require uri::urn; # tcllib 1.2
package require ip; # tcllib 1.7
namespace eval ::dns {
variable version 1.3.3
variable rcsid {$Id: dns.tcl,v 1.36 2008/11/22 12:28:54 mic42 Exp $}
namespace export configure resolve name address cname \
status reset wait cleanup errorcode
variable options
if {![info exists options]} {
array set options {
port 53
timeout 30000
protocol tcp
search {}
nameserver {localhost}
loglevel warn
}
variable log [logger::init dns]
${log}::setlevel $options(loglevel)
}
# We can use either ceptcl or tcludp for UDP support.
if {![catch {package require udp 1.0.4} msg]} { ;# tcludp 1.0.4+
# If TclUDP 1.0.4 or better is available, use it.
set options(protocol) udp
} else {
if {![catch {package require ceptcl} msg]} {
set options(protocol) udp
}
}
variable types
array set types {
A 1 NS 2 MD 3 MF 4 CNAME 5 SOA 6 MB 7 MG 8 MR 9
NULL 10 WKS 11 PTR 12 HINFO 13 MINFO 14 MX 15 TXT 16
SPF 16 AAAA 28 SRV 33 IXFR 251 AXFR 252 MAILB 253 MAILA 254
ANY 255 * 255
}
variable classes
array set classes { IN 1 CS 2 CH 3 HS 4 * 255}
variable uid
if {![info exists uid]} {
set uid 0
}
}
# -------------------------------------------------------------------------
# Description:
# Configure the DNS package. In particular the local nameserver will need
# to be set. With no options, returns a list of all current settings.
#
proc ::dns::configure {args} {
variable options
variable log
if {[llength $args] < 1} {
set r {}
foreach opt [lsort [array names options]] {
lappend r -$opt $options($opt)
}
return $r
}
set cget 0
if {[llength $args] == 1} {
set cget 1
}
while {[string match -* [lindex $args 0]]} {
switch -glob -- [lindex $args 0] {
-n* -
-ser* {
if {$cget} {
return $options(nameserver)
} else {
set options(nameserver) [Pop args 1]
}
}
-po* {
if {$cget} {
return $options(port)
} else {
set options(port) [Pop args 1]
}
}
-ti* {
if {$cget} {
return $options(timeout)
} else {
set options(timeout) [Pop args 1]
}
}
-pr* {
if {$cget} {
return $options(protocol)
} else {
set proto [string tolower [Pop args 1]]
if {[string compare udp $proto] == 0 \
&& [string compare tcp $proto] == 0} {
return -code error "invalid protocol \"$proto\":\
protocol must be either \"udp\" or \"tcp\""
}
set options(protocol) $proto
}
}
-sea* {
if {$cget} {
return $options(search)
} else {
set options(search) [Pop args 1]
}
}
-log* {
if {$cget} {
return $options(loglevel)
} else {
set options(loglevel) [Pop args 1]
${log}::setlevel $options(loglevel)
}
}
-- { Pop args ; break }
default {
set opts [join [lsort [array names options]] ", -"]
return -code error "bad option [lindex $args 0]:\
must be one of -$opts"
}
}
Pop args
}
return
}
# -------------------------------------------------------------------------
# Description:
# Create a DNS query and send to the specified name server. Returns a token
# to be used to obtain any further information about this query.
#
proc ::dns::resolve {query args} {
variable uid
variable options
variable log
# get a guaranteed unique and non-present token id.
set id [incr uid]
while {[info exists [set token [namespace current]::$id]]} {
set id [incr uid]
}
# FRINK: nocheck
variable $token
upvar 0 $token state
# Setup token/state defaults.
set state(id) $id
set state(query) $query
set state(qdata) ""
set state(opcode) 0; # 0 = query, 1 = inverse query.
set state(-type) A; # DNS record type (A address)
set state(-class) IN; # IN (internet address space)
set state(-recurse) 1; # Recursion Desired
set state(-command) {}; # asynchronous handler
set state(-timeout) $options(timeout); # connection timeout default.
set state(-nameserver) $options(nameserver);# default nameserver
set state(-port) $options(port); # default namerservers port
set state(-search) $options(search); # domain search list
set state(-protocol) $options(protocol); # which protocol udp/tcp
# Handle DNS URL's
if {[string match "dns:*" $query]} {
array set URI [uri::split $query]
foreach {opt value} [uri::split $query] {
if {$value != {} && [info exists state(-$opt)]} {
set state(-$opt) $value
}
}
set state(query) $URI(query)
${log}::debug "parsed query: $query"
}
while {[string match -* [lindex $args 0]]} {
switch -glob -- [lindex $args 0] {
-n* - ns -
-ser* { set state(-nameserver) [Pop args 1] }
-po* { set state(-port) [Pop args 1] }
-ti* { set state(-timeout) [Pop args 1] }
-co* { set state(-command) [Pop args 1] }
-cl* { set state(-class) [Pop args 1] }
-ty* { set state(-type) [Pop args 1] }
-pr* { set state(-protocol) [Pop args 1] }
-sea* { set state(-search) [Pop args 1] }
-re* { set state(-recurse) [Pop args 1] }
-inv* { set state(opcode) 1 }
-status {set state(opcode) 2}
-data { set state(qdata) [Pop args 1] }
default {
set opts [join [lsort [array names state -*]] ", "]
return -code error "bad option [lindex $args 0]: \
must be $opts"
}
}
Pop args
}
if {$state(-nameserver) == {}} {
return -code error "no nameserver specified"
}
if {$state(-protocol) == "udp"} {
if {[llength [package provide ceptcl]] == 0 \
&& [llength [package provide udp]] == 0} {
return -code error "udp support is not available,\
get ceptcl or tcludp"
}
}
# Check for reverse lookups
if {[regexp {^(?:\d{0,3}\.){3}\d{0,3}$} $state(query)]} {
set addr [lreverse [split $state(query) .]]
lappend addr in-addr arpa
set state(query) [join $addr .]
set state(-type) PTR
}
BuildMessage $token
if {$state(-protocol) == "tcp"} {
TcpTransmit $token
if {$state(-command) == {}} {
wait $token
}
} else {
UdpTransmit $token
}
return $token
}
# -------------------------------------------------------------------------
# Description:
# Return a list of domain names returned as results for the last query.
#
proc ::dns::name {token} {
set r {}
Flags $token flags
array set reply [Decode $token]
switch -exact -- $flags(opcode) {
0 {
# QUERY
foreach answer $reply(AN) {
array set AN $answer
if {![info exists AN(type)]} {set AN(type) {}}
switch -exact -- $AN(type) {
MX - NS - PTR {
if {[info exists AN(rdata)]} {lappend r $AN(rdata)}
}
default {
if {[info exists AN(name)]} {
lappend r $AN(name)
}
}
}
}
}
1 {
# IQUERY
foreach answer $reply(QD) {
array set QD $answer
lappend r $QD(name)
}
}
default {
return -code error "not supported for this query type"
}
}
return $r
}
# Description:
# Return a list of the IP addresses returned for this query.
#
proc ::dns::address {token} {
set r {}
array set reply [Decode $token]
foreach answer $reply(AN) {
array set AN $answer
if {[info exists AN(type)]} {
switch -exact -- $AN(type) {
"A" {
lappend r $AN(rdata)
}
"AAAA" {
lappend r $AN(rdata)
}
}
}
}
return $r
}
# Description:
# Return a list of all CNAME results returned for this query.
#
proc ::dns::cname {token} {
set r {}
array set reply [Decode $token]
foreach answer $reply(AN) {
array set AN $answer
if {[info exists AN(type)]} {
if {$AN(type) == "CNAME"} {
lappend r $AN(rdata)
}
}
}
return $r
}
# Description:
# Return the decoded answer records. This can be used for more complex
# queries where the answer isn't supported byb cname/address/name.
proc ::dns::result {token args} {
array set reply [eval [linsert $args 0 Decode $token]]
return $reply(AN)
}
# -------------------------------------------------------------------------
# Description:
# Get the status of the request.
#
proc ::dns::status {token} {
upvar #0 $token state
return $state(status)
}
# Description:
# Get the error message. Empty if no error.
#
proc ::dns::error {token} {
upvar #0 $token state
if {[info exists state(error)]} {
return $state(error)
}
return ""
}
# Description
# Get the error code. This is 0 for a successful transaction.
#
proc ::dns::errorcode {token} {
upvar #0 $token state
set flags [Flags $token]
set ndx [lsearch -exact $flags errorcode]
incr ndx
return [lindex $flags $ndx]
}
# Description:
# Reset a connection with optional reason.
#
proc ::dns::reset {token {why reset} {errormsg {}}} {
upvar #0 $token state
set state(status) $why
if {[string length $errormsg] > 0 && ![info exists state(error)]} {
set state(error) $errormsg
}
catch {fileevent $state(sock) readable {}}
Finish $token
}
# Description:
# Wait for a request to complete and return the status.
#
proc ::dns::wait {token} {
upvar #0 $token state
if {$state(status) == "connect"} {
vwait [subst $token](status)
}
return $state(status)
}
# Description:
# Remove any state associated with this token.
#
proc ::dns::cleanup {token} {
upvar #0 $token state
if {[info exists state]} {
catch {close $state(sock)}
catch {after cancel $state(after)}
unset state
}
}
# -------------------------------------------------------------------------
# Description:
# Dump the raw data of the request and reply packets.
#
proc ::dns::dump {args} {
if {[llength $args] == 1} {
set type -reply
set token [lindex $args 0]
} elseif { [llength $args] == 2 } {
set type [lindex $args 0]
set token [lindex $args 1]
} else {
return -code error "wrong # args:\
should be \"dump ?option? methodName\""
}
# FRINK: nocheck
variable $token
upvar 0 $token state
set result {}
switch -glob -- $type {
-qu* -
-req* {
set result [DumpMessage $state(request)]
}
-rep* {
set result [DumpMessage $state(reply)]
}
default {
error "unrecognised option: must be one of \
\"-query\", \"-request\" or \"-reply\""
}
}
return $result
}
# Description:
# Perform a hex dump of binary data.
#
proc ::dns::DumpMessage {data} {
set result {}
binary scan $data c* r
foreach c $r {
append result [format "%02x " [expr {$c & 0xff}]]
}
return $result
}
# -------------------------------------------------------------------------
# Description:
# Contruct a DNS query packet.
#
proc ::dns::BuildMessage {token} {
# FRINK: nocheck
variable $token
upvar 0 $token state
variable types
variable classes
variable options
if {! [info exists types($state(-type))] } {
return -code error "invalid DNS query type"
}
if {! [info exists classes($state(-class))] } {
return -code error "invalid DNS query class"
}
set qdcount 0
set qsection {}
set nscount 0
set nsdata {}
# In theory we can send multiple queries. In practice, named doesn't
# appear to like that much. If it did work we'd do this:
# foreach domain [linsert $options(search) 0 {}] ...
# Pack the query: QNAME QTYPE QCLASS
set qsection [PackName $state(query)]
append qsection [binary format SS \
$types($state(-type))\
$classes($state(-class))]
incr qdcount
if {[string length $state(qdata)] > 0} {
set nsdata [eval [linsert $state(qdata) 0 PackRecord]]
incr nscount
}
switch -exact -- $state(opcode) {
0 {
# QUERY
set state(request) [binary format SSSSSS $state(id) \
[expr {($state(opcode) << 11) | ($state(-recurse) << 8)}] \
$qdcount 0 $nscount 0]
append state(request) $qsection $nsdata
}
1 {
# IQUERY
set state(request) [binary format SSSSSS $state(id) \
[expr {($state(opcode) << 11) | ($state(-recurse) << 8)}] \
0 $qdcount 0 0 0]
append state(request) \
[binary format cSSI 0 \
$types($state(-type)) $classes($state(-class)) 0]
switch -exact -- $state(-type) {
A {
append state(request) \
[binary format Sc4 4 [split $state(query) .]]
}
PTR {
append state(request) \
[binary format Sc4 4 [split $state(query) .]]
}
default {
return -code error "inverse query not supported for this type"
}
}
}
default {
return -code error "operation not supported"
}
}
return
}
# Pack a human readable dns name into a DNS resource record format.
proc ::dns::PackName {name} {
set data ""
foreach part [split [string trim $name .] .] {
set len [string length $part]
append data [binary format ca$len $len $part]
}
append data \x00
return $data
}
# Pack a character string - byte length prefixed
proc ::dns::PackString {text} {
set len [string length $text]
set data [binary format ca$len $len $text]
return $data
}
# Pack up a single DNS resource record. See RFC1035: 3.2 for the format
# of each type.
# eg: PackRecord name wiki.tcl.tk type MX class IN rdata {10 mail.example.com}
#
proc ::dns::PackRecord {args} {
variable types
variable classes
array set rr {name "" type A class IN ttl 0 rdlength 0 rdata ""}
array set rr $args
set data [PackName $rr(name)]
switch -exact -- $rr(type) {
CNAME - MB - MD - MF - MG - MR - NS - PTR {
set rr(rdata) [PackName $rr(rdata)]
}
HINFO {
array set r {CPU {} OS {}}
array set r $rr(rdata)
set rr(rdata) [PackString $r(CPU)]
append rr(rdata) [PackString $r(OS)]
}
MINFO {
array set r {RMAILBX {} EMAILBX {}}
array set r $rr(rdata)
set rr(rdata) [PackString $r(RMAILBX)]
append rr(rdata) [PackString $r(EMAILBX)]
}
MX {
foreach {pref exch} $rr(rdata) break
set rr(rdata) [binary format S $pref]
append rr(rdata) [PackName $exch]
}
TXT {
set str $rr(rdata)
set len [string length [set str $rr(rdata)]]
set rr(rdata) ""
for {set n 0} {$n < $len} {incr n} {
set s [string range $str $n [incr n 253]]
append rr(rdata) [PackString $s]
}
}
NULL {}
SOA {
array set r {MNAME {} RNAME {}
SERIAL 0 REFRESH 0 RETRY 0 EXPIRE 0 MINIMUM 0}
array set r $rr(rdata)
set rr(rdata) [PackName $r(MNAME)]
append rr(rdata) [PackName $r(RNAME)]
append rr(rdata) [binary format IIIII $r(SERIAL) \
$r(REFRESH) $r(RETRY) $r(EXPIRE) $r(MINIMUM)]
}
}
# append the root label and the type flag and query class.
append data [binary format SSIS $types($rr(type)) \
$classes($rr(class)) $rr(ttl) [string length $rr(rdata)]]
append data $rr(rdata)
return $data
}
# -------------------------------------------------------------------------
# Description:
# Transmit a DNS request over a tcp connection.
#
proc ::dns::TcpTransmit {token} {
# FRINK: nocheck
variable $token
upvar 0 $token state
# setup the timeout
if {$state(-timeout) > 0} {
set state(after) [after $state(-timeout) \
[list [namespace origin reset] \
$token timeout\
"operation timed out"]]
}
# Sometimes DNS servers drop TCP requests. So it's better to
# use asynchronous connect
set s [socket -async $state(-nameserver) $state(-port)]
fileevent $s writable [list [namespace origin TcpConnected] $token $s]
set state(sock) $s
set state(status) connect
return $token
}
proc ::dns::TcpConnected {token s} {
variable $token
upvar 0 $token state
fileevent $s writable {}
if {[catch {fconfigure $s -peername}]} {
# TCP connection failed
Finish $token "can't connect to server"
return
}
fconfigure $s -blocking 0 -translation binary -buffering none
# For TCP the message must be prefixed with a 16bit length field.
set req [binary format S [string length $state(request)]]
append req $state(request)
puts -nonewline $s $req
fileevent $s readable [list [namespace current]::TcpEvent $token]
}
# -------------------------------------------------------------------------
# Description:
# Transmit a DNS request using UDP datagrams
#
# Note:
# This requires a UDP implementation that can transmit binary data.
# As yet I have been unable to test this myself and the tcludp package
# cannot do this.
#
proc ::dns::UdpTransmit {token} {
# FRINK: nocheck
variable $token
upvar 0 $token state
# setup the timeout
if {$state(-timeout) > 0} {
set state(after) [after $state(-timeout) \
[list [namespace origin reset] \
$token timeout\
"operation timed out"]]
}
if {[llength [package provide ceptcl]] > 0} {
# using ceptcl
set state(sock) [cep -type datagram $state(-nameserver) $state(-port)]
fconfigure $state(sock) -blocking 0
} else {
# using tcludp
set state(sock) [udp_open]
udp_conf $state(sock) $state(-nameserver) $state(-port)
}
fconfigure $state(sock) -translation binary -buffering none
set state(status) connect
puts -nonewline $state(sock) $state(request)
fileevent $state(sock) readable [list [namespace current]::UdpEvent $token]
return $token
}
# -------------------------------------------------------------------------
# Description:
# Tidy up after a tcp transaction.
#
proc ::dns::Finish {token {errormsg ""}} {
# FRINK: nocheck
variable $token
upvar 0 $token state
global errorInfo errorCode
if {[string length $errormsg] != 0} {
set state(error) $errormsg
set state(status) error
}
catch {close $state(sock)}
catch {after cancel $state(after)}
if {[info exists state(-command)] && $state(-command) != {}} {
if {[catch {eval $state(-command) {$token}} err]} {
if {[string length $errormsg] == 0} {
set state(error) [list $err $errorInfo $errorCode]
set state(status) error
}
}
if {[info exists state(-command)]} {
unset state(-command)
}
}
}
# -------------------------------------------------------------------------
# Description:
# Handle end-of-file on a tcp connection.
#
proc ::dns::Eof {token} {
# FRINK: nocheck
variable $token
upvar 0 $token state
set state(status) eof
Finish $token
}
# -------------------------------------------------------------------------
# Description:
# Process a DNS reply packet (protocol independent)
#
proc ::dns::Receive {token} {
# FRINK: nocheck
variable $token
upvar 0 $token state
binary scan $state(reply) SS id flags
set status [expr {$flags & 0x000F}]
switch -- $status {
0 {
set state(status) ok
Finish $token
}
1 { Finish $token "Format error - unable to interpret the query." }
2 { Finish $token "Server failure - internal server error." }
3 { Finish $token "Name Error - domain does not exist" }
4 { Finish $token "Not implemented - the query type is not available." }
5 { Finish $token "Refused - your request has been refused by the server." }
default {
Finish $token "unrecognised error code: $err"
}
}
}
# -------------------------------------------------------------------------
# Description:
# file event handler for tcp socket. Wait for the reply data.
#
proc ::dns::TcpEvent {token} {
variable log
# FRINK: nocheck
variable $token
upvar 0 $token state
set s $state(sock)
if {[eof $s]} {
Eof $token
return
}
set status [catch {read $state(sock)} result]
if {$status != 0} {
${log}::debug "Event error: $result"
Finish $token "error reading data: $result"
} elseif { [string length $result] >= 0 } {
if {[catch {
# Handle incomplete reads - check the size and keep reading.
if {![info exists state(size)]} {
binary scan $result S state(size)
set result [string range $result 2 end]
}
append state(reply) $result
# check the length and flags and chop off the tcp length prefix.
if {[string length $state(reply)] >= $state(size)} {
binary scan $result S id
set id [expr {$id & 0xFFFF}]
if {$id != [expr {$state(id) & 0xFFFF}]} {
${log}::error "received packed with incorrect id"
}
# bug #1158037 - doing this causes problems > 65535 requests!
#Receive [namespace current]::$id
Receive $token
} else {
${log}::debug "Incomplete tcp read:\
[string length $state(reply)] should be $state(size)"
}
} err]} {
Finish $token "Event error: $err"
}
} elseif { [eof $state(sock)] } {
Eof $token
} elseif { [fblocked $state(sock)] } {
${log}::debug "Event blocked"
} else {
${log}::critical "Event error: this can't happen!"
Finish $token "Event error: this can't happen!"
}
}
# -------------------------------------------------------------------------
# Description:
# file event handler for udp sockets.
proc ::dns::UdpEvent {token} {
# FRINK: nocheck
variable $token
upvar 0 $token state
set s $state(sock)
set payload [read $state(sock)]
append state(reply) $payload
binary scan $payload S id
set id [expr {$id & 0xFFFF}]
if {$id != [expr {$state(id) & 0xFFFF}]} {
${log}::error "received packed with incorrect id"
}
# bug #1158037 - doing this causes problems > 65535 requests!
#Receive [namespace current]::$id
Receive $token
}
# -------------------------------------------------------------------------
proc ::dns::Flags {token {varname {}}} {
# FRINK: nocheck
variable $token
upvar 0 $token state
if {$varname != {}} {
upvar $varname flags
}
array set flags {query 0 opcode 0 authoritative 0 errorcode 0
truncated 0 recursion_desired 0 recursion_allowed 0}
binary scan $state(reply) SSSSSS mid hdr nQD nAN nNS nAR
set flags(response) [expr {($hdr & 0x8000) >> 15}]
set flags(opcode) [expr {($hdr & 0x7800) >> 11}]
set flags(authoritative) [expr {($hdr & 0x0400) >> 10}]
set flags(truncated) [expr {($hdr & 0x0200) >> 9}]
set flags(recursion_desired) [expr {($hdr & 0x0100) >> 8}]
set flags(recursion_allowed) [expr {($hdr & 0x0080) >> 7}]
set flags(errorcode) [expr {($hdr & 0x000F)}]
return [array get flags]
}
# -------------------------------------------------------------------------
# Description:
# Decode a DNS packet (either query or response).
#
proc ::dns::Decode {token args} {
variable log
# FRINK: nocheck
variable $token
upvar 0 $token state
array set opts {-rdata 0 -query 0}
while {[string match -* [set option [lindex $args 0]]]} {
switch -exact -- $option {
-rdata { set opts(-rdata) 1 }
-query { set opts(-query) 1 }
default {
return -code error "bad option \"$option\":\
must be -rdata"
}
}
Pop args
}
if {$opts(-query)} {
binary scan $state(request) SSSSSSc* mid hdr nQD nAN nNS nAR data
} else {
binary scan $state(reply) SSSSSSc* mid hdr nQD nAN nNS nAR data
}
set fResponse [expr {($hdr & 0x8000) >> 15}]
set fOpcode [expr {($hdr & 0x7800) >> 11}]
set fAuthoritative [expr {($hdr & 0x0400) >> 10}]
set fTrunc [expr {($hdr & 0x0200) >> 9}]
set fRecurse [expr {($hdr & 0x0100) >> 8}]
set fCanRecurse [expr {($hdr & 0x0080) >> 7}]
set fRCode [expr {($hdr & 0x000F)}]
set flags ""
if {$fResponse} {set flags "QR"} else {set flags "Q"}
set opcodes [list QUERY IQUERY STATUS]
lappend flags [lindex $opcodes $fOpcode]
if {$fAuthoritative} {lappend flags "AA"}
if {$fTrunc} {lappend flags "TC"}
if {$fRecurse} {lappend flags "RD"}
if {$fCanRecurse} {lappend flags "RA"}
set info "ID: $mid\
Fl: [format 0x%02X [expr {$hdr & 0xFFFF}]] ($flags)\
NQ: $nQD\
NA: $nAN\
NS: $nNS\
AR: $nAR"
${log}::debug $info
set ndx 12
set r {}
set QD [ReadQuestion $nQD $state(reply) ndx]
lappend r QD $QD
set AN [ReadAnswer $nAN $state(reply) ndx $opts(-rdata)]
lappend r AN $AN
set NS [ReadAnswer $nNS $state(reply) ndx $opts(-rdata)]
lappend r NS $NS
set AR [ReadAnswer $nAR $state(reply) ndx $opts(-rdata)]
lappend r AR $AR
return $r
}
# -------------------------------------------------------------------------
proc ::dns::Expand {data} {
set r {}
binary scan $data c* d
foreach c $d {
lappend r [expr {$c & 0xFF}]
}
return $r
}
# -------------------------------------------------------------------------
# Description:
# Pop the nth element off a list. Used in options processing.
#
proc ::dns::Pop {varname {nth 0}} {
upvar $varname args
set r [lindex $args $nth]
set args [lreplace $args $nth $nth]
return $r
}
# -------------------------------------------------------------------------
# Description:
# Reverse a list. Code from http://wiki.tcl.tk/tcl/43
#
proc ::dns::lreverse {lst} {
set res {}
set i [llength $lst]
while {$i} {lappend res [lindex $lst [incr i -1]]}
return $res
}
# -------------------------------------------------------------------------
proc ::dns::KeyOf {arrayname value {default {}}} {
upvar $arrayname array
set lst [array get array]
set ndx [lsearch -exact $lst $value]
if {$ndx != -1} {
incr ndx -1
set r [lindex $lst $ndx]
} else {
set r $default
}
return $r
}
# -------------------------------------------------------------------------
# Read the question section from a DNS message. This always starts at index
# 12 of a message but may be of variable length.
#
proc ::dns::ReadQuestion {nitems data indexvar} {
variable types
variable classes
upvar $indexvar index
set result {}
for {set cn 0} {$cn < $nitems} {incr cn} {
set r {}
lappend r name [ReadName data $index offset]
incr index $offset
# Read off QTYPE and QCLASS for this query.
set ndx $index
incr index 3
binary scan [string range $data $ndx $index] SS qtype qclass
set qtype [expr {$qtype & 0xFFFF}]
set qclass [expr {$qclass & 0xFFFF}]
incr index
lappend r type [KeyOf types $qtype $qtype] \
class [KeyOf classes $qclass $qclass]
lappend result $r
}
return $result
}
# -------------------------------------------------------------------------
# Read an answer section from a DNS message.
#
proc ::dns::ReadAnswer {nitems data indexvar {raw 0}} {
variable types
variable classes
upvar $indexvar index
set result {}
for {set cn 0} {$cn < $nitems} {incr cn} {
set r {}
lappend r name [ReadName data $index offset]
incr index $offset
# Read off TYPE, CLASS, TTL and RDLENGTH
binary scan [string range $data $index end] SSIS type class ttl rdlength
set type [expr {$type & 0xFFFF}]
set type [KeyOf types $type $type]
set class [expr {$class & 0xFFFF}]
set class [KeyOf classes $class $class]
set ttl [expr {$ttl & 0xFFFFFFFF}]
set rdlength [expr {$rdlength & 0xFFFF}]
incr index 10
set rdata [string range $data $index [expr {$index + $rdlength - 1}]]
if {! $raw} {
switch -- $type {
A {
set rdata [join [Expand $rdata] .]
}
AAAA {
set rdata [ip::contract [ip::ToString $rdata]]
}
NS - CNAME - PTR {
set rdata [ReadName data $index off]
}
MX {
binary scan $rdata S preference
set exchange [ReadName data [expr {$index + 2}] off]
set rdata [list $preference $exchange]
}
SRV {
set x $index
set rdata [list priority [ReadUShort data $x off]]
incr x $off
lappend rdata weight [ReadUShort data $x off]
incr x $off
lappend rdata port [ReadUShort data $x off]
incr x $off
lappend rdata target [ReadName data $x off]
incr x $off
}
TXT {
set rdata [ReadString data $index $rdlength]
}
SOA {
set x $index
set rdata [list MNAME [ReadName data $x off]]
incr x $off
lappend rdata RNAME [ReadName data $x off]
incr x $off
lappend rdata SERIAL [ReadULong data $x off]
incr x $off
lappend rdata REFRESH [ReadLong data $x off]
incr x $off
lappend rdata RETRY [ReadLong data $x off]
incr x $off
lappend rdata EXPIRE [ReadLong data $x off]
incr x $off
lappend rdata MINIMUM [ReadULong data $x off]
incr x $off
}
}
}
incr index $rdlength
lappend r type $type class $class ttl $ttl rdlength $rdlength rdata $rdata
lappend result $r
}
return $result
}
# Read a 32bit integer from a DNS packet. These are compatible with
# the ReadName proc. Additionally - ReadULong takes measures to ensure
# the unsignedness of the value obtained.
#
proc ::dns::ReadLong {datavar index usedvar} {
upvar $datavar data
upvar $usedvar used
set r {}
set used 0
if {[binary scan $data @${index}I r]} {
set used 4
}
return $r
}
proc ::dns::ReadULong {datavar index usedvar} {
upvar $datavar data
upvar $usedvar used
set r {}
set used 0
if {[binary scan $data @${index}cccc b1 b2 b3 b4]} {
set used 4
# This gets us an unsigned value.
set r [expr {($b4 & 0xFF) + (($b3 & 0xFF) << 8)
+ (($b2 & 0xFF) << 16) + ($b1 << 24)}]
}
return $r
}
proc ::dns::ReadUShort {datavar index usedvar} {
upvar $datavar data
upvar $usedvar used
set r {}
set used 0
if {[binary scan [string range $data $index end] cc b1 b2]} {
set used 2
# This gets us an unsigned value.
set r [expr {(($b2 & 0xff) + (($b1 & 0xff) << 8)) & 0xffff}]
}
return $r
}
# Read off the NAME or QNAME element. This reads off each label in turn,
# dereferencing pointer labels until we have finished. The length of data
# used is passed back using the usedvar variable.
#
proc ::dns::ReadName {datavar index usedvar} {
upvar $datavar data
upvar $usedvar used
set startindex $index
set r {}
set len 1
set max [string length $data]
while {$len != 0 && $index < $max} {
# Read the label length (and preread the pointer offset)
binary scan [string range $data $index end] cc len lenb
set len [expr {$len & 0xFF}]
incr index
if {$len != 0} {
if {[expr {$len & 0xc0}]} {
binary scan [binary format cc [expr {$len & 0x3f}] [expr {$lenb & 0xff}]] S offset
incr index
lappend r [ReadName data $offset junk]
set len 0
} else {
lappend r [string range $data $index [expr {$index + $len - 1}]]
incr index $len
}
}
}
set used [expr {$index - $startindex}]
return [join $r .]
}
proc ::dns::ReadString {datavar index length} {
upvar $datavar data
set startindex $index
set r {}
set max [expr {$index + $length}]
while {$index < $max} {
binary scan [string range $data $index end] c len
set len [expr {$len & 0xFF}]
incr index
if {$len != 0} {
append r [string range $data $index [expr {$index + $len - 1}]]
incr index $len
}
}
return $r
}
# -------------------------------------------------------------------------
# Support for finding the local nameservers
#
# For unix we can just parse the /etc/resolv.conf if it exists.
# Of course, some unices use /etc/resolver and other things (NIS for instance)
# On Windows, we can examine the Internet Explorer settings from the registry.
#
switch -exact $::tcl_platform(platform) {
windows {
proc ::dns::nameservers {} {
package require registry
set base {HKEY_LOCAL_MACHINE\System\CurrentControlSet\Services}
set param "$base\\Tcpip\\Parameters"
set interfaces "$param\\Interfaces"
set nameservers {}
if {[string equal $::tcl_platform(os) "Windows NT"]} {
AppendRegistryValue $param NameServer nameservers
AppendRegistryValue $param DhcpNameServer nameservers
foreach i [registry keys $interfaces] {
AppendRegistryValue "$interfaces\\$i" NameServer nameservers
AppendRegistryValue "$interfaces\\$i" DhcpNameServer nameservers
}
} else {
set param "$base\\VxD\\MSTCP"
AppendRegistryValue $param NameServer nameservers
}
return $nameservers
}
proc ::dns::AppendRegistryValue {key val listName} {
upvar $listName lst
if {![catch {registry get $key $val} v]} {
foreach ns [split $v ", "] {
if {[lsearch -exact $lst $ns] == -1} {
lappend lst $ns
}
}
}
}
}
unix {
proc ::dns::nameservers {} {
set nameservers {}
if {[file readable /etc/resolv.conf]} {
set f [open /etc/resolv.conf r]
while {![eof $f]} {
gets $f line
if {[regexp {^\s*nameserver\s+(.*)$} $line -> ns]} {
lappend nameservers $ns
}
}
close $f
}
if {[llength $nameservers] < 1} {
lappend nameservers 127.0.0.1
}
return $nameservers
}
}
default {
proc ::dns::nameservers {} {
return -code error "command not supported for this platform."
}
}
}
# -------------------------------------------------------------------------
# Possible support for the DNS URL scheme.
# Ref: http://www.ietf.org/internet-drafts/draft-josefsson-dns-url-04.txt
# eg: dns:target?class=IN;type=A
# dns://nameserver/target?type=A
#
# URI quoting to be accounted for.
#
catch {
uri::register {dns} {
set escape [set [namespace parent [namespace current]]::basic::escape]
set host [set [namespace parent [namespace current]]::basic::host]
set hostOrPort [set [namespace parent [namespace current]]::basic::hostOrPort]
set class [string map {* \\\\*} \
"class=([join [array names ::dns::classes] {|}])"]
set type [string map {* \\\\*} \
"type=([join [array names ::dns::types] {|}])"]
set classOrType "(?:${class}|${type})"
set classOrTypeSpec "(?:${class}|${type})(?:;(?:${class}|${type}))?"
set query "${host}(${classOrTypeSpec})?"
variable schemepart "(//${hostOrPort}/)?(${query})"
variable url "dns:$schemepart"
}
}
namespace eval ::uri {} ;# needed for pkg_mkIndex.
proc ::uri::SplitDns {uri} {
upvar \#0 [namespace current]::dns::schemepart schemepart
upvar \#0 [namespace current]::dns::class classOrType
upvar \#0 [namespace current]::dns::class classRE
upvar \#0 [namespace current]::dns::type typeRE
upvar \#0 [namespace current]::dns::classOrTypeSpec classOrTypeSpec
array set parts {nameserver {} query {} class {} type {} port {}}
# validate the uri
if {[regexp -- $dns::schemepart $uri r] == 1} {
# deal with the optional class and type specifiers
if {[regexp -indices -- "${classOrTypeSpec}$" $uri range]} {
set spec [string range $uri [lindex $range 0] [lindex $range 1]]
set uri [string range $uri 0 [expr {[lindex $range 0] - 2}]]
if {[regexp -- "$classRE" $spec -> class]} {
set parts(class) $class
}
if {[regexp -- "$typeRE" $spec -> type]} {
set parts(type) $type
}
}
# Handle the nameserver specification
if {[string match "//*" $uri]} {
set uri [string range $uri 2 end]
array set tmp [GetHostPort uri]
set parts(nameserver) $tmp(host)
set parts(port) $tmp(port)
}
# what's left is the query domain name.
set parts(query) [string trimleft $uri /]
}
return [array get parts]
}
proc ::uri::JoinDns {args} {
array set parts {nameserver {} port {} query {} class {} type {}}
array set parts $args
set query [::uri::urn::quote $parts(query)]
if {$parts(type) != {}} {
append query "?type=$parts(type)"
}
if {$parts(class) != {}} {
if {$parts(type) == {}} {
append query "?class=$parts(class)"
} else {
append query ";class=$parts(class)"
}
}
if {$parts(nameserver) != {}} {
set ns "$parts(nameserver)"
if {$parts(port) != {}} {
append ns ":$parts(port)"
}
set query "//${ns}/${query}"
}
return "dns:$query"
}
# -------------------------------------------------------------------------
catch {dns::configure -nameserver [lindex [dns::nameservers] 0]}
package provide dns $dns::version
# -------------------------------------------------------------------------
# Local Variables:
# indent-tabs-mode: nil
# End:
|