Gotweb

Blob

Date:: Fri Feb 24 17:36:19 2023 UTC
Message:: add some helper functions to compute hashes This adds a set of functions to abstract over SHA1Init, SHA1Update, SHA1Final, their respective SHA256 variants and how to compare digests. Replace all the SHA1*() usage with the new APIs. It's a preparatory step for sha256 handling. ok stsp@
Actions:: History | Blame | Raw File
1 /*
2  * Copyright (c) 2019 Stefan Sperling <stsp@openbsd.org>
3  *
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.
7  *
8  * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
9  * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
10  * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
11  * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
12  * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
13  * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
14  * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
15  */
16 
17 #include <sys/queue.h>
18 
19 #include <errno.h>
20 #include <stdio.h>
21 #include <stdlib.h>
22 #include <string.h>
23 #include <zlib.h>
24 #include <time.h>
25 
26 #include "got_error.h"
27 #include "got_object.h"
28 #include "got_path.h"
29 
30 #include "got_lib_deflate.h"
31 #include "got_lib_hash.h"
32 #include "got_lib_poll.h"
33 
34 #ifndef MIN
35 #define	MIN(_a,_b) ((_a) < (_b) ? (_a) : (_b))
36 #endif
37 
38 const struct got_error *
39 got_deflate_init(struct got_deflate_buf *zb, uint8_t *outbuf, size_t bufsize)
40 {
41 	const struct got_error *err = NULL;
42 	int zerr;
43 
44 	memset(zb, 0, sizeof(*zb));
45 
46 	zb->z.zalloc = Z_NULL;
47 	zb->z.zfree = Z_NULL;
48 	zerr = deflateInit(&zb->z, Z_DEFAULT_COMPRESSION);
49 	if (zerr != Z_OK) {
50 		if  (zerr == Z_ERRNO)
51 			return got_error_from_errno("deflateInit");
52 		if  (zerr == Z_MEM_ERROR) {
53 			errno = ENOMEM;
54 			return got_error_from_errno("deflateInit");
55 		}
56 		return got_error(GOT_ERR_COMPRESSION);
57 	}
58 
59 	zb->inlen = zb->outlen = bufsize;
60 
61 	zb->inbuf = calloc(1, zb->inlen);
62 	if (zb->inbuf == NULL) {
63 		err = got_error_from_errno("calloc");
64 		goto done;
65 	}
66 
67 	zb->flags = 0;
68 	if (outbuf == NULL) {
69 		zb->outbuf = calloc(1, zb->outlen);
70 		if (zb->outbuf == NULL) {
71 			err = got_error_from_errno("calloc");
72 			goto done;
73 		}
74 		zb->flags |= GOT_DEFLATE_F_OWN_OUTBUF;
75 	} else
76 		zb->outbuf = outbuf;
77 done:
78 	if (err)
79 		got_deflate_end(zb);
80 	return err;
81 }
82 
83 static void
84 csum_output(struct got_deflate_checksum *csum, const uint8_t *buf, size_t len)
85 {
86 	if (csum->output_crc)
87 		*csum->output_crc = crc32(*csum->output_crc, buf, len);
88 
89 	if (csum->output_sha1)
90 		SHA1Update(csum->output_sha1, buf, len);
91 
92 	if (csum->output_ctx)
93 		got_hash_update(csum->output_ctx, buf, len);
94 }
95 
96 const struct got_error *
97 got_deflate_read(struct got_deflate_buf *zb, FILE *f, off_t len,
98     size_t *outlenp, off_t *consumed)
99 {
100 	size_t last_total_out = zb->z.total_out;
101 	z_stream *z = &zb->z;
102 	int ret = Z_ERRNO;
103 
104 	z->next_out = zb->outbuf;
105 	z->avail_out = zb->outlen;
106 
107 	*outlenp = 0;
108 	*consumed = 0;
109 	do {
110 		size_t last_total_in = z->total_in;
111 		if (z->avail_in == 0) {
112 			size_t n = 0;
113 			if (*consumed < len) {
114 				n = fread(zb->inbuf, 1,
115 				    MIN(zb->inlen, len - *consumed), f);
116 			}
117 			if (n == 0) {
118 				if (ferror(f))
119 					return got_ferror(f, GOT_ERR_IO);
120 				/* EOF */
121 				ret = deflate(z, Z_FINISH);
122 				break;
123 			}
124 			z->next_in = zb->inbuf;
125 			z->avail_in = n;
126 		}
127 		ret = deflate(z, Z_NO_FLUSH);
128 		*consumed += z->total_in - last_total_in;
129 	} while (ret == Z_OK && z->avail_out > 0);
130 
131 	if (ret == Z_OK) {
132 		zb->flags |= GOT_DEFLATE_F_HAVE_MORE;
133 	} else {
134 		if (ret != Z_STREAM_END)
135 			return got_error(GOT_ERR_COMPRESSION);
136 		zb->flags &= ~GOT_DEFLATE_F_HAVE_MORE;
137 	}
138 
139 	*outlenp = z->total_out - last_total_out;
140 	return NULL;
141 }
142 
143 static const struct got_error *
144 deflate_read_mmap(struct got_deflate_buf *zb, uint8_t *map, size_t offset,
145     size_t len, size_t *outlenp, size_t *consumed, int flush_on_eof)
146 {
147 	z_stream *z = &zb->z;
148 	size_t last_total_out = z->total_out;
149 	int ret = Z_ERRNO;
150 
151 	z->next_out = zb->outbuf;
152 	z->avail_out = zb->outlen;
153 
154 	*outlenp = 0;
155 	*consumed = 0;
156 	do {
157 		size_t last_total_in = z->total_in;
158 		if (z->avail_in == 0) {
159 			z->next_in = map + offset + *consumed;
160 			if (len - *consumed > UINT_MAX)
161 				z->avail_in = UINT_MAX;
162 			else
163 				z->avail_in = len - *consumed;
164 			if (z->avail_in == 0) {
165 				/* EOF */
166 				if (flush_on_eof)
167 					ret = deflate(z, Z_FINISH);
168 				break;
169 			}
170 		}
171 		ret = deflate(z, Z_NO_FLUSH);
172 		*consumed += z->total_in - last_total_in;
173 	} while (ret == Z_OK && z->avail_out > 0);
174 
175 	if (ret == Z_OK) {
176 		zb->flags |= GOT_DEFLATE_F_HAVE_MORE;
177 	} else {
178 		if (ret != Z_STREAM_END)
179 			return got_error(GOT_ERR_COMPRESSION);
180 		zb->flags &= ~GOT_DEFLATE_F_HAVE_MORE;
181 	}
182 
183 	*outlenp = z->total_out - last_total_out;
184 	return NULL;
185 }
186 
187 const struct got_error *
188 got_deflate_read_mmap(struct got_deflate_buf *zb, uint8_t *map, size_t offset,
189     size_t len, size_t *outlenp, size_t *consumed)
190 {
191 	return deflate_read_mmap(zb, map, offset, len, outlenp, consumed, 1);
192 }
193 
194 const struct got_error *
195 got_deflate_flush(struct got_deflate_buf *zb, FILE *outfile,
196     struct got_deflate_checksum *csum, off_t *outlenp)
197 {
198 	int ret;
199 	size_t n;
200 	z_stream *z = &zb->z;
201 
202 	if (z->avail_in != 0)
203 		return got_error_msg(GOT_ERR_COMPRESSION,
204 		    "cannot flush zb with pending input data");
205 
206 	do {
207 		size_t avail, last_total_out = zb->z.total_out;
208 
209 		z->next_out = zb->outbuf;
210 		z->avail_out = zb->outlen;
211 
212 		ret = deflate(z, Z_FINISH);
213 		if (ret != Z_STREAM_END && ret != Z_OK)
214 			return got_error(GOT_ERR_COMPRESSION);
215 
216 		avail = z->total_out - last_total_out;
217 		if (avail > 0) {
218 			n = fwrite(zb->outbuf, avail, 1, outfile);
219 			if (n != 1)
220 				return got_ferror(outfile, GOT_ERR_IO);
221 			if (csum)
222 				csum_output(csum, zb->outbuf, avail);
223 			if (outlenp)
224 				*outlenp += avail;
225 		}
226 	} while (ret != Z_STREAM_END);
227 
228 	zb->flags &= ~GOT_DEFLATE_F_HAVE_MORE;
229 	return NULL;
230 }
231 
232 void
233 got_deflate_end(struct got_deflate_buf *zb)
234 {
235 	free(zb->inbuf);
236 	if (zb->flags & GOT_DEFLATE_F_OWN_OUTBUF)
237 		free(zb->outbuf);
238 	deflateEnd(&zb->z);
239 }
240 
241 const struct got_error *
242 got_deflate_to_fd(off_t *outlen, FILE *infile, off_t len, int outfd,
243     struct got_deflate_checksum *csum)
244 {
245 	const struct got_error *err;
246 	size_t avail;
247 	off_t consumed;
248 	struct got_deflate_buf zb;
249 
250 	err = got_deflate_init(&zb, NULL, GOT_DEFLATE_BUFSIZE);
251 	if (err)
252 		goto done;
253 
254 	*outlen = 0;
255 
256 	do {
257 		err = got_deflate_read(&zb, infile, len, &avail, &consumed);
258 		if (err)
259 			goto done;
260 		len -= consumed;
261 		if (avail > 0) {
262 			err = got_poll_write_full(outfd, zb.outbuf, avail);
263 			if (err)
264 				goto done;
265 			if (csum)
266 				csum_output(csum, zb.outbuf, avail);
267 			*outlen += avail;
268 		}
269 	} while (zb.flags & GOT_DEFLATE_F_HAVE_MORE);
270 
271 done:
272 	got_deflate_end(&zb);
273 	return err;
274 }
275 
276 const struct got_error *
277 got_deflate_to_fd_mmap(off_t *outlen, uint8_t *map, size_t offset,
278     size_t len, int outfd, struct got_deflate_checksum *csum)
279 {
280 	const struct got_error *err;
281 	size_t avail, consumed;
282 	struct got_deflate_buf zb;
283 
284 	err = got_deflate_init(&zb, NULL, GOT_DEFLATE_BUFSIZE);
285 	if (err)
286 		goto done;
287 
288 	*outlen = 0;
289 	do {
290 		err = got_deflate_read_mmap(&zb, map, offset, len, &avail,
291 		    &consumed);
292 		if (err)
293 			goto done;
294 		offset += consumed;
295 		len -= consumed;
296 		if (avail > 0) {
297 			err = got_poll_write_full(outfd, zb.outbuf, avail);
298 			if (err)
299 				goto done;
300 			if (csum)
301 				csum_output(csum, zb.outbuf, avail);
302 			*outlen += avail;
303 		}
304 	} while (zb.flags & GOT_DEFLATE_F_HAVE_MORE);
305 
306 done:
307 	got_deflate_end(&zb);
308 	return err;
309 }
310 
311 const struct got_error *
312 got_deflate_to_file(off_t *outlen, FILE *infile, off_t len,
313     FILE *outfile, struct got_deflate_checksum *csum)
314 {
315 	const struct got_error *err;
316 	size_t avail;
317 	off_t consumed;
318 	struct got_deflate_buf zb;
319 
320 	err = got_deflate_init(&zb, NULL, GOT_DEFLATE_BUFSIZE);
321 	if (err)
322 		goto done;
323 
324 	*outlen = 0;
325 
326 	do {
327 		err = got_deflate_read(&zb, infile, len, &avail, &consumed);
328 		if (err)
329 			goto done;
330 		len -= consumed;
331 		if (avail > 0) {
332 			size_t n;
333 			n = fwrite(zb.outbuf, avail, 1, outfile);
334 			if (n != 1) {
335 				err = got_ferror(outfile, GOT_ERR_IO);
336 				goto done;
337 			}
338 			if (csum)
339 				csum_output(csum, zb.outbuf, avail);
340 			*outlen += avail;
341 		}
342 	} while (zb.flags & GOT_DEFLATE_F_HAVE_MORE);
343 
344 done:
345 	got_deflate_end(&zb);
346 	return err;
347 }
348 
349 const struct got_error *
350 got_deflate_to_file_mmap(off_t *outlen, uint8_t *map, size_t offset,
351     size_t len, FILE *outfile, struct got_deflate_checksum *csum)
352 {
353 	const struct got_error *err;
354 	size_t avail, consumed;
355 	struct got_deflate_buf zb;
356 
357 	err = got_deflate_init(&zb, NULL, GOT_DEFLATE_BUFSIZE);
358 	if (err)
359 		goto done;
360 
361 	*outlen = 0;
362 	do {
363 		err = got_deflate_read_mmap(&zb, map, offset, len, &avail,
364 		    &consumed);
365 		if (err)
366 			goto done;
367 		offset += consumed;
368 		len -= consumed;
369 		if (avail > 0) {
370 			size_t n;
371 			n = fwrite(zb.outbuf, avail, 1, outfile);
372 			if (n != 1) {
373 				err = got_ferror(outfile, GOT_ERR_IO);
374 				goto done;
375 			}
376 			if (csum)
377 				csum_output(csum, zb.outbuf, avail);
378 			*outlen += avail;
379 		}
380 	} while (zb.flags & GOT_DEFLATE_F_HAVE_MORE);
381 
382 done:
383 	got_deflate_end(&zb);
384 	return err;
385 }
386 
387 const struct got_error *
388 got_deflate_append_to_file_mmap(struct got_deflate_buf *zb, off_t *outlen,
389     uint8_t *map, size_t offset, size_t len, FILE *outfile,
390     struct got_deflate_checksum *csum)
391 {
392 	const struct got_error *err;
393 	size_t avail, consumed;
394 
395 	do {
396 		err = deflate_read_mmap(zb, map, offset, len, &avail,
397 		    &consumed, 0);
398 		if (err)
399 			break;
400 		offset += consumed;
401 		len -= consumed;
402 		if (avail > 0) {
403 			size_t n;
404 			n = fwrite(zb->outbuf, avail, 1, outfile);
405 			if (n != 1) {
406 				err = got_ferror(outfile, GOT_ERR_IO);
407 				break;
408 			}
409 			if (csum)
410 				csum_output(csum, zb->outbuf, avail);
411 			if (outlen)
412 				*outlen += avail;
413 		}
414 	} while ((zb->flags & GOT_DEFLATE_F_HAVE_MORE) && len > 0);
415 
416 	return err;
417 }
418 
419 const struct got_error *
420 got_deflate_to_mem_mmap(uint8_t **outbuf, size_t *outlen,
421     size_t *consumed_total, struct got_deflate_checksum *csum, uint8_t *map,
422     size_t offset, size_t len)
423 {
424 	const struct got_error *err;
425 	size_t avail, consumed;
426 	struct got_deflate_buf zb;
427 	void *newbuf;
428 	size_t nbuf = 1;
429 
430 	if (outbuf) {
431 		*outbuf = malloc(GOT_DEFLATE_BUFSIZE);
432 		if (*outbuf == NULL)
433 			return got_error_from_errno("malloc");
434 		err = got_deflate_init(&zb, *outbuf, GOT_DEFLATE_BUFSIZE);
435 		if (err) {
436 			free(*outbuf);
437 			*outbuf = NULL;
438 			return err;
439 		}
440 	} else {
441 		err = got_deflate_init(&zb, NULL, GOT_DEFLATE_BUFSIZE);
442 		if (err)
443 			return err;
444 	}
445 
446 	*outlen = 0;
447 	if (consumed_total)
448 		*consumed_total = 0;
449 	do {
450 		err = got_deflate_read_mmap(&zb, map, offset, len, &avail,
451 		    &consumed);
452 		if (err)
453 			goto done;
454 		offset += consumed;
455 		if (consumed_total)
456 			*consumed_total += consumed;
457 		len -= consumed;
458 		if (avail > 0 && csum)
459 			csum_output(csum, zb.outbuf, avail);
460 		*outlen += avail;
461 		if ((zb.flags & GOT_DEFLATE_F_HAVE_MORE) && outbuf != NULL) {
462 			newbuf = reallocarray(*outbuf, ++nbuf,
463 			    GOT_DEFLATE_BUFSIZE);
464 			if (newbuf == NULL) {
465 				err = got_error_from_errno("reallocarray");
466 				free(*outbuf);
467 				*outbuf = NULL;
468 				*outlen = 0;
469 				goto done;
470 			}
471 			*outbuf = newbuf;
472 			zb.outbuf = newbuf + *outlen;
473 			zb.outlen = (nbuf * GOT_DEFLATE_BUFSIZE) - *outlen;
474 		}
475 	} while (zb.flags & GOT_DEFLATE_F_HAVE_MORE);
476 done:
477 	got_deflate_end(&zb);
478 	return err;
479 }