1 /*
2  * Copyright (c) 2018 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 <stdio.h>
20 #include <stdlib.h>
21 #include <string.h>
22 #include <zlib.h>
23 #include <sha1.h>
24 #include <time.h>
25 
26 #include "got_error.h"
27 #include "got_repository.h"
28 #include "got_object.h"
29 
30 #include "got_lib_delta.h"
31 #include "got_lib_path.h"
32 #include "got_lib_inflate.h"
33 
34 #ifndef MIN
35 #define	MIN(_a,_b) ((_a) < (_b) ? (_a) : (_b))
36 #endif
37 
38 struct got_delta *
39 got_delta_open(off_t offset, size_t tslen, int type, size_t size,
40     off_t data_offset, uint8_t *delta_buf, size_t delta_len)
41 {
42 	struct got_delta *delta;
43 
44 	delta = calloc(1, sizeof(*delta));
45 	if (delta == NULL)
46 		return NULL;
47 
48 	delta->type = type;
49 	delta->offset = offset;
50 	delta->tslen = tslen;
51 	delta->size = size;
52 	delta->data_offset = data_offset;
53 	delta->delta_buf = delta_buf;
54 	delta->delta_len = delta_len;
55 	return delta;
56 }
57 
58 void
59 got_delta_close(struct got_delta *delta)
60 {
61 	free(delta->delta_buf);
62 	free(delta);
63 }
64 
65 const struct got_error *
66 got_delta_chain_get_base_type(int *type, struct got_delta_chain *deltas)
67 {
68 	struct got_delta *delta;
69 
70 	/* The first delta in the chain should represent the base object. */
71 	delta = SIMPLEQ_FIRST(&deltas->entries);
72 	if (delta->type == GOT_OBJ_TYPE_COMMIT ||
73 	    delta->type == GOT_OBJ_TYPE_TREE ||
74 	    delta->type == GOT_OBJ_TYPE_BLOB ||
75 	    delta->type == GOT_OBJ_TYPE_TAG) {
76 		*type = delta->type;
77 		return NULL;
78 	}
79 
80 	return got_error(GOT_ERR_BAD_DELTA_CHAIN);
81 }
82 
83 /* Fetch another (required) byte from the delta stream. */
84 static const struct got_error *
85 next_delta_byte(const uint8_t **p, size_t *remain)
86 {
87 	if (--(*remain) == 0)
88 		return got_error(GOT_ERR_BAD_DELTA);
89 	(*p)++;
90 	return NULL;
91 }
92 
93 static const struct got_error *
94 parse_size(uint64_t *size, const uint8_t **p, size_t *remain)
95 {
96 	const struct got_error *err = NULL;
97 	int i = 0;
98 
99 	*size = 0;
100 	do {
101 		/* We do not support size values which don't fit in 64 bit. */
102 		if (i > 9)
103 			return got_error(GOT_ERR_NO_SPACE);
104 
105 		if (i == 0)
106 			*size = ((**p) & GOT_DELTA_SIZE_VAL_MASK);
107 		else {
108 			size_t shift = GOT_DELTA_SIZE_SHIFT * i;
109 			*size |= (((**p) & GOT_DELTA_SIZE_VAL_MASK) << shift);
110 		}
111 
112 		if (((**p) & GOT_DELTA_SIZE_MORE) == 0)
113 			break;
114 		i++;
115 		err = next_delta_byte(p, remain);
116 	} while (err == NULL);
117 
118 	return err;
119 }
120 
121 static const struct got_error *
122 parse_opcode(off_t *offset, size_t *len, const uint8_t **p, size_t *remain)
123 {
124 	const struct got_error *err = NULL;
125 	off_t o = 0;
126 	size_t l = 0;
127 	uint8_t opcode = **p;
128 
129 	if (opcode & GOT_DELTA_COPY_OFF1) {
130 		err = next_delta_byte(p, remain);
131 		if (err)
132 			return err;
133 		o = (off_t)(**p);
134 	}
135 	if (opcode & GOT_DELTA_COPY_OFF2) {
136 		err = next_delta_byte(p, remain);
137 		if (err)
138 			return err;
139 		o |= ((off_t)(**p)) << 8;
140 	}
141 	if (opcode & GOT_DELTA_COPY_OFF3) {
142 		err = next_delta_byte(p, remain);
143 		if (err)
144 			return err;
145 		o |= ((off_t)(**p)) << 16;
146 	}
147 	if (opcode & GOT_DELTA_COPY_OFF4) {
148 		err = next_delta_byte(p, remain);
149 		if (err)
150 			return err;
151 		o |= ((off_t)(**p)) << 24;
152 	}
153 
154 	if (opcode & GOT_DELTA_COPY_LEN1) {
155 		err = next_delta_byte(p, remain);
156 		if (err)
157 			return err;
158 		l = (off_t)(**p);
159 	}
160 	if (opcode & GOT_DELTA_COPY_LEN2) {
161 		err = next_delta_byte(p, remain);
162 		if (err)
163 			return err;
164 		l |= ((off_t)(**p)) << 8;
165 	}
166 	if (opcode & GOT_DELTA_COPY_LEN3) {
167 		err = next_delta_byte(p, remain);
168 		if (err)
169 			return err;
170 		l |= ((off_t)(**p)) << 16;
171 	}
172 
173 	if (o == 0)
174 		o = GOT_DELTA_COPY_DEFAULT_OFF;
175 	if (l == 0)
176 		l = GOT_DELTA_COPY_DEFAULT_LEN;
177 
178 	*offset = o;
179 	*len = l;
180 	return NULL;
181 }
182 
183 static const struct got_error *
184 copy_from_base(FILE *base_file, off_t offset, size_t size, FILE *outfile)
185 {
186 	if (fseeko(base_file, offset, SEEK_SET) != 0)
187 		return got_error_from_errno();
188 
189 	while (size > 0) {
190 		uint8_t data[2048];
191 		size_t len = MIN(size, sizeof(data));
192 		size_t n;
193 
194 		n = fread(data, len, 1, base_file);
195 		if (n != 1)
196 			return got_ferror(base_file, GOT_ERR_IO);
197 
198 		n = fwrite(data, len, 1, outfile);
199 		if (n != 1)
200 			return got_ferror(outfile, GOT_ERR_IO);
201 
202 		size -= len;
203 	}
204 
205 	return NULL;
206 }
207 
208 static const struct got_error *
209 copy_from_delta(const uint8_t **p, size_t *remain, size_t len, FILE *outfile)
210 {
211 	size_t n;
212 
213 	if (*remain < len)
214 		return got_error(GOT_ERR_BAD_DELTA);
215 
216 	n = fwrite(*p, len, 1, outfile);
217 	if (n != 1)
218 		return got_ferror(outfile, GOT_ERR_IO);
219 
220 	*p += len;
221 	*remain -= len;
222 	return NULL;
223 }
224 
225 static const struct got_error *
226 parse_delta_sizes(uint64_t *base_size, uint64_t *result_size,
227     const uint8_t **p, size_t *remain)
228 {
229 	const struct got_error *err;
230 
231 	/* Read the two size fields at the beginning of the stream. */
232 	err = parse_size(base_size, p, remain);
233 	if (err)
234 		return err;
235 	err = next_delta_byte(p, remain);
236 	if (err)
237 		return err;
238 	err = parse_size(result_size, p, remain);
239 	if (err)
240 		return err;
241 
242 	return NULL;
243 }
244 
245 const struct got_error *
246 got_delta_get_sizes(uint64_t *base_size, uint64_t *result_size,
247     const uint8_t *delta_buf, size_t delta_len)
248 {
249 	size_t remain;
250 	const uint8_t *p;
251 
252 	if (delta_len < GOT_DELTA_STREAM_LENGTH_MIN)
253 		return got_error(GOT_ERR_BAD_DELTA);
254 
255 	p = delta_buf;
256 	remain = delta_len;
257 	return parse_delta_sizes(base_size, result_size, &p, &remain);
258 }
259 
260 const struct got_error *
261 got_delta_apply_in_mem(uint8_t *base_buf, const uint8_t *delta_buf,
262     size_t delta_len, uint8_t *outbuf, size_t *outsize)
263 {
264 	const struct got_error *err = NULL;
265 	uint64_t base_size, result_size;
266 	size_t remain;
267 	const uint8_t *p;
268 
269 	*outsize= 0;
270 
271 	if (delta_len < GOT_DELTA_STREAM_LENGTH_MIN)
272 		return got_error(GOT_ERR_BAD_DELTA);
273 
274 	p = delta_buf;
275 	remain = delta_len;
276 	err = parse_delta_sizes(&base_size, &result_size, &p, &remain);
277 	if (err)
278 		return err;
279 
280 	/* Decode and execute copy instructions from the delta stream. */
281 	err = next_delta_byte(&p, &remain);
282 	while (err == NULL && remain > 0) {
283 		if (*p & GOT_DELTA_BASE_COPY) {
284 			off_t offset = 0;
285 			size_t len = 0;
286 			err = parse_opcode(&offset, &len, &p, &remain);
287 			if (err)
288 				break;
289 			memcpy(outbuf + *outsize, base_buf + offset, len);
290 			if (err == NULL) {
291 				*outsize += len;
292 				if (remain > 0) {
293 					p++;
294 					remain--;
295 				}
296 			}
297 		} else {
298 			size_t len = (size_t)*p;
299 			if (len == 0) {
300 				err = got_error(GOT_ERR_BAD_DELTA);
301 				break;
302 			}
303 			err = next_delta_byte(&p, &remain);
304 			if (err)
305 				break;
306 			if (remain < len)
307 				return got_error(GOT_ERR_BAD_DELTA);
308 			memcpy(outbuf + *outsize, p, len);
309 			p += len;
310 			remain -= len;
311 			*outsize += len;
312 		}
313 	}
314 
315 	if (*outsize != result_size)
316 		err = got_error(GOT_ERR_BAD_DELTA);
317 	return err;
318 }
319 
320 const struct got_error *
321 got_delta_apply(FILE *base_file, const uint8_t *delta_buf,
322     size_t delta_len, FILE *outfile, size_t *outsize)
323 {
324 	const struct got_error *err = NULL;
325 	uint64_t base_size, result_size;
326 	size_t remain = 0;
327 	const uint8_t *p;
328 	FILE *memstream = NULL;
329 	char *memstream_buf = NULL;
330 	size_t memstream_size = 0;
331 
332 	*outsize = 0;
333 
334 	if (delta_len < GOT_DELTA_STREAM_LENGTH_MIN)
335 		return got_error(GOT_ERR_BAD_DELTA);
336 
337 	p = delta_buf;
338 	remain = delta_len;
339 	err = parse_delta_sizes(&base_size, &result_size, &p, &remain);
340 	if (err)
341 		return err;
342 
343 	if (result_size < GOT_DELTA_RESULT_SIZE_CACHED_MAX)
344 		memstream = open_memstream(&memstream_buf, &memstream_size);
345 
346 	/* Decode and execute copy instructions from the delta stream. */
347 	err = next_delta_byte(&p, &remain);
348 	while (err == NULL && remain > 0) {
349 		if (*p & GOT_DELTA_BASE_COPY) {
350 			off_t offset = 0;
351 			size_t len = 0;
352 			err = parse_opcode(&offset, &len, &p, &remain);
353 			if (err)
354 				break;
355 			err = copy_from_base(base_file, offset, len,
356 			    memstream ? memstream : outfile);
357 			if (err == NULL) {
358 				*outsize += len;
359 				if (remain > 0) {
360 					p++;
361 					remain--;
362 				}
363 			}
364 		} else {
365 			size_t len = (size_t)*p;
366 			if (len == 0) {
367 				err = got_error(GOT_ERR_BAD_DELTA);
368 				break;
369 			}
370 			err = next_delta_byte(&p, &remain);
371 			if (err)
372 				break;
373 			err = copy_from_delta(&p, &remain, len,
374 			    memstream ? memstream : outfile);
375 			if (err == NULL)
376 				*outsize += len;
377 		}
378 	}
379 
380 	if (*outsize != result_size)
381 		err = got_error(GOT_ERR_BAD_DELTA);
382 
383 	if (memstream != NULL) {
384 		fclose(memstream);
385 		if (err == NULL) {
386 			size_t n;
387 			n = fwrite(memstream_buf, 1, memstream_size, outfile);
388 			if (n != memstream_size)
389 				err = got_ferror(outfile, GOT_ERR_IO);
390 		}
391 		free(memstream_buf);
392 	}
393 	if (err == NULL)
394 		rewind(outfile);
395 	return err;
396 }