2 * Copyright (c) 1996-1999 by Internet Software Consortium.
4 * Permission to use, copy, modify, and distribute this software for any
5 * purpose with or without fee is hereby granted, provided that the above
6 * copyright notice and this permission notice appear in all copies.
8 * THE SOFTWARE IS PROVIDED "AS IS" AND INTERNET SOFTWARE CONSORTIUM DISCLAIMS
9 * ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES
10 * OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL INTERNET SOFTWARE
11 * CONSORTIUM BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL
12 * DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR
13 * PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS
14 * ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS
18 #if !defined(_LIBC) && !defined(lint)
19 static const char rcsid
[] = "$BINDId: ns_print.c,v 8.18 2000/02/29 05:48:12 vixie Exp $";
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>
38 # define SPRINTF(x) strlen(sprintf/**/x)
40 # define SPRINTF(x) ((size_t)sprintf x)
45 static size_t prune_origin(const char *name
, const char *origin
);
46 static int charstr(const u_char
*rdata
, const u_char
*edata
,
47 char **buf
, size_t *buflen
);
48 static int addname(const u_char
*msg
, size_t msglen
,
49 const u_char
**p
, const char *origin
,
50 char **buf
, size_t *buflen
);
51 static void addlen(size_t len
, char **buf
, size_t *buflen
);
52 static int addstr(const char *src
, size_t len
,
53 char **buf
, size_t *buflen
);
54 static int addtab(size_t len
, size_t target
, int spaced
,
55 char **buf
, size_t *buflen
);
60 u_int16_t
dst_s_dns_key_id(const u_char
*, const int);
75 * ns_sprintrr(handle, rr, name_ctx, origin, buf, buflen)
76 * Convert an RR to presentation format.
78 * Number of characters written to buf, or -1 (check errno).
81 ns_sprintrr(const ns_msg
*handle
, const ns_rr
*rr
,
82 const char *name_ctx
, const char *origin
,
83 char *buf
, size_t buflen
)
87 n
= ns_sprintrrf(ns_msg_base(*handle
), ns_msg_size(*handle
),
88 ns_rr_name(*rr
), ns_rr_class(*rr
), ns_rr_type(*rr
),
89 ns_rr_ttl(*rr
), ns_rr_rdata(*rr
), ns_rr_rdlen(*rr
),
90 name_ctx
, origin
, buf
, buflen
);
96 * ns_sprintrrf(msg, msglen, name, class, type, ttl, rdata, rdlen,
97 * name_ctx, origin, buf, buflen)
98 * Convert the fields of an RR into presentation format.
100 * Number of characters written to buf, or -1 (check errno).
103 ns_sprintrrf(const u_char
*msg
, size_t msglen
,
104 const char *name
, ns_class
class, ns_type type
,
105 u_long ttl
, const u_char
*rdata
, size_t rdlen
,
106 const char *name_ctx
, const char *origin
,
107 char *buf
, size_t buflen
)
109 const char *obuf
= buf
;
110 const u_char
*edata
= rdata
+ rdlen
;
120 if (name_ctx
!= NULL
&& ns_samename(name_ctx
, name
) == 1) {
121 T(addstr("\t\t\t", 3, &buf
, &buflen
));
123 len
= prune_origin(name
, origin
);
125 T(addstr("@\t\t\t", 4, &buf
, &buflen
));
127 T(addstr(name
, len
, &buf
, &buflen
));
128 /* Origin not used or not root, and no trailing dot? */
129 if (((origin
== NULL
|| origin
[0] == '\0') ||
130 (origin
[0] != '.' && origin
[1] != '\0' &&
131 name
[len
] == '\0')) && name
[len
- 1] != '.') {
132 T(addstr(".", 1, &buf
, &buflen
));
135 T(spaced
= addtab(len
, 24, spaced
, &buf
, &buflen
));
142 T(x
= ns_format_ttl(ttl
, buf
, buflen
));
143 addlen(x
, &buf
, &buflen
);
144 len
= SPRINTF((tmp
, " %s %s", p_class(class), p_type(type
)));
145 T(addstr(tmp
, len
, &buf
, &buflen
));
146 T(spaced
= addtab(x
+ len
, 16, spaced
, &buf
, &buflen
));
153 if (rdlen
!= NS_INADDRSZ
)
155 (void) inet_ntop(AF_INET
, rdata
, buf
, buflen
);
156 addlen(strlen(buf
), &buf
, &buflen
);
165 T(addname(msg
, msglen
, &rdata
, origin
, &buf
, &buflen
));
171 T(len
= charstr(rdata
, edata
, &buf
, &buflen
));
175 T(addstr(" ", 1, &buf
, &buflen
));
178 /* Second word, optional in ISDN records. */
179 if (type
== ns_t_isdn
&& rdata
== edata
)
182 T(len
= charstr(rdata
, edata
, &buf
, &buflen
));
192 T(addname(msg
, msglen
, &rdata
, origin
, &buf
, &buflen
));
193 T(addstr(" ", 1, &buf
, &buflen
));
195 /* Administrator name. */
196 T(addname(msg
, msglen
, &rdata
, origin
, &buf
, &buflen
));
197 T(addstr(" (\n", 3, &buf
, &buflen
));
200 if ((edata
- rdata
) != 5*NS_INT32SZ
)
204 t
= ns_get32(rdata
); rdata
+= NS_INT32SZ
;
205 T(addstr("\t\t\t\t\t", 5, &buf
, &buflen
));
206 len
= SPRINTF((tmp
, "%lu", t
));
207 T(addstr(tmp
, len
, &buf
, &buflen
));
208 T(spaced
= addtab(len
, 16, spaced
, &buf
, &buflen
));
209 T(addstr("; serial\n", 9, &buf
, &buflen
));
212 /* Refresh interval. */
213 t
= ns_get32(rdata
); rdata
+= NS_INT32SZ
;
214 T(addstr("\t\t\t\t\t", 5, &buf
, &buflen
));
215 T(len
= ns_format_ttl(t
, buf
, buflen
));
216 addlen(len
, &buf
, &buflen
);
217 T(spaced
= addtab(len
, 16, spaced
, &buf
, &buflen
));
218 T(addstr("; refresh\n", 10, &buf
, &buflen
));
221 /* Retry interval. */
222 t
= ns_get32(rdata
); rdata
+= NS_INT32SZ
;
223 T(addstr("\t\t\t\t\t", 5, &buf
, &buflen
));
224 T(len
= ns_format_ttl(t
, buf
, buflen
));
225 addlen(len
, &buf
, &buflen
);
226 T(spaced
= addtab(len
, 16, spaced
, &buf
, &buflen
));
227 T(addstr("; retry\n", 8, &buf
, &buflen
));
231 t
= ns_get32(rdata
); rdata
+= NS_INT32SZ
;
232 T(addstr("\t\t\t\t\t", 5, &buf
, &buflen
));
233 T(len
= ns_format_ttl(t
, buf
, buflen
));
234 addlen(len
, &buf
, &buflen
);
235 T(spaced
= addtab(len
, 16, spaced
, &buf
, &buflen
));
236 T(addstr("; expiry\n", 9, &buf
, &buflen
));
240 t
= ns_get32(rdata
); rdata
+= NS_INT32SZ
;
241 T(addstr("\t\t\t\t\t", 5, &buf
, &buflen
));
242 T(len
= ns_format_ttl(t
, buf
, buflen
));
243 addlen(len
, &buf
, &buflen
);
244 T(addstr(" )", 2, &buf
, &buflen
));
245 T(spaced
= addtab(len
, 16, spaced
, &buf
, &buflen
));
246 T(addstr("; minimum\n", 10, &buf
, &buflen
));
256 if (rdlen
< NS_INT16SZ
)
262 len
= SPRINTF((tmp
, "%u ", t
));
263 T(addstr(tmp
, len
, &buf
, &buflen
));
266 T(addname(msg
, msglen
, &rdata
, origin
, &buf
, &buflen
));
274 if (rdlen
< NS_INT16SZ
)
280 len
= SPRINTF((tmp
, "%u ", t
));
281 T(addstr(tmp
, len
, &buf
, &buflen
));
284 T(addname(msg
, msglen
, &rdata
, origin
, &buf
, &buflen
));
285 T(addstr(" ", 1, &buf
, &buflen
));
288 T(addname(msg
, msglen
, &rdata
, origin
, &buf
, &buflen
));
294 T(len
= charstr(rdata
, edata
, &buf
, &buflen
));
301 while (rdata
< edata
) {
302 T(len
= charstr(rdata
, edata
, &buf
, &buflen
));
307 T(addstr(" ", 1, &buf
, &buflen
));
312 /* 2*255 for hex digits, 128 for '.' and '\0', 2 for
313 0x if inet_nsap_ntoa starts using it. */
314 char t
[255*2 + 128 + 2];
316 (void) inet_nsap_ntoa(rdlen
, rdata
, t
);
317 T(addstr(t
, strlen(t
), &buf
, &buflen
));
322 if (rdlen
!= NS_IN6ADDRSZ
)
324 (void) inet_ntop(AF_INET6
, rdata
, buf
, buflen
);
325 addlen(strlen(buf
), &buf
, &buflen
);
331 /* XXX protocol format checking? */
332 (void) loc_ntoa(rdata
, t
);
333 T(addstr(t
, strlen(t
), &buf
, &buflen
));
338 u_int order
, preference
;
341 if (rdlen
< 2*NS_INT16SZ
)
344 /* Order, Precedence. */
345 order
= ns_get16(rdata
); rdata
+= NS_INT16SZ
;
346 preference
= ns_get16(rdata
); rdata
+= NS_INT16SZ
;
347 len
= SPRINTF((t
, "%u %u ", order
, preference
));
348 T(addstr(t
, len
, &buf
, &buflen
));
351 T(len
= charstr(rdata
, edata
, &buf
, &buflen
));
355 T(addstr(" ", 1, &buf
, &buflen
));
358 T(len
= charstr(rdata
, edata
, &buf
, &buflen
));
362 T(addstr(" ", 1, &buf
, &buflen
));
365 T(len
= charstr(rdata
, edata
, &buf
, &buflen
));
371 T(addstr(" ", 1, &buf
, &buflen
));
374 T(addname(msg
, msglen
, &rdata
, origin
, &buf
, &buflen
));
379 u_int priority
, weight
, port
;
382 if (rdlen
< NS_INT16SZ
*3)
385 /* Priority, Weight, Port. */
386 priority
= ns_get16(rdata
); rdata
+= NS_INT16SZ
;
387 weight
= ns_get16(rdata
); rdata
+= NS_INT16SZ
;
388 port
= ns_get16(rdata
); rdata
+= NS_INT16SZ
;
389 len
= SPRINTF((t
, "%u %u %u ", priority
, weight
, port
));
390 T(addstr(t
, len
, &buf
, &buflen
));
393 T(addname(msg
, msglen
, &rdata
, origin
, &buf
, &buflen
));
400 T(addname(msg
, msglen
, &rdata
, origin
, &buf
, &buflen
));
401 T(addstr(" ", 1, &buf
, &buflen
));
404 T(addname(msg
, msglen
, &rdata
, origin
, &buf
, &buflen
));
411 if (rdlen
< NS_INT32SZ
+ 1)
415 (void) inet_ntop(AF_INET
, rdata
, buf
, buflen
);
416 addlen(strlen(buf
), &buf
, &buflen
);
417 rdata
+= NS_INADDRSZ
;
420 len
= SPRINTF((tmp
, " %u ( ", *rdata
));
421 T(addstr(tmp
, len
, &buf
, &buflen
));
427 while (rdata
< edata
) {
432 T(addstr("\n\t\t\t\t", 5,
437 len
= SPRINTF((tmp
, "%d ", n
));
438 T(addstr(tmp
, len
, &buf
, &buflen
));
444 T(addstr(")", 1, &buf
, &buflen
));
451 char base64_key
[NS_MD5RSA_MAX_BASE64
];
452 u_int keyflags
, protocol
, algorithm
, key_id
;
456 if (rdlen
< NS_INT16SZ
+ NS_INT8SZ
+ NS_INT8SZ
)
459 /* Key flags, Protocol, Algorithm. */
460 key_id
= dst_s_dns_key_id(rdata
, edata
-rdata
);
461 keyflags
= ns_get16(rdata
); rdata
+= NS_INT16SZ
;
463 algorithm
= *rdata
++;
464 len
= SPRINTF((tmp
, "0x%04x %u %u",
465 keyflags
, protocol
, algorithm
));
466 T(addstr(tmp
, len
, &buf
, &buflen
));
468 /* Public key data. */
469 len
= b64_ntop(rdata
, edata
- rdata
,
470 base64_key
, sizeof base64_key
);
474 T(addstr(" (", 2, &buf
, &buflen
));
479 for (n
= 0; n
< len
; n
+= 48) {
480 T(addstr(leader
, strlen(leader
), &buf
, &buflen
));
481 T(addstr(base64_key
+ n
, MIN(len
- n
, 48),
485 T(addstr(" )", 2, &buf
, &buflen
));
486 n
= SPRINTF((tmp
, " ; key_tag= %u", key_id
));
487 T(addstr(tmp
, n
, &buf
, &buflen
));
495 char base64_key
[NS_MD5RSA_MAX_BASE64
];
496 u_int type
, algorithm
, labels
, footprint
;
504 /* Type covered, Algorithm, Label count, Original TTL. */
505 type
= ns_get16(rdata
); rdata
+= NS_INT16SZ
;
506 algorithm
= *rdata
++;
508 t
= ns_get32(rdata
); rdata
+= NS_INT32SZ
;
509 len
= SPRINTF((tmp
, "%s %d %d %lu ",
510 p_type(type
), algorithm
, labels
, t
));
511 T(addstr(tmp
, len
, &buf
, &buflen
));
512 if (labels
> (u_int
)dn_count_labels(name
))
515 /* Signature expiry. */
516 t
= ns_get32(rdata
); rdata
+= NS_INT32SZ
;
517 len
= SPRINTF((tmp
, "%s ", p_secstodate(t
)));
518 T(addstr(tmp
, len
, &buf
, &buflen
));
521 t
= ns_get32(rdata
); rdata
+= NS_INT32SZ
;
522 len
= SPRINTF((tmp
, "%s ", p_secstodate(t
)));
523 T(addstr(tmp
, len
, &buf
, &buflen
));
525 /* Signature Footprint. */
526 footprint
= ns_get16(rdata
); rdata
+= NS_INT16SZ
;
527 len
= SPRINTF((tmp
, "%u ", footprint
));
528 T(addstr(tmp
, len
, &buf
, &buflen
));
531 T(addname(msg
, msglen
, &rdata
, origin
, &buf
, &buflen
));
534 len
= b64_ntop(rdata
, edata
- rdata
,
535 base64_key
, sizeof base64_key
);
537 T(addstr(" (", 2, &buf
, &buflen
));
544 for (n
= 0; n
< len
; n
+= 48) {
545 T(addstr(leader
, strlen(leader
), &buf
, &buflen
));
546 T(addstr(base64_key
+ n
, MIN(len
- n
, 48),
550 T(addstr(" )", 2, &buf
, &buflen
));
558 /* Next domain name. */
559 T(addname(msg
, msglen
, &rdata
, origin
, &buf
, &buflen
));
563 for (c
= 0; c
< n
*8; c
++)
564 if (NS_NXT_BIT_ISSET(c
, rdata
)) {
565 len
= SPRINTF((tmp
, " %s", p_type(c
)));
566 T(addstr(tmp
, len
, &buf
, &buflen
));
572 u_int c_type
, key_tag
, alg
;
574 char base64_cert
[8192], *leader
, tmp
[40];
576 c_type
= ns_get16(rdata
); rdata
+= NS_INT16SZ
;
577 key_tag
= ns_get16(rdata
); rdata
+= NS_INT16SZ
;
578 alg
= (u_int
) *rdata
++;
580 len
= SPRINTF((tmp
, "%d %d %d ", c_type
, key_tag
, alg
));
581 T(addstr(tmp
, len
, &buf
, &buflen
));
582 siz
= (edata
-rdata
)*4/3 + 4; /* "+4" accounts for trailing \0 */
583 if (siz
> sizeof(base64_cert
) * 3/4) {
584 char *str
= "record too long to print";
585 T(addstr(str
, strlen(str
), &buf
, &buflen
));
588 len
= b64_ntop(rdata
, edata
-rdata
, base64_cert
, siz
);
593 T(addstr(" (", 2, &buf
, &buflen
));
600 for (n
= 0; n
< len
; n
+= 48) {
601 T(addstr(leader
, strlen(leader
),
603 T(addstr(base64_cert
+ n
, MIN(len
- n
, 48),
607 T(addstr(" )", 2, &buf
, &buflen
));
613 /* BEW - need to complete this */
616 T(len
= addname(msg
, msglen
, &rdata
, origin
, &buf
, &buflen
));
617 T(addstr(" ", 1, &buf
, &buflen
));
618 rdata
+= 8; /* time */
619 n
= ns_get16(rdata
); rdata
+= INT16SZ
;
620 rdata
+= n
; /* sig */
621 n
= ns_get16(rdata
); rdata
+= INT16SZ
; /* original id */
622 sprintf(buf
, "%d", ns_get16(rdata
));
624 addlen(strlen(buf
), &buf
, &buflen
);
629 comment
= "unknown RR type";
634 comment
= "RR format error";
639 len
= SPRINTF((tmp
, "\\#(\t\t; %s", comment
));
640 T(addstr(tmp
, len
, &buf
, &buflen
));
641 while (rdata
< edata
) {
643 p
+= SPRINTF((p
, "\n\t"));
645 n
= MIN(16, edata
- rdata
);
646 for (m
= 0; m
< n
; m
++)
647 p
+= SPRINTF((p
, "%02x ", rdata
[m
]));
648 T(addstr(tmp
, p
- tmp
, &buf
, &buflen
));
650 T(addstr(")", 1, &buf
, &buflen
));
651 T(addtab(p
- tmp
+ 1, 48, spaced
, &buf
, &buflen
));
654 p
+= SPRINTF((p
, "; "));
655 for (m
= 0; m
< n
; m
++)
656 *p
++ = (isascii(rdata
[m
]) && isprint(rdata
[m
]))
659 T(addstr(tmp
, p
- tmp
, &buf
, &buflen
));
670 * prune_origin(name, origin)
671 * Find out if the name is at or under the current origin.
673 * Number of characters in name before start of origin,
674 * or length of name if origin does not match.
676 * This function should share code with samedomain().
679 prune_origin(const char *name
, const char *origin
) {
680 const char *oname
= name
;
682 while (*name
!= '\0') {
683 if (origin
!= NULL
&& ns_samename(name
, origin
) == 1)
684 return (name
- oname
- (name
> oname
));
685 while (*name
!= '\0') {
688 /* XXX need to handle \nnn form. */
691 } else if (*name
== '.') {
698 return (name
- oname
);
703 * charstr(rdata, edata, buf, buflen)
704 * Format a <character-string> into the presentation buffer.
706 * Number of rdata octets consumed
707 * 0 for protocol format error
708 * -1 for output buffer error
710 * buffer is advanced on success.
713 charstr(const u_char
*rdata
, const u_char
*edata
, char **buf
, size_t *buflen
) {
714 const u_char
*odata
= rdata
;
715 size_t save_buflen
= *buflen
;
716 char *save_buf
= *buf
;
718 if (addstr("\"", 1, buf
, buflen
) < 0)
723 if (rdata
+ 1 + n
<= edata
) {
726 if (strchr("\n\"\\", *rdata
) != NULL
)
727 if (addstr("\\", 1, buf
, buflen
) < 0)
729 if (addstr((const char *)rdata
, 1,
736 if (addstr("\"", 1, buf
, buflen
) < 0)
738 return (rdata
- odata
);
740 __set_errno (ENOSPC
);
742 *buflen
= save_buflen
;
747 addname(const u_char
*msg
, size_t msglen
,
748 const u_char
**pp
, const char *origin
,
749 char **buf
, size_t *buflen
)
751 size_t newlen
, save_buflen
= *buflen
;
752 char *save_buf
= *buf
;
755 n
= dn_expand(msg
, msg
+ msglen
, *pp
, *buf
, *buflen
);
757 goto enospc
; /* Guess. */
758 newlen
= prune_origin(*buf
, origin
);
760 /* Use "@" instead of name. */
761 if (newlen
+ 2 > *buflen
)
762 goto enospc
; /* No room for "@\0". */
763 (*buf
)[newlen
++] = '@';
764 (*buf
)[newlen
] = '\0';
766 if (((origin
== NULL
|| origin
[0] == '\0') ||
767 (origin
[0] != '.' && origin
[1] != '\0' &&
768 (*buf
)[newlen
] == '\0')) && (*buf
)[newlen
- 1] != '.') {
769 /* No trailing dot. */
770 if (newlen
+ 2 > *buflen
)
771 goto enospc
; /* No room for ".\0". */
772 (*buf
)[newlen
++] = '.';
773 (*buf
)[newlen
] = '\0';
777 addlen(newlen
, buf
, buflen
);
781 __set_errno (ENOSPC
);
783 *buflen
= save_buflen
;
788 addlen(size_t len
, char **buf
, size_t *buflen
) {
789 assert(len
<= *buflen
);
795 addstr(const char *src
, size_t len
, char **buf
, size_t *buflen
) {
796 if (len
>= *buflen
) {
797 __set_errno (ENOSPC
);
800 memcpy(*buf
, src
, len
);
801 addlen(len
, buf
, buflen
);
807 addtab(size_t len
, size_t target
, int spaced
, char **buf
, size_t *buflen
) {
808 size_t save_buflen
= *buflen
;
809 char *save_buf
= *buf
;
812 if (spaced
|| len
>= target
- 1) {
813 T(addstr(" ", 2, buf
, buflen
));
816 for (t
= (target
- len
- 1) / 8; t
>= 0; t
--)
817 if (addstr("\t", 1, buf
, buflen
) < 0) {
818 *buflen
= save_buflen
;