1#ifndef HEADER_CURL_POP3_H
2#define HEADER_CURL_POP3_H
3/***************************************************************************
4 *                                  _   _ ____  _
5 *  Project                     ___| | | |  _ \| |
6 *                             / __| | | | |_) | |
7 *                            | (__| |_| |  _ <| |___
8 *                             \___|\___/|_| \_\_____|
9 *
10 * Copyright (C) 2009 - 2013, 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 http://curl.haxx.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 ***************************************************************************/
24
25#include "pingpong.h"
26
27/****************************************************************************
28 * POP3 unique setup
29 ***************************************************************************/
30typedef enum {
31  POP3_STOP,         /* do nothing state, stops the state machine */
32  POP3_SERVERGREET,  /* waiting for the initial greeting immediately after
33                        a connect */
34  POP3_CAPA,
35  POP3_STARTTLS,
36  POP3_UPGRADETLS,   /* asynchronously upgrade the connection to SSL/TLS
37                       (multi mode only) */
38  POP3_AUTH_PLAIN,
39  POP3_AUTH_LOGIN,
40  POP3_AUTH_LOGIN_PASSWD,
41  POP3_AUTH_CRAMMD5,
42  POP3_AUTH_DIGESTMD5,
43  POP3_AUTH_DIGESTMD5_RESP,
44  POP3_AUTH_NTLM,
45  POP3_AUTH_NTLM_TYPE2MSG,
46  POP3_AUTH_XOAUTH2,
47  POP3_AUTH_CANCEL,
48  POP3_AUTH_FINAL,
49  POP3_APOP,
50  POP3_USER,
51  POP3_PASS,
52  POP3_COMMAND,
53  POP3_QUIT,
54  POP3_LAST          /* never used */
55} pop3state;
56
57/* This POP3 struct is used in the SessionHandle. All POP3 data that is
58   connection-oriented must be in pop3_conn to properly deal with the fact that
59   perhaps the SessionHandle is changed between the times the connection is
60   used. */
61struct POP3 {
62  curl_pp_transfer transfer;
63  char *id;               /* Message ID */
64  char *custom;           /* Custom Request */
65};
66
67/* pop3_conn is used for struct connection-oriented data in the connectdata
68   struct */
69struct pop3_conn {
70  struct pingpong pp;
71  pop3state state;        /* Always use pop3.c:state() to change state! */
72  bool ssldone;           /* Is connect() over SSL done? */
73  size_t eob;             /* Number of bytes of the EOB (End Of Body) that
74                             have been received so far */
75  size_t strip;           /* Number of bytes from the start to ignore as
76                             non-body */
77  unsigned int authtypes; /* Accepted authentication types */
78  unsigned int authmechs; /* Accepted SASL authentication mechanisms */
79  unsigned int preftype;  /* Preferred authentication type */
80  unsigned int prefmech;  /* Preferred SASL authentication mechanism */
81  unsigned int authused;  /* SASL auth mechanism used for the connection */
82  char *apoptimestamp;    /* APOP timestamp from the server greeting */
83  bool tls_supported;     /* StartTLS capability supported by server */
84};
85
86extern const struct Curl_handler Curl_handler_pop3;
87extern const struct Curl_handler Curl_handler_pop3s;
88
89/* Authentication type flags */
90#define POP3_TYPE_CLEARTEXT (1 << 0)
91#define POP3_TYPE_APOP      (1 << 1)
92#define POP3_TYPE_SASL      (1 << 2)
93
94/* Authentication type values */
95#define POP3_TYPE_NONE      0
96#define POP3_TYPE_ANY       ~0U
97
98/* This is the 5-bytes End-Of-Body marker for POP3 */
99#define POP3_EOB "\x0d\x0a\x2e\x0d\x0a"
100#define POP3_EOB_LEN 5
101
102/* This function scans the body after the end-of-body and writes everything
103 * until the end is found */
104CURLcode Curl_pop3_write(struct connectdata *conn, char *str, size_t nread);
105
106#endif /* HEADER_CURL_POP3_H */
107