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.
41 #include "s_newconf.h"
44 static const char sasl_desc
[] = "Provides SASL authentication support";
46 static void m_authenticate(struct MsgBuf
*, struct Client
*, struct Client
*, int, const char **);
47 static void me_sasl(struct MsgBuf
*, struct Client
*, struct Client
*, int, const char **);
48 static void me_mechlist(struct MsgBuf
*, struct Client
*, struct Client
*, int, const char **);
50 static void abort_sasl(struct Client
*);
51 static void abort_sasl_exit(hook_data_client_exit
*);
53 static void advertise_sasl(struct Client
*);
54 static void advertise_sasl_exit(hook_data_client_exit
*);
56 static unsigned int CLICAP_SASL
= 0;
57 static char mechlist_buf
[BUFSIZE
];
59 struct Message authenticate_msgtab
= {
60 "AUTHENTICATE", 0, 0, 0, 0,
61 {{m_authenticate
, 2}, {m_authenticate
, 2}, mg_ignore
, mg_ignore
, mg_ignore
, {m_authenticate
, 2}}
63 struct Message sasl_msgtab
= {
65 {mg_ignore
, mg_ignore
, mg_ignore
, mg_ignore
, {me_sasl
, 5}, mg_ignore
}
67 struct Message mechlist_msgtab
= {
68 "MECHLIST", 0, 0, 0, 0,
69 {mg_ignore
, mg_ignore
, mg_ignore
, mg_ignore
, {me_mechlist
, 2}, mg_ignore
}
72 mapi_clist_av1 sasl_clist
[] = {
73 &authenticate_msgtab
, &sasl_msgtab
, &mechlist_msgtab
, NULL
75 mapi_hfn_list_av1 sasl_hfnlist
[] = {
76 { "new_local_user", (hookfn
) abort_sasl
},
77 { "client_exit", (hookfn
) abort_sasl_exit
},
78 { "new_remote_user", (hookfn
) advertise_sasl
},
79 { "client_exit", (hookfn
) advertise_sasl_exit
},
84 sasl_visible(struct Client
*client_p
)
86 struct Client
*agent_p
= NULL
;
88 if (ConfigFileEntry
.sasl_service
)
89 agent_p
= find_named_client(ConfigFileEntry
.sasl_service
);
91 return agent_p
!= NULL
&& IsService(agent_p
);
95 sasl_data(struct Client
*client_p
)
97 return *mechlist_buf
!= 0 ? mechlist_buf
: NULL
;
100 static struct ClientCapability capdata_sasl
= {
101 .visible
= sasl_visible
,
103 .flags
= CLICAP_FLAGS_STICKY
,
109 memset(mechlist_buf
, 0, sizeof mechlist_buf
);
110 CLICAP_SASL
= capability_put(cli_capindex
, "sasl", &capdata_sasl
);
117 capability_orphan(cli_capindex
, "sasl");
120 DECLARE_MODULE_AV2(sasl
, _modinit
, _moddeinit
, sasl_clist
, NULL
, sasl_hfnlist
, NULL
, NULL
, sasl_desc
);
123 m_authenticate(struct MsgBuf
*msgbuf_p
, struct Client
*client_p
, struct Client
*source_p
,
124 int parc
, const char *parv
[])
126 struct Client
*agent_p
= NULL
;
127 struct Client
*saslserv_p
= NULL
;
129 /* They really should use CAP for their own sake. */
130 if(!IsCapable(source_p
, CLICAP_SASL
))
133 if (strlen(client_p
->id
) == 3)
135 exit_client(client_p
, client_p
, client_p
, "Mixing client and server protocol");
139 saslserv_p
= find_named_client(ConfigFileEntry
.sasl_service
);
140 if (saslserv_p
== NULL
|| !IsService(saslserv_p
))
142 sendto_one(source_p
, form_str(ERR_SASLABORTED
), me
.name
, EmptyString(source_p
->name
) ? "*" : source_p
->name
);
146 if(source_p
->localClient
->sasl_complete
)
148 *source_p
->localClient
->sasl_agent
= '\0';
149 source_p
->localClient
->sasl_complete
= 0;
152 if(strlen(parv
[1]) > 400)
154 sendto_one(source_p
, form_str(ERR_SASLTOOLONG
), me
.name
, EmptyString(source_p
->name
) ? "*" : source_p
->name
);
160 /* Allocate a UID. */
161 strcpy(source_p
->id
, generate_uid());
162 add_to_id_hash(source_p
->id
, source_p
);
165 if(*source_p
->localClient
->sasl_agent
)
166 agent_p
= find_id(source_p
->localClient
->sasl_agent
);
170 sendto_one(saslserv_p
, ":%s ENCAP %s SASL %s %s H %s %s",
171 me
.id
, saslserv_p
->servptr
->name
, source_p
->id
, saslserv_p
->id
,
172 source_p
->host
, source_p
->sockhost
);
174 if (source_p
->certfp
!= NULL
)
175 sendto_one(saslserv_p
, ":%s ENCAP %s SASL %s %s S %s %s",
176 me
.id
, saslserv_p
->servptr
->name
, source_p
->id
, saslserv_p
->id
,
177 parv
[1], source_p
->certfp
);
179 sendto_one(saslserv_p
, ":%s ENCAP %s SASL %s %s S %s",
180 me
.id
, saslserv_p
->servptr
->name
, source_p
->id
, saslserv_p
->id
,
183 rb_strlcpy(source_p
->localClient
->sasl_agent
, saslserv_p
->id
, IDLEN
);
186 sendto_one(agent_p
, ":%s ENCAP %s SASL %s %s C %s",
187 me
.id
, agent_p
->servptr
->name
, source_p
->id
, agent_p
->id
,
189 source_p
->localClient
->sasl_out
++;
193 me_sasl(struct MsgBuf
*msgbuf_p
, struct Client
*client_p
, struct Client
*source_p
,
194 int parc
, const char *parv
[])
196 struct Client
*target_p
, *agent_p
;
198 /* Let propagate if not addressed to us, or if broadcast.
199 * Only SASL agents can answer global requests.
201 if(strncmp(parv
[2], me
.id
, 3))
204 if((target_p
= find_id(parv
[2])) == NULL
)
207 if((agent_p
= find_id(parv
[1])) == NULL
)
210 if(source_p
!= agent_p
->servptr
) /* WTF?! */
213 /* We only accept messages from SASL agents; these must have umode +S
214 * (so the server must be listed in a service{} block).
216 if(!IsService(agent_p
))
219 /* Reject if someone has already answered. */
220 if(*target_p
->localClient
->sasl_agent
&& strncmp(parv
[1], target_p
->localClient
->sasl_agent
, IDLEN
))
222 else if(!*target_p
->localClient
->sasl_agent
)
223 rb_strlcpy(target_p
->localClient
->sasl_agent
, parv
[1], IDLEN
);
226 sendto_one(target_p
, "AUTHENTICATE %s", parv
[4]);
227 else if(*parv
[3] == 'D')
230 sendto_one(target_p
, form_str(ERR_SASLFAIL
), me
.name
, EmptyString(target_p
->name
) ? "*" : target_p
->name
);
231 else if(*parv
[4] == 'S') {
232 sendto_one(target_p
, form_str(RPL_SASLSUCCESS
), me
.name
, EmptyString(target_p
->name
) ? "*" : target_p
->name
);
233 target_p
->localClient
->sasl_complete
= 1;
234 ServerStats
.is_ssuc
++;
236 *target_p
->localClient
->sasl_agent
= '\0'; /* Blank the stored agent so someone else can answer */
238 else if(*parv
[3] == 'M')
239 sendto_one(target_p
, form_str(RPL_SASLMECHS
), me
.name
, EmptyString(target_p
->name
) ? "*" : target_p
->name
, parv
[4]);
243 me_mechlist(struct MsgBuf
*msgbuf_p
, struct Client
*client_p
, struct Client
*source_p
,
244 int parc
, const char *parv
[])
246 rb_strlcpy(mechlist_buf
, parv
[1], sizeof mechlist_buf
);
249 /* If the client never finished authenticating but is
250 * registering anyway, abort the exchange.
253 abort_sasl(struct Client
*data
)
255 if(data
->localClient
->sasl_out
== 0 || data
->localClient
->sasl_complete
)
258 data
->localClient
->sasl_out
= data
->localClient
->sasl_complete
= 0;
259 ServerStats
.is_sbad
++;
262 sendto_one(data
, form_str(ERR_SASLABORTED
), me
.name
, EmptyString(data
->name
) ? "*" : data
->name
);
264 if(*data
->localClient
->sasl_agent
)
266 struct Client
*agent_p
= find_id(data
->localClient
->sasl_agent
);
269 sendto_one(agent_p
, ":%s ENCAP %s SASL %s %s D A", me
.id
, agent_p
->servptr
->name
,
270 data
->id
, agent_p
->id
);
275 sendto_server(NULL
, NULL
, CAP_TS6
|CAP_ENCAP
, NOCAPS
, ":%s ENCAP * SASL %s * D A", me
.id
,
280 abort_sasl_exit(hook_data_client_exit
*data
)
282 if (data
->target
->localClient
)
283 abort_sasl(data
->target
);
287 advertise_sasl(struct Client
*client_p
)
289 if (!ConfigFileEntry
.sasl_service
)
292 if (irccmp(client_p
->name
, ConfigFileEntry
.sasl_service
))
295 sendto_local_clients_with_capability(CLICAP_CAP_NOTIFY
, ":%s CAP * NEW :sasl", me
.name
);
299 advertise_sasl_exit(hook_data_client_exit
*data
)
301 if (!ConfigFileEntry
.sasl_service
)
304 if (irccmp(data
->target
->name
, ConfigFileEntry
.sasl_service
))
307 sendto_local_clients_with_capability(CLICAP_CAP_NOTIFY
, ":%s CAP * DEL :sasl", me
.name
);