module deimos.openssl.bytestring;

import std.stdint;

// Bytestrings are used for parsing and building TLS and ASN.1 messages.
//
// A "CBS" (CRYPTO ByteString) represents a string of bytes in memory and
// provides utility functions for safely parsing length-prefixed structures
// like TLS and ASN.1 from it.
//
// A "CBB" (CRYPTO ByteBuilder) is a memory buffer that grows as needed and
// provides utility functions for building length-prefixed messages.


extern (C):
nothrow:

// CRYPTO ByteString

struct cbs_st {
  const uint8_t *data;
  size_t len;
}

alias CBS = cbs_st;

// CBS_init sets |cbs| to point to |data|. It does not take ownership of
// |data|.
void CBS_init(CBS *cbs, const(uint8_t) *data, size_t len);

// CBS_skip advances |cbs| by |len| bytes. It returns one on success and zero
// otherwise.
int CBS_skip(CBS *cbs, size_t len);

// CBS_data returns a pointer to the contents of |cbs|.
const(uint8_t) *CBS_data(const(CBS) *cbs);

// CBS_len returns the number of bytes remaining in |cbs|.
size_t CBS_len(const(CBS) *cbs);

// CBS_stow copies the current contents of |cbs| into |*out_ptr| and
// |*out_len|. If |*out_ptr| is not NULL, the contents are freed with
// OPENSSL_free. It returns one on success and zero on allocation failure. On
// success, |*out_ptr| should be freed with OPENSSL_free. If |cbs| is empty,
// |*out_ptr| will be NULL.
int CBS_stow(const(CBS) *cbs, uint8_t **out_ptr, size_t *out_len);

// CBS_strdup copies the current contents of |cbs| into |*out_ptr| as a
// NUL-terminated C string. If |*out_ptr| is not NULL, the contents are freed
// with OPENSSL_free. It returns one on success and zero on allocation
// failure. On success, |*out_ptr| should be freed with OPENSSL_free.
//
// NOTE: If |cbs| contains NUL bytes, the string will be truncated. Call
// |CBS_contains_zero_byte(cbs)| to check for NUL bytes.
int CBS_strdup(const(CBS) *cbs, char **out_ptr);

// CBS_contains_zero_byte returns one if the current contents of |cbs| contains
// a NUL byte and zero otherwise.
int CBS_contains_zero_byte(const(CBS) *cbs);

// CBS_mem_equal compares the current contents of |cbs| with the |len| bytes
// starting at |data|. If they're equal, it returns one, otherwise zero. If the
// lengths match, it uses a constant-time comparison.
int CBS_mem_equal(const(CBS) *cbs, const uint8_t *data,
                                 size_t len);

// CBS_get_u8 sets |*out_ptr| to the next uint8_t from |cbs| and advances |cbs|. It
// returns one on success and zero on error.
int CBS_get_u8(CBS *cbs, uint8_t *out_ptr);

// CBS_get_u16 sets |*out_ptr| to the next, big-endian uint16_t from |cbs| and
// advances |cbs|. It returns one on success and zero on error.
int CBS_get_u16(CBS *cbs, uint16_t *out_ptr);

// CBS_get_u24 sets |*out_ptr| to the next, big-endian 24-bit value from |cbs| and
// advances |cbs|. It returns one on success and zero on error.
int CBS_get_u24(CBS *cbs, uint32_t *out_ptr);

// CBS_get_u32 sets |*out_ptr| to the next, big-endian uint32_t value from |cbs|
// and advances |cbs|. It returns one on success and zero on error.
int CBS_get_u32(CBS *cbs, uint32_t *out_ptr);

// CBS_get_last_u8 sets |*out_ptr| to the last uint8_t from |cbs| and shortens
// |cbs|. It returns one on success and zero on error.
int CBS_get_last_u8(CBS *cbs, uint8_t *out_ptr);

// CBS_get_bytes sets |*out_ptr| to the next |len| bytes from |cbs| and advances
// |cbs|. It returns one on success and zero on error.
int CBS_get_bytes(CBS *cbs, CBS *out_ptr, size_t len);

