1
/* -*- Mode: C; indent-tabs-mode: t; c-basic-offset: 8; tab-width: 8 -*- */
2
/* egg-buffer.c - Generic data buffer, used by openssh, gnome-keyring
4
Copyright (C) 2007 Stefan Walter
6
The Gnome Keyring Library is free software; you can redistribute it and/or
7
modify it under the terms of the GNU Library General Public License as
8
published by the Free Software Foundation; either version 2 of the
9
License, or (at your option) any later version.
11
The Gnome Keyring Library is distributed in the hope that it will be useful,
12
but WITHOUT ANY WARRANTY; without even the implied warranty of
13
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14
Library General Public License for more details.
16
You should have received a copy of the GNU Library General Public
17
License along with the Gnome Library; see the file COPYING.LIB. If not,
18
write to the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
19
Boston, MA 02111-1307, USA.
21
Author: Stef Walter <stef@memberwebs.com>
28
#include "egg-buffer.h"
30
#define DEFAULT_ALLOCATOR ((EggBufferAllocator)realloc)
33
egg_buffer_init (EggBuffer *buffer, size_t reserve)
35
return egg_buffer_init_full (buffer, reserve, NULL);
39
egg_buffer_init_full (EggBuffer *buffer, size_t reserve, EggBufferAllocator allocator)
41
memset (buffer, 0, sizeof (*buffer));
44
allocator = DEFAULT_ALLOCATOR;
48
buffer->buf = (allocator) (NULL, reserve);
55
buffer->allocated_len = reserve;
57
buffer->allocator = allocator;
63
egg_buffer_init_static (EggBuffer* buffer, const unsigned char *buf, size_t len)
65
memset (buffer, 0, sizeof (*buffer));
67
buffer->buf = (unsigned char*)buf;
69
buffer->allocated_len = len;
72
/* A null allocator, and the buffer can't change in size */
73
buffer->allocator = NULL;
77
egg_buffer_init_allocated (EggBuffer *buffer, unsigned char *buf, size_t len,
78
EggBufferAllocator allocator)
80
memset (buffer, 0, sizeof (*buffer));
83
allocator = DEFAULT_ALLOCATOR;
87
buffer->allocated_len = len;
89
buffer->allocator = allocator;
93
egg_buffer_reset (EggBuffer *buffer)
95
memset (buffer->buf, 0, buffer->allocated_len);
101
egg_buffer_uninit (EggBuffer *buffer)
107
* Free the memory block using allocator. If no allocator,
108
* then this memory is ownerd elsewhere and not to be freed.
110
if (buffer->buf && buffer->allocator)
111
(buffer->allocator) (buffer->buf, 0);
113
memset (buffer, 0, sizeof (*buffer));
117
egg_buffer_uninit_steal (EggBuffer *buffer, size_t *n_result)
119
unsigned char *result;
122
*n_result = buffer->len;
123
result = buffer->buf;
125
memset (buffer, 0, sizeof (*buffer));
131
egg_buffer_set_allocator (EggBuffer *buffer, EggBufferAllocator allocator)
133
unsigned char *buf = NULL;
136
allocator = DEFAULT_ALLOCATOR;
137
if (buffer->allocator == allocator)
140
if (buffer->allocated_len) {
141
/* Reallocate memory block using new allocator */
142
buf = (allocator) (NULL, buffer->allocated_len);
146
/* Copy stuff into new memory */
147
memcpy (buf, buffer->buf, buffer->allocated_len);
150
/* If old wasn't static, then free it */
151
if (buffer->allocator && buffer->buf)
152
(buffer->allocator) (buffer->buf, 0);
155
buffer->allocator = allocator;
161
egg_buffer_equal (EggBuffer *b1, EggBuffer *b2)
163
if (b1->len != b2->len)
165
return memcmp (b1->buf, b2->buf, b1->len) == 0;
169
egg_buffer_reserve (EggBuffer *buffer, size_t len)
171
unsigned char *newbuf;
174
if (len < buffer->allocated_len)
177
/* Calculate a new length, minimize number of buffer allocations */
178
newlen = buffer->allocated_len * 2;
182
/* Memory owned elsewhere can't be reallocated */
183
if (!buffer->allocator) {
188
/* Reallocate built in buffer using allocator */
189
newbuf = (buffer->allocator) (buffer->buf, newlen);
195
buffer->buf = newbuf;
196
buffer->allocated_len = newlen;
202
egg_buffer_resize (EggBuffer *buffer, size_t len)
204
if (!egg_buffer_reserve (buffer, len))
212
egg_buffer_add_empty (EggBuffer *buffer, size_t len)
214
size_t pos = buffer->len;
215
if (!egg_buffer_reserve (buffer, buffer->len + len))
218
return buffer->buf + pos;
222
egg_buffer_append (EggBuffer *buffer, const unsigned char *val,
225
if (!egg_buffer_reserve (buffer, buffer->len + len))
226
return 0; /* failures already incremented */
227
memcpy (buffer->buf + buffer->len, val, len);
233
egg_buffer_add_byte (EggBuffer *buffer, unsigned char val)
235
if (!egg_buffer_reserve (buffer, buffer->len + 1))
236
return 0; /* failures already incremented */
237
buffer->buf[buffer->len] = val;
243
egg_buffer_get_byte (EggBuffer *buffer, size_t offset,
244
size_t *next_offset, unsigned char *val)
247
if (buffer->len < 1 || offset > buffer->len - 1) {
251
ptr = (unsigned char*)buffer->buf + offset;
254
if (next_offset != NULL)
255
*next_offset = offset + 1;
260
egg_buffer_encode_uint16 (unsigned char* buf, uint16_t val)
262
buf[0] = (val >> 8) & 0xff;
263
buf[1] = (val >> 0) & 0xff;
267
egg_buffer_decode_uint16 (unsigned char* buf)
269
uint16_t val = buf[0] << 8 | buf[1];
274
egg_buffer_add_uint16 (EggBuffer *buffer, uint16_t val)
276
if (!egg_buffer_reserve (buffer, buffer->len + 2))
277
return 0; /* failures already incremented */
279
egg_buffer_set_uint16 (buffer, buffer->len - 2, val);
284
egg_buffer_set_uint16 (EggBuffer *buffer, size_t offset, uint16_t val)
287
if (buffer->len < 2 || offset > buffer->len - 2) {
291
ptr = (unsigned char*)buffer->buf + offset;
292
egg_buffer_encode_uint16 (ptr, val);
297
egg_buffer_get_uint16 (EggBuffer *buffer, size_t offset,
298
size_t *next_offset, uint16_t *val)
301
if (buffer->len < 2 || offset > buffer->len - 2) {
305
ptr = (unsigned char*)buffer->buf + offset;
307
*val = egg_buffer_decode_uint16 (ptr);
308
if (next_offset != NULL)
309
*next_offset = offset + 2;
314
egg_buffer_encode_uint32 (unsigned char* buf, uint32_t val)
316
buf[0] = (val >> 24) & 0xff;
317
buf[1] = (val >> 16) & 0xff;
318
buf[2] = (val >> 8) & 0xff;
319
buf[3] = (val >> 0) & 0xff;
323
egg_buffer_decode_uint32 (unsigned char* ptr)
325
uint32_t val = ptr[0] << 24 | ptr[1] << 16 | ptr[2] << 8 | ptr[3];
330
egg_buffer_add_uint32 (EggBuffer *buffer, uint32_t val)
332
if (!egg_buffer_reserve (buffer, buffer->len + 4))
333
return 0; /* failures already incremented */
335
egg_buffer_set_uint32 (buffer, buffer->len - 4, val);
340
egg_buffer_set_uint32 (EggBuffer *buffer, size_t offset, uint32_t val)
343
if (buffer->len < 4 || offset > buffer->len - 4) {
347
ptr = (unsigned char*)buffer->buf + offset;
348
egg_buffer_encode_uint32 (ptr, val);
353
egg_buffer_get_uint32 (EggBuffer *buffer, size_t offset, size_t *next_offset,
357
if (buffer->len < 4 || offset > buffer->len - 4) {
361
ptr = (unsigned char*)buffer->buf + offset;
363
*val = egg_buffer_decode_uint32 (ptr);
364
if (next_offset != NULL)
365
*next_offset = offset + 4;
370
egg_buffer_add_uint64 (EggBuffer *buffer, uint64_t val)
372
if (!egg_buffer_add_uint32 (buffer, ((val >> 32) & 0xffffffff)))
374
return egg_buffer_add_uint32 (buffer, (val & 0xffffffff));
378
egg_buffer_get_uint64 (EggBuffer *buffer, size_t offset,
379
size_t *next_offset, uint64_t *val)
382
if (!egg_buffer_get_uint32 (buffer, offset, &offset, &a))
384
if (!egg_buffer_get_uint32 (buffer, offset, &offset, &b))
387
*val = ((uint64_t)a) << 32 | b;
388
if (next_offset != NULL)
389
*next_offset = offset;
394
egg_buffer_add_byte_array (EggBuffer *buffer, const unsigned char *val,
398
return egg_buffer_add_uint32 (buffer, 0xffffffff);
399
if (len >= 0x7fffffff) {
403
if (!egg_buffer_add_uint32 (buffer, len))
405
return egg_buffer_append (buffer, val, len);
409
egg_buffer_add_byte_array_empty (EggBuffer *buffer, size_t vlen)
411
if (vlen >= 0x7fffffff) {
415
if (!egg_buffer_add_uint32 (buffer, vlen))
417
return egg_buffer_add_empty (buffer, vlen);
421
egg_buffer_get_byte_array (EggBuffer *buffer, size_t offset,
422
size_t *next_offset, const unsigned char **val,
426
if (!egg_buffer_get_uint32 (buffer, offset, &offset, &len))
428
if (len == 0xffffffff) {
430
*next_offset = offset;
436
} else if (len >= 0x7fffffff) {
441
if (buffer->len < len || offset > buffer->len - len) {
447
*val = buffer->buf + offset;
451
*next_offset = offset + len;
457
egg_buffer_add_string (EggBuffer *buffer, const char *str)
460
return egg_buffer_add_uint32 (buffer, 0xffffffff);
462
size_t len = strlen (str);
463
if (len >= 0x7fffffff)
465
if (!egg_buffer_add_uint32 (buffer, len))
467
return egg_buffer_append (buffer, (unsigned char*)str, len);
472
egg_buffer_get_string (EggBuffer *buffer, size_t offset, size_t *next_offset,
473
char **str_ret, EggBufferAllocator allocator)
478
allocator = buffer->allocator;
480
allocator = DEFAULT_ALLOCATOR;
482
if (!egg_buffer_get_uint32 (buffer, offset, &offset, &len)) {
485
if (len == 0xffffffff) {
486
*next_offset = offset;
489
} else if (len >= 0x7fffffff) {
493
if (buffer->len < len ||
494
offset > buffer->len - len) {
498
/* Make sure no null characters in string */
499
if (memchr (buffer->buf + offset, 0, len) != NULL)
502
/* The passed allocator may be for non-pageable memory */
503
*str_ret = (allocator) (NULL, len + 1);
506
memcpy (*str_ret, buffer->buf + offset, len);
508
/* Always zero terminate */
510
*next_offset = offset + len;
516
egg_buffer_add_stringv (EggBuffer *buffer, const char** strv)
524
/* Add the number of strings coming */
525
for (v = strv; *v; ++v)
527
if (!egg_buffer_add_uint32 (buffer, n))
530
/* Add the individual strings */
531
for (v = strv; *v; ++v) {
532
if (!egg_buffer_add_string (buffer, *v))
540
egg_buffer_get_stringv (EggBuffer *buffer, size_t offset, size_t *next_offset,
541
char ***strv_ret, EggBufferAllocator allocator)
547
allocator = buffer->allocator;
549
allocator = DEFAULT_ALLOCATOR;
551
/* First the number of environment variable lines */
552
if (!egg_buffer_get_uint32 (buffer, offset, &offset, &n))
555
/* Then that number of strings */
556
len = (n + 1) * sizeof (char*);
557
*strv_ret = (char**)(allocator) (NULL, len);
561
/* All null strings */
562
memset (*strv_ret, 0, len);
564
for (i = 0; i < n; ++i) {
565
if (!egg_buffer_get_string (buffer, offset, &offset,
566
&((*strv_ret)[i]), allocator)) {
568
/* Free all the strings on failure */
569
for (j = 0; j < i; ++j) {
571
(allocator) ((*strv_ret)[j], 0);
578
if (next_offset != NULL)
579
*next_offset = offset;