Use inline functions to convert buffer data to scalars.
[gnupg.git] / g13 / utils.c
1 /* utils.c - Utility functions
2  * Copyright (C) 2009 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 3 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, see <http://www.gnu.org/licenses/>.
18  */
19
20 #include <config.h>
21 #include <stdio.h>
22 #include <stdlib.h>
23 #include <string.h>
24 #include <errno.h>
25 #include <assert.h>
26
27 #include "g13.h"
28 #include "utils.h"
29
30
31 /* Definition of the tuple descriptor object.  */
32 struct tupledesc_s
33 {
34   unsigned char *data; /* The tuple data.  */
35   size_t datalen;      /* The length of the data.  */
36   size_t pos;          /* The current position as used by next_tuple.  */
37   int refcount;        /* Number of references hold. */
38 };
39
40
41
42 /* Append the TAG and the VALUE to the MEMBUF.  There is no error
43    checking here; this is instead done while getting the value back
44    from the membuf. */
45 void
46 append_tuple (membuf_t *membuf, int tag, const void *value, size_t length)
47 {
48   unsigned char buf[2];
49
50   assert (tag >= 0 && tag <= 0xffff);
51   assert (length <= 0xffff);
52
53   buf[0] = tag >> 8;
54   buf[1] = tag;
55   put_membuf (membuf, buf, 2);
56   buf[0] = length >> 8;
57   buf[1] = length;
58   put_membuf (membuf, buf, 2);
59   if (length)
60     put_membuf (membuf, value, length);
61 }
62
63
64 /* Create a tuple object by moving the ownership of (DATA,DATALEN) to
65    a new object.  Returns 0 on success and stores the new object at
66    R_TUPLEHD.  The return object must be released using
67    destroy_tuples().  */
68 gpg_error_t
69 create_tupledesc (tupledesc_t *r_desc, void *data, size_t datalen)
70 {
71   if (datalen < 5 || memcmp (data, "\x00\x00\x00\x01\x01", 5))
72     return gpg_error (GPG_ERR_NOT_SUPPORTED);
73
74   *r_desc = xtrymalloc (sizeof **r_desc);
75   if (!*r_desc)
76     return gpg_error_from_syserror ();
77   (*r_desc)->data = data;
78   (*r_desc)->datalen = datalen;
79   (*r_desc)->pos = 0;
80   (*r_desc)->refcount++;
81   return 0;
82 }
83
84 /* Unref a tuple descriptor and if the refcount is down to 0 release
85    its allocated storage.  */
86 void
87 destroy_tupledesc (tupledesc_t tupledesc)
88 {
89   if (!tupledesc)
90     return;
91
92   if (!--tupledesc->refcount)
93     {
94       xfree (tupledesc->data);
95       xfree (tupledesc);
96     }
97 }
98
99
100 tupledesc_t
101 ref_tupledesc (tupledesc_t tupledesc)
102 {
103   if (tupledesc)
104     tupledesc->refcount++;
105   return tupledesc;
106 }
107
108
109 /* Find the first tuple with tag TAG.  On success return a pointer to
110    its value and store the length of the value at R_LENGTH.  If no
111    tuple was return NULL.  For future use by next_tupe, the last
112    position is stored in the descriptor.  */
113 const void *
114 find_tuple (tupledesc_t tupledesc, unsigned int tag, size_t *r_length)
115 {
116   const unsigned char *s;
117   const unsigned char *s_end; /* Points right behind the data. */
118   unsigned int t;
119   size_t n;
120
121   s = tupledesc->data;
122   if (!s)
123     return NULL;
124   s_end = s + tupledesc->datalen;
125   while (s < s_end)
126     {
127       if (s+3 >= s_end || s + 3 < s)
128         break;
129       t  = s[0] << 8;
130       t |= s[1];
131       n  = s[2] << 8;
132       n |= s[3];
133       s += 4;
134       if (s + n > s_end || s + n < s)
135         break;
136       if (t == tag)
137         {
138           tupledesc->pos = (s + n) - tupledesc->data;
139           *r_length = n;
140           return s;
141         }
142       s += n;
143     }
144   return NULL;
145 }
146
147
148 const void *
149 next_tuple (tupledesc_t tupledesc, unsigned int *r_tag, size_t *r_length)
150 {
151   const unsigned char *s;
152   const unsigned char *s_end; /* Points right behind the data.  */
153   unsigned int t;
154   size_t n;
155
156   s = tupledesc->data;
157   if (!s)
158     return NULL;
159   s_end = s + tupledesc->datalen;
160   s += tupledesc->pos;
161   if (s < s_end
162       && !(s+3 >= s_end || s + 3 < s))
163     {
164       t  = s[0] << 8;
165       t |= s[1];
166       n  = s[2] << 8;
167       n |= s[3];
168       s += 4;
169       if (!(s + n > s_end || s + n < s))
170         {
171           tupledesc->pos = (s + n) - tupledesc->data;
172           *r_tag = t;
173           *r_length = n;
174           return s;
175         }
176     }
177
178   return NULL;
179 }