/*  $OpenBSD: sshbuf.c,v 1.19 2022/12/02 04:40:27 djm Exp $ */

/*

 * Copyright (c) 2011 Damien Miller

 *

 * Permission to use, copy, modify, and distribute this software for any

 * purpose with or without fee is hereby granted, provided that the above

 * copyright notice and this permission notice appear in all copies.

 *

 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES

 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF

 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR

 * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES

 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN

 * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF

 * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.

 */

#include "includes.h"

#include <sys/types.h>

#include <signal.h>

#include <stdlib.h>

#include <stdio.h>

#include <string.h>

#include "ssherr.h"

#define SSHBUF_INTERNAL

#include "sshbuf.h"

#include "misc.h"

/* #include "log.h" */

#define BUF_WATERSHED 256*1024

#ifdef SSHBUF_DEBUG

# define SSHBUF_TELL(what) do { \

    printf("%s:%d %s: %s size %zu alloc %zu off %zu max %zu\n", \

        __FILE__, __LINE__, __func__, what, \

        buf->size, buf->alloc, buf->off, buf->max_size); \

    fflush(stdout); \

  } while (0)

#else

# define SSHBUF_TELL(what)

#endif

struct sshbuf {

  u_char *d;    /* Data */

  const u_char *cd; /* Const data */

  size_t off;   /* First available byte is buf->d + buf->off */

  size_t size;    /* Last byte is buf->d + buf->size - 1 */

  size_t max_size;  /* Maximum size of buffer */

  size_t alloc;   /* Total bytes allocated to buf->d */

  int readonly;   /* Refers to external, const data */

  u_int refcount;   /* Tracks self and number of child buffers */

  struct sshbuf *parent;  /* If child, pointer to parent */

  char label[MAX_LABEL_LEN];   /* String for buffer label - debugging use */

  int type;               /* type of buffer enum (sshbuf_types)*/

};

/* update the label string for a given sshbuf. Useful

 * for debugging */

void

sshbuf_relabel(struct sshbuf *buf, const char *label)

{

  if (label != NULL)

    strncpy(buf->label, label, MAX_LABEL_LEN-1);

}

/* set the type (from enum sshbuf_type) of the given sshbuf.

 * The purpose is to allow different classes of buffers to

 * follow different code paths if necessary */

void

sshbuf_type(struct sshbuf *buf, int type)

{

  if (type < BUF_MAX_TYPE)

    buf->type = type;

}

static inline int

sshbuf_check_sanity(const struct sshbuf *buf)

{

  SSHBUF_TELL("sanity");

  if (__predict_false(buf == NULL ||

      (!buf->readonly && buf->d != buf->cd) ||

      buf->refcount < 1 || buf->refcount > SSHBUF_REFS_MAX ||

      buf->cd == NULL ||

      buf->max_size > SSHBUF_SIZE_MAX ||

      buf->alloc > buf->max_size ||

      buf->size > buf->alloc ||

      buf->off > buf->size)) {

    /* Do not try to recover from corrupted buffer internals */

    SSHBUF_DBG(("SSH_ERR_INTERNAL_ERROR"));

    ssh_signal(SIGSEGV, SIG_DFL);

    raise(SIGSEGV);

    return SSH_ERR_INTERNAL_ERROR;

  }

  return 0;

}

static void

sshbuf_maybe_pack(struct sshbuf *buf, int force)

{

  SSHBUF_DBG(("force %d", force));

  SSHBUF_TELL("pre-pack");

  if (buf->off == 0 || buf->readonly || buf->refcount > 1)

    return;

  if (force ||

      (buf->off >= SSHBUF_PACK_MIN && buf->off >= buf->size / 2)) {

    memmove(buf->d, buf->d + buf->off, buf->size - buf->off);

    buf->size -= buf->off;

    buf->off = 0;

    SSHBUF_TELL("packed");

  }

}

struct sshbuf *

sshbuf_new_label (const char *label)

