[irc/quakenet/snircd.git] / include / s_conf.h

/** @file s_conf.h
 * @brief ircd configuration file API.
 * @version $Id: s_conf.h,v 1.34 2005/08/21 13:46:07 entrope Exp $
 */
#ifndef INCLUDED_s_conf_h
#define INCLUDED_s_conf_h
#ifndef INCLUDED_time_h
#include <time.h>              /* struct tm */
#define INCLUDED_time_h
#endif
#ifndef INCLUDED_sys_types_h
#include <sys/types.h>
#define INCLUDED_sys_types_h
#endif
#include "client.h"

struct Client;
struct SLink;
struct Message;

/*
 * General defines
 */

/*-----------------------------------------------------------------------------
 * Macros
 */

#define CONF_ILLEGAL            0x80000000 /**< Delete the ConfItem when no remaining clients. */
#define CONF_CLIENT             0x0002     /**< ConfItem describes a Client block */
#define CONF_SERVER             0x0004     /**< ConfItem describes a Connect block */
#define CONF_OPERATOR           0x0020     /**< ConfItem describes an Operator block */
#define CONF_UWORLD             0x8000     /**< ConfItem describes a Uworld server */

#define CONF_AUTOCONNECT        0x0001     /**< Autoconnect to a server */

/** Indicates ConfItem types that count associated clients. */
#define CONF_CLIENT_MASK        (CONF_CLIENT | CONF_OPERATOR | CONF_SERVER)

/** Checks whether the CONF_ILLEGAL bit is set on \a x. */
#define IsIllegal(x)    ((x)->status & CONF_ILLEGAL)

/*
 * Structures
 */

/** Configuration item to limit peer or client access. */
struct ConfItem
{
  struct ConfItem *next;    /**< Next ConfItem in #GlobalConfList */
  unsigned int status;      /**< Set of CONF_* bits. */
  unsigned int clients;     /**< Number of *LOCAL* clients using this */
  unsigned int maximum;     /**< For CONF_SERVER, max hops.
                               For CONF_CLIENT, max connects per IP. */
  struct ConnectionClass *conn_class;  /**< Class of connection */
  struct irc_sockaddr origin;  /**< Local address for outbound connections */
  struct irc_sockaddr address; /**< IP and port */
  char *username;     /**< For CONF_CLIENT and CONF_OPERATOR, username mask. */
  char *host;         /**< Peer hostname */
  char *origin_name;  /**< Text form of origin address */
  char *passwd;       /**< Password field */
  char *name;         /**< Name of peer */
  char *hub_limit;    /**< Mask that limits servers allowed behind
                         this one. */
  time_t hold;        /**< Earliest time to attempt an outbound
                         connect on this ConfItem. */
  int dns_pending;    /**< A dns request is pending. */
  int flags;          /**< Additional modifiers for item. */
  int addrbits;       /**< Number of bits valid in ConfItem::address. */
  struct Privs privs; /**< Privileges for opers. */
  /** Used to detect if a privilege has been set by this ConfItem. */
  struct Privs privs_dirty;
};

/** Channel quarantine structure. */
struct qline
{
  struct qline *next; /**< Next qline in #GlobalQuarantineList. */
  char *chname;       /**< Quarantined channel name. */
  char *reason;       /**< Reason for quarantine. */
};

struct sline {
  struct sline *next;
  char *spoofhost;
  char *passwd;
  char *realhost;
  char *username;
  struct irc_in_addr address;
  unsigned int flags;
  char bits; /* Number of bits for CIDR match on realhost */
};

#define SLINE_FLAGS_HOSTNAME 0x0001 /* S-line by hostname */
#define SLINE_FLAGS_IP       0x0002 /* S-line by IP address/CIDR */

/** Local K-line structure. */
struct DenyConf {
  struct DenyConf*    next;     /**< Next DenyConf in #denyConfList. */
  char*               hostmask; /**< Mask for  IP or hostname. */
  char*               message;  /**< Message to send to denied users. */
  char*               usermask; /**< Mask for client's username. */
  char*               realmask; /**< Mask for realname. */
  struct irc_in_addr  address;  /**< Address for IP-based denies. */
  unsigned int        flags;    /**< Interpretation flags for the above.  */
  unsigned char       bits;     /**< Number of bits for ipkills */
};

#define DENY_FLAGS_FILE     0x0001 /**< Comment is a filename */

/** Local server configuration. */
struct LocalConf {
  char*          name;        /**< Name of server. */
  char*          description; /**< Description of server. */
  unsigned int   numeric;     /**< Globally assigned server numnick. */
  char*          location1;   /**< First line of location information. */
  char*          location2;   /**< Second line of location information. */
  char*          contact;     /**< Admin contact information. */
};

