summaryrefslogtreecommitdiff
path: root/source4/libcli/auth/spnego.c
blob: 59ccbc7ba7bed379b99df4c73530f173a4c4ab69 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
/* 
   Unix SMB/CIFS implementation.

   RFC2478 Compliant SPNEGO implementation
   
   Copyright (C) Jim McDonough <jmcd@us.ibm.com>      2003
   Copyright (C) Andrew Bartlett <abartlet@samba.org> 2004

   This program is free software; you can redistribute it and/or modify
   it under the terms of the GNU General Public License as published by
   the Free Software Foundation; either version 2 of the License, or
   (at your option) any later version.
   
   This program is distributed in the hope that it will be useful,
   but WITHOUT ANY WARRANTY; without even the implied warranty of
   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
   GNU General Public License for more details.

   
   You should have received a copy of the GNU General Public License
   along with this program; if not, write to the Free Software
   Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
*/

#include "includes.h"

#undef DBGC_CLASS
#define DBGC_CLASS DBGC_AUTH

enum spnego_state_position {
	SPNEGO_SERVER_START,
	SPNEGO_CLIENT_START,
	SPNEGO_CLIENT_SEND_MECHS,
	SPNEGO_TARG,
	SPNEGO_FALLBACK,
	SPNEGO_DONE
};

struct spnego_state {
	TALLOC_CTX *mem_ctx;
	uint_t ref_count;
	enum spnego_message_type expected_packet;
	enum spnego_message_type state_position;
	enum spnego_negResult result;
	struct gensec_security *sub_sec_security;
};

static NTSTATUS gensec_spnego_client_start(struct gensec_security *gensec_security)
{
	struct spnego_state *spnego_state;
	TALLOC_CTX *mem_ctx = talloc_init("gensec_spengo_client_start");
	if (!mem_ctx) {
		return NT_STATUS_NO_MEMORY;
	}
	spnego_state = talloc_p(mem_ctx, struct spnego_state);
		
	if (!spnego_state) {
		return NT_STATUS_NO_MEMORY;
	}

	spnego_state->expected_packet = SPNEGO_NEG_TOKEN_INIT;
	spnego_state->state_position = SPNEGO_CLIENT_START;
	spnego_state->result = SPNEGO_ACCEPT_INCOMPLETE;
	spnego_state->mem_ctx = mem_ctx;
	spnego_state->sub_sec_security = NULL;

	gensec_security->private_data = spnego_state;
	return NT_STATUS_OK;
}

/*
  wrappers for the spnego_*() functions
*/
static NTSTATUS gensec_spnego_unseal_packet(struct gensec_security *gensec_security, 
				     TALLOC_CTX *mem_ctx, 
				     uint8_t *data, size_t length, DATA_BLOB *sig)
{
	struct spnego_state *spnego_state = gensec_security->private_data;

	if (spnego_state->state_position != SPNEGO_DONE 
	    && spnego_state->state_position != SPNEGO_FALLBACK) {
		return NT_STATUS_INVALID_PARAMETER;
	}
	
	return gensec_unseal_packet(spnego_state->sub_sec_security, 
				    mem_ctx, data, length, sig); 
}

static NTSTATUS gensec_spnego_check_packet(struct gensec_security *gensec_security, 
				     TALLOC_CTX *mem_ctx, 
				     const uint8_t *data, size_t length, 
				     const DATA_BLOB *sig)
{
	struct spnego_state *spnego_state = gensec_security->private_data;

	return NT_STATUS_NOT_IMPLEMENTED;
	if (spnego_state->state_position != SPNEGO_DONE 
	    && spnego_state->state_position != SPNEGO_FALLBACK) {
		return NT_STATUS_INVALID_PARAMETER;
	}
	
	return gensec_check_packet(spnego_state->sub_sec_security, 
				mem_ctx, data, length, sig);
}

static NTSTATUS gensec_spnego_seal_packet(struct gensec_security *gensec_security, 
				    TALLOC_CTX *mem_ctx, 
				    uint8_t *data, size_t length, 
				    DATA_BLOB *sig)
{
	struct spnego_state *spnego_state = gensec_security->private_data;

	return NT_STATUS_NOT_IMPLEMENTED;
	if (spnego_state->state_position != SPNEGO_DONE 
	    && spnego_state->state_position != SPNEGO_FALLBACK) {
		return NT_STATUS_INVALID_PARAMETER;
	}
	
	return gensec_seal_packet(spnego_state->sub_sec_security, 
				  mem_ctx, data, length, sig);
}