{

  struct sshbuf *ret;

  if ((ret = calloc(sizeof(*ret), 1)) == NULL)

    return NULL;

  ret->alloc = SSHBUF_SIZE_INIT;

  ret->max_size = SSHBUF_SIZE_MAX;

  ret->readonly = 0;

  ret->refcount = 1;

  ret->parent = NULL;

  if (label != NULL)

    strncpy(ret->label, label, MAX_LABEL_LEN-1);

  if ((ret->cd = ret->d = calloc(1, ret->alloc)) == NULL) {

    free(ret);

    return NULL;

  }

  return ret;

}

struct sshbuf *

sshbuf_from(const void *blob, size_t len)

{

  struct sshbuf *ret;

  if (blob == NULL || len > SSHBUF_SIZE_MAX ||

      (ret = calloc(sizeof(*ret), 1)) == NULL)

    return NULL;

  ret->alloc = ret->size = ret->max_size = len;

  ret->readonly = 1;

  ret->refcount = 1;

  ret->parent = NULL;

  ret->cd = blob;

  ret->d = NULL;

  return ret;

}

int

sshbuf_set_parent(struct sshbuf *child, struct sshbuf *parent)

{

  int r;

  if ((r = sshbuf_check_sanity(child)) != 0 ||

      (r = sshbuf_check_sanity(parent)) != 0)

    return r;

  if (child->parent != NULL && child->parent != parent)

    return SSH_ERR_INTERNAL_ERROR;

  child->parent = parent;

  child->parent->refcount++;

  return 0;

}

struct sshbuf *

sshbuf_fromb(struct sshbuf *buf)

{

  struct sshbuf *ret;

  if (sshbuf_check_sanity(buf) != 0)

    return NULL;

  if ((ret = sshbuf_from(sshbuf_ptr(buf), sshbuf_len(buf))) == NULL)

    return NULL;

  if (sshbuf_set_parent(ret, buf) != 0) {

    sshbuf_free(ret);

    return NULL;

  }

  return ret;

}

void

sshbuf_free(struct sshbuf *buf)

{

  if (buf == NULL)

    return;

  /*

   * The following will leak on insane buffers, but this is the safest

   * course of action - an invalid pointer or already-freed pointer may

   * have been passed to us and continuing to scribble over memory would

   * be bad.

   */

  if (sshbuf_check_sanity(buf) != 0)

    return;

  /*

   * If we are a parent with still-extant children, then don't free just

   * yet. The last child's call to sshbuf_free should decrement our

   * refcount to 0 and trigger the actual free.

   */

  buf->refcount--;

  if (buf->refcount > 0)

    return;

  /*

   * If we are a child, the free our parent to decrement its reference

   * count and possibly free it.

   */

  sshbuf_free(buf->parent);

  buf->parent = NULL;

  if (!buf->readonly) {

    explicit_bzero(buf->d, buf->alloc);

    free(buf->d);

  }

  freezero(buf, sizeof(*buf));

}

void

sshbuf_reset(struct sshbuf *buf)

{

  u_char *d;

  if (buf->readonly || buf->refcount > 1) {

    /* Nonsensical. Just make buffer appear empty */

    buf->off = buf->size;

    return;

  }

  if (sshbuf_check_sanity(buf) != 0)

    return;

  buf->off = buf->size = 0;

  if (buf->alloc != SSHBUF_SIZE_INIT) {

    if ((d = recallocarray(buf->d, buf->alloc, SSHBUF_SIZE_INIT,

        1)) != NULL) {

      buf->cd = buf->d = d;

      buf->alloc = SSHBUF_SIZE_INIT;

    }

  }

  explicit_bzero(buf->d, buf->alloc);

}

size_t

sshbuf_max_size(const struct sshbuf *buf)

{

  return buf->max_size;

}

size_t

sshbuf_alloc(const struct sshbuf *buf)

{

  return buf->alloc;

}

const struct sshbuf *

sshbuf_parent(const struct sshbuf *buf)

{

  return buf->parent;

}

u_int

sshbuf_refcount(const struct sshbuf *buf)

{

  return buf->refcount;

}

int

sshbuf_set_max_size(struct sshbuf *buf, size_t max_size)

