1 /* -*- mode: c; c-basic-offset: 4; indent-tabs-mode: nil -*- */
3 * Copyright 2001, 2008 by the Massachusetts Institute of Technology.
4 * Copyright 1993 by OpenVision Technologies, Inc.
6 * Permission to use, copy, modify, distribute, and sell this software
7 * and its documentation for any purpose is hereby granted without fee,
8 * provided that the above copyright notice appears in all copies and
9 * that both that copyright notice and this permission notice appear in
10 * supporting documentation, and that the name of OpenVision not be used
11 * in advertising or publicity pertaining to distribution of the software
12 * without specific, written prior permission. OpenVision makes no
13 * representations about the suitability of this software for any
14 * purpose. It is provided "as is" without express or implied warranty.
16 * OPENVISION DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
17 * INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO
18 * EVENT SHALL OPENVISION BE LIABLE FOR ANY SPECIAL, INDIRECT OR
19 * CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF
20 * USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR
21 * OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
22 * PERFORMANCE OF THIS SOFTWARE.
26 * Copyright (C) 1998 by the FundsXpress, INC.
28 * All rights reserved.
30 * Export of this software from the United States of America may require
31 * a specific license from the United States Government. It is the
32 * responsibility of any person or organization contemplating export to
33 * obtain such a license before exporting.
35 * WITHIN THAT CONSTRAINT, permission to use, copy, modify, and
36 * distribute this software and its documentation for any purpose and
37 * without fee is hereby granted, provided that the above copyright
38 * notice appear in all copies and that both that copyright notice and
39 * this permission notice appear in supporting documentation, and that
40 * the name of FundsXpress. not be used in advertising or publicity pertaining
41 * to distribution of the software without specific, written prior
42 * permission. FundsXpress makes no representations about the suitability of
43 * this software for any purpose. It is provided "as is" without express
44 * or implied warranty.
46 * THIS SOFTWARE IS PROVIDED ``AS IS'' AND WITHOUT ANY EXPRESS OR
47 * IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED
48 * WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR A PARTICULAR PURPOSE.
52 #include "gssapiP_krb5.h"
57 static const char kg_arcfour_l40[] = "fortybits";
59 static krb5_error_code
60 kg_copy_keys(krb5_context context, krb5_gss_ctx_id_rec *ctx, krb5_key subkey)
64 krb5_k_free_key(context, ctx->enc);
66 code = krb5_k_create_key(context, &subkey->keyblock, &ctx->enc);
70 krb5_k_free_key(context, ctx->seq);
72 code = krb5_k_create_key(context, &subkey->keyblock, &ctx->seq);
79 static krb5_error_code
80 kg_derive_des_enc_key(krb5_context context, krb5_key subkey, krb5_key *out)
83 krb5_keyblock *keyblock;
88 code = krb5_k_key_keyblock(context, subkey, &keyblock);
92 for (i = 0; i < keyblock->length; i++)
93 keyblock->contents[i] ^= 0xF0;
95 code = krb5_k_create_key(context, keyblock, out);
96 krb5_free_keyblock(context, keyblock);
101 kg_setup_keys(krb5_context context, krb5_gss_ctx_id_rec *ctx, krb5_key subkey,
102 krb5_cksumtype *cksumtype)
104 krb5_error_code code;
107 assert(subkey != NULL);
112 if (ctx->enc == NULL) {
117 code = krb5int_c_mandatory_cksumtype(context, subkey->keyblock.enctype,
122 switch (subkey->keyblock.enctype) {
123 case ENCTYPE_DES_CBC_MD5:
124 case ENCTYPE_DES_CBC_MD4:
125 case ENCTYPE_DES_CBC_CRC:
126 krb5_k_free_key(context, ctx->seq);
127 code = krb5_k_create_key(context, &subkey->keyblock, &ctx->seq);
131 krb5_k_free_key(context, ctx->enc);
132 code = kg_derive_des_enc_key(context, subkey, &ctx->enc);
136 ctx->enc->keyblock.enctype = ENCTYPE_DES_CBC_RAW;
137 ctx->seq->keyblock.enctype = ENCTYPE_DES_CBC_RAW;
138 ctx->signalg = SGN_ALG_DES_MAC_MD5;
140 ctx->sealalg = SEAL_ALG_DES;
143 case ENCTYPE_DES3_CBC_SHA1:
144 code = kg_copy_keys(context, ctx, subkey);
148 ctx->enc->keyblock.enctype = ENCTYPE_DES3_CBC_RAW;
149 ctx->seq->keyblock.enctype = ENCTYPE_DES3_CBC_RAW;
150 ctx->signalg = SGN_ALG_HMAC_SHA1_DES3_KD;
151 ctx->cksum_size = 20;
152 ctx->sealalg = SEAL_ALG_DES3KD;
154 case ENCTYPE_ARCFOUR_HMAC:
155 case ENCTYPE_ARCFOUR_HMAC_EXP:
156 /* RFC 4121 accidentally omits RC4-HMAC-EXP as a "not-newer" enctype,
157 * even though RFC 4757 treats it as one. */
158 code = kg_copy_keys(context, ctx, subkey);
162 ctx->signalg = SGN_ALG_HMAC_MD5;
164 ctx->sealalg = SEAL_ALG_MICROSOFT_RC4;
175 kg_confounder_size(krb5_context context, krb5_enctype enctype)
177 krb5_error_code code;
179 /* We special case rc4*/
180 if (enctype == ENCTYPE_ARCFOUR_HMAC || enctype == ENCTYPE_ARCFOUR_HMAC_EXP)
182 code = krb5_c_block_size(context, enctype, &blocksize);
184 return(-1); /* XXX */
190 kg_make_confounder(krb5_context context, krb5_enctype enctype,
196 confsize = kg_confounder_size(context, enctype);
198 return KRB5_BAD_MSIZE;
200 lrandom.length = confsize;
201 lrandom.data = (char *)buf;
203 return(krb5_c_random_make_octets(context, &lrandom));
206 /* Set *data_out to a krb5_data structure containing iv, or to NULL if iv is
208 static krb5_error_code
209 iv_to_state(krb5_context context, krb5_key key, krb5_pointer iv,
210 krb5_data **data_out)
212 krb5_error_code code;
220 code = krb5_c_block_size(context, key->keyblock.enctype, &blocksize);
224 data = k5alloc(sizeof(*data), &code);
227 code = alloc_data(data, blocksize);
232 memcpy(data->data, iv, blocksize);
238 kg_encrypt(krb5_context context, krb5_key key, int usage, krb5_pointer iv,
239 krb5_const_pointer in, krb5_pointer out, unsigned int length)
241 krb5_error_code code;
242 krb5_data *state, inputd;
243 krb5_enc_data outputd;
245 code = iv_to_state(context, key, iv, &state);
249 inputd.length = length;
250 inputd.data = (char *)in;
252 outputd.ciphertext.length = length;
253 outputd.ciphertext.data = out;
255 code = krb5_k_encrypt(context, key, usage, state, &inputd, &outputd);
256 krb5_free_data(context, state);
261 kg_encrypt_inplace(krb5_context context, krb5_key key, int usage,
262 krb5_pointer iv, krb5_pointer ptr, unsigned int length)
264 krb5_error_code code;
268 code = iv_to_state(context, key, iv, &state);
272 iov.flags = KRB5_CRYPTO_TYPE_DATA;
273 iov.data = make_data((void *)ptr, length);
274 code = krb5_k_encrypt_iov(context, key, usage, state, &iov, 1);
275 krb5_free_data(context, state);
279 /* length is the length of the cleartext. */
282 kg_decrypt(krb5_context context, krb5_key key, int usage, krb5_pointer iv,
283 krb5_const_pointer in, krb5_pointer out, unsigned int length)
285 krb5_error_code code;
286 krb5_data *state, outputd;
287 krb5_enc_data inputd;
289 code = iv_to_state(context, key, iv, &state);
293 inputd.enctype = ENCTYPE_UNKNOWN;
294 inputd.ciphertext.length = length;
295 inputd.ciphertext.data = (char *)in;
297 outputd.length = length;
300 code = krb5_k_decrypt(context, key, usage, state, &inputd, &outputd);
301 krb5_free_data(context, state);
306 kg_arcfour_docrypt(const krb5_keyblock *keyblock, int usage,
307 const unsigned char *kd_data, size_t kd_data_len,
308 const unsigned char *input_buf, size_t input_len,
309 unsigned char *output_buf)
311 krb5_data kd = make_data((char *) kd_data, kd_data_len);
312 krb5_crypto_iov kiov;
314 memcpy(output_buf, input_buf, input_len);
315 kiov.flags = KRB5_CRYPTO_TYPE_DATA;
316 kiov.data = make_data(output_buf, input_len);
317 return krb5int_arcfour_gsscrypt(keyblock, usage, &kd, &kiov, 1);
321 static krb5_error_code
322 kg_translate_iov_v1(krb5_context context, krb5_enctype enctype,
323 gss_iov_buffer_desc *iov, int iov_count,
324 krb5_crypto_iov **pkiov, size_t *pkiov_count)
326 gss_iov_buffer_desc *header;
327 gss_iov_buffer_desc *trailer;
330 krb5_crypto_iov *kiov;
336 conf_len = kg_confounder_size(context, enctype);
338 header = kg_locate_iov(iov, iov_count, GSS_IOV_BUFFER_TYPE_HEADER);
339 assert(header != NULL);
341 if (header->buffer.length < conf_len)
342 return KRB5_BAD_MSIZE;
344 trailer = kg_locate_iov(iov, iov_count, GSS_IOV_BUFFER_TYPE_TRAILER);
345 assert(trailer == NULL || trailer->buffer.length == 0);
347 kiov_count = 3 + iov_count;
348 kiov = (krb5_crypto_iov *)malloc(kiov_count * sizeof(krb5_crypto_iov));
352 /* For pre-CFX (raw enctypes) there is no krb5 header */
353 kiov[i].flags = KRB5_CRYPTO_TYPE_HEADER;
354 kiov[i].data.length = 0;
355 kiov[i].data.data = NULL;
358 /* For pre-CFX, the confounder is at the end of the GSS header */
359 kiov[i].flags = KRB5_CRYPTO_TYPE_DATA;
360 kiov[i].data.length = conf_len;
361 kiov[i].data.data = (char *)header->buffer.value + header->buffer.length - conf_len;
364 for (j = 0; j < iov_count; j++) {
365 kiov[i].flags = kg_translate_flag_iov(iov[j].type);
366 if (kiov[i].flags == KRB5_CRYPTO_TYPE_EMPTY)
369 kiov[i].data.length = iov[j].buffer.length;
370 kiov[i].data.data = (char *)iov[j].buffer.value;
374 kiov[i].flags = KRB5_CRYPTO_TYPE_TRAILER;
375 kiov[i].data.length = 0;
376 kiov[i].data.data = NULL;
386 * DCE_STYLE indicates actual RRC is EC + RRC
387 * EC is extra rotate count for DCE_STYLE, pad length otherwise
388 * RRC is rotate count.
390 static krb5_error_code
391 kg_translate_iov_v3(krb5_context context, int dce_style, size_t ec, size_t rrc,
392 krb5_enctype enctype, gss_iov_buffer_desc *iov,
393 int iov_count, krb5_crypto_iov **pkiov,
396 gss_iov_buffer_t header;
397 gss_iov_buffer_t trailer;
400 krb5_crypto_iov *kiov;
401 unsigned int k5_headerlen = 0, k5_trailerlen = 0;
402 size_t gss_headerlen, gss_trailerlen;
403 krb5_error_code code;
408 header = kg_locate_iov(iov, iov_count, GSS_IOV_BUFFER_TYPE_HEADER);
409 assert(header != NULL);
411 trailer = kg_locate_iov(iov, iov_count, GSS_IOV_BUFFER_TYPE_TRAILER);
412 assert(trailer == NULL || rrc == 0);
414 code = krb5_c_crypto_length(context, enctype, KRB5_CRYPTO_TYPE_HEADER,
419 code = krb5_c_crypto_length(context, enctype, KRB5_CRYPTO_TYPE_TRAILER,
424 /* Check header and trailer sizes */
425 gss_headerlen = 16 /* GSS-Header */ + k5_headerlen; /* Kerb-Header */
426 gss_trailerlen = ec + 16 /* E(GSS-Header) */ + k5_trailerlen; /* Kerb-Trailer */
428 /* If we're caller without a trailer, we must rotate by trailer length */
429 if (trailer == NULL) {
430 size_t actual_rrc = rrc;
433 actual_rrc += ec; /* compensate for Windows bug */
435 if (actual_rrc != gss_trailerlen)
436 return KRB5_BAD_MSIZE;
438 gss_headerlen += gss_trailerlen;
441 if (trailer->buffer.length != gss_trailerlen)
442 return KRB5_BAD_MSIZE;
445 if (header->buffer.length != gss_headerlen)
446 return KRB5_BAD_MSIZE;
448 kiov_count = 3 + iov_count;
449 kiov = (krb5_crypto_iov *)malloc(kiov_count * sizeof(krb5_crypto_iov));
454 * The krb5 header is located at the end of the GSS header.
456 kiov[i].flags = KRB5_CRYPTO_TYPE_HEADER;
457 kiov[i].data.length = k5_headerlen;
458 kiov[i].data.data = (char *)header->buffer.value + header->buffer.length - k5_headerlen;
461 for (j = 0; j < iov_count; j++) {
462 kiov[i].flags = kg_translate_flag_iov(iov[j].type);
463 if (kiov[i].flags == KRB5_CRYPTO_TYPE_EMPTY)
466 kiov[i].data.length = iov[j].buffer.length;
467 kiov[i].data.data = (char *)iov[j].buffer.value;
472 * The EC and encrypted GSS header are placed in the trailer, which may
473 * be rotated directly after the plaintext header if no trailer buffer
476 kiov[i].flags = KRB5_CRYPTO_TYPE_DATA;
477 kiov[i].data.length = ec + 16; /* E(Header) */
479 kiov[i].data.data = (char *)header->buffer.value + 16;
481 kiov[i].data.data = (char *)trailer->buffer.value;
485 * The krb5 trailer is placed after the encrypted copy of the
486 * krb5 header (which may be in the GSS header or trailer).
488 kiov[i].flags = KRB5_CRYPTO_TYPE_TRAILER;
489 kiov[i].data.length = k5_trailerlen;
490 kiov[i].data.data = kiov[i - 1].data.data + ec + 16; /* E(Header) */
499 /* PROTO is 1 if CFX, 0 if pre-CFX */
500 static krb5_error_code
501 kg_translate_iov(krb5_context context, int proto, int dce_style, size_t ec,
502 size_t rrc, krb5_enctype enctype, gss_iov_buffer_desc *iov,
503 int iov_count, krb5_crypto_iov **pkiov, size_t *pkiov_count)
506 kg_translate_iov_v3(context, dce_style, ec, rrc, enctype,
507 iov, iov_count, pkiov, pkiov_count) :
508 kg_translate_iov_v1(context, enctype, iov, iov_count,
513 kg_encrypt_iov(krb5_context context, int proto, int dce_style, size_t ec,
514 size_t rrc, krb5_key key, int usage, krb5_pointer iv,
515 gss_iov_buffer_desc *iov, int iov_count)
517 krb5_error_code code;
520 krb5_crypto_iov *kiov;
522 code = iv_to_state(context, key, iv, &state);
526 code = kg_translate_iov(context, proto, dce_style, ec, rrc,
527 key->keyblock.enctype, iov, iov_count,
530 code = krb5_k_encrypt_iov(context, key, usage, state, kiov, kiov_len);
534 krb5_free_data(context, state);
538 /* length is the length of the cleartext. */
541 kg_decrypt_iov(krb5_context context, int proto, int dce_style, size_t ec,
542 size_t rrc, krb5_key key, int usage, krb5_pointer iv,
543 gss_iov_buffer_desc *iov, int iov_count)
545 krb5_error_code code;
548 krb5_crypto_iov *kiov;
550 code = iv_to_state(context, key, iv, &state);
554 code = kg_translate_iov(context, proto, dce_style, ec, rrc,
555 key->keyblock.enctype, iov, iov_count,
558 code = krb5_k_decrypt_iov(context, key, usage, state, kiov, kiov_len);
562 krb5_free_data(context, state);
567 kg_arcfour_docrypt_iov(krb5_context context, const krb5_keyblock *keyblock,
568 int usage, const unsigned char *kd_data,
569 size_t kd_data_len, gss_iov_buffer_desc *iov,
572 krb5_error_code code;
573 krb5_data kd = make_data((char *) kd_data, kd_data_len);
574 krb5_crypto_iov *kiov = NULL;
577 code = kg_translate_iov(context, 0 /* proto */, 0 /* dce_style */,
578 0 /* ec */, 0 /* rrc */, keyblock->enctype,
579 iov, iov_count, &kiov, &kiov_len);
582 code = krb5int_arcfour_gsscrypt(keyblock, usage, &kd, kiov, kiov_len);
588 kg_translate_flag_iov(OM_uint32 type)
590 krb5_cryptotype ktype;
592 switch (GSS_IOV_BUFFER_TYPE(type)) {
593 case GSS_IOV_BUFFER_TYPE_DATA:
594 case GSS_IOV_BUFFER_TYPE_PADDING:
595 ktype = KRB5_CRYPTO_TYPE_DATA;
597 case GSS_IOV_BUFFER_TYPE_SIGN_ONLY:
598 ktype = KRB5_CRYPTO_TYPE_SIGN_ONLY;
601 ktype = KRB5_CRYPTO_TYPE_EMPTY;
609 kg_locate_iov(gss_iov_buffer_desc *iov, int iov_count, OM_uint32 type)
612 gss_iov_buffer_t p = GSS_C_NO_IOV_BUFFER;
614 if (iov == GSS_C_NO_IOV_BUFFER)
615 return GSS_C_NO_IOV_BUFFER;
617 for (i = iov_count - 1; i >= 0; i--) {
618 if (GSS_IOV_BUFFER_TYPE(iov[i].type) == type) {
619 if (p == GSS_C_NO_IOV_BUFFER)
622 return GSS_C_NO_IOV_BUFFER;
630 kg_iov_msglen(gss_iov_buffer_desc *iov, int iov_count, size_t *data_length_p,
631 size_t *assoc_data_length_p)
634 size_t data_length = 0, assoc_data_length = 0;
636 assert(iov != GSS_C_NO_IOV_BUFFER);
638 *data_length_p = *assoc_data_length_p = 0;
640 for (i = 0; i < iov_count; i++) {
641 OM_uint32 type = GSS_IOV_BUFFER_TYPE(iov[i].type);
643 if (type == GSS_IOV_BUFFER_TYPE_SIGN_ONLY)
644 assoc_data_length += iov[i].buffer.length;
646 if (type == GSS_IOV_BUFFER_TYPE_DATA ||
647 type == GSS_IOV_BUFFER_TYPE_SIGN_ONLY)
648 data_length += iov[i].buffer.length;
651 *data_length_p = data_length;
652 *assoc_data_length_p = assoc_data_length;
656 kg_release_iov(gss_iov_buffer_desc *iov, int iov_count)
660 assert(iov != GSS_C_NO_IOV_BUFFER);
662 for (i = 0; i < iov_count; i++) {
663 if (iov[i].type & GSS_IOV_BUFFER_FLAG_ALLOCATED) {
664 gssalloc_free(iov[i].buffer.value);
665 iov[i].buffer.length = 0;
666 iov[i].buffer.value = NULL;
667 iov[i].type &= ~(GSS_IOV_BUFFER_FLAG_ALLOCATED);
673 kg_fixup_padding_iov(OM_uint32 *minor_status, gss_iov_buffer_desc *iov,
676 gss_iov_buffer_t padding = NULL;
677 gss_iov_buffer_t data = NULL;
678 size_t padlength, relative_padlength;
681 data = kg_locate_iov(iov, iov_count, GSS_IOV_BUFFER_TYPE_DATA);
682 padding = kg_locate_iov(iov, iov_count, GSS_IOV_BUFFER_TYPE_PADDING);
686 return GSS_S_COMPLETE;
689 if (padding == NULL || padding->buffer.length == 0) {
690 *minor_status = EINVAL;
691 return GSS_S_FAILURE;
694 p = (unsigned char *)padding->buffer.value;
695 padlength = p[padding->buffer.length - 1];
697 if (data->buffer.length + padding->buffer.length < padlength ||
699 *minor_status = (OM_uint32)KRB5_BAD_MSIZE;
700 return GSS_S_DEFECTIVE_TOKEN;
704 * kg_unseal_stream_iov() will place one byte of padding in the
705 * padding buffer; its true value is unknown until after decryption.
707 * relative_padlength contains the number of bytes to compensate the
708 * padding and data buffers by; it will be zero if the caller manages
709 * the padding length.
711 * If the caller manages the padding length, then relative_padlength
714 * eg. if the buffers are structured as follows:
720 * after compensation they would look like:
726 relative_padlength = padlength - padding->buffer.length;
728 assert(data->buffer.length >= relative_padlength);
730 data->buffer.length -= relative_padlength;
732 kg_release_iov(padding, 1);
733 padding->buffer.length = 0;
734 padding->buffer.value = NULL;
736 return GSS_S_COMPLETE;
740 kg_integ_only_iov(gss_iov_buffer_desc *iov, int iov_count)
743 krb5_boolean has_conf_data = FALSE;
745 assert(iov != GSS_C_NO_IOV_BUFFER);
747 for (i = 0; i < iov_count; i++) {
748 if (GSS_IOV_BUFFER_TYPE(iov[i].type) == GSS_IOV_BUFFER_TYPE_DATA) {
749 has_conf_data = TRUE;
754 return (has_conf_data == FALSE);
758 kg_allocate_iov(gss_iov_buffer_t iov, size_t size)
760 assert(iov != GSS_C_NO_IOV_BUFFER);
761 assert(iov->type & GSS_IOV_BUFFER_FLAG_ALLOCATE);
763 iov->buffer.length = size;
764 iov->buffer.value = gssalloc_malloc(size);
765 if (iov->buffer.value == NULL) {
766 iov->buffer.length = 0;
770 iov->type |= GSS_IOV_BUFFER_FLAG_ALLOCATED;