1 /* nickserv.h - Nick/authentiction service
2 * Copyright 2000-2004 srvx Development Team
4 * This file is part of x3.
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 ACCOUNTLEN
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 /* Flag characters for the above. First char is LSB, etc. */
43 #define HANDLE_FLAGS "SphgscfnHbx"
45 /* HI_STYLE_* go into handle_info.userlist_style */
46 #define HI_STYLE_DEF 'd'
47 #define HI_STYLE_ZOOT 'Z'
49 #define HI_DEFAULT_FLAGS (HI_FLAG_MIRC_COLOR)
50 #define HI_DEFAULT_STYLE HI_STYLE_DEF
52 #define HANDLE_FLAGGED(hi, tok) ((hi)->flags & HI_FLAG_##tok)
53 #define HANDLE_SET_FLAG(hi, tok) ((hi)->flags |= HI_FLAG_##tok)
54 #define HANDLE_TOGGLE_FLAG(hi, tok) ((hi)->flags ^= HI_FLAG_##tok)
55 #define HANDLE_CLEAR_FLAG(hi, tok) ((hi)->flags &= ~HI_FLAG_##tok)
57 #define IsSupportHelper(user) (user->handle_info && HANDLE_FLAGGED(user->handle_info, SUPPORT_HELPER))
58 #define IsNetworkHelper(user) (user->handle_info && HANDLE_FLAGGED(user->handle_info, NETWORK_HELPER))
59 #define IsHelper(user) (IsSupportHelper(user) || IsNetworkHelper(user))
60 #define IsHelping(user) (user->handle_info && HANDLE_FLAGGED(user->handle_info, HELPING))
61 #define IsStaff(user) (IsOper(user) || IsSupportHelper(user) || IsNetworkHelper(user))
62 #define IsBot(user) (user->handle_info && HANDLE_FLAGGED(user->handle_info, BOT))
71 struct handle_cookie
{
72 struct handle_info
*hi
;
74 enum cookie_type type
;
76 char cookie
[COOKIELEN
+1];
80 char setter
[NICKSERV_HANDLE_LEN
+1];
86 struct nick_info
*nicks
;
87 struct string_list
*masks
;
88 struct userNode
*users
;
89 struct userData
*channels
;
90 struct handle_cookie
*cookie
;
91 struct handle_note
*note
;
92 struct language
*language
;
98 #ifdef WITH_PROTOCOL_BAHAMUT
103 unsigned short flags
;
104 unsigned short opserv_level
;
105 unsigned short screen_width
;
106 unsigned short table_width
;
107 unsigned char userlist_style
;
108 unsigned char announcements
;
109 unsigned char maxlogins
;
110 char passwd
[MD5_CRYPT_LENGTH
+1];
111 char last_quit_host
[USERLEN
+HOSTLEN
+2];
115 struct handle_info
*owner
;
116 struct nick_info
*next
; /* next nick owned by same handle */
117 char nick
[NICKLEN
+1];
120 struct handle_info_list
{
121 unsigned int used
, size
;
122 struct handle_info
**list
;
123 char *tag
; /* e.g. email address */
126 extern const char *handle_flags
;
128 void init_nickserv(const char *nick
);
129 struct handle_info
*get_handle_info(const char *handle
);
130 struct handle_info
*smart_get_handle_info(struct userNode
*service
, struct userNode
*user
, const char *name
);
131 int oper_try_set_access(struct userNode
*user
, struct userNode
*bot
, struct handle_info
*target
, unsigned int new_level
);
132 int oper_outranks(struct userNode
*user
, struct handle_info
*hi
);
133 struct nick_info
*get_nick_info(const char *nick
);
134 struct modeNode
*find_handle_in_channel(struct chanNode
*channel
, struct handle_info
*handle
, struct userNode
*except
);
135 int nickserv_modify_handle_flags(struct userNode
*user
, struct userNode
*bot
, const char *str
, unsigned long *add
, unsigned long *remove
);
136 int oper_has_access(struct userNode
*user
, struct userNode
*bot
, unsigned int min_level
, unsigned int quiet
);
137 void nickserv_show_oper_accounts(struct userNode
*user
, struct svccmd
*cmd
);
139 struct handle_info
*loc_auth(char *handle
, char *password
);
141 /* auth_funcs are called when a user gets a new handle_info. They are
142 * called *after* user->handle_info has been updated. */
143 typedef void (*auth_func_t
)(struct userNode
*user
, struct handle_info
*old_handle
);
144 void reg_auth_func(auth_func_t func
);
146 /* Called just after a handle is renamed. */
147 typedef void (*handle_rename_func_t
)(struct handle_info
*handle
, const char *old_handle
);
148 void reg_handle_rename_func(handle_rename_func_t func
);
150 /* unreg_funcs are called right before a handle is unregistered.
151 * `user' is the person who caused the handle to be unregistered (either a
152 * client authed to the handle, or an oper). */
153 typedef void (*unreg_func_t
)(struct userNode
*user
, struct handle_info
*handle
);
154 void reg_unreg_func(unreg_func_t func
);
156 /* Called just before a handle is merged */
157 typedef void (*handle_merge_func_t
)(struct userNode
*user
, struct handle_info
*handle_to
, struct handle_info
*handle_from
);
158 void reg_handle_merge_func(handle_merge_func_t
);
160 /* Called after an allowauth. handle is null if allowauth authorization was
162 typedef void (*allowauth_func_t
)(struct userNode
*user
, struct userNode
*target
, struct handle_info
*handle
);
163 void reg_allowauth_func(allowauth_func_t func
);
165 /* Called when an auth attempt fails because of a bad password */
166 typedef void (*failpw_func_t
)(struct userNode
*user
, struct handle_info
*handle
);
167 void reg_failpw_func(failpw_func_t func
);
169 void send_func_list(struct userNode
*user
);