{

  size_t rlen;

  u_char *dp;

  int r;

  SSHBUF_DBG(("set max buf = %p len = %zu", buf, max_size));

  if ((r = sshbuf_check_sanity(buf)) != 0)

    return r;

  if (max_size == buf->max_size)

    return 0;

  if (buf->readonly || buf->refcount > 1)

    return SSH_ERR_BUFFER_READ_ONLY;

  if (max_size > SSHBUF_SIZE_MAX)

    return SSH_ERR_NO_BUFFER_SPACE;

  /* pack and realloc if necessary */

  sshbuf_maybe_pack(buf, max_size < buf->size);

  if (max_size < buf->alloc && max_size > buf->size) {

    if (buf->size < SSHBUF_SIZE_INIT)

      rlen = SSHBUF_SIZE_INIT;

    else

      rlen = ROUNDUP(buf->size, SSHBUF_SIZE_INC);

    if (rlen > max_size)

      rlen = max_size;

    SSHBUF_DBG(("new alloc = %zu", rlen));

    if ((dp = recallocarray(buf->d, buf->alloc, rlen, 1)) == NULL)

      return SSH_ERR_ALLOC_FAIL;

    buf->cd = buf->d = dp;

    buf->alloc = rlen;

  }

  SSHBUF_TELL("new-max");

  if (max_size < buf->alloc)

    return SSH_ERR_NO_BUFFER_SPACE;

  buf->max_size = max_size;

  return 0;

}

size_t

sshbuf_len(const struct sshbuf *buf)

{

  if (sshbuf_check_sanity(buf) != 0)

    return 0;

  return buf->size - buf->off;

}

size_t

sshbuf_avail(const struct sshbuf *buf)

{

  if (sshbuf_check_sanity(buf) != 0 || buf->readonly || buf->refcount > 1)

    return 0;

  /* we need to reserve a small amount of overhead on the input buffer

   * or we can enter into a pathological state during bulk

   * data transfers. We use a fraction of the max size as we want it to scale

   * with the size of the input buffer. If we do it for all of the buffers

   * we fail the regression unit tests. This seems like a reasonable

   * solution. Of course, I still need to figure out *why* this is

   * happening and come up with an actual fix. TODO

   * cjr 4/19/2024 */

  if (buf->type == BUF_CHANNEL_INPUT)

    return buf->max_size / 1.05 - (buf->size - buf->off);

  else

    return buf->max_size - (buf->size - buf->off);

}

const u_char *

sshbuf_ptr(const struct sshbuf *buf)

{

  if (sshbuf_check_sanity(buf) != 0)

    return NULL;

  return buf->cd + buf->off;

}

u_char *

sshbuf_mutable_ptr(const struct sshbuf *buf)

{

  if (sshbuf_check_sanity(buf) != 0 || buf->readonly || buf->refcount > 1)

    return NULL;

  return buf->d + buf->off;

}

int

sshbuf_check_reserve(const struct sshbuf *buf, size_t len)

{

  int r;

  if ((r = sshbuf_check_sanity(buf)) != 0)

    return r;

  if (buf->readonly || buf->refcount > 1)

    return SSH_ERR_BUFFER_READ_ONLY;

  SSHBUF_TELL("check");

  /* Check that len is reasonable and that max_size + available < len */

  if (len > buf->max_size || buf->max_size - len < buf->size - buf->off)

    return SSH_ERR_NO_BUFFER_SPACE;

  return 0;

}

int

sshbuf_allocate(struct sshbuf *buf, size_t len)

