Commit | Line | Data |
---|---|---|
f78eb7c6 | 1 | /* $Cambridge: exim/src/src/auths/spa.c,v 1.6 2006/02/10 14:25:43 ph10 Exp $ */ |
0756eb3c PH |
2 | |
3 | /************************************************* | |
4 | * Exim - an Internet mail transport agent * | |
5 | *************************************************/ | |
6 | ||
d7d7b7b9 | 7 | /* Copyright (c) University of Cambridge 1995 - 2006 */ |
0756eb3c PH |
8 | /* See the file NOTICE for conditions of use and distribution. */ |
9 | ||
10 | /* This file, which provides support for Microsoft's Secure Password | |
11 | Authentication, was contributed by Marc Prud'hommeaux. Tom Kistner added SPA | |
12 | server support. I (PH) have only modified it in very trivial ways. | |
13 | ||
14 | References: | |
15 | http://www.innovation.ch/java/ntlm.html | |
16 | http://www.kuro5hin.org/story/2002/4/28/1436/66154 | |
17 | ||
18 | * It seems that some systems have existing but different definitions of some | |
19 | * of the following types. I received a complaint about "int16" causing | |
20 | * compilation problems. So I (PH) have renamed them all, to be on the safe | |
21 | * side, by adding 'x' on the end. See auths/auth-spa.h. | |
22 | ||
23 | * typedef signed short int16; | |
24 | * typedef unsigned short uint16; | |
25 | * typedef unsigned uint32; | |
26 | * typedef unsigned char uint8; | |
27 | ||
28 | 07-August-2003: PH: Patched up the code to avoid assert bombouts for stupid | |
29 | input data. Find appropriate comment by grepping for "PH". | |
30 | */ | |
31 | ||
32 | ||
33 | #include "../exim.h" | |
34 | #include "spa.h" | |
35 | ||
36 | /* #define DEBUG_SPA */ | |
37 | ||
38 | #ifdef DEBUG_SPA | |
39 | #define DSPA(x,y,z) debug_printf(x,y,z) | |
40 | #else | |
41 | #define DSPA(x,y,z) | |
42 | #endif | |
43 | ||
44 | /* Options specific to the spa authentication mechanism. */ | |
45 | ||
46 | optionlist auth_spa_options[] = { | |
47 | { "client_domain", opt_stringptr, | |
48 | (void *)(offsetof(auth_spa_options_block, spa_domain)) }, | |
49 | { "client_password", opt_stringptr, | |
50 | (void *)(offsetof(auth_spa_options_block, spa_password)) }, | |
51 | { "client_username", opt_stringptr, | |
52 | (void *)(offsetof(auth_spa_options_block, spa_username)) }, | |
53 | { "server_password", opt_stringptr, | |
54 | (void *)(offsetof(auth_spa_options_block, spa_serverpassword)) } | |
55 | }; | |
56 | ||
57 | /* Size of the options list. An extern variable has to be used so that its | |
58 | address can appear in the tables drtables.c. */ | |
59 | ||
60 | int auth_spa_options_count = | |
61 | sizeof(auth_spa_options)/sizeof(optionlist); | |
62 | ||
63 | /* Default private options block for the contidion authentication method. */ | |
64 | ||
65 | auth_spa_options_block auth_spa_option_defaults = { | |
66 | NULL, /* spa_password */ | |
67 | NULL, /* spa_username */ | |
68 | NULL, /* spa_domain */ | |
69 | NULL /* spa_serverpassword (for server side use) */ | |
70 | }; | |
71 | ||
72 | ||
73 | /************************************************* | |
74 | * Initialization entry point * | |
75 | *************************************************/ | |
76 | ||
77 | /* Called for each instance, after its options have been read, to | |
78 | enable consistency checks to be done, or anything else that needs | |
79 | to be set up. */ | |
80 | ||
81 | void | |
82 | auth_spa_init(auth_instance *ablock) | |
83 | { | |
84 | auth_spa_options_block *ob = | |
85 | (auth_spa_options_block *)(ablock->options_block); | |
86 | ||
87 | /* The public name defaults to the authenticator name */ | |
88 | ||
89 | if (ablock->public_name == NULL) ablock->public_name = ablock->name; | |
90 | ||
91 | /* Both username and password must be set for a client */ | |
92 | ||
93 | if ((ob->spa_username == NULL) != (ob->spa_password == NULL)) | |
94 | log_write(0, LOG_PANIC_DIE|LOG_CONFIG_FOR, "%s authenticator:\n " | |
95 | "one of client_username and client_password cannot be set without " | |
96 | "the other", ablock->name); | |
97 | ablock->client = ob->spa_username != NULL; | |
98 | ||
99 | /* For a server we have just one option */ | |
100 | ||
101 | ablock->server = ob->spa_serverpassword != NULL; | |
102 | } | |
103 | ||
104 | ||
105 | ||
106 | /************************************************* | |
107 | * Server entry point * | |
108 | *************************************************/ | |
109 | ||
110 | /* For interface, see auths/README */ | |
111 | ||
112 | #define CVAL(buf,pos) (((unsigned char *)(buf))[pos]) | |
113 | #define PVAL(buf,pos) ((unsigned)CVAL(buf,pos)) | |
114 | #define SVAL(buf,pos) (PVAL(buf,pos)|PVAL(buf,(pos)+1)<<8) | |
115 | #define IVAL(buf,pos) (SVAL(buf,pos)|SVAL(buf,(pos)+2)<<16) | |
116 | ||
117 | int | |
118 | auth_spa_server(auth_instance *ablock, uschar *data) | |
119 | { | |
120 | auth_spa_options_block *ob = (auth_spa_options_block *)(ablock->options_block); | |
121 | uint8x lmRespData[24]; | |
122 | uint8x ntRespData[24]; | |
123 | SPAAuthRequest request; | |
124 | SPAAuthChallenge challenge; | |
125 | SPAAuthResponse response; | |
126 | SPAAuthResponse *responseptr = &response; | |
127 | uschar msgbuf[2048]; | |
128 | uschar *clearpass; | |
129 | ||
130 | /* send a 334, MS Exchange style, and grab the client's request */ | |
131 | ||
132 | if (auth_get_no64_data(&data, US"NTLM supported") != OK) | |
133 | { | |
134 | /* something borked */ | |
135 | return FAIL; | |
136 | } | |
137 | ||
85b87bc2 | 138 | if (spa_base64_to_bits((char *)(&request), sizeof(request), (const char *)(data)) < 0) |
0756eb3c PH |
139 | { |
140 | DEBUG(D_auth) debug_printf("auth_spa_server(): bad base64 data in " | |
141 | "request: %s\n", data); | |
142 | return FAIL; | |
143 | } | |
144 | ||
145 | /* create a challenge and send it back */ | |
146 | ||
147 | spa_build_auth_challenge(&request,&challenge); | |
148 | spa_bits_to_base64 (msgbuf, (unsigned char*)&challenge, | |
149 | spa_request_length(&challenge)); | |
150 | ||
151 | if (auth_get_no64_data(&data, msgbuf) != OK) | |
152 | { | |
153 | /* something borked */ | |
154 | return FAIL; | |
155 | } | |
156 | ||
157 | /* dump client response */ | |
85b87bc2 | 158 | if (spa_base64_to_bits((char *)(&response), sizeof(response), (const char *)(data)) < 0) |
0756eb3c PH |
159 | { |
160 | DEBUG(D_auth) debug_printf("auth_spa_server(): bad base64 data in " | |
161 | "response: %s\n", data); | |
162 | return FAIL; | |
163 | } | |
164 | ||
0756eb3c PH |
165 | /*************************************************************** |
166 | PH 07-Aug-2003: The original code here was this: | |
167 | ||
168 | Ustrcpy(msgbuf, unicodeToString(((char*)responseptr) + | |
169 | IVAL(&responseptr->uUser.offset,0), | |
170 | SVAL(&responseptr->uUser.len,0)/2) ); | |
171 | ||
172 | However, if the response data is too long, unicodeToString bombs out on | |
173 | an assertion failure. It uses a 1024 fixed buffer. Bombing out is not a good | |
174 | idea. It's too messy to try to rework that function to return an error because | |
175 | it is called from a number of other places in the auth-spa.c module. Instead, | |
176 | since it is a very small function, I reproduce its code here, with a size check | |
177 | that causes failure if the size of msgbuf is exceeded. ****/ | |
178 | ||
179 | { | |
180 | int i; | |
181 | char *p = ((char*)responseptr) + IVAL(&responseptr->uUser.offset,0); | |
182 | int len = SVAL(&responseptr->uUser.len,0)/2; | |
183 | ||
184 | if (len + 1 >= sizeof(msgbuf)) return FAIL; | |
185 | for (i = 0; i < len; ++i) | |
186 | { | |
187 | msgbuf[i] = *p & 0x7f; | |
188 | p += 2; | |
189 | } | |
190 | msgbuf[i] = 0; | |
191 | } | |
192 | ||
193 | /***************************************************************/ | |
194 | ||
f78eb7c6 PH |
195 | /* Put the username in $auth1 and $1. The former is now the preferred variable; |
196 | the latter is the original variable. */ | |
197 | ||
198 | auth_vars[0] = expand_nstring[1] = msgbuf; | |
0756eb3c PH |
199 | expand_nlength[1] = Ustrlen(msgbuf); |
200 | expand_nmax = 1; | |
201 | ||
f78eb7c6 PH |
202 | debug_print_string(ablock->server_debug_string); /* customized debug */ |
203 | ||
0756eb3c PH |
204 | /* look up password */ |
205 | ||
206 | clearpass = expand_string(ob->spa_serverpassword); | |
207 | if (clearpass == NULL) | |
208 | { | |
209 | if (expand_string_forcedfail) | |
210 | { | |
211 | DEBUG(D_auth) debug_printf("auth_spa_server(): forced failure while " | |
212 | "expanding spa_serverpassword\n"); | |
213 | return FAIL; | |
214 | } | |
215 | else | |
216 | { | |
217 | DEBUG(D_auth) debug_printf("auth_spa_server(): error while expanding " | |
218 | "spa_serverpassword: %s\n", expand_string_message); | |
219 | return DEFER; | |
220 | } | |
221 | } | |
222 | ||
223 | /* create local hash copy */ | |
224 | ||
225 | spa_smb_encrypt (clearpass, challenge.challengeData, lmRespData); | |
226 | spa_smb_nt_encrypt (clearpass, challenge.challengeData, ntRespData); | |
227 | ||
228 | /* compare NT hash (LM may not be available) */ | |
229 | ||
230 | if (memcmp(ntRespData, | |
231 | ((unsigned char*)responseptr)+IVAL(&responseptr->ntResponse.offset,0), | |
232 | 24) == 0) | |
233 | /* success. we have a winner. */ | |
234 | return OK; | |
235 | ||
236 | return FAIL; | |
237 | } | |
238 | ||
239 | ||
240 | /************************************************* | |
241 | * Client entry point * | |
242 | *************************************************/ | |
243 | ||
244 | /* For interface, see auths/README */ | |
245 | ||
246 | int | |
247 | auth_spa_client( | |
248 | auth_instance *ablock, /* authenticator block */ | |
249 | smtp_inblock *inblock, /* connection inblock */ | |
250 | smtp_outblock *outblock, /* connection outblock */ | |
251 | int timeout, /* command timeout */ | |
252 | uschar *buffer, /* buffer for reading response */ | |
253 | int buffsize) /* size of buffer */ | |
254 | { | |
255 | auth_spa_options_block *ob = | |
256 | (auth_spa_options_block *)(ablock->options_block); | |
257 | SPAAuthRequest request; | |
258 | SPAAuthChallenge challenge; | |
259 | SPAAuthResponse response; | |
260 | char msgbuf[2048]; | |
261 | char *domain = NULL; | |
262 | char *username, *password; | |
263 | ||
0756eb3c PH |
264 | /* Code added by PH to expand the options */ |
265 | ||
266 | username = CS expand_string(ob->spa_username); | |
267 | if (username == NULL) | |
268 | { | |
b1206957 | 269 | if (expand_string_forcedfail) return CANCELLED; |
0756eb3c PH |
270 | string_format(buffer, buffsize, "expansion of \"%s\" failed in %s " |
271 | "authenticator: %s", ob->spa_username, ablock->name, | |
272 | expand_string_message); | |
273 | return ERROR; | |
274 | } | |
275 | ||
276 | password = CS expand_string(ob->spa_password); | |
277 | if (password == NULL) | |
278 | { | |
b1206957 | 279 | if (expand_string_forcedfail) return CANCELLED; |
0756eb3c PH |
280 | string_format(buffer, buffsize, "expansion of \"%s\" failed in %s " |
281 | "authenticator: %s", ob->spa_password, ablock->name, | |
282 | expand_string_message); | |
283 | return ERROR; | |
284 | } | |
285 | ||
286 | if (ob->spa_domain != NULL) | |
287 | { | |
288 | domain = CS expand_string(ob->spa_domain); | |
289 | if (domain == NULL) | |
290 | { | |
b1206957 | 291 | if (expand_string_forcedfail) return CANCELLED; |
0756eb3c PH |
292 | string_format(buffer, buffsize, "expansion of \"%s\" failed in %s " |
293 | "authenticator: %s", ob->spa_domain, ablock->name, | |
294 | expand_string_message); | |
295 | return ERROR; | |
296 | } | |
297 | } | |
298 | ||
299 | /* Original code */ | |
300 | ||
b1206957 PH |
301 | if (smtp_write_command(outblock, FALSE, "AUTH %s\r\n", |
302 | ablock->public_name) < 0) | |
303 | return FAIL_SEND; | |
304 | ||
305 | /* wait for the 3XX OK message */ | |
306 | if (!smtp_read_response(inblock, (uschar *)buffer, buffsize, '3', timeout)) | |
307 | return FAIL; | |
308 | ||
0756eb3c PH |
309 | DSPA("\n\n%s authenticator: using domain %s\n\n", |
310 | ablock->name, domain); | |
311 | ||
312 | spa_build_auth_request (&request, CS username, domain); | |
313 | spa_bits_to_base64 (US msgbuf, (unsigned char*)&request, | |
314 | spa_request_length(&request)); | |
315 | ||
316 | DSPA("\n\n%s authenticator: sending request (%s)\n\n", ablock->name, | |
317 | msgbuf); | |
318 | ||
319 | /* send the encrypted password */ | |
320 | if (smtp_write_command(outblock, FALSE, "%s\r\n", msgbuf) < 0) | |
321 | return FAIL_SEND; | |
322 | ||
323 | /* wait for the auth challenge */ | |
324 | if (!smtp_read_response(inblock, (uschar *)buffer, buffsize, '3', timeout)) | |
325 | return FAIL; | |
326 | ||
327 | /* convert the challenge into the challenge struct */ | |
328 | DSPA("\n\n%s authenticator: challenge (%s)\n\n", | |
329 | ablock->name, buffer + 4); | |
85b87bc2 | 330 | spa_base64_to_bits ((char *)(&challenge), sizeof(challenge), (const char *)(buffer + 4)); |
0756eb3c PH |
331 | |
332 | spa_build_auth_response (&challenge, &response, | |
333 | CS username, CS password); | |
334 | spa_bits_to_base64 (US msgbuf, (unsigned char*)&response, | |
335 | spa_request_length(&response)); | |
336 | DSPA("\n\n%s authenticator: challenge response (%s)\n\n", ablock->name, | |
337 | msgbuf); | |
338 | ||
339 | /* send the challenge response */ | |
340 | if (smtp_write_command(outblock, FALSE, "%s\r\n", msgbuf) < 0) | |
341 | return FAIL_SEND; | |
342 | ||
343 | /* If we receive a success response from the server, authentication | |
344 | has succeeded. There may be more data to send, but is there any point | |
345 | in provoking an error here? */ | |
346 | if (smtp_read_response(inblock, US buffer, buffsize, '2', timeout)) | |
347 | return OK; | |
348 | ||
349 | /* Not a success response. If errno != 0 there is some kind of transmission | |
350 | error. Otherwise, check the response code in the buffer. If it starts with | |
351 | '3', more data is expected. */ | |
352 | if (errno != 0 || buffer[0] != '3') | |
353 | return FAIL; | |
354 | ||
355 | return FAIL; | |
356 | } | |
357 | ||
358 | /* End of spa.c */ |