pop3.h 3.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293
  1. #ifndef HEADER_CURL_POP3_H
  2. #define HEADER_CURL_POP3_H
  3. /***************************************************************************
  4. * _ _ ____ _
  5. * Project ___| | | | _ \| |
  6. * / __| | | | |_) | |
  7. * | (__| |_| | _ <| |___
  8. * \___|\___/|_| \_\_____|
  9. *
  10. * Copyright (C) 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. #include "pingpong.h"
  27. #include "curl_sasl.h"
  28. /****************************************************************************
  29. * POP3 unique setup
  30. ***************************************************************************/
  31. typedef enum {
  32. POP3_STOP, /* do nothing state, stops the state machine */
  33. POP3_SERVERGREET, /* waiting for the initial greeting immediately after
  34. a connect */
  35. POP3_CAPA,
  36. POP3_STARTTLS,
  37. POP3_UPGRADETLS, /* asynchronously upgrade the connection to SSL/TLS
  38. (multi mode only) */
  39. POP3_AUTH,
  40. POP3_APOP,
  41. POP3_USER,
  42. POP3_PASS,
  43. POP3_COMMAND,
  44. POP3_QUIT,
  45. POP3_LAST /* never used */
  46. } pop3state;
  47. /* This POP3 struct is used in the Curl_easy. All POP3 data that is
  48. connection-oriented must be in pop3_conn to properly deal with the fact that
  49. perhaps the Curl_easy is changed between the times the connection is
  50. used. */
  51. struct POP3 {
  52. curl_pp_transfer transfer;
  53. char *id; /* Message ID */
  54. char *custom; /* Custom Request */
  55. };
  56. /* pop3_conn is used for struct connection-oriented data in the connectdata
  57. struct */
  58. struct pop3_conn {
  59. struct pingpong pp;
  60. pop3state state; /* Always use pop3.c:state() to change state! */
  61. size_t eob; /* Number of bytes of the EOB (End Of Body) that
  62. have been received so far */
  63. size_t strip; /* Number of bytes from the start to ignore as
  64. non-body */
  65. struct SASL sasl; /* SASL-related storage */
  66. char *apoptimestamp; /* APOP timestamp from the server greeting */
  67. unsigned char authtypes; /* Accepted authentication types */
  68. unsigned char preftype; /* Preferred authentication type */
  69. BIT(ssldone); /* Is connect() over SSL done? */
  70. BIT(tls_supported); /* StartTLS capability supported by server */
  71. };
  72. extern const struct Curl_handler Curl_handler_pop3;
  73. extern const struct Curl_handler Curl_handler_pop3s;
  74. /* Authentication type flags */
  75. #define POP3_TYPE_CLEARTEXT (1 << 0)
  76. #define POP3_TYPE_APOP (1 << 1)
  77. #define POP3_TYPE_SASL (1 << 2)
  78. /* Authentication type values */
  79. #define POP3_TYPE_NONE 0
  80. #define POP3_TYPE_ANY (POP3_TYPE_CLEARTEXT|POP3_TYPE_APOP|POP3_TYPE_SASL)
  81. /* This is the 5-bytes End-Of-Body marker for POP3 */
  82. #define POP3_EOB "\x0d\x0a\x2e\x0d\x0a"
  83. #define POP3_EOB_LEN 5
  84. #endif /* HEADER_CURL_POP3_H */