]>
Commit | Line | Data |
---|---|---|
1 | /* nickserv.h - Nick/authentiction service | |
2 | * Copyright 2000-2004 srvx Development Team | |
3 | * | |
4 | * This file is part of x3. | |
5 | * | |
6 | * x3 is free software; you can redistribute it and/or modify | |
7 | * it under the terms of the GNU General Public License as published by | |
8 | * the Free Software Foundation; either version 3 of the License, or | |
9 | * (at your option) any later version. | |
10 | * | |
11 | * This program is distributed in the hope that it will be useful, | |
12 | * but WITHOUT ANY WARRANTY; without even the implied warranty of | |
13 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
14 | * GNU General Public License for more details. | |
15 | * | |
16 | * You should have received a copy of the GNU General Public License | |
17 | * along with srvx; if not, write to the Free Software Foundation, | |
18 | * Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA. | |
19 | */ | |
20 | ||
21 | #ifndef _nickserv_h | |
22 | #define _nickserv_h | |
23 | ||
24 | #include "hash.h" /* for NICKLEN, etc., and common.h */ | |
25 | #include "dict.h" | |
26 | #include <tre/regex.h> /* for regex in nickserv_config */ | |
27 | struct svccmd; | |
28 | ||
29 | #define NICKSERV_HANDLE_LEN ACCOUNTLEN | |
30 | #define COOKIELEN 10 | |
31 | ||
32 | /* HI_FLAG_* go into handle_info.flags */ | |
33 | #define HI_FLAG_OPER_SUSPENDED 0x00000001 | |
34 | #define HI_FLAG_USE_PRIVMSG 0x00000002 | |
35 | #define HI_FLAG_SUPPORT_HELPER 0x00000004 | |
36 | #define HI_FLAG_HELPING 0x00000008 | |
37 | #define HI_FLAG_SUSPENDED 0x00000010 | |
38 | #define HI_FLAG_MIRC_COLOR 0x00000020 | |
39 | #define HI_FLAG_FROZEN 0x00000040 | |
40 | #define HI_FLAG_NODELETE 0x00000080 | |
41 | #define HI_FLAG_NETWORK_HELPER 0x00000100 | |
42 | #define HI_FLAG_BOT 0x00000200 | |
43 | #define HI_FLAG_AUTOHIDE 0x00000400 | |
44 | #define HI_FLAG_IMPERSONATE 0x00000800 | |
45 | #define HI_FLAG_ADVANCED 0x00001000 | |
46 | /* Flag characters for the above. First char is LSB, etc. */ | |
47 | #define HANDLE_FLAGS "SphgscfnHbxI" | |
48 | ||
49 | /* HI_STYLE_* go into handle_info.userlist_style */ | |
50 | #define HI_STYLE_NORMAL 'n' | |
51 | #define HI_STYLE_CLEAN 'c' | |
52 | #define HI_STYLE_ADVANCED 'a' | |
53 | #define HI_STYLE_CLASSIC 'k' | |
54 | ||
55 | #define HI_DEFAULT_FLAGS (HI_FLAG_MIRC_COLOR) | |
56 | ||
57 | /* This is overridden by conf file */ | |
58 | #define HI_DEFAULT_STYLE HI_STYLE_NORMAL | |
59 | ||
60 | #define HANDLE_FLAGGED(hi, tok) ((hi)->flags & HI_FLAG_##tok) | |
61 | #define HANDLE_SET_FLAG(hi, tok) ((hi)->flags |= HI_FLAG_##tok) | |
62 | #define HANDLE_TOGGLE_FLAG(hi, tok) ((hi)->flags ^= HI_FLAG_##tok) | |
63 | #define HANDLE_CLEAR_FLAG(hi, tok) ((hi)->flags &= ~HI_FLAG_##tok) | |
64 | ||
65 | #define IsSupportHelper(user) (user->handle_info && HANDLE_FLAGGED(user->handle_info, SUPPORT_HELPER)) | |
66 | #define IsNetworkHelper(user) (user->handle_info && HANDLE_FLAGGED(user->handle_info, NETWORK_HELPER)) | |
67 | #define IsHelper(user) (IsSupportHelper(user) || IsNetworkHelper(user)) | |
68 | #define IsHelping(user) (user->handle_info && HANDLE_FLAGGED(user->handle_info, HELPING)) | |
69 | #define IsStaff(user) (IsOper(user) || IsSupportHelper(user) || IsNetworkHelper(user)) | |
70 | #define IsBot(user) (user->handle_info && HANDLE_FLAGGED(user->handle_info, BOT)) | |
71 | ||
72 | enum cookie_type { | |
73 | ACTIVATION, | |
74 | PASSWORD_CHANGE, | |
75 | EMAIL_CHANGE, | |
76 | ALLOWAUTH | |
77 | }; | |
78 | ||
79 | struct handle_cookie { | |
80 | struct handle_info *hi; | |
81 | char *data; | |
82 | enum cookie_type type; | |
83 | time_t expires; | |
84 | char cookie[COOKIELEN+1]; | |
85 | }; | |
86 | ||
87 | struct handle_note { | |
88 | char setter[NICKSERV_HANDLE_LEN+1]; | |
89 | time_t date; | |
90 | char note[1]; | |
91 | }; | |
92 | ||
93 | struct handle_info { | |
94 | struct nick_info *nicks; | |
95 | struct string_list *masks; | |
96 | struct string_list *sslfps; | |
97 | struct string_list *ignores; | |
98 | struct userNode *users; | |
99 | struct userData *channels; | |
100 | struct handle_cookie *cookie; | |
101 | struct handle_note *note; | |
102 | struct language *language; | |
103 | char *email_addr; | |
104 | char *epithet; | |
105 | char *infoline; | |
106 | char *handle; | |
107 | char *fakehost; | |
108 | time_t registered; | |
109 | time_t lastseen; | |
110 | int karma; | |
111 | unsigned short flags; | |
112 | unsigned short opserv_level; | |
113 | unsigned short screen_width; | |
114 | unsigned short table_width; | |
115 | unsigned char userlist_style; | |
116 | unsigned char announcements; | |
117 | unsigned char maxlogins; | |
118 | char passwd[MD5_CRYPT_LENGTH+1]; | |
119 | char last_quit_host[USERLEN+HOSTLEN+2]; | |
120 | }; | |
121 | ||
122 | struct nick_info { | |
123 | struct handle_info *owner; | |
124 | struct nick_info *next; /* next nick owned by same handle */ | |
125 | char nick[NICKLEN+1]; | |
126 | time_t registered; | |
127 | time_t lastseen; | |
128 | }; | |
129 | ||
130 | struct handle_info_list { | |
131 | unsigned int used, size; | |
132 | struct handle_info **list; | |
133 | char *tag; /* e.g. email address */ | |
134 | }; | |
135 | ||
136 | extern const char *handle_flags; | |
137 | ||
138 | enum reclaim_action { | |
139 | RECLAIM_NONE, | |
140 | RECLAIM_WARN, | |
141 | RECLAIM_SVSNICK, | |
142 | RECLAIM_KILL | |
143 | }; | |
144 | ||
145 | struct nickserv_config { | |
146 | unsigned int disable_nicks : 1; | |
147 | unsigned int valid_handle_regex_set : 1; | |
148 | unsigned int valid_nick_regex_set : 1; | |
149 | unsigned int valid_fakehost_regex_set : 1; | |
150 | unsigned int autogag_enabled : 1; | |
151 | unsigned int email_enabled : 1; | |
152 | unsigned int email_required : 1; | |
153 | unsigned int default_hostmask : 1; | |
154 | unsigned int warn_nick_owned : 1; | |
155 | unsigned int warn_clone_auth : 1; | |
156 | unsigned int sync_log : 1; | |
157 | unsigned int expire_nicks : 1; | |
158 | unsigned long nicks_per_handle; | |
159 | unsigned long password_min_length; | |
160 | unsigned long password_min_digits; | |
161 | unsigned long password_min_upper; | |
162 | unsigned long password_min_lower; | |
163 | unsigned long db_backup_frequency; | |
164 | unsigned long handle_expire_frequency; | |
165 | unsigned long autogag_duration; | |
166 | unsigned long email_visible_level; | |
167 | unsigned long cookie_timeout; | |
168 | unsigned long handle_expire_delay; | |
169 | unsigned long nochan_handle_expire_delay; | |
170 | unsigned long modoper_level; | |
171 | unsigned long set_epithet_level; | |
172 | unsigned long set_title_level; | |
173 | unsigned long set_fakehost_level; | |
174 | unsigned long handles_per_email; | |
175 | unsigned long email_search_level; | |
176 | unsigned long nick_expire_frequency; | |
177 | unsigned long nick_expire_delay; | |
178 | const char *network_name; | |
179 | const char *titlehost_suffix; | |
180 | regex_t valid_handle_regex; | |
181 | regex_t valid_nick_regex; | |
182 | regex_t valid_fakehost_regex; | |
183 | dict_t weak_password_dict; | |
184 | struct policer_params *auth_policer_params; | |
185 | enum reclaim_action reclaim_action; | |
186 | enum reclaim_action auto_reclaim_action; | |
187 | unsigned long auto_reclaim_delay; | |
188 | unsigned char default_maxlogins; | |
189 | unsigned char hard_maxlogins; | |
190 | unsigned long ounregister_inactive; | |
191 | unsigned long ounregister_flags; | |
192 | const char *auto_oper; | |
193 | const char *auto_admin; | |
194 | const char *auto_oper_privs; | |
195 | const char *auto_admin_privs; | |
196 | char default_style; | |
197 | struct string_list *denied_fakehost_words; | |
198 | unsigned int force_handles_lowercase; | |
199 | unsigned int ldap_enable; | |
200 | #ifdef WITH_LDAP | |
201 | const char *ldap_uri; | |
202 | const char *ldap_base; | |
203 | const char *ldap_dn_fmt; | |
204 | unsigned int ldap_version; | |
205 | unsigned int ldap_autocreate; | |
206 | ||
207 | const char *ldap_admin_dn; | |
208 | const char *ldap_admin_pass; | |
209 | const char *ldap_field_account; | |
210 | const char *ldap_field_password; | |
211 | const char *ldap_field_email; | |
212 | const char *ldap_field_oslevel; | |
213 | struct string_list *ldap_object_classes; | |
214 | const char *ldap_oper_group_dn; | |
215 | unsigned int ldap_oper_group_level; | |
216 | const char *ldap_field_group_member; | |
217 | unsigned int ldap_timeout; | |
218 | #endif | |
219 | }; | |
220 | ||
221 | void init_nickserv(const char *nick); | |
222 | struct handle_info *get_handle_info(const char *handle); | |
223 | struct handle_info *smart_get_handle_info(struct userNode *service, struct userNode *user, const char *name); | |
224 | int oper_try_set_access(struct userNode *user, struct userNode *bot, struct handle_info *target, unsigned int new_level); | |
225 | int oper_outranks(struct userNode *user, struct handle_info *hi); | |
226 | struct nick_info *get_nick_info(const char *nick); | |
227 | struct modeNode *find_handle_in_channel(struct chanNode *channel, struct handle_info *handle, struct userNode *except); | |
228 | int nickserv_modify_handle_flags(struct userNode *user, struct userNode *bot, const char *str, unsigned long *add, unsigned long *remove); | |
229 | int oper_has_access(struct userNode *user, struct userNode *bot, unsigned int min_level, unsigned int quiet); | |
230 | void nickserv_show_oper_accounts(struct userNode *user, struct svccmd *cmd); | |
231 | ||
232 | void nickserv_do_autoauth(struct userNode *user); | |
233 | ||
234 | struct handle_info *get_victim_oper(struct userNode *user, const char *target); | |
235 | struct handle_info *loc_auth(char *sslfp, char *handle, char *password, char *userhost); | |
236 | ||
237 | typedef void (*user_mode_func_t)(struct userNode *user, const char *mode_change, void *extra); | |
238 | void reg_user_mode_func(user_mode_func_t func, void *extra); | |
239 | typedef void (*channel_mode_func_t)(struct userNode *who, struct chanNode *channel, char **mode, unsigned int argc, void *extra); | |
240 | void reg_channel_mode_func(channel_mode_func_t func, void *extra); | |
241 | ||
242 | /* auth_funcs are called when a user gets a new handle_info. They are | |
243 | * called *after* user->handle_info has been updated. */ | |
244 | typedef void (*auth_func_t)(struct userNode *user, struct handle_info *old_handle, void *extra); | |
245 | void reg_auth_func(auth_func_t func, void *extra); | |
246 | ||
247 | /* Called just after a handle is renamed. */ | |
248 | typedef void (*handle_rename_func_t)(struct handle_info *handle, const char *old_handle, void *extra); | |
249 | void reg_handle_rename_func(handle_rename_func_t func, void *extra); | |
250 | ||
251 | /* unreg_funcs are called right before a handle is unregistered. | |
252 | * `user' is the person who caused the handle to be unregistered (either a | |
253 | * client authed to the handle, or an oper). */ | |
254 | typedef void (*unreg_func_t)(struct userNode *user, struct handle_info *handle, void *extra); | |
255 | void reg_unreg_func(unreg_func_t func, void *extra); | |
256 | ||
257 | /* Called just before a handle is merged */ | |
258 | typedef void (*handle_merge_func_t)(struct userNode *user, struct handle_info *handle_to, struct handle_info *handle_from, void *extra); | |
259 | void reg_handle_merge_func(handle_merge_func_t, void *extra); | |
260 | ||
261 | /* Called after an allowauth. handle is null if allowauth authorization was | |
262 | * removed */ | |
263 | typedef void (*allowauth_func_t)(struct userNode *user, struct userNode *target, struct handle_info *handle, void *extra); | |
264 | void reg_allowauth_func(allowauth_func_t func, void *extra); | |
265 | ||
266 | /* Called when an auth attempt fails because of a bad password */ | |
267 | typedef void (*failpw_func_t)(struct userNode *user, struct handle_info *handle, void *extra); | |
268 | void reg_failpw_func(failpw_func_t func, void *extra); | |
269 | ||
270 | void send_func_list(struct userNode *user); | |
271 | ||
272 | extern dict_t nickserv_handle_dict; | |
273 | ||
274 | #endif |