static NTSTATUS gensec_spnego_sign_packet(struct gensec_security *gensec_security, 
				    TALLOC_CTX *mem_ctx, 
				    const uint8_t *data, size_t length, 
				    DATA_BLOB *sig)
{
	struct spnego_state *spnego_state = gensec_security->private_data;

	if (spnego_state->state_position != SPNEGO_DONE 
	    && spnego_state->state_position != SPNEGO_FALLBACK) {
		return NT_STATUS_INVALID_PARAMETER;
	}
	
	return gensec_sign_packet(spnego_state->sub_sec_security, 
				  mem_ctx, data, length, sig);
}

static NTSTATUS gensec_spnego_session_key(struct gensec_security *gensec_security, 
				    DATA_BLOB *session_key)
{
	struct spnego_state *spnego_state = gensec_security->private_data;
	if (spnego_state->state_position != SPNEGO_DONE 
	    && spnego_state->state_position != SPNEGO_FALLBACK) {
		return NT_STATUS_INVALID_PARAMETER;
	}
	
	return gensec_session_key(spnego_state->sub_sec_security, 
				  session_key);
}

/** Fallback to another GENSEC mechanism, based on magic strings 
 *
 * This is the 'fallback' case, where we don't get SPENGO, and have to
 * try all the other options (and hope they all have a magic string
 * they check)
*/

static NTSTATUS gensec_spengo_server_try_fallback(struct gensec_security *gensec_security, 
						  struct spnego_state *spnego_state,
						  TALLOC_CTX *out_mem_ctx, 
						  const DATA_BLOB in, DATA_BLOB *out) 
{
	int i;
	int num_ops;
	const struct gensec_security_ops **all_ops = gensec_security_all(&num_ops);
	for (i=0; i < num_ops; i++) {
		NTSTATUS nt_status;
		if (!all_ops[i]->oid) {
			continue;
		}
		nt_status = gensec_subcontext_start(gensec_security, 
						    &spnego_state->sub_sec_security);
		if (!NT_STATUS_IS_OK(nt_status)) {
			return nt_status;
		}
		/* select the sub context */
		nt_status = gensec_start_mech_by_oid(spnego_state->sub_sec_security,
						     all_ops[i]->oid);
		if (!NT_STATUS_IS_OK(nt_status)) {
			gensec_end(&spnego_state->sub_sec_security);
					continue;
		}
		nt_status = gensec_update(spnego_state->sub_sec_security,
							  out_mem_ctx, in, out);
		if (NT_STATUS_EQUAL(nt_status, NT_STATUS_MORE_PROCESSING_REQUIRED)) {
			spnego_state->state_position = SPNEGO_FALLBACK;
			return nt_status;
		}
		gensec_end(&spnego_state->sub_sec_security);
	}
	DEBUG(1, ("Failed to parse SPENGO request\n"));
	return NT_STATUS_INVALID_PARAMETER;
	
}

