Fixup internal documentation

[openssl.git] / ssl / packet_locl.h

diff --git a/ssl/packet_locl.h b/ssl/packet_locl.h
index ec31a331d21a5ec1326e1e7c2714e0e83ae77b73..9f8a09862057e94f06bb2d0603cd340d8d2bbbef 100644 (file)
--- a/ssl/packet_locl.h
+++ b/ssl/packet_locl.h
@@ -1,7 +1,7 @@
 /*
- * Copyright 2015-2016 The OpenSSL Project Authors. All Rights Reserved.
+ * Copyright 2015-2018 The OpenSSL Project Authors. All Rights Reserved.
  *
- * Licensed under the OpenSSL license (the "License").  You may not use
+ * Licensed under the Apache License 2.0 (the "License").  You may not use
  * this file except in compliance with the License.  You can obtain a copy
  * in the file LICENSE in the source distribution or at
  * https://www.openssl.org/source/license.html
@@ -18,10 +18,6 @@
 
 # include "internal/numbers.h"
 
-# ifdef __cplusplus
-extern "C" {
-# endif
-
 typedef struct {
     /* Pointer to where we are currently reading from */
     const unsigned char *curr;
@@ -164,9 +160,8 @@ __owur static ossl_inline int PACKET_get_net_2(PACKET *pkt, unsigned int *data)
 __owur static ossl_inline int PACKET_get_net_2_len(PACKET *pkt, size_t *data)
 {
     unsigned int i;
-    int ret;
+    int ret = PACKET_get_net_2(pkt, &i);
 
-    ret = PACKET_get_net_2(pkt, &i);
     if (ret)
         *data = (size_t)i;
 
@@ -206,9 +201,8 @@ __owur static ossl_inline int PACKET_get_net_3(PACKET *pkt, unsigned long *data)
 __owur static ossl_inline int PACKET_get_net_3_len(PACKET *pkt, size_t *data)
 {
     unsigned long i;
-    int ret;
+    int ret = PACKET_get_net_3(pkt, &i);
 
-    ret = PACKET_get_net_3(pkt, &i);
     if (ret)
         *data = (size_t)i;
 
@@ -249,9 +243,8 @@ __owur static ossl_inline int PACKET_get_net_4(PACKET *pkt, unsigned long *data)
 __owur static ossl_inline int PACKET_get_net_4_len(PACKET *pkt, size_t *data)
 {
     unsigned long i;
-    int ret;
+    int ret = PACKET_get_net_4(pkt, &i);
 
-    ret = PACKET_get_net_4(pkt, &i);
     if (ret)
         *data = (size_t)i;
 
@@ -285,9 +278,8 @@ __owur static ossl_inline int PACKET_get_1(PACKET *pkt, unsigned int *data)
 __owur static ossl_inline int PACKET_get_1_len(PACKET *pkt, size_t *data)
 {
     unsigned int i;
-    int ret;
+    int ret = PACKET_get_1(pkt, &i);
 
-    ret = PACKET_get_1(pkt, &i);
     if (ret)
         *data = (size_t)i;
 
@@ -629,6 +621,9 @@ struct wpacket_st {
     /* The buffer where we store the output data */
     BUF_MEM *buf;
 
+    /* Fixed sized buffer which can be used as an alternative to buf */
+    unsigned char *staticbuf;
+
     /*
      * Offset into the buffer where we are currently writing. We use an offset
      * in case the buffer grows and gets reallocated.
@@ -674,6 +669,13 @@ int WPACKET_init_len(WPACKET *pkt, BUF_MEM *buf, size_t lenbytes);
  */
 int WPACKET_init(WPACKET *pkt, BUF_MEM *buf);
 
+/*
+ * Same as WPACKET_init_len except we do not use a growable BUF_MEM structure.
+ * A fixed buffer of memory |buf| of size |len| is used instead. A failure will
+ * occur if you attempt to write beyond the end of the buffer
+ */
+int WPACKET_init_static_len(WPACKET *pkt, unsigned char *buf, size_t len,
+                            size_t lenbytes);
 /*
  * Set the flags to be applied to the current sub-packet
  */
@@ -693,6 +695,15 @@ int WPACKET_close(WPACKET *pkt);
  */
 int WPACKET_finish(WPACKET *pkt);
 
+/*
+ * Iterate through all the sub-packets and write out their lengths as if they
+ * were being closed. The lengths will be overwritten with the final lengths
+ * when the sub-packets are eventually closed (which may be different if more
+ * data is added to the WPACKET). This function fails if a sub-packet is of 0
+ * length and WPACKET_FLAGS_ABANDON_ON_ZERO_LENGTH is set.
+ */
+int WPACKET_fill_lengths(WPACKET *pkt);
+
 /*
  * Initialise a new sub-packet. Additionally |lenbytes| of data is preallocated
  * at the start of the sub-packet to store its length once we know it. Don't
@@ -722,7 +733,7 @@ int WPACKET_start_sub_packet(WPACKET *pkt);
 /*
  * Allocate bytes in the WPACKET for the output. This reserves the bytes
  * and counts them as "written", but doesn't actually do the writing. A pointer
- * to the allocated bytes is stored in |*allocbytes|.
+ * to the allocated bytes is stored in |*allocbytes|. |allocbytes| may be NULL.
  * WARNING: the allocated bytes must be filled in immediately, without further
  * WPACKET_* calls. If not then the underlying buffer may be realloc'd and
  * change its location.
@@ -818,6 +829,9 @@ int WPACKET_set_max_size(WPACKET *pkt, size_t maxsize);
 /* Copy |len| bytes of data from |*src| into the WPACKET. */
 int WPACKET_memcpy(WPACKET *pkt, const void *src, size_t len);
 
+/* Set |len| bytes of data to |ch| into the WPACKET. */
+int WPACKET_memset(WPACKET *pkt, int ch, size_t len);
+
 /*
  * Copy |len| bytes of data from |*src| into the WPACKET and prefix with its
  * length (consuming |lenbytes| of data for the length). Don't call this
@@ -848,11 +862,13 @@ int WPACKET_get_total_written(WPACKET *pkt, size_t *written);
  */
 int WPACKET_get_length(WPACKET *pkt, size_t *len);
 
+/*
+ * Returns a pointer to the current write location, but does not allocate any
+ * bytes.
+ */
+unsigned char *WPACKET_get_curr(WPACKET *pkt);
+
 /* Release resources in a WPACKET if a failure has occurred. */
 void WPACKET_cleanup(WPACKET *pkt);
 
-# ifdef __cplusplus
-}
-# endif
-
 #endif                          /* HEADER_PACKET_LOCL_H */