enum {
  CRULE_AUTO = 1, /**< CRule applies to automatic connections. */
  CRULE_ALL  = 2, /**< CRule applies to oper-requested connections. */
  CRULE_MASK = 3
};

/** Connection rule configuration. */
struct CRuleConf {
  struct CRuleConf* next;     /**< Next CRule in cruleConfList. */
  char*             hostmask; /**< Mask of affected server names. */
  char*             rule;     /**< Text version of the rule. */
  int               type;     /**< One of CRULE_AUTO or CRULE_ALL. */
  struct CRuleNode* node;     /**< Parsed form of the rule. */
};

/** Authorization check result. */
enum AuthorizationCheckResult {
  ACR_OK,                 /**< User accepted. */
  ACR_NO_AUTHORIZATION,   /**< No matching ConfItem for the user. */
  ACR_TOO_MANY_IN_CLASS,  /**< Connection class was already full. */
  ACR_TOO_MANY_FROM_IP,   /**< User's IP already has max connections. */
  ACR_ALREADY_AUTHORIZED, /**< User already had an attached ConfItem. */
  ACR_BAD_SOCKET          /**< Client has bad file descriptor. */
};

/** Target description for service commands. */
struct nick_host {
  struct nick_host *next; /**< Next nick_host struct in struct s_map. */
  int nicklen;            /**< offset of @ part of server string */
  char nick[1];           /**< start of nick\@server string */
};

#define SMAP_FAST 1           /**< Command does not have MFLG_SLOW. */

/** Target set for a service pseudo-command. */
struct s_map {
  struct s_map *next;         /**< Next element in #GlobalServiceMapList. */
  struct Message *msg;        /**< Message element formed for this mapping. */
  char *name;                 /**< Text name of the mapping. */
  char *command;              /**< Command name to use. */
  char *prepend;              /**< Extra text to prepend to user's text. */
  unsigned int flags;         /**< Bitwise map of SMAP_* flags. */
  struct nick_host *services; /**< Linked list of possible targets. */
};


/*
 * GLOBALS
 */
extern struct ConfItem* GlobalConfList;
extern int              GlobalConfCount;
extern struct s_map*    GlobalServiceMapList;
extern struct qline*    GlobalQuarantineList;
extern struct sline*	GlobalSList;

/*
 * Proto types
 */

extern int init_conf(void);

extern const struct LocalConf* conf_get_local(void);
extern const struct CRuleConf* conf_get_crule_list(void);
extern const struct DenyConf*  conf_get_deny_list(void);

extern const char* conf_eval_crule(const char* name, int mask);

extern struct ConfItem* attach_confs_byhost(struct Client* cptr, const char* host, int statmask);
extern struct ConfItem* find_conf_byhost(struct SLink* lp, const char* host, int statmask);
extern struct ConfItem* find_conf_byname(struct SLink* lp, const char *name, int statmask);
extern struct ConfItem* conf_find_server(const char* name);

extern void det_confs_butmask(struct Client *cptr, int mask);
extern enum AuthorizationCheckResult attach_conf(struct Client *cptr, struct ConfItem *aconf);
extern struct ConfItem* find_conf_exact(const char* name, struct Client *cptr, int statmask);
extern enum AuthorizationCheckResult conf_check_client(struct Client *cptr);
extern int  conf_check_server(struct Client *cptr);
extern int rehash(struct Client *cptr, int sig);
extern int find_kill(struct Client *cptr, int glinecheck);
extern const char *find_quarantine(const char* chname);
extern void lookup_confhost(struct ConfItem *aconf);
extern void conf_parse_userhost(struct ConfItem *aconf, char *host);
extern struct ConfItem *conf_debug_iline(const char *client);
extern void free_mapping(struct s_map *smap);

extern void conf_add_sline(const char* const* fields, int count);
extern void clear_slines(void);
extern int conf_check_slines(struct Client *cptr);
extern void free_spoofhost(struct sline *spoof);

extern void yyerror(const char *msg);

