xref: /minix3/external/bsd/bind/dist/lib/dns/ttl.c (revision 00b67f09dd46474d133c95011a48590a8e8f94c7)
1*00b67f09SDavid van Moolenbroek /*	$NetBSD: ttl.c,v 1.7 2014/12/10 04:37:58 christos Exp $	*/
2*00b67f09SDavid van Moolenbroek 
3*00b67f09SDavid van Moolenbroek /*
4*00b67f09SDavid van Moolenbroek  * Copyright (C) 2004, 2005, 2007, 2011-2014  Internet Systems Consortium, Inc. ("ISC")
5*00b67f09SDavid van Moolenbroek  * Copyright (C) 1999-2001  Internet Software Consortium.
6*00b67f09SDavid van Moolenbroek  *
7*00b67f09SDavid van Moolenbroek  * Permission to use, copy, modify, and/or distribute this software for any
8*00b67f09SDavid van Moolenbroek  * purpose with or without fee is hereby granted, provided that the above
9*00b67f09SDavid van Moolenbroek  * copyright notice and this permission notice appear in all copies.
10*00b67f09SDavid van Moolenbroek  *
11*00b67f09SDavid van Moolenbroek  * THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
12*00b67f09SDavid van Moolenbroek  * REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
13*00b67f09SDavid van Moolenbroek  * AND FITNESS.  IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
14*00b67f09SDavid van Moolenbroek  * INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
15*00b67f09SDavid van Moolenbroek  * LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
16*00b67f09SDavid van Moolenbroek  * OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
17*00b67f09SDavid van Moolenbroek  * PERFORMANCE OF THIS SOFTWARE.
18*00b67f09SDavid van Moolenbroek  */
19*00b67f09SDavid van Moolenbroek 
20*00b67f09SDavid van Moolenbroek /* Id */
21*00b67f09SDavid van Moolenbroek 
22*00b67f09SDavid van Moolenbroek /*! \file */
23*00b67f09SDavid van Moolenbroek 
24*00b67f09SDavid van Moolenbroek #include <config.h>
25*00b67f09SDavid van Moolenbroek 
26*00b67f09SDavid van Moolenbroek #include <ctype.h>
27*00b67f09SDavid van Moolenbroek #include <errno.h>
28*00b67f09SDavid van Moolenbroek #include <stdio.h>
29*00b67f09SDavid van Moolenbroek #include <stdlib.h>
30*00b67f09SDavid van Moolenbroek 
31*00b67f09SDavid van Moolenbroek #include <isc/buffer.h>
32*00b67f09SDavid van Moolenbroek #include <isc/parseint.h>
33*00b67f09SDavid van Moolenbroek #include <isc/print.h>
34*00b67f09SDavid van Moolenbroek #include <isc/region.h>
35*00b67f09SDavid van Moolenbroek #include <isc/string.h>
36*00b67f09SDavid van Moolenbroek #include <isc/util.h>
37*00b67f09SDavid van Moolenbroek 
38*00b67f09SDavid van Moolenbroek #include <dns/result.h>
39*00b67f09SDavid van Moolenbroek #include <dns/ttl.h>
40*00b67f09SDavid van Moolenbroek 
41*00b67f09SDavid van Moolenbroek #define RETERR(x) do { \
42*00b67f09SDavid van Moolenbroek 	isc_result_t _r = (x); \
43*00b67f09SDavid van Moolenbroek 	if (_r != ISC_R_SUCCESS) \
44*00b67f09SDavid van Moolenbroek 		return (_r); \
45*00b67f09SDavid van Moolenbroek 	} while (/*CONSTCOND*/0)
46*00b67f09SDavid van Moolenbroek 
47*00b67f09SDavid van Moolenbroek 
48*00b67f09SDavid van Moolenbroek static isc_result_t bind_ttl(isc_textregion_t *source, isc_uint32_t *ttl);
49*00b67f09SDavid van Moolenbroek 
50*00b67f09SDavid van Moolenbroek /*
51*00b67f09SDavid van Moolenbroek  * Helper for dns_ttl_totext().
52*00b67f09SDavid van Moolenbroek  */
53*00b67f09SDavid van Moolenbroek static isc_result_t
ttlfmt(unsigned int t,const char * s,isc_boolean_t verbose,isc_boolean_t space,isc_buffer_t * target)54*00b67f09SDavid van Moolenbroek ttlfmt(unsigned int t, const char *s, isc_boolean_t verbose,
55*00b67f09SDavid van Moolenbroek        isc_boolean_t space, isc_buffer_t *target)
56*00b67f09SDavid van Moolenbroek {
57*00b67f09SDavid van Moolenbroek 	char tmp[60];
58*00b67f09SDavid van Moolenbroek 	unsigned int len;
59*00b67f09SDavid van Moolenbroek 	isc_region_t region;
60*00b67f09SDavid van Moolenbroek 
61*00b67f09SDavid van Moolenbroek 	if (verbose)
62*00b67f09SDavid van Moolenbroek 		len = snprintf(tmp, sizeof(tmp), "%s%u %s%s",
63*00b67f09SDavid van Moolenbroek 			       space ? " " : "",
64*00b67f09SDavid van Moolenbroek 			       t, s,
65*00b67f09SDavid van Moolenbroek 			       t == 1 ? "" : "s");
66*00b67f09SDavid van Moolenbroek 	else
67*00b67f09SDavid van Moolenbroek 		len = snprintf(tmp, sizeof(tmp), "%u%c", t, s[0]);
68*00b67f09SDavid van Moolenbroek 
69*00b67f09SDavid van Moolenbroek 	INSIST(len + 1 <= sizeof(tmp));
70*00b67f09SDavid van Moolenbroek 	isc_buffer_availableregion(target, &region);
71*00b67f09SDavid van Moolenbroek 	if (len > region.length)
72*00b67f09SDavid van Moolenbroek 		return (ISC_R_NOSPACE);
73*00b67f09SDavid van Moolenbroek 	memmove(region.base, tmp, len);
74*00b67f09SDavid van Moolenbroek 	isc_buffer_add(target, len);
75*00b67f09SDavid van Moolenbroek 
76*00b67f09SDavid van Moolenbroek 	return (ISC_R_SUCCESS);
77*00b67f09SDavid van Moolenbroek }
78*00b67f09SDavid van Moolenbroek 
79*00b67f09SDavid van Moolenbroek /*
80*00b67f09SDavid van Moolenbroek  * Derived from bind8 ns_format_ttl().
81*00b67f09SDavid van Moolenbroek  */
82*00b67f09SDavid van Moolenbroek isc_result_t
dns_ttl_totext(isc_uint32_t src,isc_boolean_t verbose,isc_buffer_t * target)83*00b67f09SDavid van Moolenbroek dns_ttl_totext(isc_uint32_t src, isc_boolean_t verbose, isc_buffer_t *target) {
84*00b67f09SDavid van Moolenbroek 	unsigned secs, mins, hours, days, weeks, x;
85*00b67f09SDavid van Moolenbroek 
86*00b67f09SDavid van Moolenbroek 	secs = src % 60;   src /= 60;
87*00b67f09SDavid van Moolenbroek 	mins = src % 60;   src /= 60;
88*00b67f09SDavid van Moolenbroek 	hours = src % 24;  src /= 24;
89*00b67f09SDavid van Moolenbroek 	days = src % 7;    src /= 7;
90*00b67f09SDavid van Moolenbroek 	weeks = src;       src = 0;
91*00b67f09SDavid van Moolenbroek 	POST(src);
92*00b67f09SDavid van Moolenbroek 
93*00b67f09SDavid van Moolenbroek 	x = 0;
94*00b67f09SDavid van Moolenbroek 	if (weeks != 0) {
95*00b67f09SDavid van Moolenbroek 		RETERR(ttlfmt(weeks, "week", verbose, ISC_TF(x > 0), target));
96*00b67f09SDavid van Moolenbroek 		x++;
97*00b67f09SDavid van Moolenbroek 	}
98*00b67f09SDavid van Moolenbroek 	if (days != 0) {
99*00b67f09SDavid van Moolenbroek 		RETERR(ttlfmt(days, "day", verbose, ISC_TF(x > 0), target));
100*00b67f09SDavid van Moolenbroek 		x++;
101*00b67f09SDavid van Moolenbroek 	}
102*00b67f09SDavid van Moolenbroek 	if (hours != 0) {
103*00b67f09SDavid van Moolenbroek 		RETERR(ttlfmt(hours, "hour", verbose, ISC_TF(x > 0), target));
104*00b67f09SDavid van Moolenbroek 		x++;
105*00b67f09SDavid van Moolenbroek 	}
106*00b67f09SDavid van Moolenbroek 	if (mins != 0) {
107*00b67f09SDavid van Moolenbroek 		RETERR(ttlfmt(mins, "minute", verbose, ISC_TF(x > 0), target));
108*00b67f09SDavid van Moolenbroek 		x++;
109*00b67f09SDavid van Moolenbroek 	}
110*00b67f09SDavid van Moolenbroek 	if (secs != 0 ||
111*00b67f09SDavid van Moolenbroek 	    (weeks == 0 && days == 0 && hours == 0 && mins == 0)) {
112*00b67f09SDavid van Moolenbroek 		RETERR(ttlfmt(secs, "second", verbose, ISC_TF(x > 0), target));
113*00b67f09SDavid van Moolenbroek 		x++;
114*00b67f09SDavid van Moolenbroek 	}
115*00b67f09SDavid van Moolenbroek 	INSIST (x > 0);
116*00b67f09SDavid van Moolenbroek 	/*
117*00b67f09SDavid van Moolenbroek 	 * If only a single unit letter is printed, print it
118*00b67f09SDavid van Moolenbroek 	 * in upper case. (Why?  Because BIND 8 does that.
119*00b67f09SDavid van Moolenbroek 	 * Presumably it has a reason.)
120*00b67f09SDavid van Moolenbroek 	 */
121*00b67f09SDavid van Moolenbroek 	if (x == 1 && !verbose) {
122*00b67f09SDavid van Moolenbroek 		isc_region_t region;
123*00b67f09SDavid van Moolenbroek 		/*
124*00b67f09SDavid van Moolenbroek 		 * The unit letter is the last character in the
125*00b67f09SDavid van Moolenbroek 		 * used region of the buffer.
126*00b67f09SDavid van Moolenbroek 		 *
127*00b67f09SDavid van Moolenbroek 		 * toupper() does not need its argument to be masked of cast
128*00b67f09SDavid van Moolenbroek 		 * here because region.base is type unsigned char *.
129*00b67f09SDavid van Moolenbroek 		 */
130*00b67f09SDavid van Moolenbroek 		isc_buffer_usedregion(target, &region);
131*00b67f09SDavid van Moolenbroek 		region.base[region.length - 1] =
132*00b67f09SDavid van Moolenbroek 			toupper(region.base[region.length - 1]);
133*00b67f09SDavid van Moolenbroek 	}
134*00b67f09SDavid van Moolenbroek 	return (ISC_R_SUCCESS);
135*00b67f09SDavid van Moolenbroek }
136*00b67f09SDavid van Moolenbroek 
137*00b67f09SDavid van Moolenbroek isc_result_t
dns_counter_fromtext(isc_textregion_t * source,isc_uint32_t * ttl)138*00b67f09SDavid van Moolenbroek dns_counter_fromtext(isc_textregion_t *source, isc_uint32_t *ttl) {
139*00b67f09SDavid van Moolenbroek 	return (bind_ttl(source, ttl));
140*00b67f09SDavid van Moolenbroek }
141*00b67f09SDavid van Moolenbroek 
142*00b67f09SDavid van Moolenbroek isc_result_t
dns_ttl_fromtext(isc_textregion_t * source,isc_uint32_t * ttl)143*00b67f09SDavid van Moolenbroek dns_ttl_fromtext(isc_textregion_t *source, isc_uint32_t *ttl) {
144*00b67f09SDavid van Moolenbroek 	isc_result_t result;
145*00b67f09SDavid van Moolenbroek 
146*00b67f09SDavid van Moolenbroek 	result = bind_ttl(source, ttl);
147*00b67f09SDavid van Moolenbroek 	if (result != ISC_R_SUCCESS && result != ISC_R_RANGE)
148*00b67f09SDavid van Moolenbroek 		result = DNS_R_BADTTL;
149*00b67f09SDavid van Moolenbroek 	return (result);
150*00b67f09SDavid van Moolenbroek }
151*00b67f09SDavid van Moolenbroek 
152*00b67f09SDavid van Moolenbroek static isc_result_t
bind_ttl(isc_textregion_t * source,isc_uint32_t * ttl)153*00b67f09SDavid van Moolenbroek bind_ttl(isc_textregion_t *source, isc_uint32_t *ttl) {
154*00b67f09SDavid van Moolenbroek 	isc_uint64_t tmp = 0ULL;
155*00b67f09SDavid van Moolenbroek 	isc_uint32_t n;
156*00b67f09SDavid van Moolenbroek 	char *s;
157*00b67f09SDavid van Moolenbroek 	char buf[64];
158*00b67f09SDavid van Moolenbroek 	char nbuf[64]; /* Number buffer */
159*00b67f09SDavid van Moolenbroek 
160*00b67f09SDavid van Moolenbroek 	/*
161*00b67f09SDavid van Moolenbroek 	 * Copy the buffer as it may not be NULL terminated.
162*00b67f09SDavid van Moolenbroek 	 * No legal counter / ttl is longer that 63 characters.
163*00b67f09SDavid van Moolenbroek 	 */
164*00b67f09SDavid van Moolenbroek 	if (source->length > sizeof(buf) - 1)
165*00b67f09SDavid van Moolenbroek 		return (DNS_R_SYNTAX);
166*00b67f09SDavid van Moolenbroek 	strncpy(buf, source->base, source->length);
167*00b67f09SDavid van Moolenbroek 	buf[source->length] = '\0';
168*00b67f09SDavid van Moolenbroek 	s = buf;
169*00b67f09SDavid van Moolenbroek 
170*00b67f09SDavid van Moolenbroek 	do {
171*00b67f09SDavid van Moolenbroek 		isc_result_t result;
172*00b67f09SDavid van Moolenbroek 
173*00b67f09SDavid van Moolenbroek 		char *np = nbuf;
174*00b67f09SDavid van Moolenbroek 		while (*s != '\0' && isdigit((unsigned char)*s))
175*00b67f09SDavid van Moolenbroek 			*np++ = *s++;
176*00b67f09SDavid van Moolenbroek 		*np++ = '\0';
177*00b67f09SDavid van Moolenbroek 		INSIST(np - nbuf <= (int)sizeof(nbuf));
178*00b67f09SDavid van Moolenbroek 		result = isc_parse_uint32(&n, nbuf, 10);
179*00b67f09SDavid van Moolenbroek 		if (result != ISC_R_SUCCESS)
180*00b67f09SDavid van Moolenbroek 			return (DNS_R_SYNTAX);
181*00b67f09SDavid van Moolenbroek 		switch (*s) {
182*00b67f09SDavid van Moolenbroek 		case 'w':
183*00b67f09SDavid van Moolenbroek 		case 'W':
184*00b67f09SDavid van Moolenbroek 			tmp += (isc_uint64_t) n * 7 * 24 * 3600;
185*00b67f09SDavid van Moolenbroek 			s++;
186*00b67f09SDavid van Moolenbroek 			break;
187*00b67f09SDavid van Moolenbroek 		case 'd':
188*00b67f09SDavid van Moolenbroek 		case 'D':
189*00b67f09SDavid van Moolenbroek 			tmp += (isc_uint64_t) n * 24 * 3600;
190*00b67f09SDavid van Moolenbroek 			s++;
191*00b67f09SDavid van Moolenbroek 			break;
192*00b67f09SDavid van Moolenbroek 		case 'h':
193*00b67f09SDavid van Moolenbroek 		case 'H':
194*00b67f09SDavid van Moolenbroek 			tmp += (isc_uint64_t) n * 3600;
195*00b67f09SDavid van Moolenbroek 			s++;
196*00b67f09SDavid van Moolenbroek 			break;
197*00b67f09SDavid van Moolenbroek 		case 'm':
198*00b67f09SDavid van Moolenbroek 		case 'M':
199*00b67f09SDavid van Moolenbroek 			tmp += (isc_uint64_t) n * 60;
200*00b67f09SDavid van Moolenbroek 			s++;
201*00b67f09SDavid van Moolenbroek 			break;
202*00b67f09SDavid van Moolenbroek 		case 's':
203*00b67f09SDavid van Moolenbroek 		case 'S':
204*00b67f09SDavid van Moolenbroek 			tmp += (isc_uint64_t) n;
205*00b67f09SDavid van Moolenbroek 			s++;
206*00b67f09SDavid van Moolenbroek 			break;
207*00b67f09SDavid van Moolenbroek 		case '\0':
208*00b67f09SDavid van Moolenbroek 			/* Plain number? */
209*00b67f09SDavid van Moolenbroek 			if (tmp != 0ULL)
210*00b67f09SDavid van Moolenbroek 				return (DNS_R_SYNTAX);
211*00b67f09SDavid van Moolenbroek 			tmp = n;
212*00b67f09SDavid van Moolenbroek 			break;
213*00b67f09SDavid van Moolenbroek 		default:
214*00b67f09SDavid van Moolenbroek 			return (DNS_R_SYNTAX);
215*00b67f09SDavid van Moolenbroek 		}
216*00b67f09SDavid van Moolenbroek 	} while (*s != '\0');
217*00b67f09SDavid van Moolenbroek 
218*00b67f09SDavid van Moolenbroek 	if (tmp > 0xffffffffULL)
219*00b67f09SDavid van Moolenbroek 		return (ISC_R_RANGE);
220*00b67f09SDavid van Moolenbroek 
221*00b67f09SDavid van Moolenbroek 	*ttl = (isc_uint32_t)(tmp & 0xffffffffUL);
222*00b67f09SDavid van Moolenbroek 	return (ISC_R_SUCCESS);
223*00b67f09SDavid van Moolenbroek }
224