2 * @brief ircd configuration file API.
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
11 #ifndef INCLUDED_sys_types_h
12 #include <sys/types.h>
13 #define INCLUDED_sys_types_h
25 /*-----------------------------------------------------------------------------
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 */
35 /** Indicates ConfItem types that count associated clients. */
36 #define CONF_CLIENT_MASK (CONF_CLIENT | CONF_OPERATOR | CONF_SERVER)
38 /** Checks whether the CONF_ILLEGAL bit is set on \a x. */
39 #define IsIllegal(x) ((x)->status & CONF_ILLEGAL)
45 /** Configuration item to limit peer or client access. */
48 struct ConfItem *next; /**< Next ConfItem in #GlobalConfList */
49 unsigned int status; /**< Set of CONF_* bits. */
50 unsigned int clients; /**< Number of *LOCAL* clients using this */
51 unsigned int maximum; /**< For CONF_SERVER, max hops.
52 For CONF_CLIENT, max connects per IP. */
53 struct ConnectionClass *conn_class; /**< Class of connection */
54 struct irc_sockaddr origin; /**< Local address for outbound connections */
55 struct irc_sockaddr address; /**< IP and port */
56 char *username; /**< For CONF_CLIENT and CONF_OPERATOR, username mask. */
57 char *host; /**< Peer hostname */
58 char *origin_name; /**< Text form of origin address */
59 char *passwd; /**< Password field */
60 char *name; /**< Name of peer */
61 char *hub_limit; /**< Mask that limits servers allowed behind
63 time_t hold; /**< Earliest time to attempt an outbound
64 connect on this ConfItem. */
65 int dns_pending; /**< A dns request is pending. */
66 int addrbits; /**< Number of bits valid in ConfItem::address. */
67 struct Privs privs; /**< Privileges for opers. */
68 /** Used to detect if a privilege has been set by this ConfItem. */
69 struct Privs privs_dirty;
72 /** Channel quarantine structure. */
75 struct qline *next; /**< Next qline in #GlobalQuarantineList. */
76 char *chname; /**< Quarantined channel name. */
77 char *reason; /**< Reason for quarantine. */
80 /** Local K-line structure. */
82 struct DenyConf* next; /**< Next DenyConf in #denyConfList. */
83 char* hostmask; /**< Mask for realname, IP or hostname. */
84 char* message; /**< Message to send to denied users. */
85 char* usermask; /**< Mask for client's username. */
86 struct irc_in_addr address; /**< Address for IP-based denies. */
87 unsigned int flags; /**< Interpretation flags for the above. */
88 unsigned char bits; /**< Number of bits for ipkills */
91 #define DENY_FLAGS_FILE 0x0001 /**< Comment is a filename */
92 #define DENY_FLAGS_IP 0x0002 /**< K-line by IP address */
93 #define DENY_FLAGS_REALNAME 0x0004 /**< K-line by real name */
95 /** Local server configuration. */
97 char* name; /**< Name of server. */
98 char* description; /**< Description of server. */
99 unsigned int numeric; /**< Globally assigned server numnick. */
100 char* location1; /**< First line of location information. */
101 char* location2; /**< Second line of location information. */
102 char* contact; /**< Admin contact information. */
106 CRULE_AUTO = 1, /**< CRule applies to automatic connections. */
107 CRULE_ALL = 2, /**< CRule applies to oper-requested connections. */
111 /** Connection rule configuration. */
113 struct CRuleConf* next; /**< Next CRule in cruleConfList. */
114 char* hostmask; /**< Mask of affected server names. */
115 char* rule; /**< Text version of the rule. */
116 int type; /**< One of CRULE_AUTO or CRULE_ALL. */
117 struct CRuleNode* node; /**< Parsed form of the rule. */
120 /** Authorization check result. */
121 enum AuthorizationCheckResult {
122 ACR_OK, /**< User accepted. */
123 ACR_NO_AUTHORIZATION, /**< No matching ConfItem for the user. */
124 ACR_TOO_MANY_IN_CLASS, /**< Connection class was already full. */
125 ACR_TOO_MANY_FROM_IP, /**< User's IP already has max connections. */
126 ACR_ALREADY_AUTHORIZED, /**< User already had an attached ConfItem. */
127 ACR_BAD_SOCKET /**< Client has bad file descriptor. */
130 /** Target description for service commands. */
132 struct nick_host *next; /**< Next nick_host struct in struct s_map. */
133 int nicklen; /**< offset of @ part of server string */
134 char nick[1]; /**< start of nick\@server string */
137 /** Target set for a service pseudo-command. */
139 struct s_map *next; /**< Next element in #GlobalServiceMapList. */
140 struct Message *msg; /**< Message element formed for this mapping. */
141 char *name; /**< Text name of the mapping. */
142 char *command; /**< Command name to use. */
143 char *prepend; /**< Extra text to prepend to user's text. */
144 struct nick_host *services; /**< Linked list of possible targets. */
151 extern struct ConfItem* GlobalConfList;
152 extern int GlobalConfCount;
153 extern struct s_map* GlobalServiceMapList;
154 extern struct qline* GlobalQuarantineList;
160 extern int init_conf(void);
162 extern const struct LocalConf* conf_get_local(void);
163 extern const struct CRuleConf* conf_get_crule_list(void);
164 extern const struct DenyConf* conf_get_deny_list(void);
166 extern const char* conf_eval_crule(const char* name, int mask);
168 extern struct ConfItem* attach_confs_byhost(struct Client* cptr, const char* host, int statmask);
169 extern struct ConfItem* find_conf_byhost(struct SLink* lp, const char* host, int statmask);
170 extern struct ConfItem* find_conf_byname(struct SLink* lp, const char *name, int statmask);
171 extern struct ConfItem* conf_find_server(const char* name);
173 extern void det_confs_butmask(struct Client *cptr, int mask);
174 extern enum AuthorizationCheckResult attach_conf(struct Client *cptr, struct ConfItem *aconf);
175 extern struct ConfItem* find_conf_exact(const char* name, struct Client *cptr, int statmask);
176 extern enum AuthorizationCheckResult conf_check_client(struct Client *cptr);
177 extern int conf_check_server(struct Client *cptr);
178 extern int rehash(struct Client *cptr, int sig);
179 extern int find_kill(struct Client *cptr);
180 extern const char *find_quarantine(const char* chname);
181 extern void lookup_confhost(struct ConfItem *aconf);
182 extern void conf_parse_userhost(struct ConfItem *aconf, char *host);
184 extern void yyerror(const char *msg);
186 #endif /* INCLUDED_s_conf_h */