#endif /* INCLUDED_s_conf_h */
Commit	Line	Data
189935b1	1	/** @file s_conf.h
	2	* @brief ircd configuration file API.
	3	* @version $Id: s_conf.h,v 1.34 2005/08/21 13:46:07 entrope Exp $
	4	*/
	5	#ifndef INCLUDED_s_conf_h
	6	#define INCLUDED_s_conf_h
	7	#ifndef INCLUDED_time_h
	8	#include <time.h> /* struct tm */
	9	#define INCLUDED_time_h
	10	#endif
	11	#ifndef INCLUDED_sys_types_h
	12	#include <sys/types.h>
	13	#define INCLUDED_sys_types_h
	14	#endif
	15	#include "client.h"
	16
	17	struct Client;
	18	struct SLink;
	19	struct Message;
	20
	21	/*
	22	* General defines
	23	*/
	24
	25	/*-----------------------------------------------------------------------------
	26	* Macros
	27	*/
	28
	29	#define CONF_ILLEGAL 0x80000000 /*< Delete the ConfItem when no remaining clients. /
	30	#define CONF_CLIENT 0x0002 /*< ConfItem describes a Client block /
	31	#define CONF_SERVER 0x0004 /*< ConfItem describes a Connect block /
	32	#define CONF_OPERATOR 0x0020 /*< ConfItem describes an Operator block /
	33	#define CONF_UWORLD 0x8000 /*< ConfItem describes a Uworld server /
	34
	35	#define CONF_AUTOCONNECT 0x0001 /*< Autoconnect to a server /
	36
	37	/** Indicates ConfItem types that count associated clients. */
	38	#define CONF_CLIENT_MASK (CONF_CLIENT \| CONF_OPERATOR \| CONF_SERVER)
	39
	40	/** Checks whether the CONF_ILLEGAL bit is set on \a x. */
	41	#define IsIllegal(x) ((x)->status & CONF_ILLEGAL)
	42
	43	/*
	44	* Structures
	45	*/
	46
	47	/** Configuration item to limit peer or client access. */
	48	struct ConfItem
	49	{
	50	struct ConfItem next; /< Next ConfItem in #GlobalConfList /
	51	unsigned int status; /*< Set of CONF_ bits. */
	52	unsigned int clients; /*< Number of LOCAL* clients using this */
	53	unsigned int maximum; /**< For CONF_SERVER, max hops.
	54	For CONF_CLIENT, max connects per IP. */
	55	struct ConnectionClass conn_class; /< Class of connection /
	56	struct irc_sockaddr origin; /*< Local address for outbound connections /
	57	struct irc_sockaddr address; /*< IP and port /
	58	char username; /< For CONF_CLIENT and CONF_OPERATOR, username mask. /
	59	char host; /< Peer hostname /
	60	char origin_name; /< Text form of origin address /
	61	char passwd; /< Password field /
	62	char name; /< Name of peer /
	63	char hub_limit; /*< Mask that limits servers allowed behind
	64	this one. */
65	time_t hold; /**< Earliest time to attempt an outbound
66	connect on this ConfItem. */
67	int dns_pending; /*< A dns request is pending. /
68	int flags; /*< Additional modifiers for item. /
69	int addrbits; /*< Number of bits valid in ConfItem::address. /
70	struct Privs privs; /*< Privileges for opers. /
71	/** Used to detect if a privilege has been set by this ConfItem. */
72	struct Privs privs_dirty;
73	};
74
75	/** Channel quarantine structure. */
76	struct qline
77	{
78	struct qline next; /< Next qline in #GlobalQuarantineList. /
79	char chname; /< Quarantined channel name. /
80	char reason; /< Reason for quarantine. /
81	};
82
1d4df40c	83	struct sline {
	84	struct sline *next;
	85	char *spoofhost;
	86	char *passwd;
	87	char *realhost;
	88	char *username;
	89	struct irc_in_addr address;
	90	unsigned int flags;
	91	char bits; /* Number of bits for CIDR match on realhost */
	92	};
	93
	94	#define SLINE_FLAGS_HOSTNAME 0x0001 /* S-line by hostname */
	95	#define SLINE_FLAGS_IP 0x0002 /* S-line by IP address/CIDR */
	96
