crypto/openssh/sshbuf.h

   1 /*      $OpenBSD: sshbuf.h,v 1.11 2018/07/09 21:56:06 markus 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 #include <pwd.h>
  25 #ifdef WITH_OPENSSL
  26 # include <openssl/bn.h>
  27 # ifdef OPENSSL_HAS_ECC
  28 #  include <openssl/ec.h>
  29 # endif /* OPENSSL_HAS_ECC */
  30 #endif /* WITH_OPENSSL */
  31
  32 #define SSHBUF_SIZE_MAX         0x8000000       /* Hard maximum size */
  33 #define SSHBUF_REFS_MAX         0x100000        /* Max child buffers */
  34 #define SSHBUF_MAX_BIGNUM       (16384 / 8)     /* Max bignum *bytes* */
  35 #define SSHBUF_MAX_ECPOINT      ((528 * 2 / 8) + 1) /* Max EC point *bytes* */
  36
  37 /*
  38  * NB. do not depend on the internals of this. It will be made opaque
  39  * one day.
  40  */
  41 struct sshbuf {
  42         u_char *d;              /* Data */
  43         const u_char *cd;       /* Const data */
  44         size_t off;             /* First available byte is buf->d + buf->off */
  45         size_t size;            /* Last byte is buf->d + buf->size - 1 */
  46         size_t max_size;        /* Maximum size of buffer */
  47         size_t alloc;           /* Total bytes allocated to buf->d */
  48         int readonly;           /* Refers to external, const data */
  49         int dont_free;          /* Kludge to support sshbuf_init */
  50         u_int refcount;         /* Tracks self and number of child buffers */
  51         struct sshbuf *parent;  /* If child, pointer to parent */
  52 };
  53
  54 /*
  55  * Create a new sshbuf buffer.
  56  * Returns pointer to buffer on success, or NULL on allocation failure.
  57  */
  58 struct sshbuf *sshbuf_new(void);
  59
  60 /*
  61  * Create a new, read-only sshbuf buffer from existing data.
  62  * Returns pointer to buffer on success, or NULL on allocation failure.
  63  */
  64 struct sshbuf *sshbuf_from(const void *blob, size_t len);
  65
  66 /*
  67  * Create a new, read-only sshbuf buffer from the contents of an existing
  68  * buffer. The contents of "buf" must not change in the lifetime of the
  69  * resultant buffer.
  70  * Returns pointer to buffer on success, or NULL on allocation failure.
  71  */
  72 struct sshbuf *sshbuf_fromb(struct sshbuf *buf);
  73
  74 /*
  75  * Create a new, read-only sshbuf buffer from the contents of a string in
  76  * an existing buffer (the string is consumed in the process).
  77  * The contents of "buf" must not change in the lifetime of the resultant
  78  * buffer.
  79  * Returns pointer to buffer on success, or NULL on allocation failure.
  80  */
  81 int     sshbuf_froms(struct sshbuf *buf, struct sshbuf **bufp);
  82
  83 /*
  84  * Clear and free buf
  85  */
  86 void    sshbuf_free(struct sshbuf *buf);
  87
  88 /*
  89  * Reset buf, clearing its contents. NB. max_size is preserved.
  90  */
  91 void    sshbuf_reset(struct sshbuf *buf);
  92
  93 /*
  94  * Return the maximum size of buf
  95  */
  96 size_t  sshbuf_max_size(const struct sshbuf *buf);
  97
  98 /*
  99  * Set the maximum size of buf
 100  * Returns 0 on success, or a negative SSH_ERR_* error code on failure.
 101  */
 102 int     sshbuf_set_max_size(struct sshbuf *buf, size_t max_size);
 103
 104 /*
 105  * Returns the length of data in buf
 106  */
 107 size_t  sshbuf_len(const struct sshbuf *buf);
 108
 109 /*
 110  * Returns number of bytes left in buffer before hitting max_size.
 111  */
 112 size_t  sshbuf_avail(const struct sshbuf *buf);
 113
 114 /*
 115  * Returns a read-only pointer to the start of the data in buf
 116  */
 117 const u_char *sshbuf_ptr(const struct sshbuf *buf);
 118
 119 /*
 120  * Returns a mutable pointer to the start of the data in buf, or
 121  * NULL if the buffer is read-only.
 122  */
 123 u_char *sshbuf_mutable_ptr(const struct sshbuf *buf);
 124
 125 /*
 126  * Check whether a reservation of size len will succeed in buf
 127  * Safer to use than direct comparisons again sshbuf_avail as it copes
 128  * with unsigned overflows correctly.
 129  * Returns 0 on success, or a negative SSH_ERR_* error code on failure.
 130  */
 131 int     sshbuf_check_reserve(const struct sshbuf *buf, size_t len);
 132
 133 /*
 134  * Preallocates len additional bytes in buf.
 135  * Useful for cases where the caller knows how many bytes will ultimately be
 136  * required to avoid realloc in the buffer code.
 137  * Returns 0 on success, or a negative SSH_ERR_* error code on failure.
 138  */
 139 int     sshbuf_allocate(struct sshbuf *buf, size_t len);
 140
 141 /*
 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.
 145  */
 146 int     sshbuf_reserve(struct sshbuf *buf, size_t len, u_char **dpp);
 147
 148 /*
 149  * Consume len bytes from the start of buf
 150  * Returns 0 on success, or a negative SSH_ERR_* error code on failure.
 151  */
 152 int     sshbuf_consume(struct sshbuf *buf, size_t len);
 153
 154 /*
 155  * Consume len bytes from the end of buf
 156  * Returns 0 on success, or a negative SSH_ERR_* error code on failure.
 157  */
 158 int     sshbuf_consume_end(struct sshbuf *buf, size_t len);
 159
 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);
 164
 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);
 169
 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);
 179
 180 /*
 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.
 184  */
 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);
 191
 192 /*
 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.
 196  */
 197 int     sshbuf_get_string_direct(struct sshbuf *buf, const u_char **valp,
 198             size_t *lenp);
 199
 200 /* Skip past a string */
 201 #define sshbuf_skip_string(buf) sshbuf_get_string_direct(buf, NULL, NULL)
 202
 203 /* Another variant: "peeks" into the buffer without modifying it */
 204 int     sshbuf_peek_string_direct(const struct sshbuf *buf, const u_char **valp,
 205             size_t *lenp);
 206 /* XXX peek_u8 / peek_u32 */
 207
 208 /*
 209  * Functions to extract or store SSH wire encoded bignums and elliptic
 210  * curve points.
 211  */
 212 int     sshbuf_put_bignum2_bytes(struct sshbuf *buf, const void *v, size_t len);
 213 int     sshbuf_get_bignum2_bytes_direct(struct sshbuf *buf,
 214             const u_char **valp, size_t *lenp);
 215 #ifdef WITH_OPENSSL
 216 int     sshbuf_get_bignum2(struct sshbuf *buf, BIGNUM *v);
 217 int     sshbuf_get_bignum1(struct sshbuf *buf, BIGNUM *v);
 218 int     sshbuf_put_bignum2(struct sshbuf *buf, const BIGNUM *v);
 219 int     sshbuf_put_bignum1(struct sshbuf *buf, const BIGNUM *v);
 220 # ifdef OPENSSL_HAS_ECC
 221 int     sshbuf_get_ec(struct sshbuf *buf, EC_POINT *v, const EC_GROUP *g);
 222 int     sshbuf_get_eckey(struct sshbuf *buf, EC_KEY *v);
 223 int     sshbuf_put_ec(struct sshbuf *buf, const EC_POINT *v, const EC_GROUP *g);
 224 int     sshbuf_put_eckey(struct sshbuf *buf, const EC_KEY *v);
 225 # endif /* OPENSSL_HAS_ECC */
 226 #endif /* WITH_OPENSSL */
 227
 228 /* Dump the contents of the buffer in a human-readable format */
 229 void    sshbuf_dump(struct sshbuf *buf, FILE *f);
 230
 231 /* Dump specified memory in a human-readable format */
 232 void    sshbuf_dump_data(const void *s, size_t len, FILE *f);
 233
 234 /* Return the hexadecimal representation of the contents of the buffer */
 235 char    *sshbuf_dtob16(struct sshbuf *buf);
 236
 237 /* Encode the contents of the buffer as base64 */
 238 char    *sshbuf_dtob64(struct sshbuf *buf);
 239
 240 /* Decode base64 data and append it to the buffer */
 241 int     sshbuf_b64tod(struct sshbuf *buf, const char *b64);
 242
 243 /*
 244  * Duplicate the contents of a buffer to a string (caller to free).
 245  * Returns NULL on buffer error, or if the buffer contains a premature
 246  * nul character.
 247  */
 248 char *sshbuf_dup_string(struct sshbuf *buf);
 249
 250 /*
 251  * store struct pwd
 252  */
 253 int sshbuf_put_passwd(struct sshbuf *buf, const struct passwd *pwent);
 254
 255 /*
 256  * extract struct pwd
 257  */
 258 struct passwd *sshbuf_get_passwd(struct sshbuf *buf);
 259
 260 /*
 261  * free struct passwd obtained from sshbuf_get_passwd.
 262  */
 263 void sshbuf_free_passwd(struct passwd *pwent);
 264
 265 /* Macros for decoding/encoding integers */
 266 #define PEEK_U64(p) \
 267         (((u_int64_t)(((const u_char *)(p))[0]) << 56) | \
 268          ((u_int64_t)(((const u_char *)(p))[1]) << 48) | \
 269          ((u_int64_t)(((const u_char *)(p))[2]) << 40) | \
 270          ((u_int64_t)(((const u_char *)(p))[3]) << 32) | \
 271          ((u_int64_t)(((const u_char *)(p))[4]) << 24) | \
 272          ((u_int64_t)(((const u_char *)(p))[5]) << 16) | \
 273          ((u_int64_t)(((const u_char *)(p))[6]) << 8) | \
 274           (u_int64_t)(((const u_char *)(p))[7]))
 275 #define PEEK_U32(p) \
 276         (((u_int32_t)(((const u_char *)(p))[0]) << 24) | \
 277          ((u_int32_t)(((const u_char *)(p))[1]) << 16) | \
 278          ((u_int32_t)(((const u_char *)(p))[2]) << 8) | \
 279           (u_int32_t)(((const u_char *)(p))[3]))
 280 #define PEEK_U16(p) \
 281         (((u_int16_t)(((const u_char *)(p))[0]) << 8) | \
 282           (u_int16_t)(((const u_char *)(p))[1]))
 283
 284 #define POKE_U64(p, v) \
 285         do { \
 286                 const u_int64_t __v = (v); \
 287                 ((u_char *)(p))[0] = (__v >> 56) & 0xff; \
 288                 ((u_char *)(p))[1] = (__v >> 48) & 0xff; \
 289                 ((u_char *)(p))[2] = (__v >> 40) & 0xff; \
 290                 ((u_char *)(p))[3] = (__v >> 32) & 0xff; \
 291                 ((u_char *)(p))[4] = (__v >> 24) & 0xff; \
 292                 ((u_char *)(p))[5] = (__v >> 16) & 0xff; \
 293                 ((u_char *)(p))[6] = (__v >> 8) & 0xff; \
 294                 ((u_char *)(p))[7] = __v & 0xff; \
 295         } while (0)
 296 #define POKE_U32(p, v) \
 297         do { \
 298                 const u_int32_t __v = (v); \
 299                 ((u_char *)(p))[0] = (__v >> 24) & 0xff; \
 300                 ((u_char *)(p))[1] = (__v >> 16) & 0xff; \
 301                 ((u_char *)(p))[2] = (__v >> 8) & 0xff; \
 302                 ((u_char *)(p))[3] = __v & 0xff; \
 303         } while (0)
 304 #define POKE_U16(p, v) \
 305         do { \
 306                 const u_int16_t __v = (v); \
 307                 ((u_char *)(p))[0] = (__v >> 8) & 0xff; \
 308                 ((u_char *)(p))[1] = __v & 0xff; \
 309         } while (0)
 310
 311 /* Internal definitions follow. Exposed for regress tests */
 312 #ifdef SSHBUF_INTERNAL
 313
 314 /*
 315  * Return the allocation size of buf
 316  */
 317 size_t  sshbuf_alloc(const struct sshbuf *buf);
 318
 319 /*
 320  * Increment the reference count of buf.
 321  */
 322 int     sshbuf_set_parent(struct sshbuf *child, struct sshbuf *parent);
 323
 324 /*
 325  * Return the parent buffer of buf, or NULL if it has no parent.
 326  */
 327 const struct sshbuf *sshbuf_parent(const struct sshbuf *buf);
 328
 329 /*
 330  * Return the reference count of buf
 331  */
 332 u_int   sshbuf_refcount(const struct sshbuf *buf);
 333
 334 # define SSHBUF_SIZE_INIT       256             /* Initial allocation */
 335 # define SSHBUF_SIZE_INC        256             /* Preferred increment length */
 336 # define SSHBUF_PACK_MIN        8192            /* Minimim packable offset */
 337
 338 /* # define SSHBUF_ABORT abort */
 339 /* # define SSHBUF_DEBUG */
 340
 341 # ifndef SSHBUF_ABORT
 342 #  define SSHBUF_ABORT()
 343 # endif
 344
 345 # ifdef SSHBUF_DEBUG
 346 #  define SSHBUF_TELL(what) do { \
 347                 printf("%s:%d %s: %s size %zu alloc %zu off %zu max %zu\n", \
 348                     __FILE__, __LINE__, __func__, what, \
 349                     buf->size, buf->alloc, buf->off, buf->max_size); \
 350                 fflush(stdout); \
 351         } while (0)
 352 #  define SSHBUF_DBG(x) do { \
 353                 printf("%s:%d %s: ", __FILE__, __LINE__, __func__); \
 354                 printf x; \
 355                 printf("\n"); \
 356                 fflush(stdout); \
 357         } while (0)
 358 # else
 359 #  define SSHBUF_TELL(what)
 360 #  define SSHBUF_DBG(x)
 361 # endif
 362 #endif /* SSHBUF_INTERNAL */
 363
 364 #endif /* _SSHBUF_H */