// CBS_copy_bytes copies the next |len| bytes from |cbs| to |out| and advances
// |cbs|. It returns one on success and zero on error.
int CBS_copy_bytes(CBS *cbs, uint8_t *out_ptr, size_t len);

// CBS_get_u8_length_prefixed sets |*out_ptr| to the contents of an 8-bit,
// length-prefixed value from |cbs| and advances |cbs| over it. It returns one
// on success and zero on error.
int CBS_get_u8_length_prefixed(CBS *cbs, CBS *out_ptr);

// CBS_get_u16_length_prefixed sets |*out_ptr| to the contents of a 16-bit,
// big-endian, length-prefixed value from |cbs| and advances |cbs| over it. It
// returns one on success and zero on error.
int CBS_get_u16_length_prefixed(CBS *cbs, CBS *out_ptr);

// CBS_get_u24_length_prefixed sets |*out_ptr| to the contents of a 24-bit,
// big-endian, length-prefixed value from |cbs| and advances |cbs| over it. It
// returns one on success and zero on error.
int CBS_get_u24_length_prefixed(CBS *cbs, CBS *out_ptr);


// Parsing ASN.1

// The following values are tag numbers for UNIVERSAL elements.
enum CBS_ASN1_BOOLEAN = 0x1;
enum CBS_ASN1_INTEGER = 0x2;
enum CBS_ASN1_BITSTRING = 0x3;
enum CBS_ASN1_OCTETSTRING = 0x4;
enum CBS_ASN1_NULL = 0x5;
enum CBS_ASN1_OBJECT = 0x6;
enum CBS_ASN1_ENUMERATED = 0xa;
enum CBS_ASN1_UTF8STRING = 0xc;
enum CBS_ASN1_SEQUENCE = (0x10 | CBS_ASN1_CONSTRUCTED);
enum CBS_ASN1_SET = (0x11 | CBS_ASN1_CONSTRUCTED);
enum CBS_ASN1_NUMERICSTRING = 0x12;
enum CBS_ASN1_PRINTABLESTRING = 0x13;
enum CBS_ASN1_T61STRING = 0x14;
enum CBS_ASN1_VIDEOTEXSTRING = 0x15;
enum CBS_ASN1_IA5STRING = 0x16;
enum CBS_ASN1_UTCTIME = 0x17;
enum CBS_ASN1_GENERALIZEDTIME = 0x18;
enum CBS_ASN1_GRAPHICSTRING = 0x19;
enum CBS_ASN1_VISIBLESTRING = 0x1a;
enum CBS_ASN1_GENERALSTRING = 0x1b;
enum CBS_ASN1_UNIVERSALSTRING = 0x1c;
enum CBS_ASN1_BMPSTRING = 0x1e;

// CBS_ASN1_TAG_SHIFT is how much the in-memory representation shifts the class
// and constructed bits from the DER serialization. This allows representing tag
// numbers beyond 31.
//
// Consumers must use the following constants to decompose or assemble tags.
enum CBS_ASN1_TAG_SHIFT = 24;

// CBS_ASN1_CONSTRUCTED may be ORed into a tag to toggle the constructed
// bit. |CBS| and |CBB| APIs consider the constructed bit to be part of the
// tag.
enum CBS_ASN1_CONSTRUCTED = (0x20 << CBS_ASN1_TAG_SHIFT);

// The following values specify the tag class and may be ORed into a tag number
// to produce the final tag. If none is used, the tag will be UNIVERSAL.
enum CBS_ASN1_UNIVERSAL = (0 << CBS_ASN1_TAG_SHIFT);
enum CBS_ASN1_APPLICATION = (0x40 << CBS_ASN1_TAG_SHIFT);
enum CBS_ASN1_CONTEXT_SPECIFIC = (0x80 << CBS_ASN1_TAG_SHIFT);
enum CBS_ASN1_PRIVATE = (0xc0 << CBS_ASN1_TAG_SHIFT);

