]>
Commit | Line | Data |
---|---|---|
212380e3 AC |
1 | /* modules/m_sasl.c |
2 | * Copyright (C) 2006 Michael Tharp <gxti@partiallystapled.com> | |
f62f94b0 | 3 | * Copyright (C) 2006 charybdis development team |
15b05f95 | 4 | * Copyright (C) 2016 ChatLounge IRC Network Development Team |
212380e3 AC |
5 | * |
6 | * Redistribution and use in source and binary forms, with or without | |
7 | * modification, are permitted provided that the following conditions are | |
8 | * met: | |
9 | * | |
10 | * 1.Redistributions of source code must retain the above copyright notice, | |
11 | * this list of conditions and the following disclaimer. | |
12 | * 2.Redistributions in binary form must reproduce the above copyright | |
13 | * notice, this list of conditions and the following disclaimer in the | |
14 | * documentation and/or other materials provided with the distribution. | |
15 | * 3.The name of the author may not be used to endorse or promote products | |
16 | * derived from this software without specific prior written permission. | |
17 | * | |
18 | * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR | |
19 | * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED | |
20 | * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE | |
21 | * DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, | |
22 | * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES | |
23 | * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR | |
24 | * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) | |
25 | * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, | |
26 | * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING | |
27 | * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE | |
28 | * POSSIBILITY OF SUCH DAMAGE. | |
212380e3 AC |
29 | */ |
30 | ||
31 | #include "stdinc.h" | |
32 | ||
33 | #include "client.h" | |
34 | #include "hash.h" | |
35 | #include "send.h" | |
36 | #include "msg.h" | |
37 | #include "modules.h" | |
38 | #include "numeric.h" | |
37289346 | 39 | #include "reject.h" |
212380e3 AC |
40 | #include "s_serv.h" |
41 | #include "s_stats.h" | |
42 | #include "string.h" | |
7d33cce8 MT |
43 | #include "s_newconf.h" |
44 | #include "s_conf.h" | |
212380e3 | 45 | |
eeabf33a EM |
46 | static const char sasl_desc[] = "Provides SASL authentication support"; |
47 | ||
3c7d6fcc EM |
48 | static void m_authenticate(struct MsgBuf *, struct Client *, struct Client *, int, const char **); |
49 | static void me_sasl(struct MsgBuf *, struct Client *, struct Client *, int, const char **); | |
50 | static void me_mechlist(struct MsgBuf *, struct Client *, struct Client *, int, const char **); | |
212380e3 AC |
51 | |
52 | static void abort_sasl(struct Client *); | |
53 | static void abort_sasl_exit(hook_data_client_exit *); | |
54 | ||
15b05f95 SA |
55 | static void advertise_sasl_cap(bool); |
56 | static void advertise_sasl_new(struct Client *); | |
57 | static void advertise_sasl_exit(void *); | |
58 | static void advertise_sasl_config(void *); | |
12565204 | 59 | |
da3e5fcb AC |
60 | static unsigned int CLICAP_SASL = 0; |
61 | static char mechlist_buf[BUFSIZE]; | |
15b05f95 | 62 | static bool sasl_agent_present = false; |
193d4db3 | 63 | |
212380e3 | 64 | struct Message authenticate_msgtab = { |
7baa37a9 | 65 | "AUTHENTICATE", 0, 0, 0, 0, |
ef3ab8e3 | 66 | {{m_authenticate, 2}, {m_authenticate, 2}, mg_ignore, mg_ignore, mg_ignore, {m_authenticate, 2}} |
212380e3 AC |
67 | }; |
68 | struct Message sasl_msgtab = { | |
7baa37a9 | 69 | "SASL", 0, 0, 0, 0, |
212380e3 AC |
70 | {mg_ignore, mg_ignore, mg_ignore, mg_ignore, {me_sasl, 5}, mg_ignore} |
71 | }; | |
da3e5fcb AC |
72 | struct Message mechlist_msgtab = { |
73 | "MECHLIST", 0, 0, 0, 0, | |
74 | {mg_ignore, mg_ignore, mg_ignore, mg_ignore, {me_mechlist, 2}, mg_ignore} | |
75 | }; | |
212380e3 | 76 | |
55abcbb2 | 77 | mapi_clist_av1 sasl_clist[] = { |
da3e5fcb | 78 | &authenticate_msgtab, &sasl_msgtab, &mechlist_msgtab, NULL |
212380e3 AC |
79 | }; |
80 | mapi_hfn_list_av1 sasl_hfnlist[] = { | |
81 | { "new_local_user", (hookfn) abort_sasl }, | |
82 | { "client_exit", (hookfn) abort_sasl_exit }, | |
15b05f95 SA |
83 | { "new_remote_user", (hookfn) advertise_sasl_new }, |
84 | { "after_client_exit", (hookfn) advertise_sasl_exit }, | |
85 | { "conf_read_end", (hookfn) advertise_sasl_config }, | |
212380e3 AC |
86 | { NULL, NULL } |
87 | }; | |
88 | ||
3c7d6fcc | 89 | static bool |
15b05f95 | 90 | sasl_visible(struct Client *ignored) |
193d4db3 AC |
91 | { |
92 | struct Client *agent_p = NULL; | |
93 | ||
94 | if (ConfigFileEntry.sasl_service) | |
95 | agent_p = find_named_client(ConfigFileEntry.sasl_service); | |
96 | ||
97 | return agent_p != NULL && IsService(agent_p); | |
98 | } | |
99 | ||
da3e5fcb | 100 | static const char * |
38ffccf8 | 101 | sasl_data(struct Client *client_p) |
da3e5fcb AC |
102 | { |
103 | return *mechlist_buf != 0 ? mechlist_buf : NULL; | |
104 | } | |
105 | ||
193d4db3 AC |
106 | static struct ClientCapability capdata_sasl = { |
107 | .visible = sasl_visible, | |
da3e5fcb | 108 | .data = sasl_data, |
193d4db3 AC |
109 | .flags = CLICAP_FLAGS_STICKY, |
110 | }; | |
111 | ||
112 | static int | |
113 | _modinit(void) | |
114 | { | |
da3e5fcb | 115 | memset(mechlist_buf, 0, sizeof mechlist_buf); |
15b05f95 SA |
116 | sasl_agent_present = false; |
117 | ||
193d4db3 | 118 | CLICAP_SASL = capability_put(cli_capindex, "sasl", &capdata_sasl); |
15b05f95 | 119 | advertise_sasl_config(NULL); |
193d4db3 AC |
120 | return 0; |
121 | } | |
122 | ||
123 | static void | |
124 | _moddeinit(void) | |
125 | { | |
15b05f95 | 126 | advertise_sasl_cap(false); |
193d4db3 AC |
127 | capability_orphan(cli_capindex, "sasl"); |
128 | } | |
129 | ||
3abc337f | 130 | DECLARE_MODULE_AV2(sasl, _modinit, _moddeinit, sasl_clist, NULL, sasl_hfnlist, NULL, NULL, sasl_desc); |
212380e3 | 131 | |
3c7d6fcc | 132 | static void |
428ca87b | 133 | m_authenticate(struct MsgBuf *msgbuf_p, struct Client *client_p, struct Client *source_p, |
212380e3 AC |
134 | int parc, const char *parv[]) |
135 | { | |
136 | struct Client *agent_p = NULL; | |
7d33cce8 | 137 | struct Client *saslserv_p = NULL; |
212380e3 AC |
138 | |
139 | /* They really should use CAP for their own sake. */ | |
140 | if(!IsCapable(source_p, CLICAP_SASL)) | |
3c7d6fcc | 141 | return; |
212380e3 | 142 | |
9d07a42d MM |
143 | if(source_p->localClient->sasl_next_retry > rb_current_time()) |
144 | { | |
145 | sendto_one(source_p, form_str(RPL_LOAD2HI), me.name, EmptyString(source_p->name) ? "*" : source_p->name, msgbuf_p->cmd); | |
146 | return; | |
147 | } | |
148 | ||
d5d52a99 | 149 | if (strlen(client_p->id) == 3 || (source_p->preClient && !EmptyString(source_p->preClient->id))) |
1b19fe8b JT |
150 | { |
151 | exit_client(client_p, client_p, client_p, "Mixing client and server protocol"); | |
3c7d6fcc | 152 | return; |
1b19fe8b JT |
153 | } |
154 | ||
ac88154f AJ |
155 | if (*parv[1] == ':' || strchr(parv[1], ' ')) |
156 | { | |
157 | exit_client(client_p, client_p, client_p, "Malformed AUTHENTICATE"); | |
158 | return; | |
159 | } | |
160 | ||
7d33cce8 | 161 | saslserv_p = find_named_client(ConfigFileEntry.sasl_service); |
9d07a42d | 162 | if(saslserv_p == NULL || !IsService(saslserv_p)) |
7d33cce8 MT |
163 | { |
164 | sendto_one(source_p, form_str(ERR_SASLABORTED), me.name, EmptyString(source_p->name) ? "*" : source_p->name); | |
3c7d6fcc | 165 | return; |
7d33cce8 MT |
166 | } |
167 | ||
c6bc97fd | 168 | if(source_p->localClient->sasl_complete) |
212380e3 | 169 | { |
51535fcb | 170 | *source_p->localClient->sasl_agent = '\0'; |
c6bc97fd | 171 | source_p->localClient->sasl_complete = 0; |
212380e3 AC |
172 | } |
173 | ||
174 | if(strlen(parv[1]) > 400) | |
175 | { | |
176 | sendto_one(source_p, form_str(ERR_SASLTOOLONG), me.name, EmptyString(source_p->name) ? "*" : source_p->name); | |
3c7d6fcc | 177 | return; |
212380e3 AC |
178 | } |
179 | ||
180 | if(!*source_p->id) | |
181 | { | |
182 | /* Allocate a UID. */ | |
4d5a902f | 183 | rb_strlcpy(source_p->id, generate_uid(), sizeof(source_p->id)); |
212380e3 AC |
184 | add_to_id_hash(source_p->id, source_p); |
185 | } | |
186 | ||
c6bc97fd AC |
187 | if(*source_p->localClient->sasl_agent) |
188 | agent_p = find_id(source_p->localClient->sasl_agent); | |
212380e3 AC |
189 | |
190 | if(agent_p == NULL) | |
572488e0 | 191 | { |
280ce6a9 AJ |
192 | if (!strcmp(parv[1], "*")) |
193 | { | |
194 | sendto_one(source_p, form_str(ERR_SASLABORTED), me.name, EmptyString(source_p->name) ? "*" : source_p->name); | |
6d8a8851 | 195 | source_p->localClient->sasl_out = 0; |
631c3089 | 196 | return; |
280ce6a9 AJ |
197 | } |
198 | ||
0ee833da | 199 | sendto_one(saslserv_p, ":%s ENCAP %s SASL %s %s H %s %s %c", |
1cae2411 | 200 | me.id, saslserv_p->servptr->name, source_p->id, saslserv_p->id, |
0ee833da SA |
201 | source_p->host, source_p->sockhost, |
202 | IsSSL(source_p) ? 'S' : 'P'); | |
a3fa9d81 | 203 | |
802710b5 | 204 | if (source_p->certfp != NULL) |
6fb9f214 MM |
205 | sendto_one(saslserv_p, ":%s ENCAP %s SASL %s %s S %s %s", |
206 | me.id, saslserv_p->servptr->name, source_p->id, saslserv_p->id, | |
207 | parv[1], source_p->certfp); | |
572488e0 | 208 | else |
6fb9f214 MM |
209 | sendto_one(saslserv_p, ":%s ENCAP %s SASL %s %s S %s", |
210 | me.id, saslserv_p->servptr->name, source_p->id, saslserv_p->id, | |
211 | parv[1]); | |
7d33cce8 | 212 | |
c6bc97fd | 213 | rb_strlcpy(source_p->localClient->sasl_agent, saslserv_p->id, IDLEN); |
572488e0 | 214 | } |
212380e3 | 215 | else |
280ce6a9 AJ |
216 | { |
217 | if (!strcmp(parv[1], "*")) | |
218 | { | |
219 | sendto_one(source_p, form_str(ERR_SASLABORTED), me.name, EmptyString(source_p->name) ? "*" : source_p->name); | |
220 | sendto_one(agent_p, ":%s ENCAP %s SASL %s %s D A", me.id, agent_p->servptr->name, source_p->id, agent_p->id); | |
6d8a8851 | 221 | source_p->localClient->sasl_out = 0; |
631c3089 | 222 | return; |
280ce6a9 AJ |
223 | } |
224 | ||
6fb9f214 MM |
225 | sendto_one(agent_p, ":%s ENCAP %s SASL %s %s C %s", |
226 | me.id, agent_p->servptr->name, source_p->id, agent_p->id, | |
7d33cce8 | 227 | parv[1]); |
280ce6a9 AJ |
228 | } |
229 | ||
c6bc97fd | 230 | source_p->localClient->sasl_out++; |
212380e3 AC |
231 | } |
232 | ||
3c7d6fcc | 233 | static void |
428ca87b | 234 | me_sasl(struct MsgBuf *msgbuf_p, struct Client *client_p, struct Client *source_p, |
212380e3 AC |
235 | int parc, const char *parv[]) |
236 | { | |
237 | struct Client *target_p, *agent_p; | |
40a766a0 | 238 | bool in_progress; |
212380e3 AC |
239 | |
240 | /* Let propagate if not addressed to us, or if broadcast. | |
241 | * Only SASL agents can answer global requests. | |
242 | */ | |
243 | if(strncmp(parv[2], me.id, 3)) | |
3c7d6fcc | 244 | return; |
212380e3 AC |
245 | |
246 | if((target_p = find_id(parv[2])) == NULL) | |
3c7d6fcc | 247 | return; |
212380e3 | 248 | |
212380e3 | 249 | if((agent_p = find_id(parv[1])) == NULL) |
3c7d6fcc | 250 | return; |
212380e3 AC |
251 | |
252 | if(source_p != agent_p->servptr) /* WTF?! */ | |
3c7d6fcc | 253 | return; |
212380e3 AC |
254 | |
255 | /* We only accept messages from SASL agents; these must have umode +S | |
256 | * (so the server must be listed in a service{} block). | |
257 | */ | |
258 | if(!IsService(agent_p)) | |
3c7d6fcc | 259 | return; |
212380e3 | 260 | |
40a766a0 SA |
261 | /* If SASL has been aborted, we only want to track authentication failures. */ |
262 | in_progress = target_p->localClient->sasl_out != 0; | |
263 | ||
212380e3 | 264 | /* Reject if someone has already answered. */ |
c6bc97fd | 265 | if(*target_p->localClient->sasl_agent && strncmp(parv[1], target_p->localClient->sasl_agent, IDLEN)) |
3c7d6fcc | 266 | return; |
40a766a0 | 267 | else if(!*target_p->localClient->sasl_agent && in_progress) |
c6bc97fd | 268 | rb_strlcpy(target_p->localClient->sasl_agent, parv[1], IDLEN); |
212380e3 | 269 | |
f62f94b0 | 270 | if(*parv[3] == 'C') |
37289346 | 271 | { |
40a766a0 SA |
272 | if (in_progress) { |
273 | sendto_one(target_p, "AUTHENTICATE %s", parv[4]); | |
274 | target_p->localClient->sasl_messages++; | |
275 | } | |
37289346 | 276 | } |
212380e3 AC |
277 | else if(*parv[3] == 'D') |
278 | { | |
834579ce MM |
279 | if(*parv[4] == 'F') |
280 | { | |
40a766a0 SA |
281 | if (in_progress) { |
282 | sendto_one(target_p, form_str(ERR_SASLFAIL), me.name, EmptyString(target_p->name) ? "*" : target_p->name); | |
283 | } | |
9d07a42d | 284 | /* Failures with zero messages are just "unknown mechanism" errors; don't count those. */ |
834579ce | 285 | if(target_p->localClient->sasl_messages > 0) |
37289346 | 286 | { |
9d07a42d MM |
287 | if(*target_p->name) |
288 | { | |
46ef49c3 X |
289 | /* Allow 2 tries before rate-limiting as some clients try EXTERNAL |
290 | * then PLAIN right after it if the auth failed, causing the client to be | |
291 | * rate-limited immediately and not being able to login with SASL. | |
292 | */ | |
293 | if (target_p->localClient->sasl_failures++ > 0) | |
23f5c317 | 294 | target_p->localClient->sasl_next_retry = rb_current_time() + (1 << MIN(target_p->localClient->sasl_failures + 1, 8)); |
9d07a42d MM |
295 | } |
296 | else if(throttle_add((struct sockaddr*)&target_p->localClient->ip)) | |
37289346 MM |
297 | { |
298 | exit_client(target_p, target_p, &me, "Too many failed authentication attempts"); | |
299 | return; | |
300 | } | |
301 | } | |
302 | } | |
834579ce MM |
303 | else if(*parv[4] == 'S') |
304 | { | |
40a766a0 SA |
305 | if (in_progress) { |
306 | sendto_one(target_p, form_str(RPL_SASLSUCCESS), me.name, EmptyString(target_p->name) ? "*" : target_p->name); | |
307 | target_p->localClient->sasl_failures = 0; | |
308 | target_p->localClient->sasl_complete = 1; | |
309 | ServerStats.is_ssuc++; | |
310 | } | |
212380e3 | 311 | } |
c6bc97fd | 312 | *target_p->localClient->sasl_agent = '\0'; /* Blank the stored agent so someone else can answer */ |
37289346 | 313 | target_p->localClient->sasl_messages = 0; |
212380e3 | 314 | } |
dbd8ca2b | 315 | else if(*parv[3] == 'M') |
40a766a0 SA |
316 | { |
317 | if (in_progress) { | |
318 | sendto_one(target_p, form_str(RPL_SASLMECHS), me.name, EmptyString(target_p->name) ? "*" : target_p->name, parv[4]); | |
319 | } | |
320 | } | |
212380e3 AC |
321 | } |
322 | ||
3c7d6fcc | 323 | static void |
da3e5fcb AC |
324 | me_mechlist(struct MsgBuf *msgbuf_p, struct Client *client_p, struct Client *source_p, |
325 | int parc, const char *parv[]) | |
326 | { | |
327 | rb_strlcpy(mechlist_buf, parv[1], sizeof mechlist_buf); | |
da3e5fcb AC |
328 | } |
329 | ||
212380e3 AC |
330 | /* If the client never finished authenticating but is |
331 | * registering anyway, abort the exchange. | |
332 | */ | |
333 | static void | |
334 | abort_sasl(struct Client *data) | |
335 | { | |
c6bc97fd | 336 | if(data->localClient->sasl_out == 0 || data->localClient->sasl_complete) |
212380e3 AC |
337 | return; |
338 | ||
c6bc97fd | 339 | data->localClient->sasl_out = data->localClient->sasl_complete = 0; |
47adde3d | 340 | ServerStats.is_sbad++; |
212380e3 AC |
341 | |
342 | if(!IsClosing(data)) | |
343 | sendto_one(data, form_str(ERR_SASLABORTED), me.name, EmptyString(data->name) ? "*" : data->name); | |
344 | ||
c6bc97fd | 345 | if(*data->localClient->sasl_agent) |
212380e3 | 346 | { |
c6bc97fd | 347 | struct Client *agent_p = find_id(data->localClient->sasl_agent); |
212380e3 AC |
348 | if(agent_p) |
349 | { | |
350 | sendto_one(agent_p, ":%s ENCAP %s SASL %s %s D A", me.id, agent_p->servptr->name, | |
351 | data->id, agent_p->id); | |
352 | return; | |
353 | } | |
354 | } | |
355 | ||
356 | sendto_server(NULL, NULL, CAP_TS6|CAP_ENCAP, NOCAPS, ":%s ENCAP * SASL %s * D A", me.id, | |
357 | data->id); | |
358 | } | |
359 | ||
360 | static void | |
361 | abort_sasl_exit(hook_data_client_exit *data) | |
362 | { | |
c23902ae AC |
363 | if (data->target->localClient) |
364 | abort_sasl(data->target); | |
212380e3 AC |
365 | } |
366 | ||
12565204 | 367 | static void |
15b05f95 SA |
368 | advertise_sasl_cap(bool available) |
369 | { | |
370 | if (sasl_agent_present != available) { | |
371 | if (available) { | |
372 | sendto_local_clients_with_capability(CLICAP_CAP_NOTIFY, ":%s CAP * NEW :sasl", me.name); | |
373 | } else { | |
374 | sendto_local_clients_with_capability(CLICAP_CAP_NOTIFY, ":%s CAP * DEL :sasl", me.name); | |
375 | } | |
376 | sasl_agent_present = available; | |
377 | } | |
378 | } | |
379 | ||
380 | static void | |
381 | advertise_sasl_new(struct Client *client_p) | |
12565204 AC |
382 | { |
383 | if (!ConfigFileEntry.sasl_service) | |
384 | return; | |
385 | ||
386 | if (irccmp(client_p->name, ConfigFileEntry.sasl_service)) | |
387 | return; | |
388 | ||
15b05f95 | 389 | advertise_sasl_cap(IsService(client_p)); |
12565204 AC |
390 | } |
391 | ||
392 | static void | |
15b05f95 | 393 | advertise_sasl_exit(void *ignored) |
12565204 AC |
394 | { |
395 | if (!ConfigFileEntry.sasl_service) | |
396 | return; | |
397 | ||
15b05f95 SA |
398 | if (sasl_agent_present) { |
399 | advertise_sasl_cap(sasl_visible(NULL)); | |
400 | } | |
401 | } | |
12565204 | 402 | |
15b05f95 SA |
403 | static void |
404 | advertise_sasl_config(void *ignored) | |
405 | { | |
406 | advertise_sasl_cap(sasl_visible(NULL)); | |
12565204 | 407 | } |