summaryrefslogtreecommitdiffstats
path: root/src/login-common/login-common.h
blob: cd6f5fbac32c899b978b3cc48c841dbac6b8496c (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
#ifndef LOGIN_COMMON_H
#define LOGIN_COMMON_H

#include "lib.h"
#include "net.h"
#include "login-settings.h"

/* Used only for string sanitization */
#define MAX_MECH_NAME 64

#define AUTH_FAILED_MSG "Authentication failed."
#define AUTH_TEMP_FAILED_MSG "Temporary authentication failure."
#define AUTH_PLAINTEXT_DISABLED_MSG \
	"Plaintext authentication disallowed on non-secure (SSL/TLS) connections."

#define LOGIN_DEFAULT_SOCKET "login"
#define LOGIN_TOKEN_DEFAULT_SOCKET "tokenlogin"

struct login_binary {
	/* e.g. imap, pop3 */
	const char *protocol;
	/* e.g. imap-login, pop3-login */
	const char *process_name;

	/* e.g. 143, 110 */
	in_port_t default_port;
	/* e.g. 993, 995. if there is no ssl port, use 0. */
	in_port_t default_ssl_port;

	/* if value is NULL, LOGIN_DEFAULT_SOCKET is used as the default */
	const char *default_login_socket;

	struct event_category event_category;

	const struct client_vfuncs *client_vfuncs;
	void (*preinit)(void);
	void (*init)(void);
	void (*deinit)(void);

	bool sasl_support_final_reply:1;
	bool anonymous_login_acceptable:1;
};

struct login_module_register {
	unsigned int id;
};
extern struct login_module_register login_module_register;

extern struct login_binary *login_binary;
extern struct auth_client *auth_client;
extern struct master_auth *master_auth;
extern bool closing_down, login_debug;
extern struct anvil_client *anvil;
extern const char *login_rawlog_dir;
extern unsigned int initial_service_count;
/* NULL-terminated array of all alt_usernames seen so far. Existing fields are
   never removed. */
extern ARRAY_TYPE(string) global_alt_usernames;
extern bool login_ssl_initialized;

extern const struct login_settings *global_login_settings;
extern const struct master_service_ssl_settings *global_ssl_settings;
extern void **global_other_settings;

extern const struct ip_addr *login_source_ips;
extern unsigned int login_source_ips_idx, login_source_ips_count;
extern struct event *event_auth;


void login_refresh_proctitle(void);
void login_client_destroyed(void);

/* Call to guarantee that the "anvil" global variable is initialized. */
void login_anvil_init(void);

int login_binary_run(struct login_binary *binary,
		     int argc, char *argv[]);

#endif