static NTSTATUS gensec_spnego_update(struct gensec_security *gensec_security, TALLOC_CTX *out_mem_ctx, 
			       const DATA_BLOB in, DATA_BLOB *out) 
{
	struct spnego_state *spnego_state = gensec_security->private_data;
	DATA_BLOB null_data_blob = data_blob(NULL, 0);
	DATA_BLOB unwrapped_out;
	struct spnego_data spnego_out;
	struct spnego_data spnego;

	ssize_t len;

	if (!out_mem_ctx) {
		out_mem_ctx = spnego_state->mem_ctx;
	}

	/* and switch into the state machine */

	switch (spnego_state->state_position) {
	case SPNEGO_FALLBACK:
		return gensec_update(spnego_state->sub_sec_security,
				     out_mem_ctx, in, out);
	case SPNEGO_SERVER_START:
	{
		if (in.length) {
			len = spnego_read_data(in, &spnego);
			if (len == -1) {
				return gensec_spengo_server_try_fallback(gensec_security, spnego_state, out_mem_ctx, in, out);
			} else {
				/* client sent NegTargetInit */
			}
		} else {
			/* server needs to send NegTargetInit */
		}
	}

	case SPNEGO_CLIENT_START:
	{
		/* The server offers a list of mechanisms */
		
		char **mechType;
		char *my_mechs[] = {NULL, NULL};
		int i;
		NTSTATUS nt_status;

		if (!in.length) {
			/* client to produce negTokenInit */
			return NT_STATUS_INVALID_PARAMETER;
		}
		
		len = spnego_read_data(in, &spnego);
		
		if (len == -1) {
			return NT_STATUS_INVALID_PARAMETER;
		}
		
		/* OK, so it's real SPNEGO, check the packet's the one we expect */
		if (spnego.type != spnego_state->expected_packet) {
			spnego_free_data(&spnego);
			DEBUG(1, ("Invalid SPENGO request: %d, expected %d\n", spnego.type, 
				  spnego_state->expected_packet));
			return NT_STATUS_INVALID_PARAMETER;
		}

		mechType = spnego.negTokenInit.mechTypes;
		for (i=0; mechType && mechType[i]; i++) {
			nt_status = gensec_client_start(&spnego_state->sub_sec_security);
			if (!NT_STATUS_IS_OK(nt_status)) {
				break;
			}
			/* forward the user info to the sub context */
			spnego_state->sub_sec_security->user = gensec_security->user;
			spnego_state->sub_sec_security->password_callback = gensec_security->password_callback;
			spnego_state->sub_sec_security->password_callback_private = gensec_security->password_callback_private;
			/* select the sub context */
			nt_status = gensec_start_mech_by_oid(spnego_state->sub_sec_security,
							     mechType[i]);
			if (!NT_STATUS_IS_OK(nt_status)) {
				gensec_end(&spnego_state->sub_sec_security);
				continue;
			}
			
			if (i == 0) {
				nt_status = gensec_update(spnego_state->sub_sec_security,
							  out_mem_ctx, 
							  spnego.negTokenInit.mechToken, 
							  &unwrapped_out);
			} else {
				/* only get the helping start blob for the first OID */
				nt_status = gensec_update(spnego_state->sub_sec_security,
							  out_mem_ctx, 
							  null_data_blob, 
							  &unwrapped_out);
			}
			if (!NT_STATUS_EQUAL(nt_status, NT_STATUS_MORE_PROCESSING_REQUIRED)) {
				DEBUG(1, ("SPENGO(%s) NEG_TOKEN_INIT failed: %s\n", 
					  spnego_state->sub_sec_security->ops->name, nt_errstr(nt_status)));
				gensec_end(&spnego_state->sub_sec_security);
			} else {
				break;
			}
		}
		if (!mechType || !mechType[i]) {
			DEBUG(1, ("SPENGO: Could not find a suitable mechtype in NEG_TOKEN_INIT\n"));
		}
		
		spnego_free_data(&spnego);
		if (!NT_STATUS_EQUAL(nt_status, NT_STATUS_MORE_PROCESSING_REQUIRED)) {
			return nt_status;
		}
		
		/* compose reply */
		my_mechs[0] = spnego_state->sub_sec_security->ops->oid;
		
		spnego_out.type = SPNEGO_NEG_TOKEN_INIT;
		spnego_out.negTokenInit.mechTypes = my_mechs;
		spnego_out.negTokenInit.reqFlags = 0;
		spnego_out.negTokenInit.mechListMIC = null_data_blob;
		spnego_out.negTokenInit.mechToken = unwrapped_out;
		
		if (spnego_write_data(out_mem_ctx, out, &spnego_out) == -1) {
			DEBUG(1, ("Failed to write SPENGO reply to NEG_TOKEN_INIT\n"));
				return NT_STATUS_INVALID_PARAMETER;
		}
		
		/* set next state */
		spnego_state->expected_packet = SPNEGO_NEG_TOKEN_TARG;
		spnego_state->state_position = SPNEGO_TARG;
		
		return nt_status;
	}
	case SPNEGO_TARG:
	{
		NTSTATUS nt_status;
		if (!in.length) {
			return NT_STATUS_INVALID_PARAMETER;
		}
		
		len = spnego_read_data(in, &spnego);
		
		if (len == -1) {
			return NT_STATUS_INVALID_PARAMETER;
		}
		
		/* OK, so it's real SPNEGO, check the packet's the one we expect */
		if (spnego.type != spnego_state->expected_packet) {
			spnego_free_data(&spnego);
			DEBUG(1, ("Invalid SPENGO request: %d, expected %d\n", spnego.type, 
				  spnego_state->expected_packet));
			return NT_STATUS_INVALID_PARAMETER;
		}
	
		if (spnego.negTokenTarg.negResult == SPNEGO_REJECT) {
			return NT_STATUS_ACCESS_DENIED;
		}
		
		if (spnego.negTokenTarg.responseToken.length) {
			nt_status = gensec_update(spnego_state->sub_sec_security,
						  out_mem_ctx, 
						  spnego.negTokenTarg.responseToken, 
						  &unwrapped_out);
		} else {
			unwrapped_out = data_blob(NULL, 0);
			nt_status = NT_STATUS_OK;
		}
		
		if (NT_STATUS_IS_OK(nt_status) 
		    && (spnego.negTokenTarg.negResult != SPNEGO_ACCEPT_COMPLETED)) {
			nt_status = NT_STATUS_INVALID_PARAMETER;
		}
		
		spnego_state->result = spnego.negTokenTarg.negResult;
		spnego_free_data(&spnego);
		
		if (NT_STATUS_EQUAL(nt_status, NT_STATUS_MORE_PROCESSING_REQUIRED)) {
			/* compose reply */
			spnego_out.type = SPNEGO_NEG_TOKEN_TARG;
			spnego_out.negTokenTarg.negResult = SPNEGO_ACCEPT_INCOMPLETE;
			spnego_out.negTokenTarg.supportedMech 
				= spnego_state->sub_sec_security->ops->oid;
			spnego_out.negTokenTarg.responseToken = unwrapped_out;
			spnego_out.negTokenTarg.mechListMIC = null_data_blob;
			
			if (spnego_write_data(out_mem_ctx, out, &spnego_out) == -1) {
				DEBUG(1, ("Failed to write SPENGO reply to NEG_TOKEN_TARG\n"));
				return NT_STATUS_INVALID_PARAMETER;
			}
			spnego_state->state_position = SPNEGO_TARG;
		} else if (NT_STATUS_IS_OK(nt_status)) {
			spnego_state->state_position = SPNEGO_DONE;
		} else {
			DEBUG(1, ("SPENGO(%s) login failed: %s\n", 
				  spnego_state->sub_sec_security->ops->name, 
				  nt_errstr(nt_status)));
			return nt_status;
		}
		
		return nt_status;
	}
	default:
		spnego_free_data(&spnego);
		DEBUG(1, ("Invalid SPENGO request: %d\n", spnego.type));
		return NT_STATUS_INVALID_PARAMETER;
	}
}

