src/login-common/client-common.h

	client-common.h revision 00fa8dcbc66f56daa737487c9dec7166c37de79e
#ifndef CLIENT_COMMON_H
#define CLIENT_COMMON_H

#include "network.h"
#include "sasl-server.h"

/* max. size of input buffer. this means:

   SASL: Max SASL request length from client
   IMAP: Max. length of a single parameter
   POP3: Max. length of a command line (spec says 512 would be enough)
*/
#define LOGIN_MAX_INBUF_SIZE 4096

enum client_cmd_reply {
    CLIENT_CMD_REPLY_OK,
    CLIENT_CMD_REPLY_AUTH_FAILED,
    CLIENT_CMD_REPLY_AUTHZ_FAILED,
    CLIENT_CMD_REPLY_AUTH_FAIL_TEMP,
    CLIENT_CMD_REPLY_AUTH_FAIL_REASON,
    CLIENT_CMD_REPLY_AUTH_FAIL_NOSSL,
    CLIENT_CMD_REPLY_BAD,
    CLIENT_CMD_REPLY_BYE,
    CLIENT_CMD_REPLY_STATUS
};

struct client {
    struct client *prev, *next;
    pool_t pool;

    struct ip_addr local_ip;
    struct ip_addr ip;
    unsigned int local_port, remote_port;
    struct ssl_proxy *proxy;
    const struct login_settings *set;

    int fd;
    struct istream *input;
    unsigned char *master_data_prefix;
    unsigned int master_data_prefix_len;

    char *auth_mech_name;
    struct auth_request *auth_request;

    unsigned int master_tag;
    sasl_server_callback_t *sasl_callback;

    unsigned int auth_attempts;
    pid_t mail_pid;

    char *virtual_user;
    unsigned int tls:1;
    unsigned int secured:1;
    unsigned int trusted:1;
    unsigned int proxying:1;
    unsigned int authenticating:1;
    unsigned int auth_tried_disabled_plaintext:1;
    /* ... */
};

extern struct client *clients;

struct client *client_create(int fd, bool ssl, pool_t pool,
                 const struct login_settings *set,
                 const struct ip_addr *local_ip,
                 const struct ip_addr *remote_ip);

void client_link(struct client *client);
void client_unlink(struct client *client);
unsigned int clients_get_count(void) ATTR_PURE;

void client_send_line(struct client *client, enum client_cmd_reply reply,
              const char *text);

void client_syslog(struct client *client, const char *msg);
void client_syslog_err(struct client *client, const char *msg);
const char *client_get_extra_disconnect_reason(struct client *client);
bool client_is_trusted(struct client *client);

void clients_notify_auth_connected(void);
void client_destroy_oldest(void);
void clients_destroy_all(void);

void clients_init(void);
void clients_deinit(void);

#endif