buf.h 5.4 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137
  1. /* Copyright (C) 1995-1998 Eric Young (eay@cryptsoft.com)
  2. * All rights reserved.
  3. *
  4. * This package is an SSL implementation written
  5. * by Eric Young (eay@cryptsoft.com).
  6. * The implementation was written so as to conform with Netscapes SSL.
  7. *
  8. * This library is free for commercial and non-commercial use as long as
  9. * the following conditions are aheared to. The following conditions
  10. * apply to all code found in this distribution, be it the RC4, RSA,
  11. * lhash, DES, etc., code; not just the SSL code. The SSL documentation
  12. * included with this distribution is covered by the same copyright terms
  13. * except that the holder is Tim Hudson (tjh@cryptsoft.com).
  14. *
  15. * Copyright remains Eric Young's, and as such any Copyright notices in
  16. * the code are not to be removed.
  17. * If this package is used in a product, Eric Young should be given attribution
  18. * as the author of the parts of the library used.
  19. * This can be in the form of a textual message at program startup or
  20. * in documentation (online or textual) provided with the package.
  21. *
  22. * Redistribution and use in source and binary forms, with or without
  23. * modification, are permitted provided that the following conditions
  24. * are met:
  25. * 1. Redistributions of source code must retain the copyright
  26. * notice, this list of conditions and the following disclaimer.
  27. * 2. Redistributions in binary form must reproduce the above copyright
  28. * notice, this list of conditions and the following disclaimer in the
  29. * documentation and/or other materials provided with the distribution.
  30. * 3. All advertising materials mentioning features or use of this software
  31. * must display the following acknowledgement:
  32. * "This product includes cryptographic software written by
  33. * Eric Young (eay@cryptsoft.com)"
  34. * The word 'cryptographic' can be left out if the rouines from the library
  35. * being used are not cryptographic related :-).
  36. * 4. If you include any Windows specific code (or a derivative thereof) from
  37. * the apps directory (application code) you must include an acknowledgement:
  38. * "This product includes software written by Tim Hudson (tjh@cryptsoft.com)"
  39. *
  40. * THIS SOFTWARE IS PROVIDED BY ERIC YOUNG ``AS IS'' AND
  41. * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  42. * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  43. * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  44. * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  45. * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  46. * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  47. * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  48. * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  49. * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  50. * SUCH DAMAGE.
  51. *
  52. * The licence and distribution terms for any publically available version or
  53. * derivative of this code cannot be changed. i.e. this code cannot simply be
  54. * copied and put under another distribution licence
  55. * [including the GNU Public Licence.] */
  56. #ifndef OPENSSL_HEADER_BUFFER_H
  57. #define OPENSSL_HEADER_BUFFER_H
  58. #include <openssl/base.h>
  59. #if defined(__cplusplus)
  60. extern "C" {
  61. #endif
  62. // Memory and string functions, see also mem.h.
  63. // buf_mem_st (aka |BUF_MEM|) is a generic buffer object used by OpenSSL.
  64. struct buf_mem_st {
  65. size_t length; // current number of bytes
  66. char *data;
  67. size_t max; // size of buffer
  68. };
  69. // BUF_MEM_new creates a new BUF_MEM which has no allocated data buffer.
  70. OPENSSL_EXPORT BUF_MEM *BUF_MEM_new(void);
  71. // BUF_MEM_free frees |buf->data| if needed and then frees |buf| itself.
  72. OPENSSL_EXPORT void BUF_MEM_free(BUF_MEM *buf);
  73. // BUF_MEM_reserve ensures |buf| has capacity |cap| and allocates memory if
  74. // needed. It returns one on success and zero on error.
  75. OPENSSL_EXPORT int BUF_MEM_reserve(BUF_MEM *buf, size_t cap);
  76. // BUF_MEM_grow ensures that |buf| has length |len| and allocates memory if
  77. // needed. If the length of |buf| increased, the new bytes are filled with
  78. // zeros. It returns the length of |buf|, or zero if there's an error.
  79. OPENSSL_EXPORT size_t BUF_MEM_grow(BUF_MEM *buf, size_t len);
  80. // BUF_MEM_grow_clean calls |BUF_MEM_grow|. BoringSSL always zeros memory
  81. // allocated memory on free.
  82. OPENSSL_EXPORT size_t BUF_MEM_grow_clean(BUF_MEM *buf, size_t len);
  83. // BUF_MEM_append appends |in| to |buf|. It returns one on success and zero on
  84. // error.
  85. OPENSSL_EXPORT int BUF_MEM_append(BUF_MEM *buf, const void *in, size_t len);
  86. // Deprecated functions.
  87. // BUF_strdup calls |OPENSSL_strdup|.
  88. OPENSSL_EXPORT char *BUF_strdup(const char *str);
  89. // BUF_strnlen calls |OPENSSL_strnlen|.
  90. OPENSSL_EXPORT size_t BUF_strnlen(const char *str, size_t max_len);
  91. // BUF_strndup calls |OPENSSL_strndup|.
  92. OPENSSL_EXPORT char *BUF_strndup(const char *str, size_t size);
  93. // BUF_memdup calls |OPENSSL_memdup|.
  94. OPENSSL_EXPORT void *BUF_memdup(const void *data, size_t size);
  95. // BUF_strlcpy calls |OPENSSL_strlcpy|.
  96. OPENSSL_EXPORT size_t BUF_strlcpy(char *dst, const char *src, size_t dst_size);
  97. // BUF_strlcat calls |OPENSSL_strlcat|.
  98. OPENSSL_EXPORT size_t BUF_strlcat(char *dst, const char *src, size_t dst_size);
  99. #if defined(__cplusplus)
  100. } // extern C
  101. extern "C++" {
  102. BSSL_NAMESPACE_BEGIN
  103. BORINGSSL_MAKE_DELETER(BUF_MEM, BUF_MEM_free)
  104. BSSL_NAMESPACE_END
  105. } // extern C++
  106. #endif
  107. #endif // OPENSSL_HEADER_BUFFER_H