189935b1	97	/** Local K-line structure. */
	98	struct DenyConf {
	99	struct DenyConf* next; /*< Next DenyConf in #denyConfList. /
	100	char* hostmask; /*< Mask for IP or hostname. /
	101	char* message; /*< Message to send to denied users. /
	102	char* usermask; /*< Mask for client's username. /
	103	char* realmask; /*< Mask for realname. /
	104	struct irc_in_addr address; /*< Address for IP-based denies. /
	105	unsigned int flags; /*< Interpretation flags for the above. /
	106	unsigned char bits; /*< Number of bits for ipkills /
	107	};
	108
	109	#define DENY_FLAGS_FILE 0x0001 /*< Comment is a filename /
	110
	111	/** Local server configuration. */
	112	struct LocalConf {
	113	char* name; /*< Name of server. /
	114	char* description; /*< Description of server. /
	115	unsigned int numeric; /*< Globally assigned server numnick. /
	116	char* location1; /*< First line of location information. /
	117	char* location2; /*< Second line of location information. /
	118	char* contact; /*< Admin contact information. /
	119	};
	120
	121	enum {
	122	CRULE_AUTO = 1, /*< CRule applies to automatic connections. /
	123	CRULE_ALL = 2, /*< CRule applies to oper-requested connections. /
	124	CRULE_MASK = 3
	125	};
	126
	127	/** Connection rule configuration. */
	128	struct CRuleConf {
	129	struct CRuleConf* next; /*< Next CRule in cruleConfList. /
	130	char* hostmask; /*< Mask of affected server names. /
	131	char* rule; /*< Text version of the rule. /
	132	int type; /*< One of CRULE_AUTO or CRULE_ALL. /
	133	struct CRuleNode* node; /*< Parsed form of the rule. /
	134	};
	135
	136	/** Authorization check result. */
	137	enum AuthorizationCheckResult {
	138	ACR_OK, /*< User accepted. /
	139	ACR_NO_AUTHORIZATION, /*< No matching ConfItem for the user. /
	140	ACR_TOO_MANY_IN_CLASS, /*< Connection class was already full. /
	141	ACR_TOO_MANY_FROM_IP, /*< User's IP already has max connections. /
	142	ACR_ALREADY_AUTHORIZED, /*< User already had an attached ConfItem. /
	143	ACR_BAD_SOCKET /*< Client has bad file descriptor. /
	144	};
	145
	146	/** Target description for service commands. */
	147	struct nick_host {
	148	struct nick_host next; /< Next nick_host struct in struct s_map. /
	149	int nicklen; /*< offset of @ part of server string /
	150	char nick[1]; /*< start of nick\@server string /
	151	};
	152
	153	#define SMAP_FAST 1 /*< Command does not have MFLG_SLOW. /
	154
	155	/** Target set for a service pseudo-command. */
	156	struct s_map {
	157	struct s_map next; /< Next element in #GlobalServiceMapList. /
	158	struct Message msg; /< Message element formed for this mapping. /
	159	char name; /< Text name of the mapping. /
	160	char command; /< Command name to use. /
161	char prepend; /< Extra text to prepend to user's text. /
162	unsigned int flags; /*< Bitwise map of SMAP_ flags. */
163	struct nick_host services; /< Linked list of possible targets. /
164	};
165
166
167	/*
168	* GLOBALS
169	*/
170	extern struct ConfItem* GlobalConfList;
171	extern int GlobalConfCount;
172	extern struct s_map* GlobalServiceMapList;
173	extern struct qline* GlobalQuarantineList;
1d4df40c	174	extern struct sline* GlobalSList;
189935b1	175
	176	/*
	177	* Proto types
	178	*/
	179
	180	extern int init_conf(void);
	181
	182	extern const struct LocalConf* conf_get_local(void);
	183	extern const struct CRuleConf* conf_get_crule_list(void);
	184	extern const struct DenyConf* conf_get_deny_list(void);
	185
	186	extern const char* conf_eval_crule(const char* name, int mask);
	187
	188	extern struct ConfItem* attach_confs_byhost(struct Client* cptr, const char* host, int statmask);
	189	extern struct ConfItem* find_conf_byhost(struct SLink* lp, const char* host, int statmask);
	190	extern struct ConfItem* find_conf_byname(struct SLink* lp, const char *name, int statmask);
	191	extern struct ConfItem* conf_find_server(const char* name);
	192
	193	extern void det_confs_butmask(struct Client *cptr, int mask);
	194	extern enum AuthorizationCheckResult attach_conf(struct Client cptr, struct ConfItem aconf);
	195	extern struct ConfItem* find_conf_exact(const char* name, struct Client *cptr, int statmask);
	196	extern enum AuthorizationCheckResult conf_check_client(struct Client *cptr);
	197	extern int conf_check_server(struct Client *cptr);
	198	extern int rehash(struct Client *cptr, int sig);
8b897318	199	extern int find_kill(struct Client *cptr, int glinecheck);
189935b1	200	extern const char find_quarantine(const char chname);
	201	extern void lookup_confhost(struct ConfItem *aconf);
	202	extern void conf_parse_userhost(struct ConfItem aconf, char host);
	203	extern struct ConfItem conf_debug_iline(const char client);
	204	extern void free_mapping(struct s_map *smap);
	205
1d4df40c	206	extern void conf_add_sline(const char* const* fields, int count);
	207	extern void clear_slines(void);
	208	extern int conf_check_slines(struct Client *cptr);
	209	extern void free_spoofhost(struct sline *spoof);
	210
189935b1	211	extern void yyerror(const char *msg);
	212
	213	#endif /* INCLUDED_s_conf_h */