src/nickserv.h

   1 /* nickserv.h - Nick/authentiction service
   2  * Copyright 2000-2004 srvx Development Team
   3  *
   4  * This file is part of srvx.
   5  *
   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.
  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 struct svccmd;
  26
  27 #define NICKSERV_HANDLE_LEN NICKLEN
  28 #define COOKIELEN 10
  29
  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 /* Flag characters for the above.  First char is LSB, etc. */
  42 #define HANDLE_FLAGS "SphgscfnHb"
  43
  44 /* HI_STYLE_* go into handle_info.userlist_style */
  45 #define HI_STYLE_DEF    'd'
  46 #define HI_STYLE_ZOOT   'Z'
  47
  48 #define HI_DEFAULT_FLAGS       (HI_FLAG_MIRC_COLOR)
  49 #define HI_DEFAULT_STYLE       HI_STYLE_DEF
  50
  51 #define HANDLE_FLAGGED(hi, tok) ((hi)->flags & HI_FLAG_##tok)
  52 #define HANDLE_SET_FLAG(hi, tok) ((hi)->flags |= HI_FLAG_##tok)
  53 #define HANDLE_TOGGLE_FLAG(hi, tok) ((hi)->flags ^= HI_FLAG_##tok)
  54 #define HANDLE_CLEAR_FLAG(hi, tok) ((hi)->flags &= ~HI_FLAG_##tok)
  55
  56 #define IsSupportHelper(user) (user->handle_info && HANDLE_FLAGGED(user->handle_info, SUPPORT_HELPER))
  57 #define IsNetworkHelper(user) (user->handle_info && HANDLE_FLAGGED(user->handle_info, NETWORK_HELPER))
  58 #define IsHelper(user) (IsSupportHelper(user) || IsNetworkHelper(user))
  59 #define IsHelping(user) (user->handle_info && HANDLE_FLAGGED(user->handle_info, HELPING))
  60 #define IsStaff(user) (IsOper(user) || IsSupportHelper(user) || IsNetworkHelper(user))
  61 #define IsBot(user) (user->handle_info && HANDLE_FLAGGED(user->handle_info, BOT))
  62
  63 enum cookie_type {
  64     ACTIVATION,
  65     PASSWORD_CHANGE,
  66     EMAIL_CHANGE,
  67     ALLOWAUTH
  68 };
  69
  70 struct handle_cookie {
  71     struct handle_info *hi;
  72     char *data;
  73     enum cookie_type type;
  74     unsigned long expires;
  75     char cookie[COOKIELEN+1];
  76 };
  77
  78 struct handle_note {
  79     struct handle_note *next;
  80     unsigned long expires;
  81     unsigned long set;
  82     int id;
  83     char setter[NICKSERV_HANDLE_LEN+1];
  84     char note[1];
  85 };
  86
  87 struct handle_info {
  88     struct nick_info *nicks;
  89     struct string_list *masks;
  90     struct userNode *users;
  91     struct userData *channels;
  92     struct handle_cookie *cookie;
  93     struct handle_note *notes;
  94     struct language *language;
  95     char *email_addr;
  96     char *epithet;
  97     char *infoline;
  98     char *handle;
  99     char *fakehost;
 100 #ifdef WITH_PROTOCOL_BAHAMUT
 101     unsigned long id;
 102 #endif
 103     unsigned long registered;
 104     unsigned long lastseen;
 105     int karma;
 106     unsigned short flags;
 107     unsigned short opserv_level;
 108     unsigned short screen_width;
 109     unsigned short table_width;
 110     unsigned char userlist_style;
 111     unsigned char maxlogins;
 112     char passwd[MD5_CRYPT_LENGTH+1];
 113     char last_quit_host[USERLEN+HOSTLEN+2];
 114 };
 115
 116 struct nick_info {
 117     struct handle_info *owner;
 118     struct nick_info *next; /* next nick owned by same handle */
 119     char nick[NICKLEN+1];
 120 };
 121
 122 struct handle_info_list {
 123     unsigned int used, size;
 124     struct handle_info **list;
 125     char *tag; /* e.g. email address */
 126 };
 127
 128 extern const char *handle_flags;
 129
 130 void init_nickserv(const char *nick);
 131 struct handle_info *get_handle_info(const char *handle);
 132 struct handle_info *smart_get_handle_info(struct userNode *service, struct userNode *user, const char *name);
 133 int oper_try_set_access(struct userNode *user, struct userNode *bot, struct handle_info *target, unsigned int new_level);
 134 int oper_outranks(struct userNode *user, struct handle_info *hi);
 135 struct nick_info *get_nick_info(const char *nick);
 136 struct modeNode *find_handle_in_channel(struct chanNode *channel, struct handle_info *handle, struct userNode *except);
 137 int nickserv_modify_handle_flags(struct userNode *user, struct userNode *bot, const char *str, unsigned long *add, unsigned long *remove);
 138 int oper_has_access(struct userNode *user, struct userNode *bot, unsigned int min_level, unsigned int quiet);
 139 void nickserv_show_oper_accounts(struct userNode *user, struct svccmd *cmd);
 140
 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);
 145
 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);
 149
 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);
 155
 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);
 159
 160 /* Called after an allowauth. handle is null if allowauth authorization was
 161  * removed */
 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);
 164
 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);
 168
 169 #endif