eb436c46691648fd89d8a7cc26078b3fb8a48c7b
[gnupg.git] / common / membuf.c
1 /* membuf.c - A simple implementation of a dynamic buffer
2  *      Copyright (C) 2001, 2003 Free Software Foundation, Inc.
3  *
4  * This file is part of GnuPG.
5  *
6  * GnuPG is free software; you can redistribute it and/or modify
7  * it under the terms of the GNU General Public License as published by
8  * the Free Software Foundation; either version 2 of the License, or
9  * (at your option) any later version.
10  *
11  * GnuPG 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
14  * GNU General Public License for more details.
15  *
16  * You should have received a copy of the GNU General Public License
17  * along with this program; if not, write to the Free Software
18  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301,
19  * USA.
20  */
21
22 #include <config.h>
23 #include <stdlib.h>
24 #include <errno.h>
25
26 #include "membuf.h"
27
28 #include "util.h"
29
30
31 /* A simple implementation of a dynamic buffer.  Use init_membuf() to
32    create a buffer, put_membuf to append bytes and get_membuf to
33    release and return the buffer.  Allocation errors are detected but
34    only returned at the final get_membuf(), this helps not to clutter
35    the code with out of core checks.  */
36
37 void
38 init_membuf (membuf_t *mb, int initiallen)
39 {
40   mb->len = 0;
41   mb->size = initiallen;
42   mb->out_of_core = 0;
43   mb->buf = xtrymalloc (initiallen);
44   if (!mb->buf)
45     mb->out_of_core = errno;
46 }
47
48 /* Same as init_membuf but allocates the buffer in secure memory.  */
49 void
50 init_membuf_secure (membuf_t *mb, int initiallen)
51 {
52   mb->len = 0;
53   mb->size = initiallen;
54   mb->out_of_core = 0;
55   mb->buf = xtrymalloc_secure (initiallen);
56   if (!mb->buf)
57     mb->out_of_core = errno;
58 }
59
60
61 void
62 put_membuf (membuf_t *mb, const void *buf, size_t len)
63 {
64   if (mb->out_of_core)
65     return;
66
67   if (mb->len + len >= mb->size)
68     {
69       char *p;
70       
71       mb->size += len + 1024;
72       p = xtryrealloc (mb->buf, mb->size);
73       if (!p)
74         {
75           mb->out_of_core = errno ? errno : ENOMEM;
76           /* Wipe out what we already accumulated.  This is required
77              in case we are storing sensitive data here.  The membuf
78              API does not provide another way to cleanup after an
79              error. */ 
80           memset (mb->buf, 0, mb->len);
81           return;
82         }
83       mb->buf = p;
84     }
85   memcpy (mb->buf + mb->len, buf, len);
86   mb->len += len;
87 }
88
89
90 void
91 put_membuf_str (membuf_t *mb, const char *string)
92 {
93   put_membuf (mb, string, strlen (string));
94 }
95
96
97 void *
98 get_membuf (membuf_t *mb, size_t *len)
99 {
100   char *p;
101
102   if (mb->out_of_core)
103     {
104       xfree (mb->buf);
105       mb->buf = NULL;
106       errno = mb->out_of_core;
107       return NULL;
108     }
109
110   p = mb->buf;
111   if (len)
112     *len = mb->len;
113   mb->buf = NULL;
114   mb->out_of_core = ENOMEM; /* hack to make sure it won't get reused. */
115   return p;
116 }