src/nickserv.h

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