client-common.h revision 2dfd08e8aa16dfcc975d8a62bc8d20b2ef849d71
2686ef87921233609d1d8ec8dee2883facc2c5ebTimo Sirainen#ifndef CLIENT_COMMON_H
2686ef87921233609d1d8ec8dee2883facc2c5ebTimo Sirainen#define CLIENT_COMMON_H
2686ef87921233609d1d8ec8dee2883facc2c5ebTimo Sirainen
c076ad69e28e7d41af83ada84e12019793ffcfa2Timo Sirainen#include "net.h"
2686ef87921233609d1d8ec8dee2883facc2c5ebTimo Sirainen#include "login-proxy.h"
2686ef87921233609d1d8ec8dee2883facc2c5ebTimo Sirainen#include "sasl-server.h"
2686ef87921233609d1d8ec8dee2883facc2c5ebTimo Sirainen#include "master-login.h" /* for LOGIN_MAX_SESSION_ID_LEN */
c076ad69e28e7d41af83ada84e12019793ffcfa2Timo Sirainen
c076ad69e28e7d41af83ada84e12019793ffcfa2Timo Sirainen#define LOGIN_MAX_SESSION_ID_LEN 64
c076ad69e28e7d41af83ada84e12019793ffcfa2Timo Sirainen#define LOGIN_MAX_MASTER_PREFIX_LEN 128
2686ef87921233609d1d8ec8dee2883facc2c5ebTimo Sirainen
2686ef87921233609d1d8ec8dee2883facc2c5ebTimo Sirainen/* max. size of input buffer. this means:
2686ef87921233609d1d8ec8dee2883facc2c5ebTimo Sirainen
2686ef87921233609d1d8ec8dee2883facc2c5ebTimo Sirainen IMAP: Max. length of command's all parameters. SASL-IR is read into
2686ef87921233609d1d8ec8dee2883facc2c5ebTimo Sirainen a separate larger buffer.
2686ef87921233609d1d8ec8dee2883facc2c5ebTimo Sirainen POP3: Max. length of a command line (spec says 512 would be enough)
2686ef87921233609d1d8ec8dee2883facc2c5ebTimo Sirainen*/
2686ef87921233609d1d8ec8dee2883facc2c5ebTimo Sirainen#define LOGIN_MAX_INBUF_SIZE \
2686ef87921233609d1d8ec8dee2883facc2c5ebTimo Sirainen (MASTER_AUTH_MAX_DATA_SIZE - LOGIN_MAX_MASTER_PREFIX_LEN - \
2686ef87921233609d1d8ec8dee2883facc2c5ebTimo Sirainen LOGIN_MAX_SESSION_ID_LEN)
2686ef87921233609d1d8ec8dee2883facc2c5ebTimo Sirainen/* max. size of output buffer. if it gets full, the client is disconnected.
2686ef87921233609d1d8ec8dee2883facc2c5ebTimo Sirainen SASL authentication gives the largest output. */
2686ef87921233609d1d8ec8dee2883facc2c5ebTimo Sirainen#define LOGIN_MAX_OUTBUF_SIZE 4096
2686ef87921233609d1d8ec8dee2883facc2c5ebTimo Sirainen
2686ef87921233609d1d8ec8dee2883facc2c5ebTimo Sirainen/* Max. length of SASL authentication buffer. */
2686ef87921233609d1d8ec8dee2883facc2c5ebTimo Sirainen#define LOGIN_MAX_AUTH_BUF_SIZE 8192
2686ef87921233609d1d8ec8dee2883facc2c5ebTimo Sirainen
2686ef87921233609d1d8ec8dee2883facc2c5ebTimo Sirainen/* Disconnect client after this many milliseconds if it hasn't managed
2686ef87921233609d1d8ec8dee2883facc2c5ebTimo Sirainen to log in yet. */
2686ef87921233609d1d8ec8dee2883facc2c5ebTimo Sirainen#define CLIENT_LOGIN_TIMEOUT_MSECS (MASTER_LOGIN_TIMEOUT_SECS*1000)
2686ef87921233609d1d8ec8dee2883facc2c5ebTimo Sirainen
2686ef87921233609d1d8ec8dee2883facc2c5ebTimo Sirainen#define AUTH_SERVER_WAITING_MSG \
2686ef87921233609d1d8ec8dee2883facc2c5ebTimo Sirainen "Waiting for authentication process to respond.."
2686ef87921233609d1d8ec8dee2883facc2c5ebTimo Sirainen#define AUTH_MASTER_WAITING_MSG \
2686ef87921233609d1d8ec8dee2883facc2c5ebTimo Sirainen "Waiting for authentication master process to respond.."
2686ef87921233609d1d8ec8dee2883facc2c5ebTimo Sirainen
2686ef87921233609d1d8ec8dee2883facc2c5ebTimo Sirainenstruct master_service_connection;
2686ef87921233609d1d8ec8dee2883facc2c5ebTimo Sirainen
2686ef87921233609d1d8ec8dee2883facc2c5ebTimo Sirainenenum client_disconnect_reason {
2686ef87921233609d1d8ec8dee2883facc2c5ebTimo Sirainen CLIENT_DISCONNECT_TIMEOUT,
2686ef87921233609d1d8ec8dee2883facc2c5ebTimo Sirainen CLIENT_DISCONNECT_SYSTEM_SHUTDOWN,
2686ef87921233609d1d8ec8dee2883facc2c5ebTimo Sirainen CLIENT_DISCONNECT_RESOURCE_CONSTRAINT,
2686ef87921233609d1d8ec8dee2883facc2c5ebTimo Sirainen CLIENT_DISCONNECT_INTERNAL_ERROR
2686ef87921233609d1d8ec8dee2883facc2c5ebTimo Sirainen};
2686ef87921233609d1d8ec8dee2883facc2c5ebTimo Sirainen
c076ad69e28e7d41af83ada84e12019793ffcfa2Timo Sirainenenum client_auth_result {
c076ad69e28e7d41af83ada84e12019793ffcfa2Timo Sirainen CLIENT_AUTH_RESULT_SUCCESS,
c076ad69e28e7d41af83ada84e12019793ffcfa2Timo Sirainen CLIENT_AUTH_RESULT_REFERRAL_SUCCESS,
c076ad69e28e7d41af83ada84e12019793ffcfa2Timo Sirainen CLIENT_AUTH_RESULT_REFERRAL_NOLOGIN,
c076ad69e28e7d41af83ada84e12019793ffcfa2Timo Sirainen CLIENT_AUTH_RESULT_ABORTED,
c076ad69e28e7d41af83ada84e12019793ffcfa2Timo Sirainen CLIENT_AUTH_RESULT_AUTHFAILED,
c076ad69e28e7d41af83ada84e12019793ffcfa2Timo Sirainen CLIENT_AUTH_RESULT_AUTHFAILED_REASON,
c076ad69e28e7d41af83ada84e12019793ffcfa2Timo Sirainen CLIENT_AUTH_RESULT_AUTHZFAILED,
c076ad69e28e7d41af83ada84e12019793ffcfa2Timo Sirainen CLIENT_AUTH_RESULT_TEMPFAIL,
c076ad69e28e7d41af83ada84e12019793ffcfa2Timo Sirainen CLIENT_AUTH_RESULT_SSL_REQUIRED
c076ad69e28e7d41af83ada84e12019793ffcfa2Timo Sirainen};
c076ad69e28e7d41af83ada84e12019793ffcfa2Timo Sirainen
c076ad69e28e7d41af83ada84e12019793ffcfa2Timo Sirainenstruct client_auth_reply {
c076ad69e28e7d41af83ada84e12019793ffcfa2Timo Sirainen const char *master_user, *reason;
c076ad69e28e7d41af83ada84e12019793ffcfa2Timo Sirainen /* for proxying */
c076ad69e28e7d41af83ada84e12019793ffcfa2Timo Sirainen const char *host, *hostip, *source_ip;
c076ad69e28e7d41af83ada84e12019793ffcfa2Timo Sirainen const char *destuser, *password, *proxy_mech;
c076ad69e28e7d41af83ada84e12019793ffcfa2Timo Sirainen unsigned int port;
c076ad69e28e7d41af83ada84e12019793ffcfa2Timo Sirainen unsigned int proxy_timeout_msecs;
c076ad69e28e7d41af83ada84e12019793ffcfa2Timo Sirainen unsigned int proxy_refresh_secs;
c076ad69e28e7d41af83ada84e12019793ffcfa2Timo Sirainen enum login_proxy_ssl_flags ssl_flags;
c076ad69e28e7d41af83ada84e12019793ffcfa2Timo Sirainen
c076ad69e28e7d41af83ada84e12019793ffcfa2Timo Sirainen unsigned int proxy:1;
c076ad69e28e7d41af83ada84e12019793ffcfa2Timo Sirainen unsigned int proxy_nopipelining:1;
c076ad69e28e7d41af83ada84e12019793ffcfa2Timo Sirainen unsigned int temp:1;
c076ad69e28e7d41af83ada84e12019793ffcfa2Timo Sirainen unsigned int nologin:1;
c076ad69e28e7d41af83ada84e12019793ffcfa2Timo Sirainen unsigned int authz_failure:1;
c076ad69e28e7d41af83ada84e12019793ffcfa2Timo Sirainen};
c076ad69e28e7d41af83ada84e12019793ffcfa2Timo Sirainen
c076ad69e28e7d41af83ada84e12019793ffcfa2Timo Sirainenstruct client_vfuncs {
c076ad69e28e7d41af83ada84e12019793ffcfa2Timo Sirainen struct client *(*alloc)(pool_t pool);
c076ad69e28e7d41af83ada84e12019793ffcfa2Timo Sirainen void (*create)(struct client *client, void **other_sets);
c076ad69e28e7d41af83ada84e12019793ffcfa2Timo Sirainen void (*destroy)(struct client *client);
c076ad69e28e7d41af83ada84e12019793ffcfa2Timo Sirainen void (*notify_auth_ready)(struct client *client);
c076ad69e28e7d41af83ada84e12019793ffcfa2Timo Sirainen void (*notify_disconnect)(struct client *client,
c076ad69e28e7d41af83ada84e12019793ffcfa2Timo Sirainen enum client_disconnect_reason reason,
c076ad69e28e7d41af83ada84e12019793ffcfa2Timo Sirainen const char *text);
c076ad69e28e7d41af83ada84e12019793ffcfa2Timo Sirainen void (*notify_status)(struct client *client,
c076ad69e28e7d41af83ada84e12019793ffcfa2Timo Sirainen bool bad, const char *text);
c076ad69e28e7d41af83ada84e12019793ffcfa2Timo Sirainen void (*notify_starttls)(struct client *client,
c076ad69e28e7d41af83ada84e12019793ffcfa2Timo Sirainen bool success, const char *text);
c076ad69e28e7d41af83ada84e12019793ffcfa2Timo Sirainen void (*starttls)(struct client *client);
c076ad69e28e7d41af83ada84e12019793ffcfa2Timo Sirainen void (*input)(struct client *client);
c076ad69e28e7d41af83ada84e12019793ffcfa2Timo Sirainen void (*auth_send_challenge)(struct client *client, const char *data);
c076ad69e28e7d41af83ada84e12019793ffcfa2Timo Sirainen void (*auth_parse_response)(struct client *client);
c076ad69e28e7d41af83ada84e12019793ffcfa2Timo Sirainen void (*auth_result)(struct client *client,
c076ad69e28e7d41af83ada84e12019793ffcfa2Timo Sirainen enum client_auth_result result,
c076ad69e28e7d41af83ada84e12019793ffcfa2Timo Sirainen const struct client_auth_reply *reply,
c076ad69e28e7d41af83ada84e12019793ffcfa2Timo Sirainen const char *text);
c076ad69e28e7d41af83ada84e12019793ffcfa2Timo Sirainen void (*proxy_reset)(struct client *client);
c076ad69e28e7d41af83ada84e12019793ffcfa2Timo Sirainen int (*proxy_parse_line)(struct client *client, const char *line);
2686ef87921233609d1d8ec8dee2883facc2c5ebTimo Sirainen void (*proxy_error)(struct client *client, const char *text);
2686ef87921233609d1d8ec8dee2883facc2c5ebTimo Sirainen};
2686ef87921233609d1d8ec8dee2883facc2c5ebTimo Sirainen
2686ef87921233609d1d8ec8dee2883facc2c5ebTimo Sirainenstruct client {
c076ad69e28e7d41af83ada84e12019793ffcfa2Timo Sirainen struct client *prev, *next;
2686ef87921233609d1d8ec8dee2883facc2c5ebTimo Sirainen pool_t pool;
struct client_vfuncs v;
time_t created;
int refcount;
struct ip_addr local_ip;
struct ip_addr ip;
struct ip_addr real_remote_ip, real_local_ip;
unsigned int local_port, remote_port;
unsigned int real_local_port, real_remote_port;
struct ssl_proxy *ssl_proxy;
const struct login_settings *set;
const struct master_service_ssl_settings *ssl_set;
const char *session_id, *listener_name;
int fd;
struct istream *input;
struct ostream *output;
struct io *io;
struct timeout *to_auth_waiting;
struct timeout *to_disconnect;
unsigned char *master_data_prefix;
unsigned int master_data_prefix_len;
struct login_proxy *login_proxy;
char *proxy_user, *proxy_master_user, *proxy_password;
const struct dsasl_client_mech *proxy_mech;
struct dsasl_client *proxy_sasl_client;
unsigned int proxy_state;
unsigned int proxy_ttl;
char *auth_mech_name;
struct auth_client_request *auth_request;
string_t *auth_response;
time_t auth_first_started, auth_finished;
const char *sasl_final_resp;
const char *const *auth_passdb_args;
unsigned int master_auth_id;
unsigned int master_tag;
sasl_server_callback_t *sasl_callback;
unsigned int bad_counter;
unsigned int auth_attempts, auth_successes;
pid_t mail_pid;
char *virtual_user, *virtual_user_orig, *virtual_auth_user;
unsigned int destroyed:1;
unsigned int input_blocked:1;
unsigned int login_success:1;
unsigned int starttls:1;
unsigned int tls:1;
unsigned int secured:1;
unsigned int trusted:1;
unsigned int ssl_servername_settings_read:1;
unsigned int authenticating:1;
unsigned int auth_tried_disabled_plaintext:1;
unsigned int auth_tried_unsupported_mech:1;
unsigned int auth_try_aborted:1;
unsigned int auth_initializing:1;
unsigned int auth_process_comm_fail:1;
unsigned int proxy_auth_failed:1;
unsigned int proxy_nopipelining:1;
unsigned int auth_waiting:1;
unsigned int auth_user_disabled:1;
unsigned int auth_pass_expired:1;
unsigned int notified_auth_ready:1;
unsigned int notified_disconnect:1;
/* ... */
};
extern struct client *clients;
struct client *
client_create(int fd, bool ssl, pool_t pool,
const struct master_service_connection *conn,
const struct login_settings *set,
const struct master_service_ssl_settings *ssl_set,
void **other_sets);
void client_destroy(struct client *client, const char *reason);
void client_destroy_success(struct client *client, const char *reason);
void client_destroy_internal_failure(struct client *client);
void client_ref(struct client *client);
bool client_unref(struct client **client) ATTR_NOWARN_UNUSED_RESULT;
void client_cmd_starttls(struct client *client);
unsigned int clients_get_count(void) ATTR_PURE;
void client_set_title(struct client *client);
void client_log(struct client *client, const char *msg);
void client_log_err(struct client *client, const char *msg);
void client_log_warn(struct client *client, const char *msg);
const char *client_get_extra_disconnect_reason(struct client *client);
void client_auth_respond(struct client *client, const char *response);
void client_auth_abort(struct client *client);
bool client_is_tls_enabled(struct client *client);
void client_auth_fail(struct client *client, const char *text);
const char *client_get_session_id(struct client *client);
bool client_read(struct client *client);
void client_input(struct client *client);
void client_notify_auth_ready(struct client *client);
void client_notify_status(struct client *client, bool bad, const char *text);
void client_notify_disconnect(struct client *client,
enum client_disconnect_reason reason,
const char *text);
void client_send_raw_data(struct client *client, const void *data, size_t size);
void client_send_raw(struct client *client, const char *data);
void client_set_auth_waiting(struct client *client);
void client_auth_send_challenge(struct client *client, const char *data);
void client_auth_parse_response(struct client *client);
int client_auth_begin(struct client *client, const char *mech_name,
const char *init_resp);
bool client_check_plaintext_auth(struct client *client, bool pass_sent);
int client_auth_read_line(struct client *client);
void client_proxy_finish_destroy_client(struct client *client);
void client_proxy_log_failure(struct client *client, const char *line);
void client_proxy_failed(struct client *client, bool send_line);
void clients_notify_auth_connected(void);
void client_destroy_oldest(void);
void clients_destroy_all(void);
void clients_destroy_all_reason(const char *reason);
#endif