{

  size_t rlen, need;

  u_char *dp;

  int r;

  SSHBUF_DBG(("allocate buf = %p len = %zu", buf, len));

  if ((r = sshbuf_check_reserve(buf, len)) != 0)

    return r;

  /*

   * If the requested allocation appended would push us past max_size

   * then pack the buffer, zeroing buf->off.

   */

  sshbuf_maybe_pack(buf, buf->size + len > buf->max_size);

  SSHBUF_TELL("allocate");

  if (len + buf->size <= buf->alloc)

    return 0; /* already have it. */

  /*

   * Prefer to alloc in SSHBUF_SIZE_INC units, but

   * allocate less if doing so would overflow max_size.

   */

  need = len + buf->size - buf->alloc;

  rlen = ROUNDUP(buf->alloc + need, SSHBUF_SIZE_INC);

  /* With the changes in 8.9 the output buffer end up growing pretty

   * slowly. It's knows that it needs to grow but it only does so 32K

   * at a time. This means a lot of calls to realloc and memcpy which

   * kills performance until the buffer reaches some maximum size.

   * So we explicitly test for a buffer that's trying to grow and

   * if it is then we push the growth by 4MB at a time. This can result in

   * the buffer being over allocated (in terms of actual needs) but the

   * process is fast. This significantly reduces overhead

   * and improves performance. In this case we look for a buffer that is trying

   * to grow larger than BUF_WATERSHED (256*1024 taken from PACKET_MAX_SIZE)

   * and explcitly check that the buffer is being used for inbound outbound

   * channel buffering.

   * Updated for 18.4.1 -cjr 04/20/24

   */

  if (rlen > BUF_WATERSHED && (buf->type == BUF_CHANNEL_OUTPUT || buf->type == BUF_CHANNEL_INPUT)) {

    /* debug_f ("Prior: label: %s, %p, rlen is %zu need is %zu max_size is %zu",

       buf->label, buf, rlen, need, buf->max_size); */

    /* easiest thing to do is grow the nuffer by 4MB each time. It might end

     * up being somewhat overallocated but works quickly */

    need = (4*1024*1024);

    rlen = ROUNDUP(buf->alloc + need, SSHBUF_SIZE_INC);

    /* debug_f ("Post: label: %s, %p, rlen is %zu need is %zu max_size is %zu", */

    /*   buf->label, buf, rlen, need, buf->max_size); */

  }

  SSHBUF_DBG(("need %zu initial rlen %zu", need, rlen));

  /* rlen might be above the max allocation */

  if (rlen > buf->max_size)

    rlen = buf->max_size;

  SSHBUF_DBG(("adjusted rlen %zu", rlen));

  if ((dp = recallocarray(buf->d, buf->alloc, rlen, 1)) == NULL) {

    SSHBUF_DBG(("realloc fail"));

    return SSH_ERR_ALLOC_FAIL;

  }

  buf->alloc = rlen;

  buf->cd = buf->d = dp;

  if ((r = sshbuf_check_reserve(buf, len)) < 0) {

    /* shouldn't fail */

    return r;

  }

  SSHBUF_TELL("done");

  return 0;

}

int

sshbuf_reserve(struct sshbuf *buf, size_t len, u_char **dpp)

{

  u_char *dp;

  int r;

  if (dpp != NULL)

    *dpp = NULL;

  SSHBUF_DBG(("reserve buf = %p len = %zu", buf, len));

  if ((r = sshbuf_allocate(buf, len)) != 0)

    return r;

  dp = buf->d + buf->size;

  buf->size += len;

  if (dpp != NULL)

    *dpp = dp;

  return 0;

}

int

sshbuf_consume(struct sshbuf *buf, size_t len)

{

  int r;

  SSHBUF_DBG(("len = %zu", len));

  if ((r = sshbuf_check_sanity(buf)) != 0)

    return r;

  if (len == 0)

    return 0;

  if (len > sshbuf_len(buf))

    return SSH_ERR_MESSAGE_INCOMPLETE;

  buf->off += len;

  /* deal with empty buffer */

  if (buf->off == buf->size)

    buf->off = buf->size = 0;

  SSHBUF_TELL("done");

  return 0;

}

int

sshbuf_consume_end(struct sshbuf *buf, size_t len)

{

  int r;

  SSHBUF_DBG(("len = %zu", len));

  if ((r = sshbuf_check_sanity(buf)) != 0)

    return r;

  if (len == 0)

    return 0;

  if (len > sshbuf_len(buf))

    return SSH_ERR_MESSAGE_INCOMPLETE;

  buf->size -= len;

  SSHBUF_TELL("done");

  return 0;

}