http_chunks.h 3.4 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100
  1. #ifndef HEADER_CURL_HTTP_CHUNKS_H
  2. #define HEADER_CURL_HTTP_CHUNKS_H
  3. /***************************************************************************
  4. * _ _ ____ _
  5. * Project ___| | | | _ \| |
  6. * / __| | | | |_) | |
  7. * | (__| |_| | _ <| |___
  8. * \___|\___/|_| \_\_____|
  9. *
  10. * Copyright (C) 1998 - 2022, Daniel Stenberg, <daniel@haxx.se>, et al.
  11. *
  12. * This software is licensed as described in the file COPYING, which
  13. * you should have received as part of this distribution. The terms
  14. * are also available at https://curl.se/docs/copyright.html.
  15. *
  16. * You may opt to use, copy, modify, merge, publish, distribute and/or sell
  17. * copies of the Software, and permit persons to whom the Software is
  18. * furnished to do so, under the terms of the COPYING file.
  19. *
  20. * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
  21. * KIND, either express or implied.
  22. *
  23. * SPDX-License-Identifier: curl
  24. *
  25. ***************************************************************************/
  26. struct connectdata;
  27. /*
  28. * The longest possible hexadecimal number we support in a chunked transfer.
  29. * Neither RFC2616 nor the later HTTP specs define a maximum chunk size.
  30. * For 64 bit curl_off_t we support 16 digits. For 32 bit, 8 digits.
  31. */
  32. #define CHUNK_MAXNUM_LEN (SIZEOF_CURL_OFF_T * 2)
  33. typedef enum {
  34. /* await and buffer all hexadecimal digits until we get one that isn't a
  35. hexadecimal digit. When done, we go CHUNK_LF */
  36. CHUNK_HEX,
  37. /* wait for LF, ignore all else */
  38. CHUNK_LF,
  39. /* We eat the amount of data specified. When done, we move on to the
  40. POST_CR state. */
  41. CHUNK_DATA,
  42. /* POSTLF should get a CR and then a LF and nothing else, then move back to
  43. HEX as the CRLF combination marks the end of a chunk. A missing CR is no
  44. big deal. */
  45. CHUNK_POSTLF,
  46. /* Used to mark that we're out of the game. NOTE: that there's a 'datasize'
  47. field in the struct that will tell how many bytes that were not passed to
  48. the client in the end of the last buffer! */
  49. CHUNK_STOP,
  50. /* At this point optional trailer headers can be found, unless the next line
  51. is CRLF */
  52. CHUNK_TRAILER,
  53. /* A trailer CR has been found - next state is CHUNK_TRAILER_POSTCR.
  54. Next char must be a LF */
  55. CHUNK_TRAILER_CR,
  56. /* A trailer LF must be found now, otherwise CHUNKE_BAD_CHUNK will be
  57. signalled If this is an empty trailer CHUNKE_STOP will be signalled.
  58. Otherwise the trailer will be broadcasted via Curl_client_write() and the
  59. next state will be CHUNK_TRAILER */
  60. CHUNK_TRAILER_POSTCR
  61. } ChunkyState;
  62. typedef enum {
  63. CHUNKE_STOP = -1,
  64. CHUNKE_OK = 0,
  65. CHUNKE_TOO_LONG_HEX = 1,
  66. CHUNKE_ILLEGAL_HEX,
  67. CHUNKE_BAD_CHUNK,
  68. CHUNKE_BAD_ENCODING,
  69. CHUNKE_OUT_OF_MEMORY,
  70. CHUNKE_PASSTHRU_ERROR, /* Curl_httpchunk_read() returns a CURLcode to use */
  71. CHUNKE_LAST
  72. } CHUNKcode;
  73. const char *Curl_chunked_strerror(CHUNKcode code);
  74. struct Curl_chunker {
  75. curl_off_t datasize;
  76. ChunkyState state;
  77. unsigned char hexindex;
  78. char hexbuffer[ CHUNK_MAXNUM_LEN + 1]; /* +1 for null-terminator */
  79. };
  80. /* The following functions are defined in http_chunks.c */
  81. void Curl_httpchunk_init(struct Curl_easy *data);
  82. CHUNKcode Curl_httpchunk_read(struct Curl_easy *data, char *datap,
  83. ssize_t length, ssize_t *wrote,
  84. CURLcode *passthru);
  85. #endif /* HEADER_CURL_HTTP_CHUNKS_H */