crypto/openssh/sshbuf.h

   1 /*      $OpenBSD: sshbuf.h,v 1.13 2019/01/21 09:54:11 djm Exp $ */
   2 /*
   3  * Copyright (c) 2011 Damien Miller
   4  *
   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.
   8  *
   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.
  16  */
  17
  18 #ifndef _SSHBUF_H
  19 #define _SSHBUF_H
  20
  21 #include <sys/types.h>
  22 #include <stdarg.h>
  23 #include <stdio.h>
  24 #ifdef WITH_OPENSSL
  25 # include <openssl/bn.h>
  26 # ifdef OPENSSL_HAS_ECC
  27 #  include <openssl/ec.h>
  28 # endif /* OPENSSL_HAS_ECC */
  29 #endif /* WITH_OPENSSL */
  30
  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* */
  35
  36 /*
  37  * NB. do not depend on the internals of this. It will be made opaque
  38  * one day.
  39  */
  40 struct sshbuf {
  41         u_char *d;              /* Data */
  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 */
  51 };
  52
  53 /*
  54  * Create a new sshbuf buffer.
  55  * Returns pointer to buffer on success, or NULL on allocation failure.
  56  */
  57 struct sshbuf *sshbuf_new(void);
  58
  59 /*
  60  * Create a new, read-only sshbuf buffer from existing data.
  61  * Returns pointer to buffer on success, or NULL on allocation failure.
  62  */
  63 struct sshbuf *sshbuf_from(const void *blob, size_t len);
  64
  65 /*
  66  * Create a new, read-only sshbuf buffer from the contents of an existing
  67  * buffer. The contents of "buf" must not change in the lifetime of the
  68  * resultant buffer.
  69  * Returns pointer to buffer on success, or NULL on allocation failure.
  70  */
  71 struct sshbuf *sshbuf_fromb(struct sshbuf *buf);
  72
  73 /*
  74  * Create a new, read-only sshbuf buffer from the contents of a string in
  75  * an existing buffer (the string is consumed in the process).
  76  * The contents of "buf" must not change in the lifetime of the resultant
  77  * buffer.
  78  * Returns pointer to buffer on success, or NULL on allocation failure.
  79  */
  80 int     sshbuf_froms(struct sshbuf *buf, struct sshbuf **bufp);
  81
  82 /*
  83  * Clear and free buf
  84  */
  85 void    sshbuf_free(struct sshbuf *buf);
  86
  87 /*
  88  * Reset buf, clearing its contents. NB. max_size is preserved.
  89  */
  90 void    sshbuf_reset(struct sshbuf *buf);
  91
  92 /*
  93  * Return the maximum size of buf
  94  */
  95 size_t  sshbuf_max_size(const struct sshbuf *buf);
  96
  97 /*
  98  * Set the maximum size of buf
  99  * Returns 0 on success, or a negative SSH_ERR_* error code on failure.
 100  */
 101 int     sshbuf_set_max_size(struct sshbuf *buf, size_t max_size);
 102
 103 /*
 104  * Returns the length of data in buf
 105  */
 106 size_t  sshbuf_len(const struct sshbuf *buf);
 107
 108 /*
 109  * Returns number of bytes left in buffer before hitting max_size.
 110  */
 111 size_t  sshbuf_avail(const struct sshbuf *buf);
 112
 113 /*
 114  * Returns a read-only pointer to the start of the data in buf
 115  */
 116 const u_char *sshbuf_ptr(const struct sshbuf *buf);
 117
 118 /*
 119  * Returns a mutable pointer to the start of the data in buf, or
 120  * NULL if the buffer is read-only.
 121  */
 122 u_char *sshbuf_mutable_ptr(const struct sshbuf *buf);
 123
 124 /*
 125  * Check whether a reservation of size len will succeed in buf
 126  * Safer to use than direct comparisons again sshbuf_avail as it copes
 127  * with unsigned overflows correctly.
 128  * Returns 0 on success, or a negative SSH_ERR_* error code on failure.
 129  */
 130 int     sshbuf_check_reserve(const struct sshbuf *buf, size_t len);
 131
 132 /*
 133  * Preallocates len additional bytes in buf.
 134  * Useful for cases where the caller knows how many bytes will ultimately be
 135  * required to avoid realloc in the buffer code.
 136  * Returns 0 on success, or a negative SSH_ERR_* error code on failure.
 137  */
 138 int     sshbuf_allocate(struct sshbuf *buf, size_t len);
 139
 140 /*
 141  * Reserve len bytes in buf.
 142  * Returns 0 on success and a pointer to the first reserved byte via the
 143  * optional dpp parameter or a negative * SSH_ERR_* error code on failure.
 144  */
 145 int     sshbuf_reserve(struct sshbuf *buf, size_t len, u_char **dpp);
 146
 147 /*
 148  * Consume len bytes from the start of buf
 149  * Returns 0 on success, or a negative SSH_ERR_* error code on failure.
 150  */
 151 int     sshbuf_consume(struct sshbuf *buf, size_t len);
 152
 153 /*
 154  * Consume len bytes from the end of buf
 155  * Returns 0 on success, or a negative SSH_ERR_* error code on failure.
 156  */
 157 int     sshbuf_consume_end(struct sshbuf *buf, size_t len);
 158
 159 /* Extract or deposit some bytes */
 160 int     sshbuf_get(struct sshbuf *buf, void *v, size_t len);
 161 int     sshbuf_put(struct sshbuf *buf, const void *v, size_t len);
 162 int     sshbuf_putb(struct sshbuf *buf, const struct sshbuf *v);
 163
 164 /* Append using a printf(3) format */
 165 int     sshbuf_putf(struct sshbuf *buf, const char *fmt, ...)
 166             __attribute__((format(printf, 2, 3)));
 167 int     sshbuf_putfv(struct sshbuf *buf, const char *fmt, va_list ap);
 168
 169 /* Functions to extract or store big-endian words of various sizes */
 170 int     sshbuf_get_u64(struct sshbuf *buf, u_int64_t *valp);
 171 int     sshbuf_get_u32(struct sshbuf *buf, u_int32_t *valp);
 172 int     sshbuf_get_u16(struct sshbuf *buf, u_int16_t *valp);
 173 int     sshbuf_get_u8(struct sshbuf *buf, u_char *valp);
 174 int     sshbuf_put_u64(struct sshbuf *buf, u_int64_t val);
 175 int     sshbuf_put_u32(struct sshbuf *buf, u_int32_t val);
 176 int     sshbuf_put_u16(struct sshbuf *buf, u_int16_t val);
 177 int     sshbuf_put_u8(struct sshbuf *buf, u_char val);
 178
 179 /*
 180  * Functions to extract or store SSH wire encoded strings (u32 len || data)
 181  * The "cstring" variants admit no \0 characters in the string contents.
 182  * Caller must free *valp.
 183  */
 184 int     sshbuf_get_string(struct sshbuf *buf, u_char **valp, size_t *lenp);
 185 int     sshbuf_get_cstring(struct sshbuf *buf, char **valp, size_t *lenp);
 186 int     sshbuf_get_stringb(struct sshbuf *buf, struct sshbuf *v);
 187 int     sshbuf_put_string(struct sshbuf *buf, const void *v, size_t len);
 188 int     sshbuf_put_cstring(struct sshbuf *buf, const char *v);
 189 int     sshbuf_put_stringb(struct sshbuf *buf, const struct sshbuf *v);
 190
 191 /*
 192  * "Direct" variant of sshbuf_get_string, returns pointer into the sshbuf to
 193  * avoid an malloc+memcpy. The pointer is guaranteed to be valid until the
 194  * next sshbuf-modifying function call. Caller does not free.
 195  */
 196 int     sshbuf_get_string_direct(struct sshbuf *buf, const u_char **valp,
 197             size_t *lenp);
 198
 199 /* Skip past a string */
 200 #define sshbuf_skip_string(buf) sshbuf_get_string_direct(buf, NULL, NULL)
 201
 202 /* Another variant: "peeks" into the buffer without modifying it */
 203 int     sshbuf_peek_string_direct(const struct sshbuf *buf, const u_char **valp,
 204             size_t *lenp);
 205 /* XXX peek_u8 / peek_u32 */
 206
 207 /*
 208  * Functions to extract or store SSH wire encoded bignums and elliptic
 209  * curve points.
 210  */
 211 int     sshbuf_put_bignum2_bytes(struct sshbuf *buf, const void *v, size_t len);
 212 int     sshbuf_get_bignum2_bytes_direct(struct sshbuf *buf,
 213             const u_char **valp, size_t *lenp);
 214 #ifdef WITH_OPENSSL
 215 int     sshbuf_get_bignum2(struct sshbuf *buf, BIGNUM **valp);
 216 int     sshbuf_put_bignum2(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 */
 224
 225 /* Dump the contents of the buffer in a human-readable format */
 226 void    sshbuf_dump(struct sshbuf *buf, FILE *f);
 227
 228 /* Dump specified memory in a human-readable format */
 229 void    sshbuf_dump_data(const void *s, size_t len, FILE *f);
 230
 231 /* Return the hexadecimal representation of the contents of the buffer */
 232 char    *sshbuf_dtob16(struct sshbuf *buf);
 233
 234 /* Encode the contents of the buffer as base64 */
 235 char    *sshbuf_dtob64(struct sshbuf *buf);
 236
 237 /* Decode base64 data and append it to the buffer */
 238 int     sshbuf_b64tod(struct sshbuf *buf, const char *b64);
 239
 240 /*
 241  * Duplicate the contents of a buffer to a string (caller to free).
 242  * Returns NULL on buffer error, or if the buffer contains a premature
 243  * nul character.
 244  */
 245 char *sshbuf_dup_string(struct sshbuf *buf);
 246
 247 /* Macros for decoding/encoding integers */
 248 #define PEEK_U64(p) \
 249         (((u_int64_t)(((const u_char *)(p))[0]) << 56) | \
 250          ((u_int64_t)(((const u_char *)(p))[1]) << 48) | \
 251          ((u_int64_t)(((const u_char *)(p))[2]) << 40) | \
 252          ((u_int64_t)(((const u_char *)(p))[3]) << 32) | \
 253          ((u_int64_t)(((const u_char *)(p))[4]) << 24) | \
 254          ((u_int64_t)(((const u_char *)(p))[5]) << 16) | \
 255          ((u_int64_t)(((const u_char *)(p))[6]) << 8) | \
 256           (u_int64_t)(((const u_char *)(p))[7]))
 257 #define PEEK_U32(p) \
 258         (((u_int32_t)(((const u_char *)(p))[0]) << 24) | \
 259          ((u_int32_t)(((const u_char *)(p))[1]) << 16) | \
 260          ((u_int32_t)(((const u_char *)(p))[2]) << 8) | \
 261           (u_int32_t)(((const u_char *)(p))[3]))
 262 #define PEEK_U16(p) \
 263         (((u_int16_t)(((const u_char *)(p))[0]) << 8) | \
 264           (u_int16_t)(((const u_char *)(p))[1]))
 265
 266 #define POKE_U64(p, v) \
 267         do { \
 268                 const u_int64_t __v = (v); \
 269                 ((u_char *)(p))[0] = (__v >> 56) & 0xff; \
 270                 ((u_char *)(p))[1] = (__v >> 48) & 0xff; \
 271                 ((u_char *)(p))[2] = (__v >> 40) & 0xff; \
 272                 ((u_char *)(p))[3] = (__v >> 32) & 0xff; \
 273                 ((u_char *)(p))[4] = (__v >> 24) & 0xff; \
 274                 ((u_char *)(p))[5] = (__v >> 16) & 0xff; \
 275                 ((u_char *)(p))[6] = (__v >> 8) & 0xff; \
 276                 ((u_char *)(p))[7] = __v & 0xff; \
 277         } while (0)
 278 #define POKE_U32(p, v) \
 279         do { \
 280                 const u_int32_t __v = (v); \
 281                 ((u_char *)(p))[0] = (__v >> 24) & 0xff; \
 282                 ((u_char *)(p))[1] = (__v >> 16) & 0xff; \
 283                 ((u_char *)(p))[2] = (__v >> 8) & 0xff; \
 284                 ((u_char *)(p))[3] = __v & 0xff; \
 285         } while (0)
 286 #define POKE_U16(p, v) \
 287         do { \
 288                 const u_int16_t __v = (v); \
 289                 ((u_char *)(p))[0] = (__v >> 8) & 0xff; \
 290                 ((u_char *)(p))[1] = __v & 0xff; \
 291         } while (0)
 292
 293 /* Internal definitions follow. Exposed for regress tests */
 294 #ifdef SSHBUF_INTERNAL
 295
 296 /*
 297  * Return the allocation size of buf
 298  */
 299 size_t  sshbuf_alloc(const struct sshbuf *buf);
 300
 301 /*
 302  * Increment the reference count of buf.
 303  */
 304 int     sshbuf_set_parent(struct sshbuf *child, struct sshbuf *parent);
 305
 306 /*
 307  * Return the parent buffer of buf, or NULL if it has no parent.
 308  */
 309 const struct sshbuf *sshbuf_parent(const struct sshbuf *buf);
 310
 311 /*
 312  * Return the reference count of buf
 313  */
 314 u_int   sshbuf_refcount(const struct sshbuf *buf);
 315
 316 # define SSHBUF_SIZE_INIT       256             /* Initial allocation */
 317 # define SSHBUF_SIZE_INC        256             /* Preferred increment length */
 318 # define SSHBUF_PACK_MIN        8192            /* Minimim packable offset */
 319
 320 /* # define SSHBUF_ABORT abort */
 321 /* # define SSHBUF_DEBUG */
 322
 323 # ifndef SSHBUF_ABORT
 324 #  define SSHBUF_ABORT()
 325 # endif
 326
 327 # ifdef SSHBUF_DEBUG
 328 #  define SSHBUF_TELL(what) do { \
 329                 printf("%s:%d %s: %s size %zu alloc %zu off %zu max %zu\n", \
 330                     __FILE__, __LINE__, __func__, what, \
 331                     buf->size, buf->alloc, buf->off, buf->max_size); \
 332                 fflush(stdout); \
 333         } while (0)
 334 #  define SSHBUF_DBG(x) do { \
 335                 printf("%s:%d %s: ", __FILE__, __LINE__, __func__); \
 336                 printf x; \
 337                 printf("\n"); \
 338                 fflush(stdout); \
 339         } while (0)
 340 # else
 341 #  define SSHBUF_TELL(what)
 342 #  define SSHBUF_DBG(x)
 343 # endif
 344 #endif /* SSHBUF_INTERNAL */
 345
 346 #endif /* _SSHBUF_H */