static void gensec_spnego_end(struct gensec_security *gensec_security)
{
	struct spnego_state *spnego_state = gensec_security->private_data;

	if (spnego_state->sub_sec_security) {
		gensec_end(&spnego_state->sub_sec_security);
	}

	talloc_destroy(spnego_state->mem_ctx);

	gensec_security->private_data = NULL;
}

static const struct gensec_security_ops gensec_spnego_security_ops = {
	.name		= "spnego",
	.sasl_name	= "GSS-SPNEGO",
	.auth_type	= DCERPC_AUTH_TYPE_SPNEGO,
	.oid            = OID_SPNEGO,
	.client_start   = gensec_spnego_client_start,
	.update 	= gensec_spnego_update,
	.seal_packet	= gensec_spnego_seal_packet,
	.sign_packet	= gensec_spnego_sign_packet,
	.check_packet	= gensec_spnego_check_packet,
	.unseal_packet	= gensec_spnego_unseal_packet,
	.session_key	= gensec_spnego_session_key,
	.end		= gensec_spnego_end
};

NTSTATUS gensec_spengo_init(void)
{
	NTSTATUS ret;
	ret = register_backend("gensec", &gensec_spnego_security_ops);
	if (!NT_STATUS_IS_OK(ret)) {
		DEBUG(0,("Failed to register '%s' gensec backend!\n",
			gensec_spnego_security_ops.name));
		return ret;
	}

	return ret;
}