// CBS_ASN1_CLASS_MASK may be ANDed with a tag to query its class. This will
// give one of the four values above.
enum CBS_ASN1_CLASS_MASK = (0xc0 << CBS_ASN1_TAG_SHIFT);

// CBS_ASN1_TAG_NUMBER_MASK may be ANDed with a tag to query its number.
enum CBS_ASN1_TAG_NUMBER_MASK = ((1 << (5 + CBS_ASN1_TAG_SHIFT)) - 1);

// CBS_get_asn1 sets |*out_ptr| to the contents of DER-encoded, ASN.1 element (not
// including tag and length bytes) and advances |cbs| over it. The ASN.1
// element must match |tag_value|. It returns one on success and zero
// on error.
int CBS_get_asn1(CBS *cbs, CBS *out_ptr, uint tag_value);

// CBS_get_asn1_element acts like |CBS_get_asn1| but |out| will include the
// ASN.1 header bytes too.
int CBS_get_asn1_element(CBS *cbs, CBS *out_ptr, uint tag_value);

// CBS_peek_asn1_tag looks ahead at the next ASN.1 tag and returns one
// if the next ASN.1 element on |cbs| would have tag |tag_value|. If
// |cbs| is empty or the tag does not match, it returns zero. Note: if
// it returns one, CBS_get_asn1 may still fail if the rest of the
// element is malformed.
int CBS_peek_asn1_tag(const(CBS) *cbs, uint tag_value);

// CBS_get_any_asn1 sets |*out_ptr| to contain the next ASN.1 element from |*cbs|
// (not including tag and length bytes), sets |*out_tag| to the tag number, and
// advances |*cbs|. It returns one on success and zero on error. Either of |out|
// and |out_tag| may be NULL to ignore the value.
int CBS_get_any_asn1(CBS *cbs, CBS *out_ptr, uint *out_tag);

// CBS_get_any_asn1_element sets |*out_ptr| to contain the next ASN.1 element from
// |*cbs| (including header bytes) and advances |*cbs|. It sets |*out_tag| to
// the tag number and |*out_header_len| to the length of the ASN.1 header. Each
// of |out|, |out_tag|, and |out_header_len| may be NULL to ignore the value.
int CBS_get_any_asn1_element(CBS *cbs, CBS *out_ptr,
                                            uint *out_tag,
                                            size_t *out_header_len);

// CBS_get_any_ber_asn1_element acts the same as |CBS_get_any_asn1_element| but
// also allows indefinite-length elements to be returned. In that case,
// |*out_header_len| and |CBS_len(out)| will both be two as only the header is
// returned, otherwise it behaves the same as the previous function.
int CBS_get_any_ber_asn1_element(CBS *cbs, CBS *out_ptr,
                                                uint *out_tag,
                                                size_t *out_header_len);

// CBS_get_asn1_uint64 gets an ASN.1 INTEGER from |cbs| using |CBS_get_asn1|
// and sets |*out_ptr| to its value. It returns one on success and zero on error,
// where error includes the integer being negative, or too large to represent
// in 64 bits.
int CBS_get_asn1_uint64(CBS *cbs, uint64_t *out_ptr);

// CBS_get_asn1_bool gets an ASN.1 BOOLEAN from |cbs| and sets |*out_ptr| to zero
// or one based on its value. It returns one on success or zero on error.
int CBS_get_asn1_bool(CBS *cbs, int *out_ptr);

// CBS_get_optional_asn1 gets an optional explicitly-tagged element from |cbs|
// tagged with |tag| and sets |*out_ptr| to its contents, or ignores it if |out| is
// NULL. If present and if |out_present| is not NULL, it sets |*out_present| to
// one, otherwise zero. It returns one on success, whether or not the element
// was present, and zero on decode failure.
int CBS_get_optional_asn1(CBS *cbs, CBS *out_ptr, int *out_present,
                                         uint tag);

