1 /* $OpenBSD: sshbuf.h,v 1.3 2014/06/24 01:13:21 djm Exp $ */
3 * Copyright (c) 2011 Damien Miller
5 * Permission to use, copy, modify, and distribute this software for any
6 * purpose with or without fee is hereby granted, provided that the above
7 * copyright notice and this permission notice appear in all copies.
9 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
10 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
11 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
12 * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
13 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
14 * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
15 * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
21 #include <sys/types.h>
25 # include <openssl/bn.h>
26 # ifdef OPENSSL_HAS_ECC
27 # include <openssl/ec.h>
28 # endif /* OPENSSL_HAS_ECC */
29 #endif /* WITH_OPENSSL */
31 #define SSHBUF_SIZE_MAX 0x8000000 /* Hard maximum size */
32 #define SSHBUF_REFS_MAX 0x100000 /* Max child buffers */
33 #define SSHBUF_MAX_BIGNUM (16384 / 8) /* Max bignum *bytes* */
34 #define SSHBUF_MAX_ECPOINT ((528 * 2 / 8) + 1) /* Max EC point *bytes* */
37 * NB. do not depend on the internals of this. It will be made opaque
42 const u_char
*cd
; /* Const data */
43 size_t off
; /* First available byte is buf->d + buf->off */
44 size_t size
; /* Last byte is buf->d + buf->size - 1 */
45 size_t max_size
; /* Maximum size of buffer */
46 size_t alloc
; /* Total bytes allocated to buf->d */
47 int readonly
; /* Refers to external, const data */
48 int dont_free
; /* Kludge to support sshbuf_init */
49 u_int refcount
; /* Tracks self and number of child buffers */
50 struct sshbuf
*parent
; /* If child, pointer to parent */
53 #ifndef SSHBUF_NO_DEPREACTED
55 * NB. Please do not use sshbuf_init() in new code. Please use sshbuf_new()
56 * instead. sshbuf_init() is deprectated and will go away soon (it is
57 * only included to allow compat with buffer_* in OpenSSH)
59 void sshbuf_init(struct sshbuf
*buf
);
63 * Create a new sshbuf buffer.
64 * Returns pointer to buffer on success, or NULL on allocation failure.
66 struct sshbuf
*sshbuf_new(void);
69 * Create a new, read-only sshbuf buffer from existing data.
70 * Returns pointer to buffer on success, or NULL on allocation failure.
72 struct sshbuf
*sshbuf_from(const void *blob
, size_t len
);
75 * Create a new, read-only sshbuf buffer from the contents of an existing
76 * buffer. The contents of "buf" must not change in the lifetime of the
78 * Returns pointer to buffer on success, or NULL on allocation failure.
80 struct sshbuf
*sshbuf_fromb(struct sshbuf
*buf
);
83 * Create a new, read-only sshbuf buffer from the contents of a string in
84 * an existing buffer (the string is consumed in the process).
85 * The contents of "buf" must not change in the lifetime of the resultant
87 * Returns pointer to buffer on success, or NULL on allocation failure.
89 int sshbuf_froms(struct sshbuf
*buf
, struct sshbuf
**bufp
);
94 void sshbuf_free(struct sshbuf
*buf
);
97 * Reset buf, clearing its contents. NB. max_size is preserved.
99 void sshbuf_reset(struct sshbuf
*buf
);
102 * Return the maximum size of buf
104 size_t sshbuf_max_size(const struct sshbuf
*buf
);
107 * Set the maximum size of buf
108 * Returns 0 on success, or a negative SSH_ERR_* error code on failure.
110 int sshbuf_set_max_size(struct sshbuf
*buf
, size_t max_size
);
113 * Returns the length of data in buf
115 size_t sshbuf_len(const struct sshbuf
*buf
);
118 * Returns number of bytes left in buffer before hitting max_size.
120 size_t sshbuf_avail(const struct sshbuf
*buf
);
123 * Returns a read-only pointer to the start of the the data in buf
125 const u_char
*sshbuf_ptr(const struct sshbuf
*buf
);
128 * Returns a mutable pointer to the start of the the data in buf, or
129 * NULL if the buffer is read-only.
131 u_char
*sshbuf_mutable_ptr(const struct sshbuf
*buf
);
134 * Check whether a reservation of size len will succeed in buf
135 * Safer to use than direct comparisons again sshbuf_avail as it copes
136 * with unsigned overflows correctly.
137 * Returns 0 on success, or a negative SSH_ERR_* error code on failure.
139 int sshbuf_check_reserve(const struct sshbuf
*buf
, size_t len
);
142 * Reserve len bytes in buf.
143 * Returns 0 on success and a pointer to the first reserved byte via the
144 * optional dpp parameter or a negative * SSH_ERR_* error code on failure.
146 int sshbuf_reserve(struct sshbuf
*buf
, size_t len
, u_char
**dpp
);
149 * Consume len bytes from the start of buf
150 * Returns 0 on success, or a negative SSH_ERR_* error code on failure.
152 int sshbuf_consume(struct sshbuf
*buf
, size_t len
);
155 * Consume len bytes from the end of buf
156 * Returns 0 on success, or a negative SSH_ERR_* error code on failure.
158 int sshbuf_consume_end(struct sshbuf
*buf
, size_t len
);
160 /* Extract or deposit some bytes */
161 int sshbuf_get(struct sshbuf
*buf
, void *v
, size_t len
);
162 int sshbuf_put(struct sshbuf
*buf
, const void *v
, size_t len
);
163 int sshbuf_putb(struct sshbuf
*buf
, const struct sshbuf
*v
);
165 /* Append using a printf(3) format */
166 int sshbuf_putf(struct sshbuf
*buf
, const char *fmt
, ...)
167 __attribute__((format(printf
, 2, 3)));
168 int sshbuf_putfv(struct sshbuf
*buf
, const char *fmt
, va_list ap
);
170 /* Functions to extract or store big-endian words of various sizes */
171 int sshbuf_get_u64(struct sshbuf
*buf
, u_int64_t
*valp
);
172 int sshbuf_get_u32(struct sshbuf
*buf
, u_int32_t
*valp
);
173 int sshbuf_get_u16(struct sshbuf
*buf
, u_int16_t
*valp
);
174 int sshbuf_get_u8(struct sshbuf
*buf
, u_char
*valp
);
175 int sshbuf_put_u64(struct sshbuf
*buf
, u_int64_t val
);
176 int sshbuf_put_u32(struct sshbuf
*buf
, u_int32_t val
);
177 int sshbuf_put_u16(struct sshbuf
*buf
, u_int16_t val
);
178 int sshbuf_put_u8(struct sshbuf
*buf
, u_char val
);
181 * Functions to extract or store SSH wire encoded strings (u32 len || data)
182 * The "cstring" variants admit no \0 characters in the string contents.
183 * Caller must free *valp.
185 int sshbuf_get_string(struct sshbuf
*buf
, u_char
**valp
, size_t *lenp
);
186 int sshbuf_get_cstring(struct sshbuf
*buf
, char **valp
, size_t *lenp
);
187 int sshbuf_get_stringb(struct sshbuf
*buf
, struct sshbuf
*v
);
188 int sshbuf_put_string(struct sshbuf
*buf
, const void *v
, size_t len
);
189 int sshbuf_put_cstring(struct sshbuf
*buf
, const char *v
);
190 int sshbuf_put_stringb(struct sshbuf
*buf
, const struct sshbuf
*v
);
193 * "Direct" variant of sshbuf_get_string, returns pointer into the sshbuf to
194 * avoid an malloc+memcpy. The pointer is guaranteed to be valid until the
195 * next sshbuf-modifying function call. Caller does not free.
197 int sshbuf_get_string_direct(struct sshbuf
*buf
, const u_char
**valp
,
200 /* Skip past a string */
201 #define sshbuf_skip_string(buf) sshbuf_get_string_direct(buf, NULL, NULL)
203 /* Another variant: "peeks" into the buffer without modifying it */
204 int sshbuf_peek_string_direct(const struct sshbuf
*buf
, const u_char
**valp
,
208 * Functions to extract or store SSH wire encoded bignums and elliptic
211 int sshbuf_put_bignum2_bytes(struct sshbuf
*buf
, const void *v
, size_t len
);
213 int sshbuf_get_bignum2(struct sshbuf
*buf
, BIGNUM
*v
);
214 int sshbuf_get_bignum1(struct sshbuf
*buf
, BIGNUM
*v
);
215 int sshbuf_put_bignum2(struct sshbuf
*buf
, const BIGNUM
*v
);
216 int sshbuf_put_bignum1(struct sshbuf
*buf
, const BIGNUM
*v
);
217 # ifdef OPENSSL_HAS_ECC
218 int sshbuf_get_ec(struct sshbuf
*buf
, EC_POINT
*v
, const EC_GROUP
*g
);
219 int sshbuf_get_eckey(struct sshbuf
*buf
, EC_KEY
*v
);
220 int sshbuf_put_ec(struct sshbuf
*buf
, const EC_POINT
*v
, const EC_GROUP
*g
);
221 int sshbuf_put_eckey(struct sshbuf
*buf
, const EC_KEY
*v
);
222 # endif /* OPENSSL_HAS_ECC */
223 #endif /* WITH_OPENSSL */
225 /* Dump the contents of the buffer in a human-readable format */
226 void sshbuf_dump(struct sshbuf
*buf
, FILE *f
);
228 /* Dump specified memory in a human-readable format */
229 void sshbuf_dump_data(const void *s
, size_t len
, FILE *f
);
231 /* Return the hexadecimal representation of the contents of the buffer */
232 char *sshbuf_dtob16(struct sshbuf
*buf
);
234 /* Encode the contents of the buffer as base64 */
235 char *sshbuf_dtob64(struct sshbuf
*buf
);
237 /* Decode base64 data and append it to the buffer */
238 int sshbuf_b64tod(struct sshbuf
*buf
, const char *b64
);
240 /* Macros for decoding/encoding integers */
241 #define PEEK_U64(p) \
242 (((u_int64_t)(((u_char *)(p))[0]) << 56) | \
243 ((u_int64_t)(((u_char *)(p))[1]) << 48) | \
244 ((u_int64_t)(((u_char *)(p))[2]) << 40) | \
245 ((u_int64_t)(((u_char *)(p))[3]) << 32) | \
246 ((u_int64_t)(((u_char *)(p))[4]) << 24) | \
247 ((u_int64_t)(((u_char *)(p))[5]) << 16) | \
248 ((u_int64_t)(((u_char *)(p))[6]) << 8) | \
249 (u_int64_t)(((u_char *)(p))[7]))
250 #define PEEK_U32(p) \
251 (((u_int32_t)(((u_char *)(p))[0]) << 24) | \
252 ((u_int32_t)(((u_char *)(p))[1]) << 16) | \
253 ((u_int32_t)(((u_char *)(p))[2]) << 8) | \
254 (u_int32_t)(((u_char *)(p))[3]))
255 #define PEEK_U16(p) \
256 (((u_int16_t)(((u_char *)(p))[0]) << 8) | \
257 (u_int16_t)(((u_char *)(p))[1]))
259 #define POKE_U64(p, v) \
261 ((u_char *)(p))[0] = (((u_int64_t)(v)) >> 56) & 0xff; \
262 ((u_char *)(p))[1] = (((u_int64_t)(v)) >> 48) & 0xff; \
263 ((u_char *)(p))[2] = (((u_int64_t)(v)) >> 40) & 0xff; \
264 ((u_char *)(p))[3] = (((u_int64_t)(v)) >> 32) & 0xff; \
265 ((u_char *)(p))[4] = (((u_int64_t)(v)) >> 24) & 0xff; \
266 ((u_char *)(p))[5] = (((u_int64_t)(v)) >> 16) & 0xff; \
267 ((u_char *)(p))[6] = (((u_int64_t)(v)) >> 8) & 0xff; \
268 ((u_char *)(p))[7] = ((u_int64_t)(v)) & 0xff; \
270 #define POKE_U32(p, v) \
272 ((u_char *)(p))[0] = (((u_int64_t)(v)) >> 24) & 0xff; \
273 ((u_char *)(p))[1] = (((u_int64_t)(v)) >> 16) & 0xff; \
274 ((u_char *)(p))[2] = (((u_int64_t)(v)) >> 8) & 0xff; \
275 ((u_char *)(p))[3] = ((u_int64_t)(v)) & 0xff; \
277 #define POKE_U16(p, v) \
279 ((u_char *)(p))[0] = (((u_int64_t)(v)) >> 8) & 0xff; \
280 ((u_char *)(p))[1] = ((u_int64_t)(v)) & 0xff; \
283 /* Internal definitions follow. Exposed for regress tests */
284 #ifdef SSHBUF_INTERNAL
287 * Return the allocation size of buf
289 size_t sshbuf_alloc(const struct sshbuf
*buf
);
292 * Increment the reference count of buf.
294 int sshbuf_set_parent(struct sshbuf
*child
, struct sshbuf
*parent
);
297 * Return the parent buffer of buf, or NULL if it has no parent.
299 const struct sshbuf
*sshbuf_parent(const struct sshbuf
*buf
);
302 * Return the reference count of buf
304 u_int
sshbuf_refcount(const struct sshbuf
*buf
);
306 # define SSHBUF_SIZE_INIT 256 /* Initial allocation */
307 # define SSHBUF_SIZE_INC 256 /* Preferred increment length */
308 # define SSHBUF_PACK_MIN 8192 /* Minimim packable offset */
310 /* # define SSHBUF_ABORT abort */
311 /* # define SSHBUF_DEBUG */
313 # ifndef SSHBUF_ABORT
314 # define SSHBUF_ABORT()
318 # define SSHBUF_TELL(what) do { \
319 printf("%s:%d %s: %s size %zu alloc %zu off %zu max %zu\n", \
320 __FILE__, __LINE__, __func__, what, \
321 buf->size, buf->alloc, buf->off, buf->max_size); \
324 # define SSHBUF_DBG(x) do { \
325 printf("%s:%d %s: ", __FILE__, __LINE__, __func__); \
331 # define SSHBUF_TELL(what)
332 # define SSHBUF_DBG(x)
334 #endif /* SSHBUF_INTERNAL */
336 #endif /* _SSHBUF_H */