2 * Copyright (C) 2006 Michael Tharp <gxti@partiallystapled.com>
3 * Copyright (C) 2006 charybdis development team
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions are
9 * 1.Redistributions of source code must retain the above copyright notice,
10 * this list of conditions and the following disclaimer.
11 * 2.Redistributions in binary form must reproduce the above copyright
12 * notice, this list of conditions and the following disclaimer in the
13 * documentation and/or other materials provided with the distribution.
14 * 3.The name of the author may not be used to endorse or promote products
15 * derived from this software without specific prior written permission.
17 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
18 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
19 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
20 * DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT,
21 * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
22 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
23 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
24 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
25 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
26 * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
27 * POSSIBILITY OF SUCH DAMAGE.
42 #include "s_newconf.h"
45 static const char sasl_desc
[] = "Provides SASL authentication support";
47 static void m_authenticate(struct MsgBuf
*, struct Client
*, struct Client
*, int, const char **);
48 static void me_sasl(struct MsgBuf
*, struct Client
*, struct Client
*, int, const char **);
49 static void me_mechlist(struct MsgBuf
*, struct Client
*, struct Client
*, int, const char **);
51 static void abort_sasl(struct Client
*);
52 static void abort_sasl_exit(hook_data_client_exit
*);
54 static void advertise_sasl(struct Client
*);
55 static void advertise_sasl_exit(hook_data_client_exit
*);
57 static unsigned int CLICAP_SASL
= 0;
58 static char mechlist_buf
[BUFSIZE
];
60 struct Message authenticate_msgtab
= {
61 "AUTHENTICATE", 0, 0, 0, 0,
62 {{m_authenticate
, 2}, {m_authenticate
, 2}, mg_ignore
, mg_ignore
, mg_ignore
, {m_authenticate
, 2}}
64 struct Message sasl_msgtab
= {
66 {mg_ignore
, mg_ignore
, mg_ignore
, mg_ignore
, {me_sasl
, 5}, mg_ignore
}
68 struct Message mechlist_msgtab
= {
69 "MECHLIST", 0, 0, 0, 0,
70 {mg_ignore
, mg_ignore
, mg_ignore
, mg_ignore
, {me_mechlist
, 2}, mg_ignore
}
73 mapi_clist_av1 sasl_clist
[] = {
74 &authenticate_msgtab
, &sasl_msgtab
, &mechlist_msgtab
, NULL
76 mapi_hfn_list_av1 sasl_hfnlist
[] = {
77 { "new_local_user", (hookfn
) abort_sasl
},
78 { "client_exit", (hookfn
) abort_sasl_exit
},
79 { "new_remote_user", (hookfn
) advertise_sasl
},
80 { "client_exit", (hookfn
) advertise_sasl_exit
},
85 sasl_visible(struct Client
*client_p
)
87 struct Client
*agent_p
= NULL
;
89 if (ConfigFileEntry
.sasl_service
)
90 agent_p
= find_named_client(ConfigFileEntry
.sasl_service
);
92 return agent_p
!= NULL
&& IsService(agent_p
);
96 sasl_data(struct Client
*client_p
)
98 return *mechlist_buf
!= 0 ? mechlist_buf
: NULL
;
101 static struct ClientCapability capdata_sasl
= {
102 .visible
= sasl_visible
,
104 .flags
= CLICAP_FLAGS_STICKY
,
110 memset(mechlist_buf
, 0, sizeof mechlist_buf
);
111 CLICAP_SASL
= capability_put(cli_capindex
, "sasl", &capdata_sasl
);
118 capability_orphan(cli_capindex
, "sasl");
121 DECLARE_MODULE_AV2(sasl
, _modinit
, _moddeinit
, sasl_clist
, NULL
, sasl_hfnlist
, NULL
, NULL
, sasl_desc
);
124 m_authenticate(struct MsgBuf
*msgbuf_p
, struct Client
*client_p
, struct Client
*source_p
,
125 int parc
, const char *parv
[])
127 struct Client
*agent_p
= NULL
;
128 struct Client
*saslserv_p
= NULL
;
130 /* They really should use CAP for their own sake. */
131 if(!IsCapable(source_p
, CLICAP_SASL
))
134 if(source_p
->localClient
->sasl_next_retry
> rb_current_time())
136 sendto_one(source_p
, form_str(RPL_LOAD2HI
), me
.name
, EmptyString(source_p
->name
) ? "*" : source_p
->name
, msgbuf_p
->cmd
);
140 if(strlen(client_p
->id
) == 3)
142 exit_client(client_p
, client_p
, client_p
, "Mixing client and server protocol");
146 saslserv_p
= find_named_client(ConfigFileEntry
.sasl_service
);
147 if(saslserv_p
== NULL
|| !IsService(saslserv_p
))
149 sendto_one(source_p
, form_str(ERR_SASLABORTED
), me
.name
, EmptyString(source_p
->name
) ? "*" : source_p
->name
);
153 if(source_p
->localClient
->sasl_complete
)
155 *source_p
->localClient
->sasl_agent
= '\0';
156 source_p
->localClient
->sasl_complete
= 0;
159 if(strlen(parv
[1]) > 400)
161 sendto_one(source_p
, form_str(ERR_SASLTOOLONG
), me
.name
, EmptyString(source_p
->name
) ? "*" : source_p
->name
);
167 /* Allocate a UID. */
168 rb_strlcpy(source_p
->id
, generate_uid(), sizeof(source_p
->id
));
169 add_to_id_hash(source_p
->id
, source_p
);
172 if(*source_p
->localClient
->sasl_agent
)
173 agent_p
= find_id(source_p
->localClient
->sasl_agent
);
177 sendto_one(saslserv_p
, ":%s ENCAP %s SASL %s %s H %s %s",
178 me
.id
, saslserv_p
->servptr
->name
, source_p
->id
, saslserv_p
->id
,
179 source_p
->host
, source_p
->sockhost
);
181 if (source_p
->certfp
!= NULL
)
182 sendto_one(saslserv_p
, ":%s ENCAP %s SASL %s %s S %s %s",
183 me
.id
, saslserv_p
->servptr
->name
, source_p
->id
, saslserv_p
->id
,
184 parv
[1], source_p
->certfp
);
186 sendto_one(saslserv_p
, ":%s ENCAP %s SASL %s %s S %s",
187 me
.id
, saslserv_p
->servptr
->name
, source_p
->id
, saslserv_p
->id
,
190 rb_strlcpy(source_p
->localClient
->sasl_agent
, saslserv_p
->id
, IDLEN
);
193 sendto_one(agent_p
, ":%s ENCAP %s SASL %s %s C %s",
194 me
.id
, agent_p
->servptr
->name
, source_p
->id
, agent_p
->id
,
196 source_p
->localClient
->sasl_out
++;
200 me_sasl(struct MsgBuf
*msgbuf_p
, struct Client
*client_p
, struct Client
*source_p
,
201 int parc
, const char *parv
[])
203 struct Client
*target_p
, *agent_p
;
205 /* Let propagate if not addressed to us, or if broadcast.
206 * Only SASL agents can answer global requests.
208 if(strncmp(parv
[2], me
.id
, 3))
211 if((target_p
= find_id(parv
[2])) == NULL
)
214 if((agent_p
= find_id(parv
[1])) == NULL
)
217 if(source_p
!= agent_p
->servptr
) /* WTF?! */
220 /* We only accept messages from SASL agents; these must have umode +S
221 * (so the server must be listed in a service{} block).
223 if(!IsService(agent_p
))
226 /* Reject if someone has already answered. */
227 if(*target_p
->localClient
->sasl_agent
&& strncmp(parv
[1], target_p
->localClient
->sasl_agent
, IDLEN
))
229 else if(!*target_p
->localClient
->sasl_agent
)
230 rb_strlcpy(target_p
->localClient
->sasl_agent
, parv
[1], IDLEN
);
234 sendto_one(target_p
, "AUTHENTICATE %s", parv
[4]);
235 target_p
->localClient
->sasl_messages
++;
237 else if(*parv
[3] == 'D')
241 sendto_one(target_p
, form_str(ERR_SASLFAIL
), me
.name
, EmptyString(target_p
->name
) ? "*" : target_p
->name
);
242 /* Failures with zero messages are just "unknown mechanism" errors; don't count those. */
243 if(target_p
->localClient
->sasl_messages
> 0)
247 target_p
->localClient
->sasl_failures
++;
248 target_p
->localClient
->sasl_next_retry
= rb_current_time() + (1 << MIN(target_p
->localClient
->sasl_failures
+ 5, 13));
250 else if(throttle_add((struct sockaddr
*)&target_p
->localClient
->ip
))
252 exit_client(target_p
, target_p
, &me
, "Too many failed authentication attempts");
257 else if(*parv
[4] == 'S')
259 sendto_one(target_p
, form_str(RPL_SASLSUCCESS
), me
.name
, EmptyString(target_p
->name
) ? "*" : target_p
->name
);
260 target_p
->localClient
->sasl_failures
= 0;
261 target_p
->localClient
->sasl_complete
= 1;
262 ServerStats
.is_ssuc
++;
264 *target_p
->localClient
->sasl_agent
= '\0'; /* Blank the stored agent so someone else can answer */
265 target_p
->localClient
->sasl_messages
= 0;
267 else if(*parv
[3] == 'M')
268 sendto_one(target_p
, form_str(RPL_SASLMECHS
), me
.name
, EmptyString(target_p
->name
) ? "*" : target_p
->name
, parv
[4]);
272 me_mechlist(struct MsgBuf
*msgbuf_p
, struct Client
*client_p
, struct Client
*source_p
,
273 int parc
, const char *parv
[])
275 rb_strlcpy(mechlist_buf
, parv
[1], sizeof mechlist_buf
);
278 /* If the client never finished authenticating but is
279 * registering anyway, abort the exchange.
282 abort_sasl(struct Client
*data
)
284 if(data
->localClient
->sasl_out
== 0 || data
->localClient
->sasl_complete
)
287 data
->localClient
->sasl_out
= data
->localClient
->sasl_complete
= 0;
288 ServerStats
.is_sbad
++;
291 sendto_one(data
, form_str(ERR_SASLABORTED
), me
.name
, EmptyString(data
->name
) ? "*" : data
->name
);
293 if(*data
->localClient
->sasl_agent
)
295 struct Client
*agent_p
= find_id(data
->localClient
->sasl_agent
);
298 sendto_one(agent_p
, ":%s ENCAP %s SASL %s %s D A", me
.id
, agent_p
->servptr
->name
,
299 data
->id
, agent_p
->id
);
304 sendto_server(NULL
, NULL
, CAP_TS6
|CAP_ENCAP
, NOCAPS
, ":%s ENCAP * SASL %s * D A", me
.id
,
309 abort_sasl_exit(hook_data_client_exit
*data
)
311 if (data
->target
->localClient
)
312 abort_sasl(data
->target
);
316 advertise_sasl(struct Client
*client_p
)
318 if (!ConfigFileEntry
.sasl_service
)
321 if (irccmp(client_p
->name
, ConfigFileEntry
.sasl_service
))
324 sendto_local_clients_with_capability(CLICAP_CAP_NOTIFY
, ":%s CAP * NEW :sasl", me
.name
);
328 advertise_sasl_exit(hook_data_client_exit
*data
)
330 if (!ConfigFileEntry
.sasl_service
)
333 if (irccmp(data
->target
->name
, ConfigFileEntry
.sasl_service
))
336 sendto_local_clients_with_capability(CLICAP_CAP_NOTIFY
, ":%s CAP * DEL :sasl", me
.name
);