// CBS_get_optional_asn1_octet_string gets an optional
// explicitly-tagged OCTET STRING from |cbs|. If present, it sets
// |*out_ptr| to the string and |*out_present| to one. Otherwise, it sets
// |*out_ptr| to empty and |*out_present| to zero. |out_present| may be
// NULL. It returns one on success, whether or not the element was
// present, and zero on decode failure.
int CBS_get_optional_asn1_octet_string(CBS *cbs, CBS *out_ptr,
                                                      int *out_present,
                                                      uint tag);

// CBS_get_optional_asn1_uint64 gets an optional explicitly-tagged
// INTEGER from |cbs|. If present, it sets |*out_ptr| to the
// value. Otherwise, it sets |*out_ptr| to |default_value|. It returns one
// on success, whether or not the element was present, and zero on
// decode failure.
int CBS_get_optional_asn1_uint64(CBS *cbs, uint64_t *out_ptr,
                                                uint tag,
                                                uint64_t default_value);

// CBS_get_optional_asn1_bool gets an optional, explicitly-tagged BOOLEAN from
// |cbs|. If present, it sets |*out_ptr| to either zero or one, based on the
// boolean. Otherwise, it sets |*out_ptr| to |default_value|. It returns one on
// success, whether or not the element was present, and zero on decode
// failure.
int CBS_get_optional_asn1_bool(CBS *cbs, int *out_ptr, uint tag,
                                              int default_value);

// CBS_is_valid_asn1_bitstring returns one if |cbs| is a valid ASN.1 BIT STRING
// and zero otherwise.
int CBS_is_valid_asn1_bitstring(const(CBS) *cbs);

// CBS_asn1_bitstring_has_bit returns one if |cbs| is a valid ASN.1 BIT STRING
// and the specified bit is present and set. Otherwise, it returns zero. |bit|
// is indexed starting from zero.
int CBS_asn1_bitstring_has_bit(const(CBS) *cbs, uint bit);

// CBS_asn1_oid_to_text interprets |cbs| as DER-encoded ASN.1 OBJECT IDENTIFIER
// contents (not including the element framing) and returns the ASCII
// representation (e.g., "1.2.840.113554.4.1.72585") in a newly-allocated
// string, or NULL on failure. The caller must release the result with
// |OPENSSL_free|.
char *CBS_asn1_oid_to_text(const(CBS) *cbs);


// CRYPTO ByteBuilder.
//
// |CBB| objects allow one to build length-prefixed serialisations. A |CBB|
// object is associated with a buffer and new buffers are created with
// |CBB_init|. Several |CBB| objects can point at the same buffer when a
// length-prefix is pending, however only a single |CBB| can be 'current' at
// any one time. For example, if one calls |CBB_add_u8_length_prefixed| then
// the new |CBB| points at the same buffer as the original. But if the original
// |CBB| is used then the length prefix is written out and the new |CBB| must
// not be used again.
//
// If one needs to force a length prefix to be written out because a |CBB| is
// going out of scope, use |CBB_flush|. If an operation on a |CBB| fails, it is
// in an undefined state and must not be used except to call |CBB_cleanup|.

struct cbb_buffer_st {
  uint8_t *buf;
  size_t len;      // The number of valid bytes.
  size_t cap;      // The size of buf.
  char can_resize; /* One iff |buf| is owned by this object. If not then |buf|
                      cannot be resized. */
  char error;      /* One iff there was an error writing to this CBB. All future
                      operations will fail. */
}

struct cbb_st {
  cbb_buffer_st *base;
  // child points to a child CBB if a length-prefix is pending.
  CBB *child;
  // offset is the number of bytes from the start of |base->buf| to this |CBB|'s
  // pending length prefix.
  size_t offset;
  // pending_len_len contains the number of bytes in this |CBB|'s pending
  // length-prefix, or zero if no length-prefix is pending.
  uint8_t pending_len_len;
  char pending_is_asn1;
  // is_top_level is true iff this is a top-level |CBB| (as opposed to a child
  // |CBB|). Top-level objects are valid arguments for |CBB_finish|.
  char is_top_level;
}

