2 * linux/net/sunrpc/gss_krb5_mech.c
4 * Copyright (c) 2001-2008 The Regents of the University of Michigan.
7 * Andy Adamson <andros@umich.edu>
8 * J. Bruce Fields <bfields@umich.edu>
10 * Redistribution and use in source and binary forms, with or without
11 * modification, are permitted provided that the following conditions
14 * 1. Redistributions of source code must retain the above copyright
15 * notice, this list of conditions and the following disclaimer.
16 * 2. Redistributions in binary form must reproduce the above copyright
17 * notice, this list of conditions and the following disclaimer in the
18 * documentation and/or other materials provided with the distribution.
19 * 3. Neither the name of the University nor the names of its
20 * contributors may be used to endorse or promote products derived
21 * from this software without specific prior written permission.
23 * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESS OR IMPLIED
24 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
25 * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
26 * DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
27 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
28 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
29 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR
30 * BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
31 * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
32 * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
33 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
37 #include <linux/err.h>
38 #include <linux/module.h>
39 #include <linux/init.h>
40 #include <linux/types.h>
41 #include <linux/slab.h>
42 #include <linux/sunrpc/auth.h>
43 #include <linux/sunrpc/gss_krb5.h>
44 #include <linux/sunrpc/xdr.h>
45 #include <linux/crypto.h>
46 #include <linux/sunrpc/gss_krb5_enctypes.h>
48 #include "auth_gss_internal.h"
50 #if IS_ENABLED(CONFIG_SUNRPC_DEBUG)
51 # define RPCDBG_FACILITY RPCDBG_AUTH
54 static struct gss_api_mech gss_kerberos_mech; /* forward declaration */
56 static const struct gss_krb5_enctype supported_gss_krb5_enctypes[] = {
58 * DES (All DES enctypes are mapped to the same gss functionality)
61 .etype = ENCTYPE_DES_CBC_RAW,
62 .ctype = CKSUMTYPE_RSA_MD5,
63 .name = "des-cbc-crc",
64 .encrypt_name = "cbc(des)",
66 .encrypt = krb5_encrypt,
67 .decrypt = krb5_decrypt,
69 .signalg = SGN_ALG_DES_MAC_MD5,
70 .sealalg = SEAL_ALG_DES,
82 .etype = ENCTYPE_ARCFOUR_HMAC,
83 .ctype = CKSUMTYPE_HMAC_MD5_ARCFOUR,
85 .encrypt_name = "ecb(arc4)",
86 .cksum_name = "hmac(md5)",
87 .encrypt = krb5_encrypt,
88 .decrypt = krb5_decrypt,
90 .signalg = SGN_ALG_HMAC_MD5,
91 .sealalg = SEAL_ALG_MICROSOFT_RC4,
103 .etype = ENCTYPE_DES3_CBC_RAW,
104 .ctype = CKSUMTYPE_HMAC_SHA1_DES3,
105 .name = "des3-hmac-sha1",
106 .encrypt_name = "cbc(des3_ede)",
107 .cksum_name = "hmac(sha1)",
108 .encrypt = krb5_encrypt,
109 .decrypt = krb5_decrypt,
110 .mk_key = gss_krb5_des3_make_key,
111 .signalg = SGN_ALG_HMAC_SHA1_DES3_KD,
112 .sealalg = SEAL_ALG_DES3KD,
124 .etype = ENCTYPE_AES128_CTS_HMAC_SHA1_96,
125 .ctype = CKSUMTYPE_HMAC_SHA1_96_AES128,
126 .name = "aes128-cts",
127 .encrypt_name = "cts(cbc(aes))",
128 .cksum_name = "hmac(sha1)",
129 .encrypt = krb5_encrypt,
130 .decrypt = krb5_decrypt,
131 .mk_key = gss_krb5_aes_make_key,
132 .encrypt_v2 = gss_krb5_aes_encrypt,
133 .decrypt_v2 = gss_krb5_aes_decrypt,
147 .etype = ENCTYPE_AES256_CTS_HMAC_SHA1_96,
148 .ctype = CKSUMTYPE_HMAC_SHA1_96_AES256,
149 .name = "aes256-cts",
150 .encrypt_name = "cts(cbc(aes))",
151 .cksum_name = "hmac(sha1)",
152 .encrypt = krb5_encrypt,
153 .decrypt = krb5_decrypt,
154 .mk_key = gss_krb5_aes_make_key,
155 .encrypt_v2 = gss_krb5_aes_encrypt,
156 .decrypt_v2 = gss_krb5_aes_decrypt,
168 static const int num_supported_enctypes =
169 ARRAY_SIZE(supported_gss_krb5_enctypes);
172 supported_gss_krb5_enctype(int etype)
175 for (i = 0; i < num_supported_enctypes; i++)
176 if (supported_gss_krb5_enctypes[i].etype == etype)
181 static const struct gss_krb5_enctype *
182 get_gss_krb5_enctype(int etype)
185 for (i = 0; i < num_supported_enctypes; i++)
186 if (supported_gss_krb5_enctypes[i].etype == etype)
187 return &supported_gss_krb5_enctypes[i];
191 static inline const void *
192 get_key(const void *p, const void *end,
193 struct krb5_ctx *ctx, struct crypto_blkcipher **res)
195 struct xdr_netobj key;
198 p = simple_get_bytes(p, end, &alg, sizeof(alg));
203 case ENCTYPE_DES_CBC_CRC:
204 case ENCTYPE_DES_CBC_MD4:
205 case ENCTYPE_DES_CBC_MD5:
206 /* Map all these key types to ENCTYPE_DES_CBC_RAW */
207 alg = ENCTYPE_DES_CBC_RAW;
211 if (!supported_gss_krb5_enctype(alg)) {
212 printk(KERN_WARNING "gss_kerberos_mech: unsupported "
213 "encryption key algorithm %d\n", alg);
214 p = ERR_PTR(-EINVAL);
217 p = simple_get_netobj(p, end, &key);
221 *res = crypto_alloc_blkcipher(ctx->gk5e->encrypt_name, 0,
224 printk(KERN_WARNING "gss_kerberos_mech: unable to initialize "
225 "crypto algorithm %s\n", ctx->gk5e->encrypt_name);
227 goto out_err_free_key;
229 if (crypto_blkcipher_setkey(*res, key.data, key.len)) {
230 printk(KERN_WARNING "gss_kerberos_mech: error setting key for "
231 "crypto algorithm %s\n", ctx->gk5e->encrypt_name);
232 goto out_err_free_tfm;
239 crypto_free_blkcipher(*res);
242 p = ERR_PTR(-EINVAL);
248 gss_import_v1_context(const void *p, const void *end, struct krb5_ctx *ctx)
252 p = simple_get_bytes(p, end, &ctx->initiate, sizeof(ctx->initiate));
256 /* Old format supports only DES! Any other enctype uses new format */
257 ctx->enctype = ENCTYPE_DES_CBC_RAW;
259 ctx->gk5e = get_gss_krb5_enctype(ctx->enctype);
260 if (ctx->gk5e == NULL) {
261 p = ERR_PTR(-EINVAL);
265 /* The downcall format was designed before we completely understood
266 * the uses of the context fields; so it includes some stuff we
267 * just give some minimal sanity-checking, and some we ignore
268 * completely (like the next twenty bytes): */
269 if (unlikely(p + 20 > end || p + 20 < p)) {
270 p = ERR_PTR(-EFAULT);
274 p = simple_get_bytes(p, end, &tmp, sizeof(tmp));
277 if (tmp != SGN_ALG_DES_MAC_MD5) {
278 p = ERR_PTR(-ENOSYS);
281 p = simple_get_bytes(p, end, &tmp, sizeof(tmp));
284 if (tmp != SEAL_ALG_DES) {
285 p = ERR_PTR(-ENOSYS);
288 p = simple_get_bytes(p, end, &ctx->endtime, sizeof(ctx->endtime));
291 p = simple_get_bytes(p, end, &ctx->seq_send, sizeof(ctx->seq_send));
294 p = simple_get_netobj(p, end, &ctx->mech_used);
297 p = get_key(p, end, ctx, &ctx->enc);
299 goto out_err_free_mech;
300 p = get_key(p, end, ctx, &ctx->seq);
302 goto out_err_free_key1;
304 p = ERR_PTR(-EFAULT);
305 goto out_err_free_key2;
311 crypto_free_blkcipher(ctx->seq);
313 crypto_free_blkcipher(ctx->enc);
315 kfree(ctx->mech_used.data);
320 static struct crypto_blkcipher *
321 context_v2_alloc_cipher(struct krb5_ctx *ctx, const char *cname, u8 *key)
323 struct crypto_blkcipher *cp;
325 cp = crypto_alloc_blkcipher(cname, 0, CRYPTO_ALG_ASYNC);
327 dprintk("gss_kerberos_mech: unable to initialize "
328 "crypto algorithm %s\n", cname);
331 if (crypto_blkcipher_setkey(cp, key, ctx->gk5e->keylength)) {
332 dprintk("gss_kerberos_mech: error setting key for "
333 "crypto algorithm %s\n", cname);
334 crypto_free_blkcipher(cp);
341 set_cdata(u8 cdata[GSS_KRB5_K5CLENGTH], u32 usage, u8 seed)
343 cdata[0] = (usage>>24)&0xff;
344 cdata[1] = (usage>>16)&0xff;
345 cdata[2] = (usage>>8)&0xff;
346 cdata[3] = usage&0xff;
351 context_derive_keys_des3(struct krb5_ctx *ctx, gfp_t gfp_mask)
353 struct xdr_netobj c, keyin, keyout;
354 u8 cdata[GSS_KRB5_K5CLENGTH];
357 c.len = GSS_KRB5_K5CLENGTH;
360 keyin.data = ctx->Ksess;
361 keyin.len = ctx->gk5e->keylength;
362 keyout.len = ctx->gk5e->keylength;
364 /* seq uses the raw key */
365 ctx->seq = context_v2_alloc_cipher(ctx, ctx->gk5e->encrypt_name,
367 if (ctx->seq == NULL)
370 ctx->enc = context_v2_alloc_cipher(ctx, ctx->gk5e->encrypt_name,
372 if (ctx->enc == NULL)
376 set_cdata(cdata, KG_USAGE_SIGN, KEY_USAGE_SEED_CHECKSUM);
377 keyout.data = ctx->cksum;
378 err = krb5_derive_key(ctx->gk5e, &keyin, &keyout, &c, gfp_mask);
380 dprintk("%s: Error %d deriving cksum key\n",
388 crypto_free_blkcipher(ctx->enc);
390 crypto_free_blkcipher(ctx->seq);
396 * Note that RC4 depends on deriving keys using the sequence
397 * number or the checksum of a token. Therefore, the final keys
398 * cannot be calculated until the token is being constructed!
401 context_derive_keys_rc4(struct krb5_ctx *ctx)
403 struct crypto_hash *hmac;
404 char sigkeyconstant[] = "signaturekey";
405 int slen = strlen(sigkeyconstant) + 1; /* include null terminator */
406 struct hash_desc desc;
407 struct scatterlist sg[1];
410 dprintk("RPC: %s: entered\n", __func__);
412 * derive cksum (aka Ksign) key
414 hmac = crypto_alloc_hash(ctx->gk5e->cksum_name, 0, CRYPTO_ALG_ASYNC);
416 dprintk("%s: error %ld allocating hash '%s'\n",
417 __func__, PTR_ERR(hmac), ctx->gk5e->cksum_name);
422 err = crypto_hash_setkey(hmac, ctx->Ksess, ctx->gk5e->keylength);
424 goto out_err_free_hmac;
426 sg_init_table(sg, 1);
427 sg_set_buf(sg, sigkeyconstant, slen);
432 err = crypto_hash_init(&desc);
434 goto out_err_free_hmac;
436 err = crypto_hash_digest(&desc, sg, slen, ctx->cksum);
438 goto out_err_free_hmac;
440 * allocate hash, and blkciphers for data and seqnum encryption
442 ctx->enc = crypto_alloc_blkcipher(ctx->gk5e->encrypt_name, 0,
444 if (IS_ERR(ctx->enc)) {
445 err = PTR_ERR(ctx->enc);
446 goto out_err_free_hmac;
449 ctx->seq = crypto_alloc_blkcipher(ctx->gk5e->encrypt_name, 0,
451 if (IS_ERR(ctx->seq)) {
452 crypto_free_blkcipher(ctx->enc);
453 err = PTR_ERR(ctx->seq);
454 goto out_err_free_hmac;
457 dprintk("RPC: %s: returning success\n", __func__);
462 crypto_free_hash(hmac);
464 dprintk("RPC: %s: returning %d\n", __func__, err);
469 context_derive_keys_new(struct krb5_ctx *ctx, gfp_t gfp_mask)
471 struct xdr_netobj c, keyin, keyout;
472 u8 cdata[GSS_KRB5_K5CLENGTH];
475 c.len = GSS_KRB5_K5CLENGTH;
478 keyin.data = ctx->Ksess;
479 keyin.len = ctx->gk5e->keylength;
480 keyout.len = ctx->gk5e->keylength;
482 /* initiator seal encryption */
483 set_cdata(cdata, KG_USAGE_INITIATOR_SEAL, KEY_USAGE_SEED_ENCRYPTION);
484 keyout.data = ctx->initiator_seal;
485 err = krb5_derive_key(ctx->gk5e, &keyin, &keyout, &c, gfp_mask);
487 dprintk("%s: Error %d deriving initiator_seal key\n",
491 ctx->initiator_enc = context_v2_alloc_cipher(ctx,
492 ctx->gk5e->encrypt_name,
493 ctx->initiator_seal);
494 if (ctx->initiator_enc == NULL)
497 /* acceptor seal encryption */
498 set_cdata(cdata, KG_USAGE_ACCEPTOR_SEAL, KEY_USAGE_SEED_ENCRYPTION);
499 keyout.data = ctx->acceptor_seal;
500 err = krb5_derive_key(ctx->gk5e, &keyin, &keyout, &c, gfp_mask);
502 dprintk("%s: Error %d deriving acceptor_seal key\n",
504 goto out_free_initiator_enc;
506 ctx->acceptor_enc = context_v2_alloc_cipher(ctx,
507 ctx->gk5e->encrypt_name,
509 if (ctx->acceptor_enc == NULL)
510 goto out_free_initiator_enc;
512 /* initiator sign checksum */
513 set_cdata(cdata, KG_USAGE_INITIATOR_SIGN, KEY_USAGE_SEED_CHECKSUM);
514 keyout.data = ctx->initiator_sign;
515 err = krb5_derive_key(ctx->gk5e, &keyin, &keyout, &c, gfp_mask);
517 dprintk("%s: Error %d deriving initiator_sign key\n",
519 goto out_free_acceptor_enc;
522 /* acceptor sign checksum */
523 set_cdata(cdata, KG_USAGE_ACCEPTOR_SIGN, KEY_USAGE_SEED_CHECKSUM);
524 keyout.data = ctx->acceptor_sign;
525 err = krb5_derive_key(ctx->gk5e, &keyin, &keyout, &c, gfp_mask);
527 dprintk("%s: Error %d deriving acceptor_sign key\n",
529 goto out_free_acceptor_enc;
532 /* initiator seal integrity */
533 set_cdata(cdata, KG_USAGE_INITIATOR_SEAL, KEY_USAGE_SEED_INTEGRITY);
534 keyout.data = ctx->initiator_integ;
535 err = krb5_derive_key(ctx->gk5e, &keyin, &keyout, &c, gfp_mask);
537 dprintk("%s: Error %d deriving initiator_integ key\n",
539 goto out_free_acceptor_enc;
542 /* acceptor seal integrity */
543 set_cdata(cdata, KG_USAGE_ACCEPTOR_SEAL, KEY_USAGE_SEED_INTEGRITY);
544 keyout.data = ctx->acceptor_integ;
545 err = krb5_derive_key(ctx->gk5e, &keyin, &keyout, &c, gfp_mask);
547 dprintk("%s: Error %d deriving acceptor_integ key\n",
549 goto out_free_acceptor_enc;
552 switch (ctx->enctype) {
553 case ENCTYPE_AES128_CTS_HMAC_SHA1_96:
554 case ENCTYPE_AES256_CTS_HMAC_SHA1_96:
555 ctx->initiator_enc_aux =
556 context_v2_alloc_cipher(ctx, "cbc(aes)",
557 ctx->initiator_seal);
558 if (ctx->initiator_enc_aux == NULL)
559 goto out_free_acceptor_enc;
560 ctx->acceptor_enc_aux =
561 context_v2_alloc_cipher(ctx, "cbc(aes)",
563 if (ctx->acceptor_enc_aux == NULL) {
564 crypto_free_blkcipher(ctx->initiator_enc_aux);
565 goto out_free_acceptor_enc;
571 out_free_acceptor_enc:
572 crypto_free_blkcipher(ctx->acceptor_enc);
573 out_free_initiator_enc:
574 crypto_free_blkcipher(ctx->initiator_enc);
580 gss_import_v2_context(const void *p, const void *end, struct krb5_ctx *ctx,
585 p = simple_get_bytes(p, end, &ctx->flags, sizeof(ctx->flags));
588 ctx->initiate = ctx->flags & KRB5_CTX_FLAG_INITIATOR;
590 p = simple_get_bytes(p, end, &ctx->endtime, sizeof(ctx->endtime));
593 p = simple_get_bytes(p, end, &ctx->seq_send64, sizeof(ctx->seq_send64));
596 /* set seq_send for use by "older" enctypes */
597 ctx->seq_send = ctx->seq_send64;
598 if (ctx->seq_send64 != ctx->seq_send) {
599 dprintk("%s: seq_send64 %lx, seq_send %x overflow?\n", __func__,
600 (unsigned long)ctx->seq_send64, ctx->seq_send);
601 p = ERR_PTR(-EINVAL);
604 p = simple_get_bytes(p, end, &ctx->enctype, sizeof(ctx->enctype));
607 /* Map ENCTYPE_DES3_CBC_SHA1 to ENCTYPE_DES3_CBC_RAW */
608 if (ctx->enctype == ENCTYPE_DES3_CBC_SHA1)
609 ctx->enctype = ENCTYPE_DES3_CBC_RAW;
610 ctx->gk5e = get_gss_krb5_enctype(ctx->enctype);
611 if (ctx->gk5e == NULL) {
612 dprintk("gss_kerberos_mech: unsupported krb5 enctype %u\n",
614 p = ERR_PTR(-EINVAL);
617 keylen = ctx->gk5e->keylength;
619 p = simple_get_bytes(p, end, ctx->Ksess, keylen);
624 p = ERR_PTR(-EINVAL);
628 ctx->mech_used.data = kmemdup(gss_kerberos_mech.gm_oid.data,
629 gss_kerberos_mech.gm_oid.len, gfp_mask);
630 if (unlikely(ctx->mech_used.data == NULL)) {
631 p = ERR_PTR(-ENOMEM);
634 ctx->mech_used.len = gss_kerberos_mech.gm_oid.len;
636 switch (ctx->enctype) {
637 case ENCTYPE_DES3_CBC_RAW:
638 return context_derive_keys_des3(ctx, gfp_mask);
639 case ENCTYPE_ARCFOUR_HMAC:
640 return context_derive_keys_rc4(ctx);
641 case ENCTYPE_AES128_CTS_HMAC_SHA1_96:
642 case ENCTYPE_AES256_CTS_HMAC_SHA1_96:
643 return context_derive_keys_new(ctx, gfp_mask);
653 gss_import_sec_context_kerberos(const void *p, size_t len,
654 struct gss_ctx *ctx_id,
658 const void *end = (const void *)((const char *)p + len);
659 struct krb5_ctx *ctx;
662 ctx = kzalloc(sizeof(*ctx), gfp_mask);
667 ret = gss_import_v1_context(p, end, ctx);
669 ret = gss_import_v2_context(p, end, ctx, gfp_mask);
672 ctx_id->internal_ctx_id = ctx;
674 *endtime = ctx->endtime;
678 dprintk("RPC: %s: returning %d\n", __func__, ret);
683 gss_delete_sec_context_kerberos(void *internal_ctx) {
684 struct krb5_ctx *kctx = internal_ctx;
686 crypto_free_blkcipher(kctx->seq);
687 crypto_free_blkcipher(kctx->enc);
688 crypto_free_blkcipher(kctx->acceptor_enc);
689 crypto_free_blkcipher(kctx->initiator_enc);
690 crypto_free_blkcipher(kctx->acceptor_enc_aux);
691 crypto_free_blkcipher(kctx->initiator_enc_aux);
692 kfree(kctx->mech_used.data);
696 static const struct gss_api_ops gss_kerberos_ops = {
697 .gss_import_sec_context = gss_import_sec_context_kerberos,
698 .gss_get_mic = gss_get_mic_kerberos,
699 .gss_verify_mic = gss_verify_mic_kerberos,
700 .gss_wrap = gss_wrap_kerberos,
701 .gss_unwrap = gss_unwrap_kerberos,
702 .gss_delete_sec_context = gss_delete_sec_context_kerberos,
705 static struct pf_desc gss_kerberos_pfs[] = {
707 .pseudoflavor = RPC_AUTH_GSS_KRB5,
708 .qop = GSS_C_QOP_DEFAULT,
709 .service = RPC_GSS_SVC_NONE,
713 .pseudoflavor = RPC_AUTH_GSS_KRB5I,
714 .qop = GSS_C_QOP_DEFAULT,
715 .service = RPC_GSS_SVC_INTEGRITY,
719 .pseudoflavor = RPC_AUTH_GSS_KRB5P,
720 .qop = GSS_C_QOP_DEFAULT,
721 .service = RPC_GSS_SVC_PRIVACY,
726 MODULE_ALIAS("rpc-auth-gss-krb5");
727 MODULE_ALIAS("rpc-auth-gss-krb5i");
728 MODULE_ALIAS("rpc-auth-gss-krb5p");
729 MODULE_ALIAS("rpc-auth-gss-390003");
730 MODULE_ALIAS("rpc-auth-gss-390004");
731 MODULE_ALIAS("rpc-auth-gss-390005");
732 MODULE_ALIAS("rpc-auth-gss-1.2.840.113554.1.2.2");
734 static struct gss_api_mech gss_kerberos_mech = {
736 .gm_owner = THIS_MODULE,
737 .gm_oid = { 9, "\x2a\x86\x48\x86\xf7\x12\x01\x02\x02" },
738 .gm_ops = &gss_kerberos_ops,
739 .gm_pf_num = ARRAY_SIZE(gss_kerberos_pfs),
740 .gm_pfs = gss_kerberos_pfs,
741 .gm_upcall_enctypes = KRB5_SUPPORTED_ENCTYPES,
744 static int __init init_kerberos_module(void)
748 status = gss_mech_register(&gss_kerberos_mech);
750 printk("Failed to register kerberos gss mechanism!\n");
754 static void __exit cleanup_kerberos_module(void)
756 gss_mech_unregister(&gss_kerberos_mech);
759 MODULE_LICENSE("GPL");
760 module_init(init_kerberos_module);
761 module_exit(cleanup_kerberos_module);