1 /* nickserv.h - Nick/authentiction service
2 * Copyright 2000-2004 srvx Development Team
4 * This file is part of srvx.
6 * srvx 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 2 of the License, or
9 * (at your option) any later version.
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.
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.
24 #include "hash.h" /* for NICKLEN, etc., and common.h */
27 #define NICKSERV_HANDLE_LEN NICKLEN
30 /* HI_FLAG_* go into handle_info.flags */
31 #define HI_FLAG_OPER_SUSPENDED 0x00000001
32 #define HI_FLAG_USE_PRIVMSG 0x00000002
33 #define HI_FLAG_SUPPORT_HELPER 0x00000004
34 #define HI_FLAG_HELPING 0x00000008
35 #define HI_FLAG_SUSPENDED 0x00000010
36 #define HI_FLAG_MIRC_COLOR 0x00000020
37 #define HI_FLAG_FROZEN 0x00000040
38 #define HI_FLAG_NODELETE 0x00000080
39 #define HI_FLAG_NETWORK_HELPER 0x00000100
40 #define HI_FLAG_BOT 0x00000200
41 #define HI_FLAG_AUTOHIDE 0x00000400
42 #define HI_FLAG_INVI 0x00000800
43 #define HI_FLAG_OPER 0x00001000
44 #define HI_FLAG_NETWORK 0x00002000
46 /* Flag characters for the above. First char is LSB, etc. */
47 #define HANDLE_FLAGS "SphgscfnHbxIoN"
49 /* HI_STYLE_* go into handle_info.userlist_style */
50 #define HI_STYLE_DEF 'd'
51 #define HI_STYLE_ZOOT 'Z'
53 #define HI_DEFAULT_FLAGS (HI_FLAG_MIRC_COLOR)
54 #define HI_DEFAULT_STYLE HI_STYLE_DEF
56 #define HANDLE_FLAGGED(hi, tok) ((hi)->flags & HI_FLAG_##tok)
57 #define HANDLE_SET_FLAG(hi, tok) ((hi)->flags |= HI_FLAG_##tok)
58 #define HANDLE_TOGGLE_FLAG(hi, tok) ((hi)->flags ^= HI_FLAG_##tok)
59 #define HANDLE_CLEAR_FLAG(hi, tok) ((hi)->flags &= ~HI_FLAG_##tok)
61 #define IsSupportHelper(user) (user->handle_info && HANDLE_FLAGGED(user->handle_info, SUPPORT_HELPER))
62 #define IsNetworkHelper(user) (user->handle_info && HANDLE_FLAGGED(user->handle_info, NETWORK_HELPER))
63 #define IsHelper(user) (IsSupportHelper(user) || IsNetworkHelper(user))
64 #define IsHelping(user) (user->handle_info && HANDLE_FLAGGED(user->handle_info, HELPING))
65 #define IsStaff(user) (IsOper(user) || IsSupportHelper(user) || IsNetworkHelper(user))
66 #define IsBot(user) (user->handle_info && HANDLE_FLAGGED(user->handle_info, BOT))
67 #define IsInvi(user) (user->handle_info && HANDLE_FLAGGED(user->handle_info, INVI))
76 struct handle_cookie {
77 struct handle_info *hi;
79 enum cookie_type type;
80 unsigned long expires;
81 char cookie[COOKIELEN+1];
85 struct handle_note *next;
86 unsigned long expires;
89 char setter[NICKSERV_HANDLE_LEN+1];
94 unsigned long login_time;
95 unsigned long logout_time;
97 const char *quit_reason;
98 struct userNode *user;
99 struct authlogEntry *next;
103 struct nick_info *nicks;
104 struct string_list *masks;
105 struct userNode *users;
106 struct userData *channels;
107 struct handle_cookie *cookie;
108 struct handle_note *notes;
109 struct language *language;
110 struct authlogEntry *authlog;
120 unsigned long registered;
121 unsigned long lastseen;
123 unsigned short flags;
124 unsigned short opserv_level;
125 unsigned short staff_level;
126 unsigned short screen_width;
127 unsigned short table_width;
128 unsigned char userlist_style;
129 unsigned char maxlogins;
130 char passwd[MD5_CRYPT_LENGTH+1];
131 char last_quit_host[USERLEN+HOSTLEN+2];
135 struct handle_info *owner;
136 struct nick_info *next; /* next nick owned by same handle */
137 char nick[NICKLEN+1];
140 struct handle_info_list {
141 unsigned int used, size;
142 struct handle_info **list;
143 char *tag; /* e.g. email address */
146 extern const char *handle_flags;
148 void init_nickserv(const char *nick);
149 struct handle_info *get_handle_info(const char *handle);
150 struct handle_info *smart_get_handle_info(struct userNode *service, struct userNode *user, const char *name);
151 int oper_try_set_access(struct userNode *user, struct userNode *bot, struct handle_info *target, unsigned int new_level);
152 int oper_outranks(struct userNode *user, struct handle_info *hi);
153 struct nick_info *get_nick_info(const char *nick);
154 struct modeNode *find_handle_in_channel(struct chanNode *channel, struct handle_info *handle, struct userNode *except);
155 int nickserv_modify_handle_flags(struct userNode *user, struct userNode *bot, const char *str, unsigned long *add, unsigned long *remove);
156 int oper_has_access(struct userNode *user, struct userNode *bot, unsigned int min_level, unsigned int quiet);
157 int staff_has_access(struct userNode *user, struct userNode *bot, unsigned int min_level, unsigned int quiet);
158 void nickserv_show_oper_accounts(struct userNode *user, struct svccmd *cmd);
159 struct handle_info *checklogin(const char *user, const char *pass, const char *numeric, const char *hostmask, const char *ipmask);
160 char *getfakehost(const char *user);
161 void nickserv_devnull_delete(char *name);
162 void nickserv_devnull_rename(char *oldname, char *newname);
163 char *generate_fakehost(struct handle_info *handle);
164 char *generate_fakeident(struct handle_info *handle, struct userNode *user);
165 void apply_fakehost(struct handle_info *handle, struct userNode *user);
167 /* auth_funcs are called when a user gets a new handle_info. They are
168 * called *after* user->handle_info has been updated. */
169 typedef void (*auth_func_t)(struct userNode *user, struct handle_info *old_handle);
170 void reg_auth_func(auth_func_t func);
172 /* Called just after a handle is renamed. */
173 typedef void (*handle_rename_func_t)(struct handle_info *handle, const char *old_handle);
174 void reg_handle_rename_func(handle_rename_func_t func);
176 /* unreg_funcs are called right before a handle is unregistered.
177 * `user' is the person who caused the handle to be unregistered (either a
178 * client authed to the handle, or an oper). */
179 typedef void (*unreg_func_t)(struct userNode *user, struct handle_info *handle);
180 void reg_unreg_func(unreg_func_t func);
182 /* Called just before a handle is merged */
183 typedef void (*handle_merge_func_t)(struct userNode *user, struct handle_info *handle_to, struct handle_info *handle_from);
184 void reg_handle_merge_func(handle_merge_func_t);
186 /* Called after an allowauth. handle is null if allowauth authorization was
188 typedef void (*allowauth_func_t)(struct userNode *user, struct userNode *target, struct handle_info *handle);
189 void reg_allowauth_func(allowauth_func_t func);
191 /* Called when an auth attempt fails because of a bad password */
192 typedef void (*failpw_func_t)(struct userNode *user, struct handle_info *handle);
193 void reg_failpw_func(failpw_func_t func);