alias CBB = cbb_st;

// CBB_zero sets an uninitialised |cbb| to the zero state. It must be
// initialised with |CBB_init| or |CBB_init_fixed| before use, but it is safe to
// call |CBB_cleanup| without a successful |CBB_init|. This may be used for more
// uniform cleanup of a |CBB|.
void CBB_zero(CBB *cbb);

// CBB_init initialises |cbb| with |initial_capacity|. Since a |CBB| grows as
// needed, the |initial_capacity| is just a hint. It returns one on success or
// zero on error.
int CBB_init(CBB *cbb, size_t initial_capacity);

// CBB_init_fixed initialises |cbb| to write to |len| bytes at |buf|. Since
// |buf| cannot grow, trying to write more than |len| bytes will cause CBB
// functions to fail. It returns one on success or zero on error.
int CBB_init_fixed(CBB *cbb, uint8_t *buf, size_t len);

// CBB_cleanup frees all resources owned by |cbb| and other |CBB| objects
// writing to the same buffer. This should be used in an error case where a
// serialisation is abandoned.
//
// This function can only be called on a "top level" |CBB|, i.e. one initialised
// with |CBB_init| or |CBB_init_fixed|, or a |CBB| set to the zero state with
// |CBB_zero|.
void CBB_cleanup(CBB *cbb);

// CBB_finish completes any pending length prefix and sets |*out_data| to a
// malloced buffer and |*out_len| to the length of that buffer. The caller
// takes ownership of the buffer and, unless the buffer was fixed with
// |CBB_init_fixed|, must call |OPENSSL_free| when done.
//
// It can only be called on a "top level" |CBB|, i.e. one initialised with
// |CBB_init| or |CBB_init_fixed|. It returns one on success and zero on
// error.
int CBB_finish(CBB *cbb, uint8_t **out_data, size_t *out_len);

// CBB_flush causes any pending length prefixes to be written out and any child
// |CBB| objects of |cbb| to be invalidated. This allows |cbb| to continue to be
// used after the children go out of scope, e.g. when local |CBB| objects are
// added as children to a |CBB| that persists after a function returns. This
// function returns one on success or zero on error.
int CBB_flush(CBB *cbb);

// CBB_data returns a pointer to the bytes written to |cbb|. It does not flush
// |cbb|. The pointer is valid until the next operation to |cbb|.
//
// To avoid unfinalized length prefixes, it is a fatal error to call this on a
// CBB with any active children.
const(uint8_t) *CBB_data(const CBB *cbb);

// CBB_len returns the number of bytes written to |cbb|. It does not flush
// |cbb|.
//
// To avoid unfinalized length prefixes, it is a fatal error to call this on a
// CBB with any active children.
size_t CBB_len(const CBB *cbb);

// CBB_add_u8_length_prefixed sets |*out_contents| to a new child of |cbb|. The
// data written to |*out_contents| will be prefixed in |cbb| with an 8-bit
// length. It returns one on success or zero on error.
int CBB_add_u8_length_prefixed(CBB *cbb, CBB *out_contents);

// CBB_add_u16_length_prefixed sets |*out_contents| to a new child of |cbb|.
// The data written to |*out_contents| will be prefixed in |cbb| with a 16-bit,
// big-endian length. It returns one on success or zero on error.
int CBB_add_u16_length_prefixed(CBB *cbb, CBB *out_contents);

// CBB_add_u24_length_prefixed sets |*out_contents| to a new child of |cbb|.
// The data written to |*out_contents| will be prefixed in |cbb| with a 24-bit,
// big-endian length. It returns one on success or zero on error.
int CBB_add_u24_length_prefixed(CBB *cbb, CBB *out_contents);

// CBB_add_asn1 sets |*out_contents| to a |CBB| into which the contents of an
// ASN.1 object can be written. The |tag| argument will be used as the tag for
// the object. It returns one on success or zero on error.
int CBB_add_asn1(CBB *cbb, CBB *out_contents, uint tag);

