xref: /aosp_15_r20/external/libwebsockets/lib/roles/http/date.c (revision 1c60b9aca93fdbc9b5f19b2d2194c91294b22281)
1*1c60b9acSAndroid Build Coastguard Worker /*
2*1c60b9acSAndroid Build Coastguard Worker  * libwebsockets - small server side websockets and web server implementation
3*1c60b9acSAndroid Build Coastguard Worker  *
4*1c60b9acSAndroid Build Coastguard Worker  * Copyright (C) 2010 - 2020 Andy Green <[email protected]>
5*1c60b9acSAndroid Build Coastguard Worker  *
6*1c60b9acSAndroid Build Coastguard Worker  * Permission is hereby granted, free of charge, to any person obtaining a copy
7*1c60b9acSAndroid Build Coastguard Worker  * of this software and associated documentation files (the "Software"), to
8*1c60b9acSAndroid Build Coastguard Worker  * deal in the Software without restriction, including without limitation the
9*1c60b9acSAndroid Build Coastguard Worker  * rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
10*1c60b9acSAndroid Build Coastguard Worker  * sell copies of the Software, and to permit persons to whom the Software is
11*1c60b9acSAndroid Build Coastguard Worker  * furnished to do so, subject to the following conditions:
12*1c60b9acSAndroid Build Coastguard Worker  *
13*1c60b9acSAndroid Build Coastguard Worker  * The above copyright notice and this permission notice shall be included in
14*1c60b9acSAndroid Build Coastguard Worker  * all copies or substantial portions of the Software.
15*1c60b9acSAndroid Build Coastguard Worker  *
16*1c60b9acSAndroid Build Coastguard Worker  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17*1c60b9acSAndroid Build Coastguard Worker  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18*1c60b9acSAndroid Build Coastguard Worker  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
19*1c60b9acSAndroid Build Coastguard Worker  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20*1c60b9acSAndroid Build Coastguard Worker  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
21*1c60b9acSAndroid Build Coastguard Worker  * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
22*1c60b9acSAndroid Build Coastguard Worker  * IN THE SOFTWARE.
23*1c60b9acSAndroid Build Coastguard Worker  *
24*1c60b9acSAndroid Build Coastguard Worker  * RFC7231 date string generation and parsing
25*1c60b9acSAndroid Build Coastguard Worker  */
26*1c60b9acSAndroid Build Coastguard Worker 
27*1c60b9acSAndroid Build Coastguard Worker #include "private-lib-core.h"
28*1c60b9acSAndroid Build Coastguard Worker 
29*1c60b9acSAndroid Build Coastguard Worker /*
30*1c60b9acSAndroid Build Coastguard Worker  * To avoid needless pointers, we encode these in one string using the fact
31*1c60b9acSAndroid Build Coastguard Worker  * they're 3 chars each to index it
32*1c60b9acSAndroid Build Coastguard Worker  */
33*1c60b9acSAndroid Build Coastguard Worker 
34*1c60b9acSAndroid Build Coastguard Worker static const char *const s =
35*1c60b9acSAndroid Build Coastguard Worker 		"JanFebMarAprMayJunJulAugSepOctNovDecMonTueWedThuFriSatSun";
36*1c60b9acSAndroid Build Coastguard Worker 
37*1c60b9acSAndroid Build Coastguard Worker static int
lws_http_date_render(char * buf,size_t len,const struct tm * tm)38*1c60b9acSAndroid Build Coastguard Worker lws_http_date_render(char *buf, size_t len, const struct tm *tm)
39*1c60b9acSAndroid Build Coastguard Worker {
40*1c60b9acSAndroid Build Coastguard Worker 	const char *w = s + 36 + (3 * tm->tm_wday), *m = s + (3 * tm->tm_mon);
41*1c60b9acSAndroid Build Coastguard Worker 
42*1c60b9acSAndroid Build Coastguard Worker 	if (len < 29)
43*1c60b9acSAndroid Build Coastguard Worker 		return -1;
44*1c60b9acSAndroid Build Coastguard Worker 
45*1c60b9acSAndroid Build Coastguard Worker 	lws_snprintf(buf, len, "%c%c%c, %02d %c%c%c %d %02d:%02d:%02d GMT",
46*1c60b9acSAndroid Build Coastguard Worker 		     w[0], w[1], w[2], tm->tm_mday, m[0], m[1], m[2],
47*1c60b9acSAndroid Build Coastguard Worker 		     1900 + tm->tm_year, tm->tm_hour, tm->tm_min, tm->tm_sec);
48*1c60b9acSAndroid Build Coastguard Worker 
49*1c60b9acSAndroid Build Coastguard Worker 	return 0;
50*1c60b9acSAndroid Build Coastguard Worker }
51*1c60b9acSAndroid Build Coastguard Worker 
52*1c60b9acSAndroid Build Coastguard Worker 
53*1c60b9acSAndroid Build Coastguard Worker int
lws_http_date_render_from_unix(char * buf,size_t len,const time_t * t)54*1c60b9acSAndroid Build Coastguard Worker lws_http_date_render_from_unix(char *buf, size_t len, const time_t *t)
55*1c60b9acSAndroid Build Coastguard Worker {
56*1c60b9acSAndroid Build Coastguard Worker #if defined(LWS_HAVE_GMTIME_R)
57*1c60b9acSAndroid Build Coastguard Worker 	struct tm tmp;
58*1c60b9acSAndroid Build Coastguard Worker 	struct tm *tm = gmtime_r(t, &tmp);
59*1c60b9acSAndroid Build Coastguard Worker #else
60*1c60b9acSAndroid Build Coastguard Worker 	struct tm *tm = gmtime(t);
61*1c60b9acSAndroid Build Coastguard Worker #endif
62*1c60b9acSAndroid Build Coastguard Worker 	if (!tm)
63*1c60b9acSAndroid Build Coastguard Worker 		return -1;
64*1c60b9acSAndroid Build Coastguard Worker 
65*1c60b9acSAndroid Build Coastguard Worker 	if (lws_http_date_render(buf, len, tm))
66*1c60b9acSAndroid Build Coastguard Worker 		return -1;
67*1c60b9acSAndroid Build Coastguard Worker 
68*1c60b9acSAndroid Build Coastguard Worker 	return 0;
69*1c60b9acSAndroid Build Coastguard Worker }
70*1c60b9acSAndroid Build Coastguard Worker 
71*1c60b9acSAndroid Build Coastguard Worker static int
lws_http_date_parse(const char * b,size_t len,struct tm * tm)72*1c60b9acSAndroid Build Coastguard Worker lws_http_date_parse(const char *b, size_t len, struct tm *tm)
73*1c60b9acSAndroid Build Coastguard Worker {
74*1c60b9acSAndroid Build Coastguard Worker 	int n;
75*1c60b9acSAndroid Build Coastguard Worker 
76*1c60b9acSAndroid Build Coastguard Worker 	if (len < 29)
77*1c60b9acSAndroid Build Coastguard Worker 		return -1;
78*1c60b9acSAndroid Build Coastguard Worker 
79*1c60b9acSAndroid Build Coastguard Worker 	/*
80*1c60b9acSAndroid Build Coastguard Worker 	 * We reject anything that isn't a properly-formatted RFC7231 date, eg
81*1c60b9acSAndroid Build Coastguard Worker 	 *
82*1c60b9acSAndroid Build Coastguard Worker 	 *     Tue, 15 Nov 1994 08:12:31 GMT
83*1c60b9acSAndroid Build Coastguard Worker 	 */
84*1c60b9acSAndroid Build Coastguard Worker 
85*1c60b9acSAndroid Build Coastguard Worker 	if (b[3] != ','  || b[4] != ' '  || b[7] != ' '  || b[11] != ' ' ||
86*1c60b9acSAndroid Build Coastguard Worker 	    b[16] != ' ' || b[19] != ':' || b[22] != ':' || b[25] != ' ' ||
87*1c60b9acSAndroid Build Coastguard Worker 	    b[26] != 'G' || b[27] != 'M' || b[28] != 'T')
88*1c60b9acSAndroid Build Coastguard Worker 		return -1;
89*1c60b9acSAndroid Build Coastguard Worker 
90*1c60b9acSAndroid Build Coastguard Worker 	memset(tm, 0, sizeof(*tm));
91*1c60b9acSAndroid Build Coastguard Worker 
92*1c60b9acSAndroid Build Coastguard Worker 	for (n = 36; n < 57; n += 3)
93*1c60b9acSAndroid Build Coastguard Worker 		if (b[0] == s[n] && b[1] == s[n + 1] && b[2] == s[n + 2])
94*1c60b9acSAndroid Build Coastguard Worker 			break;
95*1c60b9acSAndroid Build Coastguard Worker 		else
96*1c60b9acSAndroid Build Coastguard Worker 			tm->tm_wday++;
97*1c60b9acSAndroid Build Coastguard Worker 
98*1c60b9acSAndroid Build Coastguard Worker 	if (n == 57)
99*1c60b9acSAndroid Build Coastguard Worker 		return -1;
100*1c60b9acSAndroid Build Coastguard Worker 
101*1c60b9acSAndroid Build Coastguard Worker 	for (n = 0; n < 36; n += 3)
102*1c60b9acSAndroid Build Coastguard Worker 		if (b[8] == s[n] && b[9] == s[n + 1] && b[10] == s[n + 2])
103*1c60b9acSAndroid Build Coastguard Worker 			break;
104*1c60b9acSAndroid Build Coastguard Worker 		else
105*1c60b9acSAndroid Build Coastguard Worker 			tm->tm_mon++;
106*1c60b9acSAndroid Build Coastguard Worker 
107*1c60b9acSAndroid Build Coastguard Worker 	if (n == 36)
108*1c60b9acSAndroid Build Coastguard Worker 		return -1;
109*1c60b9acSAndroid Build Coastguard Worker 
110*1c60b9acSAndroid Build Coastguard Worker 	tm->tm_mday = atoi(b + 5);
111*1c60b9acSAndroid Build Coastguard Worker 	n = atoi(b + 12);
112*1c60b9acSAndroid Build Coastguard Worker 	if (n < 1900)
113*1c60b9acSAndroid Build Coastguard Worker 		return -1;
114*1c60b9acSAndroid Build Coastguard Worker 	tm->tm_year = n - 1900;
115*1c60b9acSAndroid Build Coastguard Worker 
116*1c60b9acSAndroid Build Coastguard Worker 	n = atoi(b + 17);
117*1c60b9acSAndroid Build Coastguard Worker 	if (n < 0 || n > 23)
118*1c60b9acSAndroid Build Coastguard Worker 		return -1;
119*1c60b9acSAndroid Build Coastguard Worker 	tm->tm_hour = n;
120*1c60b9acSAndroid Build Coastguard Worker 
121*1c60b9acSAndroid Build Coastguard Worker 	n = atoi(b + 20);
122*1c60b9acSAndroid Build Coastguard Worker 	if (n < 0 || n > 60)
123*1c60b9acSAndroid Build Coastguard Worker 		return -1;
124*1c60b9acSAndroid Build Coastguard Worker 	tm->tm_min = n;
125*1c60b9acSAndroid Build Coastguard Worker 
126*1c60b9acSAndroid Build Coastguard Worker 	n = atoi(b + 23);
127*1c60b9acSAndroid Build Coastguard Worker 	if (n < 0 || n > 61) /* leap second */
128*1c60b9acSAndroid Build Coastguard Worker 		return -1;
129*1c60b9acSAndroid Build Coastguard Worker 	tm->tm_sec = n;
130*1c60b9acSAndroid Build Coastguard Worker 
131*1c60b9acSAndroid Build Coastguard Worker 	return 0;
132*1c60b9acSAndroid Build Coastguard Worker }
133*1c60b9acSAndroid Build Coastguard Worker 
134*1c60b9acSAndroid Build Coastguard Worker int
lws_http_date_parse_unix(const char * b,size_t len,time_t * t)135*1c60b9acSAndroid Build Coastguard Worker lws_http_date_parse_unix(const char *b, size_t len, time_t *t)
136*1c60b9acSAndroid Build Coastguard Worker {
137*1c60b9acSAndroid Build Coastguard Worker 	struct tm tm;
138*1c60b9acSAndroid Build Coastguard Worker 
139*1c60b9acSAndroid Build Coastguard Worker 	if (lws_http_date_parse(b, len, &tm))
140*1c60b9acSAndroid Build Coastguard Worker 		return -1;
141*1c60b9acSAndroid Build Coastguard Worker 
142*1c60b9acSAndroid Build Coastguard Worker #if defined(WIN32)
143*1c60b9acSAndroid Build Coastguard Worker 	*t = _mkgmtime(&tm);
144*1c60b9acSAndroid Build Coastguard Worker #else
145*1c60b9acSAndroid Build Coastguard Worker #if defined(LWS_HAVE_TIMEGM)
146*1c60b9acSAndroid Build Coastguard Worker 	*t = timegm(&tm);
147*1c60b9acSAndroid Build Coastguard Worker #else
148*1c60b9acSAndroid Build Coastguard Worker 	/* this is a poor fallback since it uses localtime zone */
149*1c60b9acSAndroid Build Coastguard Worker 	*t = mktime(&tm);
150*1c60b9acSAndroid Build Coastguard Worker #endif
151*1c60b9acSAndroid Build Coastguard Worker #endif
152*1c60b9acSAndroid Build Coastguard Worker 
153*1c60b9acSAndroid Build Coastguard Worker 	return (int)*t == -1 ? -1 : 0;
154*1c60b9acSAndroid Build Coastguard Worker }
155*1c60b9acSAndroid Build Coastguard Worker 
156*1c60b9acSAndroid Build Coastguard Worker #if defined(LWS_WITH_CLIENT)
157*1c60b9acSAndroid Build Coastguard Worker 
158*1c60b9acSAndroid Build Coastguard Worker int
lws_http_check_retry_after(struct lws * wsi,lws_usec_t * us_interval_in_out)159*1c60b9acSAndroid Build Coastguard Worker lws_http_check_retry_after(struct lws *wsi, lws_usec_t *us_interval_in_out)
160*1c60b9acSAndroid Build Coastguard Worker {
161*1c60b9acSAndroid Build Coastguard Worker 	size_t len = (unsigned int)lws_hdr_total_length(wsi, WSI_TOKEN_HTTP_RETRY_AFTER);
162*1c60b9acSAndroid Build Coastguard Worker 	char *p = lws_hdr_simple_ptr(wsi, WSI_TOKEN_HTTP_RETRY_AFTER);
163*1c60b9acSAndroid Build Coastguard Worker 	lws_usec_t u;
164*1c60b9acSAndroid Build Coastguard Worker 	time_t t, td;
165*1c60b9acSAndroid Build Coastguard Worker 
166*1c60b9acSAndroid Build Coastguard Worker 	if (!p)
167*1c60b9acSAndroid Build Coastguard Worker 		return 1;
168*1c60b9acSAndroid Build Coastguard Worker 
169*1c60b9acSAndroid Build Coastguard Worker 	/*
170*1c60b9acSAndroid Build Coastguard Worker 	 * There are two arg styles for RETRY_AFTER specified in RFC7231 7.1.3,
171*1c60b9acSAndroid Build Coastguard Worker 	 * either a full absolute second-resolution date/time, or an integer
172*1c60b9acSAndroid Build Coastguard Worker 	 * interval
173*1c60b9acSAndroid Build Coastguard Worker 	 *
174*1c60b9acSAndroid Build Coastguard Worker 	 *      Retry-After: Fri, 31 Dec 1999 23:59:59 GMT
175*1c60b9acSAndroid Build Coastguard Worker          *      Retry-After: 120
176*1c60b9acSAndroid Build Coastguard Worker 	 */
177*1c60b9acSAndroid Build Coastguard Worker 
178*1c60b9acSAndroid Build Coastguard Worker 	if (len < 9)
179*1c60b9acSAndroid Build Coastguard Worker 		u = ((lws_usec_t)(time_t)atoi(p)) * LWS_USEC_PER_SEC;
180*1c60b9acSAndroid Build Coastguard Worker 	else {
181*1c60b9acSAndroid Build Coastguard Worker 
182*1c60b9acSAndroid Build Coastguard Worker 		if (lws_http_date_parse_unix(p, len, &t))
183*1c60b9acSAndroid Build Coastguard Worker 			return 1;
184*1c60b9acSAndroid Build Coastguard Worker 
185*1c60b9acSAndroid Build Coastguard Worker 		/*
186*1c60b9acSAndroid Build Coastguard Worker 		 * If possible, look for DATE from the server as well, so we
187*1c60b9acSAndroid Build Coastguard Worker 		 * can calculate the interval it thinks it is giving us,
188*1c60b9acSAndroid Build Coastguard Worker 		 * eliminating problems from server - client clock skew
189*1c60b9acSAndroid Build Coastguard Worker 		 */
190*1c60b9acSAndroid Build Coastguard Worker 
191*1c60b9acSAndroid Build Coastguard Worker 		time(&td);
192*1c60b9acSAndroid Build Coastguard Worker 		len = (unsigned int)lws_hdr_total_length(wsi, WSI_TOKEN_HTTP_DATE);
193*1c60b9acSAndroid Build Coastguard Worker 		if (len) {
194*1c60b9acSAndroid Build Coastguard Worker 			p = lws_hdr_simple_ptr(wsi, WSI_TOKEN_HTTP_DATE);
195*1c60b9acSAndroid Build Coastguard Worker 			/* if this fails, it leaves td as client time */
196*1c60b9acSAndroid Build Coastguard Worker 			(void)lws_http_date_parse_unix(p, len, &td);
197*1c60b9acSAndroid Build Coastguard Worker 		}
198*1c60b9acSAndroid Build Coastguard Worker 
199*1c60b9acSAndroid Build Coastguard Worker 		if (td >= t)
200*1c60b9acSAndroid Build Coastguard Worker 			/*
201*1c60b9acSAndroid Build Coastguard Worker 			 * if he's effectively giving us a 0 or negative
202*1c60b9acSAndroid Build Coastguard Worker 			 * interval, just ignore the whole thing and keep the
203*1c60b9acSAndroid Build Coastguard Worker 			 * incoming interval
204*1c60b9acSAndroid Build Coastguard Worker 			 */
205*1c60b9acSAndroid Build Coastguard Worker 			return 1;
206*1c60b9acSAndroid Build Coastguard Worker 
207*1c60b9acSAndroid Build Coastguard Worker 		u = ((lws_usec_t)(t - td)) * LWS_USEC_PER_SEC;
208*1c60b9acSAndroid Build Coastguard Worker 	}
209*1c60b9acSAndroid Build Coastguard Worker 
210*1c60b9acSAndroid Build Coastguard Worker 	/*
211*1c60b9acSAndroid Build Coastguard Worker 	 * We are only willing to increase the incoming interval, not
212*1c60b9acSAndroid Build Coastguard Worker 	 * decrease it
213*1c60b9acSAndroid Build Coastguard Worker 	 */
214*1c60b9acSAndroid Build Coastguard Worker 
215*1c60b9acSAndroid Build Coastguard Worker 	if (u < *us_interval_in_out)
216*1c60b9acSAndroid Build Coastguard Worker 		/* keep the incoming interval */
217*1c60b9acSAndroid Build Coastguard Worker 		return 1;
218*1c60b9acSAndroid Build Coastguard Worker 
219*1c60b9acSAndroid Build Coastguard Worker 	/* use the computed interval */
220*1c60b9acSAndroid Build Coastguard Worker 	*us_interval_in_out = u;
221*1c60b9acSAndroid Build Coastguard Worker 
222*1c60b9acSAndroid Build Coastguard Worker 	return 0;
223*1c60b9acSAndroid Build Coastguard Worker }
224*1c60b9acSAndroid Build Coastguard Worker 
225*1c60b9acSAndroid Build Coastguard Worker #endif
226