2 * Copyright (c) 2004 by Internet Systems Consortium, Inc. ("ISC")
3 * Copyright (c) 1996-1999 by Internet Software Consortium.
5 * Permission to use, copy, modify, and distribute this software for any
6 * purpose with or without fee is hereby granted, provided that the above
7 * copyright notice and this permission notice appear in all copies.
9 * THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES
10 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
11 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR
12 * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
13 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
14 * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT
15 * OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
17 * $Id: ns_print.c,v 1.10 2005/04/27 04:56:40 sra Exp $
22 #include "port_before.h"
24 #include <sys/types.h>
25 #include <sys/socket.h>
27 #include <netinet/in.h>
28 #include <arpa/nameser.h>
29 #include <arpa/inet.h>
33 #define INSIST(cond) assert(cond)
35 #include <isc/assertions.h>
43 #include "port_after.h"
46 # define SPRINTF(x) strlen(sprintf/**/x)
48 # define SPRINTF(x) ((size_t)sprintf x)
53 static size_t prune_origin(const char *name
, const char *origin
);
54 static int charstr(const u_char
*rdata
, const u_char
*edata
,
55 char **buf
, size_t *buflen
);
56 static int addname(const u_char
*msg
, size_t msglen
,
57 const u_char
**p
, const char *origin
,
58 char **buf
, size_t *buflen
);
59 static void addlen(size_t len
, char **buf
, size_t *buflen
);
60 static int addstr(const char *src
, size_t len
,
61 char **buf
, size_t *buflen
);
62 static int addtab(size_t len
, size_t target
, int spaced
,
63 char **buf
, size_t *buflen
);
76 * Convert an RR to presentation format.
79 *\li Number of characters written to buf, or -1 (check errno).
82 ns_sprintrr(const ns_msg
*handle
, const ns_rr
*rr
,
83 const char *name_ctx
, const char *origin
,
84 char *buf
, size_t buflen
)
88 n
= ns_sprintrrf(ns_msg_base(*handle
), ns_msg_size(*handle
),
89 ns_rr_name(*rr
), ns_rr_class(*rr
), ns_rr_type(*rr
),
90 ns_rr_ttl(*rr
), ns_rr_rdata(*rr
), ns_rr_rdlen(*rr
),
91 name_ctx
, origin
, buf
, buflen
);
96 * Convert the fields of an RR into presentation format.
99 *\li Number of characters written to buf, or -1 (check errno).
102 ns_sprintrrf(const u_char
*msg
, size_t msglen
,
103 const char *name
, ns_class
class, ns_type type
,
104 u_long ttl
, const u_char
*rdata
, size_t rdlen
,
105 const char *name_ctx
, const char *origin
,
106 char *buf
, size_t buflen
)
108 const char *obuf
= buf
;
109 const u_char
*edata
= rdata
+ rdlen
;
119 if (name_ctx
!= NULL
&& ns_samename(name_ctx
, name
) == 1) {
120 T(addstr("\t\t\t", 3, &buf
, &buflen
));
122 len
= prune_origin(name
, origin
);
125 } else if (len
== 0) {
126 T(addstr("@\t\t\t", 4, &buf
, &buflen
));
128 T(addstr(name
, len
, &buf
, &buflen
));
129 /* Origin not used or not root, and no trailing dot? */
130 if (((origin
== NULL
|| origin
[0] == '\0') ||
131 (origin
[0] != '.' && origin
[1] != '\0' &&
132 name
[len
] == '\0')) && name
[len
- 1] != '.') {
134 T(addstr(".", 1, &buf
, &buflen
));
137 T(spaced
= addtab(len
, 24, spaced
, &buf
, &buflen
));
144 T(x
= ns_format_ttl(ttl
, buf
, buflen
));
145 addlen(x
, &buf
, &buflen
);
146 len
= SPRINTF((tmp
, " %s %s", p_class(class), p_type(type
)));
147 T(addstr(tmp
, len
, &buf
, &buflen
));
148 T(spaced
= addtab(x
+ len
, 16, spaced
, &buf
, &buflen
));
155 if (rdlen
!= (size_t)NS_INADDRSZ
)
157 (void) inet_ntop(AF_INET
, rdata
, buf
, buflen
);
158 addlen(strlen(buf
), &buf
, &buflen
);
168 T(addname(msg
, msglen
, &rdata
, origin
, &buf
, &buflen
));
174 T(len
= charstr(rdata
, edata
, &buf
, &buflen
));
178 T(addstr(" ", 1, &buf
, &buflen
));
181 /* Second word, optional in ISDN records. */
182 if (type
== ns_t_isdn
&& rdata
== edata
)
185 T(len
= charstr(rdata
, edata
, &buf
, &buflen
));
195 T(addname(msg
, msglen
, &rdata
, origin
, &buf
, &buflen
));
196 T(addstr(" ", 1, &buf
, &buflen
));
198 /* Administrator name. */
199 T(addname(msg
, msglen
, &rdata
, origin
, &buf
, &buflen
));
200 T(addstr(" (\n", 3, &buf
, &buflen
));
203 if ((edata
- rdata
) != 5*NS_INT32SZ
)
207 t
= ns_get32(rdata
); rdata
+= NS_INT32SZ
;
208 T(addstr("\t\t\t\t\t", 5, &buf
, &buflen
));
209 len
= SPRINTF((tmp
, "%lu", t
));
210 T(addstr(tmp
, len
, &buf
, &buflen
));
211 T(spaced
= addtab(len
, 16, spaced
, &buf
, &buflen
));
212 T(addstr("; serial\n", 9, &buf
, &buflen
));
215 /* Refresh interval. */
216 t
= ns_get32(rdata
); rdata
+= NS_INT32SZ
;
217 T(addstr("\t\t\t\t\t", 5, &buf
, &buflen
));
218 T(len
= ns_format_ttl(t
, buf
, buflen
));
219 addlen(len
, &buf
, &buflen
);
220 T(spaced
= addtab(len
, 16, spaced
, &buf
, &buflen
));
221 T(addstr("; refresh\n", 10, &buf
, &buflen
));
224 /* Retry interval. */
225 t
= ns_get32(rdata
); rdata
+= NS_INT32SZ
;
226 T(addstr("\t\t\t\t\t", 5, &buf
, &buflen
));
227 T(len
= ns_format_ttl(t
, buf
, buflen
));
228 addlen(len
, &buf
, &buflen
);
229 T(spaced
= addtab(len
, 16, spaced
, &buf
, &buflen
));
230 T(addstr("; retry\n", 8, &buf
, &buflen
));
234 t
= ns_get32(rdata
); rdata
+= NS_INT32SZ
;
235 T(addstr("\t\t\t\t\t", 5, &buf
, &buflen
));
236 T(len
= ns_format_ttl(t
, buf
, buflen
));
237 addlen(len
, &buf
, &buflen
);
238 T(spaced
= addtab(len
, 16, spaced
, &buf
, &buflen
));
239 T(addstr("; expiry\n", 9, &buf
, &buflen
));
243 t
= ns_get32(rdata
); rdata
+= NS_INT32SZ
;
244 T(addstr("\t\t\t\t\t", 5, &buf
, &buflen
));
245 T(len
= ns_format_ttl(t
, buf
, buflen
));
246 addlen(len
, &buf
, &buflen
);
247 T(addstr(" )", 2, &buf
, &buflen
));
248 T(spaced
= addtab(len
, 16, spaced
, &buf
, &buflen
));
249 T(addstr("; minimum\n", 10, &buf
, &buflen
));
259 if (rdlen
< (size_t)NS_INT16SZ
)
265 len
= SPRINTF((tmp
, "%u ", t
));
266 T(addstr(tmp
, len
, &buf
, &buflen
));
269 T(addname(msg
, msglen
, &rdata
, origin
, &buf
, &buflen
));
277 if (rdlen
< (size_t)NS_INT16SZ
)
283 len
= SPRINTF((tmp
, "%u ", t
));
284 T(addstr(tmp
, len
, &buf
, &buflen
));
287 T(addname(msg
, msglen
, &rdata
, origin
, &buf
, &buflen
));
288 T(addstr(" ", 1, &buf
, &buflen
));
291 T(addname(msg
, msglen
, &rdata
, origin
, &buf
, &buflen
));
297 T(len
= charstr(rdata
, edata
, &buf
, &buflen
));
304 while (rdata
< edata
) {
305 T(len
= charstr(rdata
, edata
, &buf
, &buflen
));
310 T(addstr(" ", 1, &buf
, &buflen
));
317 (void) inet_nsap_ntoa(rdlen
, rdata
, t
);
318 T(addstr(t
, strlen(t
), &buf
, &buflen
));
323 if (rdlen
!= (size_t)NS_IN6ADDRSZ
)
325 (void) inet_ntop(AF_INET6
, rdata
, buf
, buflen
);
326 addlen(strlen(buf
), &buf
, &buflen
);
332 /* XXX protocol format checking? */
333 (void) loc_ntoa(rdata
, t
);
334 T(addstr(t
, strlen(t
), &buf
, &buflen
));
339 u_int order
, preference
;
342 if (rdlen
< 2U*NS_INT16SZ
)
345 /* Order, Precedence. */
346 order
= ns_get16(rdata
); rdata
+= NS_INT16SZ
;
347 preference
= ns_get16(rdata
); rdata
+= NS_INT16SZ
;
348 len
= SPRINTF((t
, "%u %u ", order
, preference
));
349 T(addstr(t
, len
, &buf
, &buflen
));
352 T(len
= charstr(rdata
, edata
, &buf
, &buflen
));
356 T(addstr(" ", 1, &buf
, &buflen
));
359 T(len
= charstr(rdata
, edata
, &buf
, &buflen
));
363 T(addstr(" ", 1, &buf
, &buflen
));
366 T(len
= charstr(rdata
, edata
, &buf
, &buflen
));
372 T(addstr(" ", 1, &buf
, &buflen
));
375 T(addname(msg
, msglen
, &rdata
, origin
, &buf
, &buflen
));
380 u_int priority
, weight
, port
;
383 if (rdlen
< 3U*NS_INT16SZ
)
386 /* Priority, Weight, Port. */
387 priority
= ns_get16(rdata
); rdata
+= NS_INT16SZ
;
388 weight
= ns_get16(rdata
); rdata
+= NS_INT16SZ
;
389 port
= ns_get16(rdata
); rdata
+= NS_INT16SZ
;
390 len
= SPRINTF((t
, "%u %u %u ", priority
, weight
, port
));
391 T(addstr(t
, len
, &buf
, &buflen
));
394 T(addname(msg
, msglen
, &rdata
, origin
, &buf
, &buflen
));
401 T(addname(msg
, msglen
, &rdata
, origin
, &buf
, &buflen
));
402 T(addstr(" ", 1, &buf
, &buflen
));
405 T(addname(msg
, msglen
, &rdata
, origin
, &buf
, &buflen
));
412 if (rdlen
< 1U + NS_INT32SZ
)
416 (void) inet_ntop(AF_INET
, rdata
, buf
, buflen
);
417 addlen(strlen(buf
), &buf
, &buflen
);
418 rdata
+= NS_INADDRSZ
;
421 len
= SPRINTF((tmp
, " %u ( ", *rdata
));
422 T(addstr(tmp
, len
, &buf
, &buflen
));
428 while (rdata
< edata
) {
433 T(addstr("\n\t\t\t\t", 5,
438 len
= SPRINTF((tmp
, "%d ", n
));
439 T(addstr(tmp
, len
, &buf
, &buflen
));
445 T(addstr(")", 1, &buf
, &buflen
));
451 char base64_key
[NS_MD5RSA_MAX_BASE64
];
452 u_int keyflags
, protocol
, algorithm
, key_id
;
456 if (rdlen
< 0U + NS_INT16SZ
+ NS_INT8SZ
+ NS_INT8SZ
)
459 /* Key flags, Protocol, Algorithm. */
461 key_id
= dst_s_dns_key_id(rdata
, edata
-rdata
);
465 keyflags
= ns_get16(rdata
); rdata
+= NS_INT16SZ
;
467 algorithm
= *rdata
++;
468 len
= SPRINTF((tmp
, "0x%04x %u %u",
469 keyflags
, protocol
, algorithm
));
470 T(addstr(tmp
, len
, &buf
, &buflen
));
472 /* Public key data. */
473 len
= b64_ntop(rdata
, edata
- rdata
,
474 base64_key
, sizeof base64_key
);
478 T(addstr(" (", 2, &buf
, &buflen
));
483 for (n
= 0; n
< len
; n
+= 48) {
484 T(addstr(leader
, strlen(leader
), &buf
, &buflen
));
485 T(addstr(base64_key
+ n
, MIN(len
- n
, 48),
489 T(addstr(" )", 2, &buf
, &buflen
));
490 n
= SPRINTF((tmp
, " ; key_tag= %u", key_id
));
491 T(addstr(tmp
, n
, &buf
, &buflen
));
497 char base64_key
[NS_MD5RSA_MAX_BASE64
];
498 u_int type
, algorithm
, labels
, footprint
;
506 /* Type covered, Algorithm, Label count, Original TTL. */
507 type
= ns_get16(rdata
); rdata
+= NS_INT16SZ
;
508 algorithm
= *rdata
++;
510 t
= ns_get32(rdata
); rdata
+= NS_INT32SZ
;
511 len
= SPRINTF((tmp
, "%s %d %d %lu ",
512 p_type(type
), algorithm
, labels
, t
));
513 T(addstr(tmp
, len
, &buf
, &buflen
));
514 if (labels
> (u_int
)dn_count_labels(name
))
517 /* Signature expiry. */
518 t
= ns_get32(rdata
); rdata
+= NS_INT32SZ
;
519 len
= SPRINTF((tmp
, "%s ", p_secstodate(t
)));
520 T(addstr(tmp
, len
, &buf
, &buflen
));
523 t
= ns_get32(rdata
); rdata
+= NS_INT32SZ
;
524 len
= SPRINTF((tmp
, "%s ", p_secstodate(t
)));
525 T(addstr(tmp
, len
, &buf
, &buflen
));
527 /* Signature Footprint. */
528 footprint
= ns_get16(rdata
); rdata
+= NS_INT16SZ
;
529 len
= SPRINTF((tmp
, "%u ", footprint
));
530 T(addstr(tmp
, len
, &buf
, &buflen
));
533 T(addname(msg
, msglen
, &rdata
, origin
, &buf
, &buflen
));
536 len
= b64_ntop(rdata
, edata
- rdata
,
537 base64_key
, sizeof base64_key
);
539 T(addstr(" (", 2, &buf
, &buflen
));
546 for (n
= 0; n
< len
; n
+= 48) {
547 T(addstr(leader
, strlen(leader
), &buf
, &buflen
));
548 T(addstr(base64_key
+ n
, MIN(len
- n
, 48),
552 T(addstr(" )", 2, &buf
, &buflen
));
559 /* Next domain name. */
560 T(addname(msg
, msglen
, &rdata
, origin
, &buf
, &buflen
));
564 for (c
= 0; c
< n
*8; c
++)
565 if (NS_NXT_BIT_ISSET(c
, rdata
)) {
566 len
= SPRINTF((tmp
, " %s", p_type(c
)));
567 T(addstr(tmp
, len
, &buf
, &buflen
));
573 u_int c_type
, key_tag
, alg
;
576 char base64_cert
[8192], tmp
[40];
579 c_type
= ns_get16(rdata
); rdata
+= NS_INT16SZ
;
580 key_tag
= ns_get16(rdata
); rdata
+= NS_INT16SZ
;
581 alg
= (u_int
) *rdata
++;
583 len
= SPRINTF((tmp
, "%d %d %d ", c_type
, key_tag
, alg
));
584 T(addstr(tmp
, len
, &buf
, &buflen
));
585 siz
= (edata
-rdata
)*4/3 + 4; /* "+4" accounts for trailing \0 */
586 if (siz
> sizeof(base64_cert
) * 3/4) {
587 const char *str
= "record too long to print";
588 T(addstr(str
, strlen(str
), &buf
, &buflen
));
591 len
= b64_ntop(rdata
, edata
-rdata
, base64_cert
, siz
);
596 T(addstr(" (", 2, &buf
, &buflen
));
603 for (n
= 0; n
< len
; n
+= 48) {
604 T(addstr(leader
, strlen(leader
),
606 T(addstr(base64_cert
+ n
, MIN(len
- n
, 48),
610 T(addstr(" )", 2, &buf
, &buflen
));
616 /* KJD - need to complete this */
618 int mode
, err
, keysize
;
620 /* Algorithm name. */
621 T(addname(msg
, msglen
, &rdata
, origin
, &buf
, &buflen
));
622 T(addstr(" ", 1, &buf
, &buflen
));
625 t
= ns_get32(rdata
); rdata
+= NS_INT32SZ
;
626 len
= SPRINTF((tmp
, "%s ", p_secstodate(t
)));
627 T(addstr(tmp
, len
, &buf
, &buflen
));
630 t
= ns_get32(rdata
); rdata
+= NS_INT32SZ
;
631 len
= SPRINTF((tmp
, "%s ", p_secstodate(t
)));
632 T(addstr(tmp
, len
, &buf
, &buflen
));
634 /* Mode , Error, Key Size. */
635 /* Priority, Weight, Port. */
636 mode
= ns_get16(rdata
); rdata
+= NS_INT16SZ
;
637 err
= ns_get16(rdata
); rdata
+= NS_INT16SZ
;
638 keysize
= ns_get16(rdata
); rdata
+= NS_INT16SZ
;
639 len
= SPRINTF((tmp
, "%u %u %u ", mode
, err
, keysize
));
640 T(addstr(tmp
, len
, &buf
, &buflen
));
642 /* XXX need to dump key, print otherdata length & other data */
647 /* BEW - need to complete this */
650 T(len
= addname(msg
, msglen
, &rdata
, origin
, &buf
, &buflen
));
651 T(addstr(" ", 1, &buf
, &buflen
));
652 rdata
+= 8; /*%< time */
653 n
= ns_get16(rdata
); rdata
+= INT16SZ
;
654 rdata
+= n
; /*%< sig */
655 n
= ns_get16(rdata
); rdata
+= INT16SZ
; /*%< original id */
656 sprintf(buf
, "%d", ns_get16(rdata
));
658 addlen(strlen(buf
), &buf
, &buflen
);
667 if (rdlen
== 0U) goto formerr
;
668 len
= SPRINTF((tmp
, "%d ", *rdata
));
669 T(addstr(tmp
, len
, &buf
, &buflen
));
671 if (pbit
> 128) goto formerr
;
672 pbyte
= (pbit
& ~7) / 8;
675 /* address suffix: provided only when prefix len != 128 */
677 if (rdata
+ pbyte
>= edata
) goto formerr
;
678 memset(&a
, 0, sizeof(a
));
679 memcpy(&a
.s6_addr
[pbyte
], rdata
, sizeof(a
) - pbyte
);
680 (void) inet_ntop(AF_INET6
, &a
, buf
, buflen
);
681 addlen(strlen(buf
), &buf
, &buflen
);
682 rdata
+= sizeof(a
) - pbyte
;
685 /* prefix name: provided only when prefix len > 0 */
688 if (rdata
>= edata
) goto formerr
;
689 T(addstr(" ", 1, &buf
, &buflen
));
690 T(addname(msg
, msglen
, &rdata
, origin
, &buf
, &buflen
));
696 len
= SPRINTF((tmp
, "%u bytes", class));
697 T(addstr(tmp
, len
, &buf
, &buflen
));
702 comment
= "unknown RR type";
707 comment
= "RR format error";
712 len
= SPRINTF((tmp
, "\\# %u%s\t; %s", (unsigned)(edata
- rdata
),
713 rdlen
!= 0U ? " (" : "", comment
));
714 T(addstr(tmp
, len
, &buf
, &buflen
));
715 while (rdata
< edata
) {
717 p
+= SPRINTF((p
, "\n\t"));
719 n
= MIN(16, edata
- rdata
);
720 for (m
= 0; m
< n
; m
++)
721 p
+= SPRINTF((p
, "%02x ", rdata
[m
]));
722 T(addstr(tmp
, p
- tmp
, &buf
, &buflen
));
724 T(addstr(")", 1, &buf
, &buflen
));
725 T(addtab(p
- tmp
+ 1, 48, spaced
, &buf
, &buflen
));
728 p
+= SPRINTF((p
, "; "));
729 for (m
= 0; m
< n
; m
++)
730 *p
++ = (isascii(rdata
[m
]) && isprint(rdata
[m
]))
733 T(addstr(tmp
, p
- tmp
, &buf
, &buflen
));
744 * prune_origin(name, origin)
745 * Find out if the name is at or under the current origin.
747 * Number of characters in name before start of origin,
748 * or length of name if origin does not match.
750 * This function should share code with samedomain().
753 prune_origin(const char *name
, const char *origin
) {
754 const char *oname
= name
;
756 while (*name
!= '\0') {
757 if (origin
!= NULL
&& ns_samename(name
, origin
) == 1)
758 return (name
- oname
- (name
> oname
));
759 while (*name
!= '\0') {
762 /* XXX need to handle \nnn form. */
765 } else if (*name
== '.') {
772 return (name
- oname
);
777 * charstr(rdata, edata, buf, buflen)
778 * Format a <character-string> into the presentation buffer.
780 * Number of rdata octets consumed
781 * 0 for protocol format error
782 * -1 for output buffer error
784 * buffer is advanced on success.
787 charstr(const u_char
*rdata
, const u_char
*edata
, char **buf
, size_t *buflen
) {
788 const u_char
*odata
= rdata
;
789 size_t save_buflen
= *buflen
;
790 char *save_buf
= *buf
;
792 if (addstr("\"", 1, buf
, buflen
) < 0)
797 if (rdata
+ 1 + n
<= edata
) {
800 if (strchr("\n\"\\", *rdata
) != NULL
)
801 if (addstr("\\", 1, buf
, buflen
) < 0)
803 if (addstr((const char *)rdata
, 1,
810 if (addstr("\"", 1, buf
, buflen
) < 0)
812 return (rdata
- odata
);
816 *buflen
= save_buflen
;
821 addname(const u_char
*msg
, size_t msglen
,
822 const u_char
**pp
, const char *origin
,
823 char **buf
, size_t *buflen
)
825 size_t newlen
, save_buflen
= *buflen
;
826 char *save_buf
= *buf
;
829 n
= dn_expand(msg
, msg
+ msglen
, *pp
, *buf
, *buflen
);
831 goto enospc
; /*%< Guess. */
832 newlen
= prune_origin(*buf
, origin
);
835 } else if (newlen
== 0U) {
836 /* Use "@" instead of name. */
837 if (newlen
+ 2 > *buflen
)
838 goto enospc
; /* No room for "@\0". */
839 (*buf
)[newlen
++] = '@';
840 (*buf
)[newlen
] = '\0';
842 if (((origin
== NULL
|| origin
[0] == '\0') ||
843 (origin
[0] != '.' && origin
[1] != '\0' &&
844 (*buf
)[newlen
] == '\0')) && (*buf
)[newlen
- 1] != '.') {
845 /* No trailing dot. */
847 if (newlen
+ 2 > *buflen
)
848 goto enospc
; /* No room for ".\0". */
849 (*buf
)[newlen
++] = '.';
850 (*buf
)[newlen
] = '\0';
854 addlen(newlen
, buf
, buflen
);
860 *buflen
= save_buflen
;
865 addlen(size_t len
, char **buf
, size_t *buflen
) {
866 INSIST(len
<= *buflen
);
872 addstr(const char *src
, size_t len
, char **buf
, size_t *buflen
) {
873 if (len
>= *buflen
) {
877 memcpy(*buf
, src
, len
);
878 addlen(len
, buf
, buflen
);
884 addtab(size_t len
, size_t target
, int spaced
, char **buf
, size_t *buflen
) {
885 size_t save_buflen
= *buflen
;
886 char *save_buf
= *buf
;
889 if (spaced
|| len
>= target
- 1) {
890 T(addstr(" ", 2, buf
, buflen
));
893 for (t
= (target
- len
- 1) / 8; t
>= 0; t
--)
894 if (addstr("\t", 1, buf
, buflen
) < 0) {
895 *buflen
= save_buflen
;