// CBB_add_bytes appends |len| bytes from |data| to |cbb|. It returns one on
// success and zero otherwise.
int CBB_add_bytes(CBB *cbb, const uint8_t *data, size_t len);

// CBB_add_space appends |len| bytes to |cbb| and sets |*out_data| to point to
// the beginning of that space. The caller must then write |len| bytes of
// actual contents to |*out_data|. It returns one on success and zero
// otherwise.
int CBB_add_space(CBB *cbb, uint8_t **out_data, size_t len);

// CBB_reserve ensures |cbb| has room for |len| additional bytes and sets
// |*out_data| to point to the beginning of that space. It returns one on
// success and zero otherwise. The caller may write up to |len| bytes to
// |*out_data| and call |CBB_did_write| to complete the write. |*out_data| is
// valid until the next operation on |cbb| or an ancestor |CBB|.
int CBB_reserve(CBB *cbb, uint8_t **out_data, size_t len);

// CBB_did_write advances |cbb| by |len| bytes, assuming the space has been
// written to by the caller. It returns one on success and zero on error.
int CBB_did_write(CBB *cbb, size_t len);

// CBB_add_u8 appends an 8-bit number from |value| to |cbb|. It returns one on
// success and zero otherwise.
int CBB_add_u8(CBB *cbb, uint8_t value);

// CBB_add_u16 appends a 16-bit, big-endian number from |value| to |cbb|. It
// returns one on success and zero otherwise.
int CBB_add_u16(CBB *cbb, uint16_t value);

// CBB_add_u24 appends a 24-bit, big-endian number from |value| to |cbb|. It
// returns one on success and zero otherwise.
int CBB_add_u24(CBB *cbb, uint32_t value);

// CBB_add_u32 appends a 32-bit, big-endian number from |value| to |cbb|. It
// returns one on success and zero otherwise.
int CBB_add_u32(CBB *cbb, uint32_t value);

// CBB_discard_child discards the current unflushed child of |cbb|. Neither the
// child's contents nor the length prefix will be included in the output.
void CBB_discard_child(CBB *cbb);

// CBB_add_asn1_uint64 writes an ASN.1 INTEGER into |cbb| using |CBB_add_asn1|
// and writes |value| in its contents. It returns one on success and zero on
// error.
int CBB_add_asn1_uint64(CBB *cbb, uint64_t value);

// CBB_add_asn1_octet_string writes an ASN.1 OCTET STRING into |cbb| with the
// given contents. It returns one on success and zero on error.
int CBB_add_asn1_octet_string(CBB *cbb, const uint8_t *data,
                                             size_t data_len);

// CBB_add_asn1_bool writes an ASN.1 BOOLEAN into |cbb| which is true iff
// |value| is non-zero.  It returns one on success and zero on error.
int CBB_add_asn1_bool(CBB *cbb, int value);

// CBB_add_asn1_oid_from_text decodes |len| bytes from |text| as an ASCII OID
// representation, e.g. "1.2.840.113554.4.1.72585", and writes the DER-encoded
// contents to |cbb|. It returns one on success and zero on malloc failure or if
// |text| was invalid. It does not include the OBJECT IDENTIFER framing, only
// the element's contents.
//
// This function considers OID strings with components which do not fit in a
// |uint64_t| to be invalid.
int CBB_add_asn1_oid_from_text(CBB *cbb, const char *text,
                                              size_t len);

// CBB_flush_asn1_set_of calls |CBB_flush| on |cbb| and then reorders the
// contents for a DER-encoded ASN.1 SET OF type. It returns one on success and
// zero on failure. DER canonicalizes SET OF contents by sorting
// lexicographically by encoding. Call this function when encoding a SET OF
// type in an order that is not already known to be canonical.
//
// Note a SET type has a slightly different ordering than a SET OF.
int CBB_flush_asn1_set_of(CBB *cbb);