pylibsmb: clang-format for the calls to Py_BuildValue()
[Samba.git] / auth / kerberos / kerberos_pac.c
blobb6272ac15eb4842d4e99dd10c68e34b562cb9236
1 /*
2 Unix SMB/CIFS implementation.
3 kerberos authorization data (PAC) utility library
4 Copyright (C) Jim McDonough <jmcd@us.ibm.com> 2003
5 Copyright (C) Andrew Bartlett <abartlet@samba.org> 2004-2005
6 Copyright (C) Andrew Tridgell 2001
7 Copyright (C) Luke Howard 2002-2003
8 Copyright (C) Stefan Metzmacher 2004-2005
9 Copyright (C) Guenther Deschner 2005,2007,2008
11 This program is free software; you can redistribute it and/or modify
12 it under the terms of the GNU General Public License as published by
13 the Free Software Foundation; either version 3 of the License, or
14 (at your option) any later version.
16 This program is distributed in the hope that it will be useful,
17 but WITHOUT ANY WARRANTY; without even the implied warranty of
18 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 GNU General Public License for more details.
21 You should have received a copy of the GNU General Public License
22 along with this program. If not, see <http://www.gnu.org/licenses/>.
25 #include "includes.h"
27 #undef DBGC_CLASS
28 #define DBGC_CLASS DBGC_AUTH
30 #ifdef HAVE_KRB5
32 #include "librpc/gen_ndr/ndr_krb5pac.h"
33 #include "librpc/gen_ndr/auth.h"
34 #include "auth/common_auth.h"
35 #include "auth/kerberos/pac_utils.h"
36 #include "lib/krb5_wrap/krb5_samba.h"
38 krb5_error_code check_pac_checksum(DATA_BLOB pac_data,
39 struct PAC_SIGNATURE_DATA *sig,
40 krb5_context context,
41 const krb5_keyblock *keyblock)
43 krb5_error_code ret;
44 krb5_checksum cksum;
45 krb5_keyusage usage = 0;
46 krb5_boolean checksum_valid = false;
47 krb5_data input;
48 size_t idx = 0;
49 struct {
50 krb5_cksumtype cksum_type;
51 krb5_enctype enc_type;
52 } supported_types[] = {
53 {CKSUMTYPE_HMAC_SHA1_96_AES_256, ENCTYPE_AES256_CTS_HMAC_SHA1_96},
54 {CKSUMTYPE_HMAC_SHA1_96_AES_128, ENCTYPE_AES128_CTS_HMAC_SHA1_96},
55 /* RFC8009 types. Not supported by AD yet but used by FreeIPA and MIT Kerberos */
56 {CKSUMTYPE_HMAC_SHA256_128_AES128, ENCTYPE_AES128_CTS_HMAC_SHA256_128},
57 {CKSUMTYPE_HMAC_SHA384_192_AES256, ENCTYPE_AES256_CTS_HMAC_SHA384_192},
58 {0, 0},
61 for(idx = 0; supported_types[idx].cksum_type != 0; idx++) {
62 if (sig->type == supported_types[idx].cksum_type) {
63 if (KRB5_KEY_TYPE(keyblock) != supported_types[idx].enc_type) {
64 return EINVAL;
66 /* ok */
67 break;
71 /* do not do key type check for HMAC-MD5 */
72 if ((sig->type != CKSUMTYPE_HMAC_MD5) &&
73 (supported_types[idx].cksum_type == 0)) {
74 DEBUG(2,("check_pac_checksum: Checksum Type %d is not supported\n",
75 (int)sig->type));
76 return EINVAL;
79 #ifdef HAVE_CHECKSUM_IN_KRB5_CHECKSUM /* Heimdal */
80 cksum.cksumtype = (krb5_cksumtype)sig->type;
81 cksum.checksum.length = sig->signature.length;
82 cksum.checksum.data = sig->signature.data;
83 #else /* MIT */
84 cksum.checksum_type = (krb5_cksumtype)sig->type;
85 cksum.length = sig->signature.length;
86 cksum.contents = sig->signature.data;
87 #endif
89 #ifdef HAVE_KRB5_KU_OTHER_CKSUM /* Heimdal */
90 usage = KRB5_KU_OTHER_CKSUM;
91 #elif defined(HAVE_KRB5_KEYUSAGE_APP_DATA_CKSUM) /* MIT */
92 usage = KRB5_KEYUSAGE_APP_DATA_CKSUM;
93 #else
94 #error UNKNOWN_KRB5_KEYUSAGE
95 #endif
97 input.data = (char *)pac_data.data;
98 input.length = pac_data.length;
100 ret = krb5_c_verify_checksum(context,
101 keyblock,
102 usage,
103 &input,
104 &cksum,
105 &checksum_valid);
106 if (!checksum_valid) {
107 ret = KRB5KRB_AP_ERR_BAD_INTEGRITY;
109 if (ret){
110 DEBUG(2,("check_pac_checksum: PAC Verification failed: %s (%d)\n",
111 error_message(ret), ret));
112 return ret;
115 return ret;
119 * @brief Decode a blob containing a NDR encoded PAC structure
121 * @param mem_ctx - The memory context
122 * @param pac_data_blob - The data blob containing the NDR encoded data
123 * @param context - The Kerberos Context
124 * @param service_keyblock - The Service Key used to verify the checksum
125 * @param client_principal - The client principal
126 * @param tgs_authtime - The ticket timestamp
127 * @param pac_data_out - [out] The decoded PAC
129 * @return - A NTSTATUS error code
131 NTSTATUS kerberos_decode_pac(TALLOC_CTX *mem_ctx,
132 DATA_BLOB pac_data_blob,
133 krb5_context context,
134 const krb5_keyblock *krbtgt_keyblock,
135 const krb5_keyblock *service_keyblock,
136 krb5_const_principal client_principal,
137 time_t tgs_authtime,
138 struct PAC_DATA **pac_data_out)
140 NTSTATUS status;
141 enum ndr_err_code ndr_err;
142 krb5_error_code ret;
143 DATA_BLOB modified_pac_blob;
145 NTTIME tgs_authtime_nttime;
146 int i;
148 struct PAC_SIGNATURE_DATA *srv_sig_ptr = NULL;
149 struct PAC_SIGNATURE_DATA *kdc_sig_ptr = NULL;
150 struct PAC_SIGNATURE_DATA *srv_sig_wipe = NULL;
151 struct PAC_SIGNATURE_DATA *kdc_sig_wipe = NULL;
152 struct PAC_LOGON_NAME *logon_name = NULL;
153 struct PAC_LOGON_INFO *logon_info = NULL;
154 struct PAC_DATA *pac_data = NULL;
155 struct PAC_DATA_RAW *pac_data_raw = NULL;
157 DATA_BLOB *srv_sig_blob = NULL;
158 DATA_BLOB *kdc_sig_blob = NULL;
160 bool bool_ret;
162 TALLOC_CTX *tmp_ctx = talloc_new(mem_ctx);
163 if (!tmp_ctx) {
164 return NT_STATUS_NO_MEMORY;
167 if (pac_data_out) {
168 *pac_data_out = NULL;
171 pac_data = talloc(tmp_ctx, struct PAC_DATA);
172 pac_data_raw = talloc(tmp_ctx, struct PAC_DATA_RAW);
173 kdc_sig_wipe = talloc(tmp_ctx, struct PAC_SIGNATURE_DATA);
174 srv_sig_wipe = talloc(tmp_ctx, struct PAC_SIGNATURE_DATA);
175 if (!pac_data_raw || !pac_data || !kdc_sig_wipe || !srv_sig_wipe) {
176 talloc_free(tmp_ctx);
177 return NT_STATUS_NO_MEMORY;
180 ndr_err = ndr_pull_struct_blob(&pac_data_blob, pac_data, pac_data,
181 (ndr_pull_flags_fn_t)ndr_pull_PAC_DATA);
182 if (!NDR_ERR_CODE_IS_SUCCESS(ndr_err)) {
183 status = ndr_map_error2ntstatus(ndr_err);
184 DEBUG(0,("can't parse the PAC: %s\n",
185 nt_errstr(status)));
186 talloc_free(tmp_ctx);
187 return status;
190 if (pac_data->num_buffers < 4) {
191 /* we need logon_info, service_key and kdc_key */
192 DEBUG(0,("less than 4 PAC buffers\n"));
193 talloc_free(tmp_ctx);
194 return NT_STATUS_INVALID_PARAMETER;
197 ndr_err = ndr_pull_struct_blob(
198 &pac_data_blob, pac_data_raw, pac_data_raw,
199 (ndr_pull_flags_fn_t)ndr_pull_PAC_DATA_RAW);
200 if (!NDR_ERR_CODE_IS_SUCCESS(ndr_err)) {
201 status = ndr_map_error2ntstatus(ndr_err);
202 DEBUG(0,("can't parse the PAC: %s\n",
203 nt_errstr(status)));
204 talloc_free(tmp_ctx);
205 return status;
208 if (pac_data_raw->num_buffers < 4) {
209 /* we need logon_info, service_key and kdc_key */
210 DEBUG(0,("less than 4 PAC buffers\n"));
211 talloc_free(tmp_ctx);
212 return NT_STATUS_INVALID_PARAMETER;
215 if (pac_data->num_buffers != pac_data_raw->num_buffers) {
216 /* we need logon_info, service_key and kdc_key */
217 DEBUG(0, ("misparse! PAC_DATA has %d buffers while "
218 "PAC_DATA_RAW has %d\n", pac_data->num_buffers,
219 pac_data_raw->num_buffers));
220 talloc_free(tmp_ctx);
221 return NT_STATUS_INVALID_PARAMETER;
224 for (i=0; i < pac_data->num_buffers; i++) {
225 struct PAC_BUFFER *data_buf = &pac_data->buffers[i];
226 struct PAC_BUFFER_RAW *raw_buf = &pac_data_raw->buffers[i];
228 if (data_buf->type != raw_buf->type) {
229 DEBUG(0, ("misparse! PAC_DATA buffer %d has type "
230 "%d while PAC_DATA_RAW has %d\n", i,
231 data_buf->type, raw_buf->type));
232 talloc_free(tmp_ctx);
233 return NT_STATUS_INVALID_PARAMETER;
235 switch (data_buf->type) {
236 case PAC_TYPE_LOGON_INFO:
237 if (!data_buf->info) {
238 break;
240 logon_info = data_buf->info->logon_info.info;
241 break;
242 case PAC_TYPE_SRV_CHECKSUM:
243 if (!data_buf->info) {
244 break;
246 srv_sig_ptr = &data_buf->info->srv_cksum;
247 srv_sig_blob = &raw_buf->info->remaining;
248 break;
249 case PAC_TYPE_KDC_CHECKSUM:
250 if (!data_buf->info) {
251 break;
253 kdc_sig_ptr = &data_buf->info->kdc_cksum;
254 kdc_sig_blob = &raw_buf->info->remaining;
255 break;
256 case PAC_TYPE_LOGON_NAME:
257 logon_name = &data_buf->info->logon_name;
258 break;
259 default:
260 break;
264 if (!logon_info) {
265 DEBUG(0,("PAC no logon_info\n"));
266 talloc_free(tmp_ctx);
267 return NT_STATUS_INVALID_PARAMETER;
270 if (!logon_name) {
271 DEBUG(0,("PAC no logon_name\n"));
272 talloc_free(tmp_ctx);
273 return NT_STATUS_INVALID_PARAMETER;
276 if (!srv_sig_ptr || !srv_sig_blob) {
277 DEBUG(0,("PAC no srv_key\n"));
278 talloc_free(tmp_ctx);
279 return NT_STATUS_INVALID_PARAMETER;
282 if (!kdc_sig_ptr || !kdc_sig_blob) {
283 DEBUG(0,("PAC no kdc_key\n"));
284 talloc_free(tmp_ctx);
285 return NT_STATUS_INVALID_PARAMETER;
288 /* Find and zero out the signatures,
289 * as required by the signing algorithm */
291 /* We find the data blobs above,
292 * now we parse them to get at the exact portion we should zero */
293 ndr_err = ndr_pull_struct_blob(
294 kdc_sig_blob, kdc_sig_wipe, kdc_sig_wipe,
295 (ndr_pull_flags_fn_t)ndr_pull_PAC_SIGNATURE_DATA);
296 if (!NDR_ERR_CODE_IS_SUCCESS(ndr_err)) {
297 status = ndr_map_error2ntstatus(ndr_err);
298 DEBUG(0,("can't parse the KDC signature: %s\n",
299 nt_errstr(status)));
300 talloc_free(tmp_ctx);
301 return status;
304 ndr_err = ndr_pull_struct_blob(
305 srv_sig_blob, srv_sig_wipe, srv_sig_wipe,
306 (ndr_pull_flags_fn_t)ndr_pull_PAC_SIGNATURE_DATA);
307 if (!NDR_ERR_CODE_IS_SUCCESS(ndr_err)) {
308 status = ndr_map_error2ntstatus(ndr_err);
309 DEBUG(0,("can't parse the SRV signature: %s\n",
310 nt_errstr(status)));
311 talloc_free(tmp_ctx);
312 return status;
315 /* Now zero the decoded structure */
316 memset(kdc_sig_wipe->signature.data,
317 '\0', kdc_sig_wipe->signature.length);
318 memset(srv_sig_wipe->signature.data,
319 '\0', srv_sig_wipe->signature.length);
321 /* and re-encode, back into the same place it came from */
322 ndr_err = ndr_push_struct_blob(
323 kdc_sig_blob, pac_data_raw, kdc_sig_wipe,
324 (ndr_push_flags_fn_t)ndr_push_PAC_SIGNATURE_DATA);
325 if (!NDR_ERR_CODE_IS_SUCCESS(ndr_err)) {
326 status = ndr_map_error2ntstatus(ndr_err);
327 DEBUG(0,("can't repack the KDC signature: %s\n",
328 nt_errstr(status)));
329 talloc_free(tmp_ctx);
330 return status;
332 ndr_err = ndr_push_struct_blob(
333 srv_sig_blob, pac_data_raw, srv_sig_wipe,
334 (ndr_push_flags_fn_t)ndr_push_PAC_SIGNATURE_DATA);
335 if (!NDR_ERR_CODE_IS_SUCCESS(ndr_err)) {
336 status = ndr_map_error2ntstatus(ndr_err);
337 DEBUG(0,("can't repack the SRV signature: %s\n",
338 nt_errstr(status)));
339 talloc_free(tmp_ctx);
340 return status;
343 /* push out the whole structure, but now with zero'ed signatures */
344 ndr_err = ndr_push_struct_blob(
345 &modified_pac_blob, pac_data_raw, pac_data_raw,
346 (ndr_push_flags_fn_t)ndr_push_PAC_DATA_RAW);
347 if (!NDR_ERR_CODE_IS_SUCCESS(ndr_err)) {
348 status = ndr_map_error2ntstatus(ndr_err);
349 DEBUG(0,("can't repack the RAW PAC: %s\n",
350 nt_errstr(status)));
351 talloc_free(tmp_ctx);
352 return status;
355 if (service_keyblock) {
356 /* verify by service_key */
357 ret = check_pac_checksum(modified_pac_blob, srv_sig_ptr,
358 context,
359 service_keyblock);
360 if (ret) {
361 DEBUG(5, ("PAC Decode: Failed to verify the service "
362 "signature: %s\n", error_message(ret)));
363 return NT_STATUS_ACCESS_DENIED;
366 if (krbtgt_keyblock) {
367 /* verify the service key checksum by krbtgt_key */
368 ret = check_pac_checksum(srv_sig_ptr->signature, kdc_sig_ptr,
369 context, krbtgt_keyblock);
370 if (ret) {
371 DEBUG(1, ("PAC Decode: Failed to verify the KDC signature: %s\n",
372 smb_get_krb5_error_message(context, ret, tmp_ctx)));
373 talloc_free(tmp_ctx);
374 return NT_STATUS_ACCESS_DENIED;
379 if (tgs_authtime) {
380 /* Convert to NT time, so as not to lose accuracy in comparison */
381 unix_to_nt_time(&tgs_authtime_nttime, tgs_authtime);
383 if (tgs_authtime_nttime != logon_name->logon_time) {
384 DEBUG(2, ("PAC Decode: "
385 "Logon time mismatch between ticket and PAC!\n"));
386 DEBUG(2, ("PAC Decode: PAC: %s\n",
387 nt_time_string(tmp_ctx, logon_name->logon_time)));
388 DEBUG(2, ("PAC Decode: Ticket: %s\n",
389 nt_time_string(tmp_ctx, tgs_authtime_nttime)));
390 talloc_free(tmp_ctx);
391 return NT_STATUS_ACCESS_DENIED;
395 if (client_principal) {
396 char *client_principal_string;
397 ret = krb5_unparse_name_flags(context, client_principal,
398 KRB5_PRINCIPAL_UNPARSE_NO_REALM|KRB5_PRINCIPAL_UNPARSE_DISPLAY,
399 &client_principal_string);
400 if (ret) {
401 DEBUG(2, ("Could not unparse name from ticket to match with name from PAC: [%s]:%s\n",
402 logon_name->account_name, error_message(ret)));
403 talloc_free(tmp_ctx);
404 return NT_STATUS_INVALID_PARAMETER;
407 bool_ret = strcmp(client_principal_string, logon_name->account_name) == 0;
409 if (!bool_ret) {
410 DEBUG(2, ("Name in PAC [%s] does not match principal name "
411 "in ticket [%s]\n",
412 logon_name->account_name,
413 client_principal_string));
414 SAFE_FREE(client_principal_string);
415 talloc_free(tmp_ctx);
416 return NT_STATUS_ACCESS_DENIED;
418 SAFE_FREE(client_principal_string);
422 DEBUG(3,("Found account name from PAC: %s [%s]\n",
423 logon_info->info3.base.account_name.string,
424 logon_info->info3.base.full_name.string));
426 DEBUG(10,("Successfully validated Kerberos PAC\n"));
428 if (DEBUGLEVEL >= 10) {
429 const char *s;
430 s = NDR_PRINT_STRUCT_STRING(tmp_ctx, PAC_DATA, pac_data);
431 if (s) {
432 DEBUGADD(10,("%s\n", s));
436 if (pac_data_out) {
437 *pac_data_out = talloc_steal(mem_ctx, pac_data);
440 return NT_STATUS_OK;
443 NTSTATUS kerberos_pac_logon_info(TALLOC_CTX *mem_ctx,
444 DATA_BLOB blob,
445 krb5_context context,
446 const krb5_keyblock *krbtgt_keyblock,
447 const krb5_keyblock *service_keyblock,
448 krb5_const_principal client_principal,
449 time_t tgs_authtime,
450 struct PAC_LOGON_INFO **logon_info)
452 NTSTATUS nt_status;
453 struct PAC_DATA *pac_data;
454 int i;
455 nt_status = kerberos_decode_pac(mem_ctx,
456 blob,
457 context,
458 krbtgt_keyblock,
459 service_keyblock,
460 client_principal,
461 tgs_authtime,
462 &pac_data);
463 if (!NT_STATUS_IS_OK(nt_status)) {
464 return nt_status;
467 *logon_info = NULL;
468 for (i=0; i < pac_data->num_buffers; i++) {
469 if (pac_data->buffers[i].type != PAC_TYPE_LOGON_INFO) {
470 continue;
472 *logon_info = pac_data->buffers[i].info->logon_info.info;
474 if (!*logon_info) {
475 return NT_STATUS_INVALID_PARAMETER;
477 return NT_STATUS_OK;
480 static NTSTATUS auth4_context_fetch_PAC_DATA_CTR(
481 struct auth4_context *auth_ctx,
482 TALLOC_CTX *mem_ctx,
483 struct smb_krb5_context *smb_krb5_context,
484 DATA_BLOB *pac_blob,
485 const char *princ_name,
486 const struct tsocket_address *remote_address,
487 uint32_t session_info_flags,
488 struct auth_session_info **session_info)
490 struct PAC_DATA_CTR *pac_data_ctr = NULL;
491 NTSTATUS status;
493 if (pac_blob == NULL) {
494 return NT_STATUS_NO_IMPERSONATION_TOKEN;
497 pac_data_ctr = talloc_zero(mem_ctx, struct PAC_DATA_CTR);
498 if (pac_data_ctr == NULL) {
499 status = NT_STATUS_NO_MEMORY;
500 goto fail;
503 status = kerberos_decode_pac(pac_data_ctr,
504 *pac_blob,
505 NULL,
506 NULL,
507 NULL,
508 NULL,
510 &pac_data_ctr->pac_data);
511 if (!NT_STATUS_IS_OK(status)) {
512 goto fail;
515 pac_data_ctr->pac_blob = data_blob_talloc(pac_data_ctr,
516 pac_blob->data,
517 pac_blob->length);
518 if (pac_data_ctr->pac_blob.length != pac_blob->length) {
519 status = NT_STATUS_NO_MEMORY;
520 goto fail;
523 *session_info = talloc_zero(mem_ctx, struct auth_session_info);
524 if (*session_info == NULL) {
525 status = NT_STATUS_NO_MEMORY;
526 goto fail;
529 TALLOC_FREE(auth_ctx->private_data);
530 auth_ctx->private_data = talloc_move(auth_ctx, &pac_data_ctr);
532 return NT_STATUS_OK;
534 fail:
535 TALLOC_FREE(pac_data_ctr);
537 return status;
540 struct auth4_context *auth4_context_for_PAC_DATA_CTR(TALLOC_CTX *mem_ctx)
542 struct auth4_context *auth_ctx = NULL;
544 auth_ctx = talloc_zero(mem_ctx, struct auth4_context);
545 if (auth_ctx == NULL) {
546 return NULL;
548 auth_ctx->generate_session_info_pac = auth4_context_fetch_PAC_DATA_CTR;
550 return auth_ctx;
553 struct PAC_DATA_CTR *auth4_context_get_PAC_DATA_CTR(struct auth4_context *auth_ctx,
554 TALLOC_CTX *mem_ctx)
556 struct PAC_DATA_CTR *p = NULL;
557 SMB_ASSERT(auth_ctx->generate_session_info_pac == auth4_context_fetch_PAC_DATA_CTR);
558 p = talloc_get_type_abort(auth_ctx->private_data, struct PAC_DATA_CTR);
559 auth_ctx->private_data = NULL;
560 return talloc_move(mem_ctx, &p);
563 #endif