/usr/bin/ntpq is in ntpsec 1.1.0+dfsg1-1.
This file is owned by root:root, with mode 0o755.
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 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 | #!/usr/bin/python3
# -*- coding: utf-8 -*-
#
# ntpq - query an NTP server using mode 6 commands
#
# Freely translated from the old C ntpq code by ESR. The idea was to
# cleanly separate ntpq-that-was into a thin front-end layer handling
# mainly command interpretation and a back-end that presents the take
# from ntpd as objects that can be re-used by other front
# ends. Reusable pieces live in pylib.
#
# SPDX-License-Identifier: BSD-2-clause
from __future__ import print_function, division
import cmd
import getopt
import hashlib
import os
import re
import resource
import socket
import sys
import time
try:
import ntp.control
import ntp.ntpc
import ntp.packet
import ntp.util
except ImportError as e:
sys.stderr.write(
"ntpq: can't find Python NTP library -- check PYTHONPATH.\n")
sys.stderr.write("%s\n" % e)
sys.exit(1)
version = ntp.util.stdversion()
# General notes on Python 2/3 compatibility:
#
# This code uses the following strategy to allow it to run on both Python 2
# and Python 3:
#
# - Use latin-1 encoding to transform binary data to/from Unicode when
# necessary for operations where Python 3 expects Unicode; the
# polystr and polybytes functions are used to do this so that
# when running on Python 2, the byte string data is used unchanged.
#
# - Construct custom stdout and stderr streams when running
# on Python 3 that force UTF-8 encoding, and wrap them around the
# underlying binary buffers (in Python 2, the streams are binary
# and are used unchanged); this ensures that the same transformation
# is done on data from/to the standard streams, as is done on binary
# data from/to files and subprocesses; the make_std_wrapper function
# does this.
#
# anyone that changes this needs to test with all combinations of
# python2, python3, LC_ALL=ascii, LC_ALL=latin-1, LC_ALL=en_US.utf8, and
# piping output to a file. While looking at the UTF-8 in the output.
forced_utf8 = False
if str is bytes: # Python 2
polystr = unicode
polybytes = bytes
def string_escape(s):
return s.decode('string_escape')
# This used to force UTF-8 encoding, but that breaks the readline system.
# Unfortunately sometimes sys.stdout.encoding lies about the encoding,
# so expect random false positives.
ntp.util.check_unicode()
else: # Python 3
import io
def polystr(o):
"Polymorphic string factory function"
if isinstance(o, str):
return o
if not isinstance(o, bytes):
return str(o)
return str(o, encoding=master_encoding)
def polybytes(s):
"Polymorphic string encoding function"
if isinstance(s, bytes):
return s
if not isinstance(s, str):
return bytes(s)
return bytes(s, encoding=master_encoding)
def string_escape(s):
"Polymorphic string_escape/unicode_escape"
# This hack is necessary because Unicode strings in Python 3 don't
# have a decode method, so there's no simple way to ask it for the
# equivalent of decode('string_escape') in Python 2. This function
# assumes that it will be called with a Python 3 'str' instance
return s.encode(master_encoding).decode('unicode_escape')
def make_std_wrapper(stream):
"Standard input/output wrapper factory function"
# This ensures that the encoding of standard output and standard
# error on Python 3 matches the master encoding we use to turn
# bytes to Unicode in polystr above
# line_buffering=True ensures that interactive command sessions
# work as expected
return io.TextIOWrapper(stream.buffer, encoding="utf-8",
newline="\n", line_buffering=True)
# This is the one situation where we *can* force unicode.
if "UTF-8" != sys.stdout.encoding:
forced_utf8 = True
sys.stdout = make_std_wrapper(sys.stdout)
if "UTF-8" != sys.stderr.encoding:
forced_utf8 = True
sys.stderr = make_std_wrapper(sys.stderr)
# NTP-specific parts resume here
# Flags for forming descriptors.
OPT = 0x80 # this argument is optional, or'd with type */
NO = 0x0
NTP_STR = 0x1 # string argument
NTP_UINT = 0x2 # unsigned integer
NTP_INT = 0x3 # signed integer
NTP_ADD = 0x4 # IP network address
IP_VERSION = 0x5 # IP version
NTP_ADP = 0x6 # IP address and port
NTP_LFP = 0x7 # NTP timestamp
NTP_MODE = 0x8 # peer mode
NTP_2BIT = 0x9 # leap bits
NTP_FLOAT = 0xa # Float value
class Ntpq(cmd.Cmd):
"ntpq command interpreter"
def __init__(self, session):
cmd.Cmd.__init__(self)
self.session = session
self.prompt = "ntpq> " if os.isatty(0) else ""
self.interactive = False # set to True when we should prompt
# self.auth_keyid = 0# Keyid used for authentication.
# self.auth_keytype = "NID_md5"# MD5 (FIXME: string value is a dummy)
# self.auth_hashlen = 16# MD5
# I do not know if the preceding are there for a specific reason
# so I am leaving them, and possibly duplicating them.
self.rawmode = False # Flag which indicates raw mode output.
self.directmode = False # Flag for direct MRU output.
self.showhostnames = True # If false, display numeric IPs
self.showunits = False # If False, show old style float
self.auth_delay = 20 # delay time (default 20msec)
self.wideremote = False # show wide remote names?
self.ccmds = [] # Queued commands
self.chosts = [] # Command-line hosts
self.peers = [] # Data from NTP peers.
self.debug = 0
self.logfp = sys.stderr
self.pktversion = ntp.magic.NTP_OLDVERSION + 1
self.uservars = ntp.util.OrderedDict()
self.ai_family = socket.AF_UNSPEC
self.termwidth = ntp.util.termsize()[0]
def get_names(self):
# Overrides a method in Cmd
return [x.replace('hot_', ':').replace('config_from_file', 'config-from-file') for x in dir(self.__class__)]
def emptyline(self):
"Called when an empty line is entered in response to the prompt."
pass
def precmd(self, line):
if line.startswith(":config"):
line = "hot_" + line[1:]
elif line.startswith("config-from-file"):
line = line.replace("config-from-file", "config_from_file")
return line
def default(self, line):
"Called on an input line when the command prefix is not recognized."
cmd, arg, line = self.parseline(line)
try:
dotext = 'do_'+cmd
cmdprefixlist = [a[3:] for a in self.get_names()
if a.startswith(dotext)]
if len(cmdprefixlist) == 1:
line = line.replace(cmd, cmdprefixlist[0])
cmd = cmdprefixlist[0]
elif len(cmdprefixlist) > 1:
self.warn("***Command `%s' ambiguous\n" % cmd)
return
elif len(cmdprefixlist) == 0:
self.warn("***Command `%s' unknown\n" % cmd)
return
if cmd == "help" and arg:
helptext = 'help_'+arg
if helptext not in self.get_names():
argprefixlist = [a[5:] for a in self.get_names()
if a.startswith(helptext)]
if len(argprefixlist) == 1:
line = line.replace(arg, argprefixlist.pop())
elif len(argprefixlist) > 1:
self.warn("Command `%s' is ambiguous\n" % arg)
return
elif len(argprefixlist) == 0:
self.warn("Command `%s' is unknown\n" % arg)
return
self.onecmd(line)
except TypeError:
self.warn("Command `%s' is unknown\n" % line)
def do_help(self, arg):
if arg:
helptext = 'help_'+arg
if helptext not in self.get_names():
argprefixlist = [a[5:] for a in self.get_names()
if a.startswith(helptext)]
if len(argprefixlist) == 1:
arg = argprefixlist.pop()
elif len(argprefixlist) > 1:
self.warn("Command `%s' is ambiguous.\n" % arg)
return
cmd.Cmd.do_help(self, arg)
def say(self, msg):
try:
sys.stdout.write(polystr(msg))
except UnicodeEncodeError as e:
print("Unicode failure:", e)
print("msg:\n", repr(msg))
raise e
sys.stdout.flush() # In case we're piping the output
def warn(self, msg):
sys.stderr.write(polystr(msg))
def help_help(self):
self.say("""\
function: tell the use and syntax of commands
usage: help [ command ]
""")
# Unexposed helper tables and functions begin here
def __dogetassoc(self):
try:
self.peers = self.session.readstat()
except ntp.packet.ControlException as e:
self.warn(e.message + "\n")
return False
except IOError as e:
print(e.strerror)
return False
if len(self.peers) == 0:
if self.chosts:
self.say("server=%s " % self.session.hostname)
self.say("No association IDs returned\n")
return False
if self.debug:
self.warn("\n%d associations total\n" % len(self.peers))
# sortassoc()
return True
def __printassoc(self, showall):
if not self.peers:
self.say("No association IDs in list\n")
return
self.say(
"\nind assid status conf reach auth condition last_event cnt\n")
self.say(
"===========================================================\n")
for (i, peer) in enumerate(self.peers):
statval = ntp.control.CTL_PEER_STATVAL(peer.status)
if ((not showall and
(statval & (ntp.control.CTL_PST_CONFIG |
ntp.control.CTL_PST_REACH)) == 0)):
continue
sw = ntp.util.PeerStatusWord(peer.status)
display = "%3d %5u %04x %3.3s %4s %4.4s %9.9s %11s %2lu" \
% (i + 1, peer.associd, peer.status, sw.conf, sw.reach,
sw.auth, sw.condition, sw.last_event, sw.event_count)
self.say(display + "\n")
def __dopeers(self, showall, mode):
if not self.__dogetassoc():
return
report = ntp.util.PeerSummary(mode,
self.pktversion,
self.showhostnames,
self.wideremote,
self.showunits,
termwidth=interpreter.termwidth,
debug=interpreter.debug,
logfp=self.logfp)
try:
maxhostlen = 0
if len(self.chosts) > 1:
maxhostlen = max([len(host) for (host, _af) in self.chosts])
self.say("%-*.*s "
% (maxhostlen, maxhostlen+1, "server"))
self.say(report.header() + "\n")
if len(self.chosts) > 1:
maxhostlen = max([len(host) for (host, _af) in self.chosts])
self.say("=" * (maxhostlen + 1))
self.say(("=" * report.width()) + "\n")
for peer in self.peers:
if ((not showall and
not (ntp.control.CTL_PEER_STATVAL(peer.status) &
(ntp.control.CTL_PST_CONFIG |
ntp.control.CTL_PST_REACH)))):
if self.debug:
self.warn("eliding [%d]\n" % peer.associd)
continue
try:
variables = self.session.readvar(peer.associd, raw=True)
except ntp.packet.ControlException as e:
self.warn(e.message + "\n")
return
except IOError as e:
print(e.strerror)
return
if not variables:
if len(self.chosts) > 1:
self.warn("server=%s " % self.session.hostname)
self.warn("***No information returned for association %d\n"
% peer.associd)
continue
if len(self.chosts) > 1:
self.say(ntp.util.PeerSummary.high_truncate(
self.session.hostname, maxhostlen) + " ")
self.say(report.summary(self.session.rstatus,
variables, peer.associd))
except KeyboardInterrupt:
pass
def __assoc_valid(self, line, required=False):
"Process a numeric associd or index."
# FIXME: This does a useless call to __dogetassoc() when associd == 0
# No big deal most of the time. Just a useless packet exchange.
if not line:
if required:
self.warn("An associd argument is required.\n")
return -1
else:
return 0
if not self.peers:
self.__dogetassoc()
if line.startswith("&"):
try:
idx = int(line[1:].split()[0])
except:
self.warn("Invalid index literal.\n")
return -1
if idx < 0 or idx >= 2**16-1:
self.warn("%d is not a valid association number.\n" % idx)
return -1
elif idx not in range(1, len(self.peers)+1):
self.warn("No such association as %d.\n" % idx)
return -1
else:
return self.peers[idx - 1].associd
else:
try:
associd = int(line.split()[0])
except:
self.warn("Invalid associd literal.\n")
return -1
if ((associd != 0 and
associd not in [peer.associd for peer in self.peers])):
self.warn("Unknown associd.\n")
return -1
else:
return associd
def __assoc_range_valid(self, line):
"Try to get a range of assoc IDs."
tokens = line.split()
if len(tokens) < 2:
return ()
lo = self.__assoc_valid(tokens[0])
hi = self.__assoc_valid(tokens[1])
if lo < 0 or hi < 0 or hi < lo:
return ()
if lo == hi:
return(lo,)
return range(lo, hi+1)
def printvars(self, variables, dtype, quiet):
"Dump variables in raw (actually, semi-cooked) mode."
if self.rawmode:
if not quiet:
self.say("status=0x%04x,\n" % self.session.rstatus)
# C ntpq not only suppressed \r but tried to visibilize
# high-half characters. We won't do that unless somebody
# files a bug, Mode 6 never seems to generate those in
# variable fetches.
text = polystr(session.response.replace(polybytes(",\r\n"),
polybytes(",\n")))
else:
if not quiet:
self.say("status=%04x %s,\n"
% (self.session.rstatus,
ntp.ntpc.statustoa(dtype, self.session.rstatus)))
text = ntp.util.cook(variables, self.showunits)
text = text.replace("'", '"')
self.say(text)
def __dolist(self, varlist, associd, op, type, quiet=False):
"List variables associated with a specified peer."
try:
variables = self.session.readvar(associd, varlist, op, raw=True)
except ntp.packet.ControlException as e:
self.warn(e.message + "\n")
return False
except IOError as e:
print(e.strerror)
return False
if len(self.chosts) > 1:
self.say("server=%s " % self.session.hostname)
if not variables:
if associd == 0:
self.say("No system%s variables returned\n"
% " clock" if (type == ntp.ntpc.TYPE_CLOCK) else "")
else:
self.say("No information returned for%s association %d\n"
% (" clock" if (type == ntp.ntpc.TYPE_CLOCK) else "",
associd))
return True
if not quiet:
self.say("associd=%d " % associd)
self.printvars(variables, type, not (not varlist))
return True
# Unexposed helper tables and functions end here
def do_units(self, _unused):
"toggle unit display"
self.showunits = not self.showunits
def help_units(self):
self.say("""\
function: toggle unit display
usage: units
""")
def do_EOF(self, _unused):
"exit ntpq"
self.say("\n")
return True
def do_timeout(self, line):
"set the primary receive time out"
if line:
try:
self.session.primary_timeout = int(line)
except ValueError:
print("What?")
print("primary timeout %d ms" % self.session.primary_timeout)
def help_timeout(self):
self.say("""\
function: set the primary receive time out
usage: timeout [ msec ]
""")
def collect_display(self, associd, variables, decodestatus):
"Query and display a collection of variables from the system."
try:
queried = self.session.readvar(associd,
[v[0] for v in variables],
raw=True)
except ntp.packet.ControlException as e:
if ntp.control.CERR_UNKNOWNVAR == e.errorcode:
self.warn("Unknown variable. Trying one at a time.\n")
varlist = [v[0] for v in variables]
items = []
for var in varlist:
try:
queried = self.session.readvar(associd, [var],
raw=True)
for (name, (value, rawvalue)) in queried.items():
items.append((name, (value, rawvalue)))
except ntp.packet.ControlException as e:
if ntp.control.CERR_UNKNOWNVAR == e.errorcode:
items.append((var, "???"))
continue
raise e
queried = ntp.util.OrderedDict(items)
else:
self.warn(e.message + "\n")
return
except IOError as e:
print(e.strerror)
return
if self.rawmode:
self.say(self.session.response)
return
if decodestatus:
if associd == 0:
statype = ntp.ntpc.TYPE_SYS
else:
statype = ntp.ntpc.TYPE_PEER
self.say("associd=%u status=%04x %s,\n"
% (associd, self.session.rstatus,
ntp.ntpc.statustoa(statype, self.session.rstatus)))
try:
for (name, legend, fmt) in variables:
if name not in queried:
continue
value = queried[name][0]
rawvalue = queried[name][1]
if fmt in (NTP_ADD, NTP_ADP):
if self.showhostnames:
if self.debug:
self.say("DNS lookup begins...")
value = ntp.util.canonicalize_dns(
value, family=self.ai_family)
if self.debug:
self.say("DNS lookup complete.")
self.say("%s %s\n" % (legend, value))
elif fmt == NTP_STR:
if value:
self.say("%s %s\n" % (legend, value))
elif fmt in (NTP_UINT, NTP_INT, NTP_FLOAT):
if self.showunits:
displayvalue = ntp.util.unitifyvar(rawvalue, name)
else:
displayvalue = value
self.say("%s %s\n" % (legend, displayvalue))
elif fmt == NTP_LFP:
self.say("%s %s\n" % (legend, ntp.ntpc.prettydate(value)))
elif fmt == NTP_2BIT:
self.say("%s %s\n"
% (legend, ("00", "01", "10", "11")[value]))
elif fmt == NTP_MODE:
modes = (
"unspec", "sym_active", "sym_passive", "client",
"server",
"broadcast", "control", "private", "bclient"
)
try:
self.say("%s %s\n" % (legend, modes[value]))
except IndexError:
self.say("%s %s%d\n" % (legend, "mode#", value))
else:
self.warn("unexpected vc type %s for %s, value %s\n"
% (fmt, name, value))
except KeyboardInterrupt:
self.warn("display interrupted\n")
def do_delay(self, line):
"set the delay added to encryption time stamps"
if not line:
self.say("delay %d ms\n" % self.auth_delay)
else:
try:
self.auth_delay = int(line)
if self.auth_delay < 0:
raise ValueError
except ValueError:
self.say("Huh?")
def help_delay(self):
self.say("""\
function: set the delay added to encryption time stamps
usage: delay [ msec ]
""")
def do_host(self, line):
"specify the host whose NTP server we talk to"
if not line:
if self.session.havehost():
print("current host is %s" % self.session.hostname)
else:
print("no current host")
else:
tokens = line.split()
if tokens[0] == '-4':
session.ai_family = socket.AF_INET
tokens.pop(0)
elif tokens[0] == '-6':
session.ai_family = socket.AF_INET6
tokens.pop(0)
try:
if ((tokens and
self.session.openhost(tokens[0], session.ai_family))):
print("current host set to %s" % self.session.hostname)
elif self.session.havehost():
print("current host remains %s" % self.session.hostname)
else:
print("still no current host")
except KeyboardInterrupt:
print("lookup interrupted")
def help_host(self):
self.say("""\
function: specify the host whose NTP server we talk to
usage: host [-4|-6] [hostname]
""")
def do_poll(self, line):
"poll an NTP server in client mode `n' times"
# And it's not in the C version, so we're off the hook here
print("poll not implemented yet")
def help_poll(self):
self.say("""\
function: poll an NTP server in client mode `n' times
usage: poll [n] [verbose]
""")
def do_passwd(self, line):
"specify a password to use for authenticated requests"
try:
self.session.password()
except ntp.packet.ControlException as e:
self.warn(e.message + "\n")
def help_passwd(self):
self.say("""\
function: specify a password to use for authenticated requests
usage: passwd []
""")
def do_hostnames(self, line):
"specify whether hostnames or net numbers are printed"
if not line:
pass
elif line == "yes":
self.showhostnames = True
elif line == "no":
self.showhostnames = False
else:
print("What?")
if self.showhostnames:
print("hostnames being shown")
else:
print("hostnames not being shown")
def help_hostnames(self):
self.say("""\
function: specify whether hostnames or net numbers are printed
usage: hostnames [yes|no]
""")
def do_debug(self, line):
"set/change debugging level"
if not line:
pass
elif line == "more":
self.debug += 1
elif line == "less":
if self.debug > 0:
self.debug -= 1
elif line == "no":
self.debug = 0
else:
try:
self.debug = int(line) # C version didn't implement this
except ValueError:
print("What?")
self.session.debug = self.debug
print("debug level is %d" % self.debug)
def do_logfile(self, line):
"""view/change logfile. \"<stderr>\" will log to stderr
instead of a file"""
if not line:
print(repr(self.logfp.name))
return
if self.logfp != sys.stderr:
self.logfp.close()
if line == "<stderr>":
self.logfp = self.session.logfp = sys.stderr
else:
try:
logfp = open(line, "a", 1) # 1 => line buffered
self.logfp = self.session.logfp = logfp
print("Logfile set to", line)
except:
print("Could not open", line, "for logging.")
def help_debug(self):
self.say("""\
function: set/change debugging level
usage: debug [no|more|less|n]
""")
def do_exit(self, line):
"exit ntpq"
return True
def help_exit(self):
self.say("""\
function: exit ntpq
usage: exit
""")
do_quit = do_exit
def help_quit(self):
self.say("""\
function: exit ntpq
usage: quit
""")
def do_keyid(self, line):
"set keyid to use for authenticated requests"
if line:
try:
self.session.keyid = int(line)
except ValueError:
print("What?")
if self.session.keyid is None:
print("no keyid defined")
else:
print("keyid is %d" % self.session.keyid)
def help_keyid(self):
self.say("""\
function: set keyid to use for authenticated requests
usage: keyid [key#]
""")
def do_version(self, line):
"print version number"
print(version)
def help_version(self):
self.say("""\
function: print version number
usage: version
""")
def do_direct(self, line):
"toggle direct mode output"
self.directmode = not self.directmode
if self.directmode:
print("Direct mode is on")
else:
print("Direct mode is off")
def help_direct(self):
self.say("""\
function: toggle direct-mode MRU output
usage: direct
""")
def do_raw(self, line):
"do raw mode variable output"
self.rawmode = True
print("Output set to raw")
def help_raw(self):
self.say("""\
function: do raw mode variable output
usage: raw
""")
def do_cooked(self, line):
"do cooked mode variable output"
self.rawmode = False
print("Output set to cooked")
def help_cooked(self):
self.say("""\
function: do cooked mode variable output
usage: cooked
""")
def do_authenticate(self, line):
"always authenticate requests to this server"
if not line:
pass
elif line == "yes":
self.session.always_auth = True
elif line == "no":
self.session.always_auth = False
else:
print("What?")
if self.session.always_auth:
print("authenticated requests being sent")
else:
print("unauthenticated requests being sent")
def help_authenticate(self):
self.say("""\
function: always authenticate requests to this server
usage: authenticate [yes|no]
""")
def do_ntpversion(self, line):
"set the NTP version number to use for requests"
if not line:
pass
else:
try:
newversion = int(line)
if ((newversion >= ntp.magic.NTP_OLDVERSION and
newversion <= ntp.magic.NTP_VERSION)):
self.pktversion = newversion
else:
print("versions %d to %d, please"
% (ntp.magic.NTP_OLDVERSION, ntp.magic.NTP_VERSION))
except ValueError:
print("What?")
print("NTP version being claimed is %d" % self.pktversion)
def help_ntpversion(self):
self.say("""\
function: set the NTP version number to use for requests
usage: ntpversion [version number]
""")
def do_keytype(self, line):
"set key type to use for authenticated requests"
if not line:
self.say("Keytype: %s\n" % self.session.keytype)
elif line not in "DSA, MD4, MD5, MDC2, RIPEMD160, SHA1":
self.warn("Keytype %s is not supported by ntpd.\n" % line)
elif line not in hashlib.algorithms_available:
self.warn("Keytype %s is not supported by ntpq.\n" % line)
else:
self.session.keytype = line
def help_keytype(self):
self.say("""\
function: set key type to use for authenticated requests, one of:
DSA, MD4, MD5, MDC2, RIPEMD160, SHA1
usage: keytype [digest-name]
""")
def do_associations(self, line):
"print list of association IDs and statuses for the server's peers"
if self.__dogetassoc():
self.__printassoc(showall=True)
def help_associations(self):
self.say("""\
function: print list of association IDs and statuses for the server's peers
usage: associations
""")
def do_passociations(self, line):
"print list of associations returned by last associations command"
self.__printassoc(showall=True)
def help_passociations(self):
self.say("""\
function: print list of associations returned by last associations command
usage: passociations
""")
def do_lassociations(self, line):
"print list of associations including all client information"
if self.__dogetassoc():
self.__printassoc(showall=True)
def help_lassociations(self):
self.say("""\
function: print list of associations including all client information
usage: lassociations
""")
def do_lpassociations(self, line):
"""\
print last obtained list of associations, including client information
"""
self.__printassoc(showall=True)
def help_lpassociations(self):
self.say("""\
function: print last obtained list of associations, including
client information
usage: lpassociations
""")
def do_addvars(self, line):
"add variables to the variable list or change their values"
if not line:
self.warn("usage: addvars name[=value][,...]\n")
return
vars_to_add = line.split(',')
for add_var in vars_to_add:
try:
(name, val) = add_var.split("=")
except ValueError:
(name, val) = (add_var, "")
self.uservars[name.strip()] = val.strip()
def help_addvars(self):
self.say("""\
function: add variables to the variable list or change their values
usage: addvars name[=value][,...]
""")
def do_rmvars(self, line):
"remove variables from the variable list"
if not line:
self.warn("usage: rmvars name[,...]\n")
return
vars_to_rm = line.split(',')
for rm_var in vars_to_rm:
if rm_var not in self.uservars:
print("%s is not in the variable list" % rm_var)
else:
del self.uservars[rm_var]
def help_rmvars(self):
self.say("""\
function: remove variables from the variable list
usage: rmvars name[,...]
""")
def do_clearvars(self, line):
"remove all variables from the variable list"
self.uservars.clear()
def help_clearvars(self):
self.say("""\
function: remove all variables from the variable list
usage: clearvars
""")
def do_showvars(self, line):
"print variables on the variable list"
if len(self.uservars) == 0:
print("No variables on list.")
for (name, value) in self.uservars.items():
if value:
print("%s=%s" % (name, value))
else:
print(name)
def help_showvars(self):
self.say("""\
function: print variables on the variable list
usage: showvars
""")
def do_readlist(self, line):
"read the system or peer variables included in the variable list"
associd = self.__assoc_valid(line)
if associd >= 0:
qtype = ntp.ntpc.TYPE_SYS if associd == 0 else ntp.ntpc.TYPE_PEER
self.__dolist(self.uservars.keys(), associd,
ntp.control.CTL_OP_READVAR, qtype)
def help_readlist(self):
self.say("""\
function: read the system or peer variables included in the variable list
usage: readlist [assocID]
""")
def do_rl(self, line):
"read the system or peer variables included in the variable list"
self.do_readlist(line)
def help_rl(self):
self.say("""\
function: read the system or peer variables included in the variable list
usage: rl [assocID]
""")
def do_writelist(self, line):
"write the system or peer variables included in the variable list"
pass
def help_writelist(self):
self.say("""\
function: write the system or peer variables included in the variable list
usage: writelist [ assocID ]
""")
def do_readvar(self, line):
"read system or peer variables"
associd = self.__assoc_valid(line)
if associd >= 0:
qtype = ntp.ntpc.TYPE_SYS if associd == 0 else ntp.ntpc.TYPE_PEER
self.__dolist(line.split()[1:], associd,
ntp.control.CTL_OP_READVAR, qtype, quiet=True)
def help_readvar(self):
self.say("""\
function: read system or peer variables
usage: readvar [assocID] [varname1] [varname2] [varname3]
""")
def do_rv(self, line):
"read system or peer variables"
self.do_readvar(line)
def help_rv(self):
self.say("""\
function: read system or peer variables
usage: rv [assocID] [varname1] [varname2] [varname3]
""")
def do_writevar(self, line):
"write system or peer variables"
pass
def help_writevar(self):
self.say("""\
function: write system or peer variables
usage: writevar assocID name=value,[...]
""")
def do_mreadlist(self, line):
"read the peer variables in the variable list for multiple peers"
if not line:
self.warn("usage: mreadlist assocIDlow assocIDhigh\n")
return
idrange = self.__assoc_range_valid(line)
if not idrange:
return
for associd in idrange:
if associd != idrange[0]:
self.say("\n")
if not self.__dolist(self.uservars,
associd, ntp.control.CTL_OP_READVAR,
ntp.ntpc.TYPE_PEER):
return
def help_mreadlist(self):
self.say("""\
function: read the peer variables in the variable list for multiple peers
usage: mreadlist assocIDlow assocIDhigh
""")
def do_mrl(self, line):
"read the peer variables in the variable list for multiple peers"
if not line:
self.warn("usage: mrl assocIDlow assocIDhigh\n")
return
self.do_mreadlist(line)
def help_mrl(self):
self.say("""\
function: read the peer variables in the variable list for multiple peers
usage: mrl assocIDlow assocIDhigh
""")
def do_mreadvar(self, line):
"read peer variables from multiple peers"
if not line:
self.warn("usage: mreadvar assocIDlow assocIDhigh "
"[ name=value[,...] ]\n")
return
idrange = self.__assoc_range_valid(line)
if not idrange:
return
varlist = line.split()[2:]
for associd in idrange:
if associd != idrange[0]:
self.say("\n")
if not self.__dolist(varlist, associd,
ntp.control.CTL_OP_READVAR,
ntp.ntpc.TYPE_PEER):
return
def help_mreadvar(self):
self.say("""\
function: read peer variables from multiple peers
usage: mreadvar assocIDlow assocIDhigh [name=value[,...]]
""")
def do_mrv(self, line):
"read peer variables from multiple peers"
if not line:
self.warn(
"usage: mrv assocIDlow assocIDhigh [name=value[,...]]\n")
return
self.do_mreadvar(line)
def help_mrv(self):
self.say("""\
function: read peer variables from multiple peers
usage: mrv assocIDlow assocIDhigh [name=value[,...]]
""")
def do_clocklist(self, line):
"read the clock variables included in the variable list"
assoc = self.__assoc_valid(line)
if assoc >= 0:
self.__dolist(self.uservars.keys(),
assoc, ntp.control.CTL_OP_READCLOCK,
ntp.ntpc.TYPE_CLOCK)
def help_clocklist(self):
self.say("""\
function: read the clock variables included in the variable list
usage: clocklist [assocID]
""")
def do_cl(self, line):
"read the clock variables included in the variable list"
self.do_clocklist(line)
def help_cl(self):
self.say("""\
function: read the clock variables included in the variable list
usage: cl [assocID]
""")
def do_clockvar(self, line):
"read clock variables"
assoc = self.__assoc_valid(line)
if assoc == 0:
self.warn("This command requires the association ID of a clock.\n")
elif assoc > 0:
self.__dolist(line.split()[1:], assoc,
ntp.control.CTL_OP_READCLOCK, ntp.ntpc.TYPE_CLOCK)
def help_clockvar(self):
self.say("""\
function: read clock variables
usage: clockvar [assocID] [name=value[,...]]
""")
def do_cv(self, line):
"read clock variables"
self.do_clockvar(line)
def help_cv(self):
self.say("""\
function: read clock variables
usage: cv [ assocID ] [ name=value[,...] ]
""")
def do_pstats(self, line):
"show statistics for a peer"
pstats = (
("srcadr", "remote host: ", NTP_ADD),
("dstadr", "local address: ", NTP_ADD),
("timerec", "time last received: ", NTP_INT),
("timer", "time until next send:", NTP_INT),
("timereach", "reachability change: ", NTP_INT),
("sent", "packets sent: ", NTP_INT),
("received", "packets received: ", NTP_INT),
("badauth", "bad authentication: ", NTP_INT),
("bogusorg", "bogus origin: ", NTP_INT),
("oldpkt", "duplicate: ", NTP_INT),
("seldisp", "bad dispersion: ", NTP_INT),
("selbroken", "bad reference time: ", NTP_INT),
("candidate", "candidate order: ", NTP_INT),
)
if not line:
self.warn("usage: pstats assocID\n")
return
associd = self.__assoc_valid(line)
if associd >= 0:
self.collect_display(associd=associd,
variables=pstats, decodestatus=True)
def help_pstats(self):
self.say("""\
function: show statistics for a peer
usage: pstats assocID
""")
def do_peers(self, line):
"obtain and print a list of the server's peers [IP version]"
self.__dopeers(showall=True, mode="peers")
def help_peers(self):
self.say("""\
function: obtain and print a list of the server's peers [IP version]
usage: peers
""")
def do_apeers(self, line):
"""
obtain and print a list of the server's peers and their assocIDs [IP version]
"""
self.__dopeers(showall=True, mode="apeers")
def help_apeers(self):
self.say("""\
function: obtain and print a list of the server's peers and their
assocIDs [IP version]
usage: apeers
""")
def do_lpeers(self, line):
"obtain and print a list of all peers and clients [IP version]"
self.__dopeers(showall=True, mode="peers")
def help_lpeers(self):
self.say("""\
function: obtain and print a list of all peers and clients [IP version]
usage: lpeers
""")
def do_opeers(self, line):
"""
print peer list the old way, with dstadr shown rather than refid [IP version]
"""
self.__dopeers(showall=True, mode="opeers")
def help_opeers(self):
self.say("""\
function: print peer list the old way, with dstadr shown rather than
refid [IP version]
usage: opeers
""")
def do_lopeers(self, line):
"""obtain and print a list of all peers and clients showing
dstadr [IP version]"""
self.__dopeers(showall=True, mode="opeers")
def help_lopeers(self):
self.say("""\
function: obtain and print a list of all peers and clients showing
dstadr [IP version]
usage: lopeers
""")
def do_hot_config(self, line):
"send a remote configuration command to ntpd"
try:
self.session.password()
except ntp.packet.ControlException as e:
self.warn(e.message + "\n")
return
if self.debug > 2:
self.warn("In Config\nKeyword = :config\nCommand = %s\n" % line)
try:
self.session.config(line)
m = re.match("column ([0-9]+) syntax error", self.session.response)
if m:
col = int(m.group(1))
if col >= 0 and col <= len(line):
if self.interactive:
self.say("_" * (len(self.prompt) + 2 + col))
else:
self.say(line + "\n")
self.say("_" * (col - 1))
self.say("^\n")
self.say(self.session.response + "\n")
except ntp.packet.ControlException as e:
self.warn(e.message + "\n")
def help_hot_config(self):
self.say("""\
function: send a remote configuration command to ntpd
usage: config <configuration command line>
""")
def do_config_from_file(self, line):
"configure ntpd using the configuration filename"
try:
with open(line) as rfp:
self.say("%s\n" % self.session.config(rfp.read()))
except IOError:
self.warn("Could not read %s\n" % line)
def help_config_from_file(self):
self.say("""\
function: configure ntpd using the configuration filename
usage: config_from_file <configuration filename>
""")
def printdirect(self, entries):
for entry in entries:
self.say(self.formatter.summary(entry) + "\n")
def do_mrulist(self, line):
"""display the list of most recently seen source addresses,
tags mincount=... resall=0x... resany=0x..."""
cmdvars = {}
for item in line.split(" "):
if not item:
continue
if '=' not in item:
cmdvars[item] = True
else:
eq = item.index("=")
var = item[:eq].strip()
val = item[eq+1:].strip()
try:
val = int(val, 0)
except ValueError:
try:
val = float(val)
except ValueError:
if val[0] == '"' and val[-1] == '"':
val = val[1:-1]
cmdvars[var] = val
if not self.directmode:
self.say("Ctrl-C will stop MRU retrieval and display "
"partial results.\n")
if self.rawmode:
mruhook = lambda v: self.printvars(variables=v,
dtype=ntp.ntpc.TYPE_SYS,
quiet=True)
else:
mruhook = None
try:
formatter = ntp.util.MRUSummary(interpreter.showhostnames,
wideremote=True)
if self.directmode:
formatter.now = None
self.formatter = formatter
if session.debug:
formatter.logfp = session.logfp
formatter.debug = session.debug
self.session.slots = 0
self.session.start = time.time()
direct = self.printdirect if self.directmode else None
span = self.session.mrulist(variables=cmdvars,
rawhook=mruhook, direct=direct)
if not self.directmode and not self.rawmode:
if not span.is_complete():
self.say("mrulist retrieval interrupted by operator.\n"
"Displaying partial client list.\n")
span.now = time.time()
try:
delta1 = time.time() - self.session.start
self.say(ntp.util.MRUSummary.header + "\n")
self.say(("=" * len(ntp.util.MRUSummary.header)) + "\n")
# reversed puts most recent entries at the top if no sort=
# see sort comments in pylib/packet.py
formatter.now = span.now
for entry in reversed(span.entries):
self.say(formatter.summary(entry) + "\n")
self.say("# Collected %d slots in %.3f seconds\n"
% (self.session.slots, delta1))
except KeyboardInterrupt:
pass
delta2 = time.time() - self.session.start
self.say("# Processed %d slots in %.3f seconds\n"
% (self.session.slots, delta2))
usage = resource.getrusage(resource.RUSAGE_SELF)
rusage_denom = 1024.
if sys.platform == 'darwin':
# OSX uses bytes, while every other platform uses kilobytes
rusage_denom = rusage_denom * rusage_denom
self.say("# Used %d megabytes of memory\n"
% (usage.ru_maxrss/rusage_denom))
except ntp.packet.ControlException as e:
# Giving up after 8 restarts from the beginning.
# With high-traffic NTP servers, this can occur if the
# MRU list is limited to less than about 16 seconds' of
# entries. See the 'mru' ntp.conf entry.
self.warn(e.message + "\n")
def help_mrulist(self):
self.say("""\
function: display the list of most recently seen source addresses,
tags mincount=... resall=0x... resany=0x...
usage: mrulist [tag=value] [tag=value] [tag=value] [tag=value]
""")
def do_ifstats(self, line):
"show statistics for each local address ntpd is using"
try:
self.session.password()
entries = self.session.ifstats()
if self.rawmode:
print(self.session.response)
else:
formatter = ntp.util.IfstatsSummary()
self.say(ntp.util.IfstatsSummary.header)
self.say(("=" * ntp.util.IfstatsSummary.width) + "\n")
for (i, entry) in enumerate(entries):
self.say(formatter.summary(i, entry))
except ntp.packet.ControlException as e:
self.warn(e.message + "\n")
return
pass
def help_ifstats(self):
self.say("""\
function: show statistics for each local address ntpd is using
usage: ifstats
""")
def do_reslist(self, line):
"show ntpd access control list"
try:
self.session.password()
entries = self.session.reslist()
if self.rawmode:
print(self.session.response)
else:
formatter = ntp.util.ReslistSummary()
self.say(ntp.util.ReslistSummary.header)
self.say(("=" * ntp.util.ReslistSummary.width) + "\n")
for entry in entries:
self.say(formatter.summary(entry))
except ntp.packet.ControlException as e:
self.warn(e.message + "\n")
return
def help_reslist(self):
self.say("""\
function: show ntpd access control list
usage: reslist
""")
def do_sysinfo(self, _line):
"display system summary"
sysinfo = (
("peeradr", "system peer: ", NTP_ADP),
("peermode", "system peer mode: ", NTP_MODE),
("leap", "leap indicator: ", NTP_2BIT),
("stratum", "stratum: ", NTP_INT),
("precision", "log2 precision: ", NTP_INT),
("rootdelay", "root delay: ", NTP_FLOAT),
("rootdisp", "root dispersion: ", NTP_FLOAT),
("rootdist", "root distance ", NTP_FLOAT),
("refid", "reference ID: ", NTP_STR),
("reftime", "reference time: ", NTP_LFP),
("sys_jitter", "system jitter: ", NTP_FLOAT),
("clk_jitter", "clock jitter: ", NTP_FLOAT),
("clk_wander", "clock wander: ", NTP_FLOAT),
("authdelay", "symm. auth. delay:", NTP_FLOAT),
)
self.collect_display(associd=0, variables=sysinfo, decodestatus=True)
def help_sysinfo(self):
self.say("""\
function: display system summary
usage: sysinfo
""")
def do_kerninfo(self, _line):
"display kernel loop and PPS statistics"
kerninfo = (
("koffset", "pll offset: ", NTP_FLOAT),
("kfreq", "pll frequency: ", NTP_FLOAT),
("kmaxerr", "maximum error: ", NTP_FLOAT),
("kesterr", "estimated error: ", NTP_FLOAT),
("kstflags", "kernel status: ", NTP_STR),
("ktimeconst", "pll time constant: ", NTP_INT),
("kprecis", "precision: ", NTP_FLOAT),
("kfreqtol", "frequency tolerance: ", NTP_INT),
("kppsfreq", "pps frequency: ", NTP_INT),
("kppsstab", "pps stability: ", NTP_INT),
("kppsjitter", "pps jitter: ", NTP_INT),
("kppscalibdur", "calibration interval ", NTP_INT),
("kppscalibs", "calibration cycles: ", NTP_INT),
("kppsjitexc", "jitter exceeded: ", NTP_INT),
("kppsstbexc", "stability exceeded: ", NTP_INT),
("kppscaliberrs", "calibration errors: ", NTP_INT),
)
self.collect_display(associd=0, variables=kerninfo, decodestatus=True)
def help_kerninfo(self):
self.say("""\
function: display kernel loop and PPS statistics
usage: kerninfo
""")
def do_sysstats(self, _line):
"display system uptime and packet counts"
sysstats = (
("ss_uptime", "uptime: ", NTP_INT),
("ss_reset", "sysstats reset: ", NTP_INT),
("ss_received", "packets received: ", NTP_INT),
("ss_thisver", "current version: ", NTP_INT),
("ss_oldver", "older version: ", NTP_INT),
("ss_numctlreq", "control requests: ", NTP_INT),
("ss_badformat", "bad length or format: ", NTP_INT),
("ss_badauth", "authentication failed:", NTP_INT),
("ss_declined", "declined: ", NTP_INT),
("ss_restricted", "restricted: ", NTP_INT),
("ss_limited", "rate limited: ", NTP_INT),
("ss_kodsent", "KoD responses: ", NTP_INT),
("ss_processed", "processed for time: ", NTP_INT),
)
self.collect_display(associd=0, variables=sysstats, decodestatus=False)
def help_sysstats(self):
self.say("""\
function: display system uptime and packet counts
usage: sysstats
""")
def do_monstats(self, _line):
"display monitor (mrulist) counters and limits"
monstats = (
("mru_enabled", "enabled: ", NTP_INT),
("mru_depth", "addresses: ", NTP_INT),
("mru_deepest", "peak addresses: ", NTP_INT),
("mru_maxdepth", "maximum addresses: ", NTP_INT),
("mru_mindepth", "reclaim above count: ", NTP_INT),
("mru_maxage", "reclaim maxage: ", NTP_INT),
("mru_minage", "reclaim minage: ", NTP_INT),
("mru_mem", "kilobytes: ", NTP_INT),
("mru_maxmem", "maximum kilobytes: ", NTP_INT),
("mru_exists", "alloc: exists: ", NTP_INT),
("mru_new", "alloc: new: ", NTP_INT),
("mru_recycleold", "alloc: recycle old: ", NTP_INT),
("mru_recyclefull", "alloc: recycle full: ", NTP_INT),
("mru_none", "alloc: none: ", NTP_INT),
("mru_oldest_age", "age of oldest slot: ", NTP_INT),
)
self.collect_display(associd=0, variables=monstats, decodestatus=False)
def help_monstats(self):
self.say("""\
function: display monitor (mrulist) counters and limits
usage: monstats
""")
def do_authinfo(self, _line):
"display symmetric authentication counters"
authinfo = (
("authreset", "time since reset:", NTP_INT),
("authkeys", "stored keys: ", NTP_INT),
("authfreek", "free keys: ", NTP_INT),
("authklookups", "key lookups: ", NTP_INT),
("authknotfound", "keys not found: ", NTP_INT),
("authkuncached", "uncached keys: ", NTP_INT),
("authkexpired", "expired keys: ", NTP_INT),
("authencrypts", "encryptions: ", NTP_INT),
("authdecrypts", "decryptions: ", NTP_INT),
)
self.collect_display(associd=0, variables=authinfo, decodestatus=False)
def help_authinfo(self):
self.say("""\
function: display symmetric authentication counters
usage: authinfo
""")
def do_iostats(self, _line):
"display network input and output counters"
iostats = (
("iostats_reset", "time since reset: ", NTP_INT),
("total_rbuf", "receive buffers: ", NTP_INT),
("free_rbuf", "free receive buffers: ", NTP_INT),
("used_rbuf", "used receive buffers: ", NTP_INT),
("rbuf_lowater", "low water refills: ", NTP_INT),
("io_dropped", "dropped packets: ", NTP_INT),
("io_ignored", "ignored packets: ", NTP_INT),
("io_received", "received packets: ", NTP_INT),
("io_sent", "packets sent: ", NTP_INT),
("io_sendfailed", "packet send failures: ", NTP_INT),
("io_wakeups", "input wakeups: ", NTP_INT),
("io_goodwakeups", "useful input wakeups: ", NTP_INT),
)
self.collect_display(associd=0, variables=iostats, decodestatus=False)
def help_iostats(self):
self.say("""\
function: display network input and output counters
usage: iostats
""")
def do_timerstats(self, line):
"display interval timer counters"
timerstats = (
("timerstats_reset", "time since reset: ", NTP_INT),
("timer_overruns", "timer overruns: ", NTP_INT),
("timer_xmts", "calls to transmit: ", NTP_INT),
)
self.collect_display(associd=0, variables=timerstats,
decodestatus=False)
def help_timerstats(self):
self.say("""\
function: display interval timer counters
usage: timerstats
""")
# Default values we use.
DEFHOST = "localhost" # default host name
#
# main - parse arguments and handle options
#
usage = '''
USAGE: ntpq [-46dphinOV] [-c str] [-D lvl] [host ...]
Flg Arg Option-Name Description
-4 no ipv4 Force IPv4 DNS name resolution
- prohibits the option 'ipv6'
-6 no ipv6 Force IPv6 DNS name resolution
- prohibits the option 'ipv4'
-a Num authentication Enable authentication with the numbered key
-c Str command Run a command and exit
- may appear multiple times
-d no debug-level Increase output debug message level
- may appear multiple times
-l Str logfile Logs debug messages to the provided filename
-D Int set-debug-level Set the output debug message level
- may appear multiple times
-h no help Print a usage message.
-p no peers Print a list of the peers
-n no numeric Numeric host addresses
-k Str keyfile Specify a keyfile. ntpq will look in this file
for the key specified with -a
-V opt version Output version information and exit
-w no wide Enable wide display of addresses / hosts
on a separate line
-W Num width Force output width to this value instead of
querying the terminal size
-u no units Display time with units.
'''
if __name__ == '__main__':
try:
(options, arguments) = getopt.getopt(
sys.argv[1:],
"46a:c:dD:hk:npVwW:ul:",
["ipv4", "ipv6", "authentication=",
"command=", "debug", "set-debug-level=",
"help", "keyfile", "numeric", "peers",
"version", "wide", "width=", "units",
"logfile="])
except getopt.GetoptError as e:
sys.stderr.write("%s\n" % e)
sys.stderr.write(usage)
raise SystemExit(1)
progname = os.path.basename(sys.argv[0])
ntp.ntpc.setprogname(progname)
session = ntp.packet.ControlSession()
interpreter = Ntpq(session)
keyid = keyfile = None
logfp = sys.stderr
for (switch, val) in options:
if switch in ("-4", "--ipv4"):
interpreter.ai_family = socket.AF_INET
elif switch in ("-6", "--ipv6"):
interpreter.ai_family = socket.AF_INET6
elif switch in ("-a", "--authentication"):
errmsg = "Error: -a parameter '%s' not a number\n"
keyid = ntp.util.safeargcast(val, int, errmsg, usage)
elif switch in ("-c", "--command"):
interpreter.ccmds.append(val)
elif switch in ("-d", "--debug"):
interpreter.debug += 1
session.debug += 1
elif switch in ("-D", "--set-debug-level"):
errmsg = "Error: -D parameter '%s' not a number\n"
cast = ntp.util.safeargcast(val, int, errmsg, usage)
session.debug = interpreter.debug = cast
elif switch in ("-h", "--help"):
print(usage)
raise SystemExit(0)
elif switch in ("-n", "--numeric"):
interpreter.showhostnames = False
elif switch in ("-p", "--peers"):
interpreter.ccmds.append("peers")
elif switch in ("-k", "--keyfile"):
keyfile = val
elif switch in ("-V", "--version"):
print("ntpq %s" % version)
raise SystemExit(0)
elif switch in ("-w", "--wide"):
interpreter.wideremote = True
elif switch in ("-W", "--width"):
errmsg = "Error: -W parameter '%s' not a number\n"
interpreter.termwidth = ntp.util.safeargcast(val, int,
errmsg, usage)
elif switch in ("-u", "--units"):
interpreter.showunits = True
elif switch in ("-l", "--logfile"):
if logfp != sys.stderr:
logfp.close()
logfp = open(val, "a", 1) # 1 => line buffered
session.logfp = interpreter.logfp = logfp
if forced_utf8 and interpreter.debug:
interpreter.warn("\nforced UTF-8 output\n")
if keyfile is not None: # Have a -k, setup the auth
credentials = None
try:
credentials = ntp.packet.Authenticator(keyfile)
except (OSError, IOError):
sys.stderr.write("ntpq: %s nonexistent or unreadable\n" % keyfile)
raise SystemExit(1)
if credentials:
session.auth = credentials
if keyid is not None: # Have an -a
session.keyid = keyid
for token in arguments:
if token.startswith("-"):
if '4' == token[-1]:
session.ai_family = socket.AF_INET
elif '6' == token[-1]:
session.ai_family = socket.AF_INET6
else:
interpreter.warn("%s: unexpected option-like thing.\n"
% progname)
raise SystemExit(1)
arguments.pop(0)
else:
interpreter.chosts.append((token, session.ai_family))
if len(arguments) == 0:
interpreter.chosts.append((DEFHOST, session.ai_family))
if ((len(interpreter.ccmds) == 0 and
not interpreter.interactive and
os.isatty(0) and
os.isatty(1)
)):
interpreter.interactive = True
try:
if len(interpreter.ccmds) == 0:
if len(interpreter.chosts) > 1:
interpreter.warn(
"ntpq can only work interactively on one host.\n")
interpreter.chosts = interpreter.chosts[:1]
session.openhost(*interpreter.chosts[0])
interpreter.cmdloop()
else:
for ihost in interpreter.chosts:
if session.openhost(*ihost):
for command in interpreter.ccmds:
interpreter.onecmd(command)
session.close()
raise SystemExit(0)
except (KeyboardInterrupt, EOFError):
if os.isatty(0):
interpreter.say("\n")
except ntp.packet.ControlException as e:
interpreter.warn(e.message + "\n")
except IOError:
print("Bailing out...")
# end
|