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 #if IS_ENABLED(CONFIG_SUNRPC_DEBUG)
49 # define RPCDBG_FACILITY RPCDBG_AUTH
52 static struct gss_api_mech gss_kerberos_mech; /* forward declaration */
54 static const struct gss_krb5_enctype supported_gss_krb5_enctypes[] = {
56 * DES (All DES enctypes are mapped to the same gss functionality)
59 .etype = ENCTYPE_DES_CBC_RAW,
60 .ctype = CKSUMTYPE_RSA_MD5,
61 .name = "des-cbc-crc",
62 .encrypt_name = "cbc(des)",
64 .encrypt = krb5_encrypt,
65 .decrypt = krb5_decrypt,
67 .signalg = SGN_ALG_DES_MAC_MD5,
68 .sealalg = SEAL_ALG_DES,
80 .etype = ENCTYPE_ARCFOUR_HMAC,
81 .ctype = CKSUMTYPE_HMAC_MD5_ARCFOUR,
83 .encrypt_name = "ecb(arc4)",
84 .cksum_name = "hmac(md5)",
85 .encrypt = krb5_encrypt,
86 .decrypt = krb5_decrypt,
88 .signalg = SGN_ALG_HMAC_MD5,
89 .sealalg = SEAL_ALG_MICROSOFT_RC4,
101 .etype = ENCTYPE_DES3_CBC_RAW,
102 .ctype = CKSUMTYPE_HMAC_SHA1_DES3,
103 .name = "des3-hmac-sha1",
104 .encrypt_name = "cbc(des3_ede)",
105 .cksum_name = "hmac(sha1)",
106 .encrypt = krb5_encrypt,
107 .decrypt = krb5_decrypt,
108 .mk_key = gss_krb5_des3_make_key,
109 .signalg = SGN_ALG_HMAC_SHA1_DES3_KD,
110 .sealalg = SEAL_ALG_DES3KD,
122 .etype = ENCTYPE_AES128_CTS_HMAC_SHA1_96,
123 .ctype = CKSUMTYPE_HMAC_SHA1_96_AES128,
124 .name = "aes128-cts",
125 .encrypt_name = "cts(cbc(aes))",
126 .cksum_name = "hmac(sha1)",
127 .encrypt = krb5_encrypt,
128 .decrypt = krb5_decrypt,
129 .mk_key = gss_krb5_aes_make_key,
130 .encrypt_v2 = gss_krb5_aes_encrypt,
131 .decrypt_v2 = gss_krb5_aes_decrypt,
145 .etype = ENCTYPE_AES256_CTS_HMAC_SHA1_96,
146 .ctype = CKSUMTYPE_HMAC_SHA1_96_AES256,
147 .name = "aes256-cts",
148 .encrypt_name = "cts(cbc(aes))",
149 .cksum_name = "hmac(sha1)",
150 .encrypt = krb5_encrypt,
151 .decrypt = krb5_decrypt,
152 .mk_key = gss_krb5_aes_make_key,
153 .encrypt_v2 = gss_krb5_aes_encrypt,
154 .decrypt_v2 = gss_krb5_aes_decrypt,
166 static const int num_supported_enctypes =
167 ARRAY_SIZE(supported_gss_krb5_enctypes);
170 supported_gss_krb5_enctype(int etype)
173 for (i = 0; i < num_supported_enctypes; i++)
174 if (supported_gss_krb5_enctypes[i].etype == etype)
179 static const struct gss_krb5_enctype *
180 get_gss_krb5_enctype(int etype)
183 for (i = 0; i < num_supported_enctypes; i++)
184 if (supported_gss_krb5_enctypes[i].etype == etype)
185 return &supported_gss_krb5_enctypes[i];
190 simple_get_bytes(const void *p, const void *end, void *res, int len)
192 const void *q = (const void *)((const char *)p + len);
193 if (unlikely(q > end || q < p))
194 return ERR_PTR(-EFAULT);
200 simple_get_netobj(const void *p, const void *end, struct xdr_netobj *res)
205 p = simple_get_bytes(p, end, &len, sizeof(len));
208 q = (const void *)((const char *)p + len);
209 if (unlikely(q > end || q < p))
210 return ERR_PTR(-EFAULT);
211 res->data = kmemdup(p, len, GFP_NOFS);
212 if (unlikely(res->data == NULL))
213 return ERR_PTR(-ENOMEM);
218 static inline const void *
219 get_key(const void *p, const void *end,
220 struct krb5_ctx *ctx, struct crypto_blkcipher **res)
222 struct xdr_netobj key;
225 p = simple_get_bytes(p, end, &alg, sizeof(alg));
230 case ENCTYPE_DES_CBC_CRC:
231 case ENCTYPE_DES_CBC_MD4:
232 case ENCTYPE_DES_CBC_MD5:
233 /* Map all these key types to ENCTYPE_DES_CBC_RAW */
234 alg = ENCTYPE_DES_CBC_RAW;
238 if (!supported_gss_krb5_enctype(alg)) {
239 printk(KERN_WARNING "gss_kerberos_mech: unsupported "
240 "encryption key algorithm %d\n", alg);
241 p = ERR_PTR(-EINVAL);
244 p = simple_get_netobj(p, end, &key);
248 *res = crypto_alloc_blkcipher(ctx->gk5e->encrypt_name, 0,
251 printk(KERN_WARNING "gss_kerberos_mech: unable to initialize "
252 "crypto algorithm %s\n", ctx->gk5e->encrypt_name);
254 goto out_err_free_key;
256 if (crypto_blkcipher_setkey(*res, key.data, key.len)) {
257 printk(KERN_WARNING "gss_kerberos_mech: error setting key for "
258 "crypto algorithm %s\n", ctx->gk5e->encrypt_name);
259 goto out_err_free_tfm;
266 crypto_free_blkcipher(*res);
269 p = ERR_PTR(-EINVAL);
275 gss_import_v1_context(const void *p, const void *end, struct krb5_ctx *ctx)
279 p = simple_get_bytes(p, end, &ctx->initiate, sizeof(ctx->initiate));
283 /* Old format supports only DES! Any other enctype uses new format */
284 ctx->enctype = ENCTYPE_DES_CBC_RAW;
286 ctx->gk5e = get_gss_krb5_enctype(ctx->enctype);
287 if (ctx->gk5e == NULL) {
288 p = ERR_PTR(-EINVAL);
292 /* The downcall format was designed before we completely understood
293 * the uses of the context fields; so it includes some stuff we
294 * just give some minimal sanity-checking, and some we ignore
295 * completely (like the next twenty bytes): */
296 if (unlikely(p + 20 > end || p + 20 < p)) {
297 p = ERR_PTR(-EFAULT);
301 p = simple_get_bytes(p, end, &tmp, sizeof(tmp));
304 if (tmp != SGN_ALG_DES_MAC_MD5) {
305 p = ERR_PTR(-ENOSYS);
308 p = simple_get_bytes(p, end, &tmp, sizeof(tmp));
311 if (tmp != SEAL_ALG_DES) {
312 p = ERR_PTR(-ENOSYS);
315 p = simple_get_bytes(p, end, &ctx->endtime, sizeof(ctx->endtime));
318 p = simple_get_bytes(p, end, &ctx->seq_send, sizeof(ctx->seq_send));
321 p = simple_get_netobj(p, end, &ctx->mech_used);
324 p = get_key(p, end, ctx, &ctx->enc);
326 goto out_err_free_mech;
327 p = get_key(p, end, ctx, &ctx->seq);
329 goto out_err_free_key1;
331 p = ERR_PTR(-EFAULT);
332 goto out_err_free_key2;
338 crypto_free_blkcipher(ctx->seq);
340 crypto_free_blkcipher(ctx->enc);
342 kfree(ctx->mech_used.data);
347 static struct crypto_blkcipher *
348 context_v2_alloc_cipher(struct krb5_ctx *ctx, const char *cname, u8 *key)
350 struct crypto_blkcipher *cp;
352 cp = crypto_alloc_blkcipher(cname, 0, CRYPTO_ALG_ASYNC);
354 dprintk("gss_kerberos_mech: unable to initialize "
355 "crypto algorithm %s\n", cname);
358 if (crypto_blkcipher_setkey(cp, key, ctx->gk5e->keylength)) {
359 dprintk("gss_kerberos_mech: error setting key for "
360 "crypto algorithm %s\n", cname);
361 crypto_free_blkcipher(cp);
368 set_cdata(u8 cdata[GSS_KRB5_K5CLENGTH], u32 usage, u8 seed)
370 cdata[0] = (usage>>24)&0xff;
371 cdata[1] = (usage>>16)&0xff;
372 cdata[2] = (usage>>8)&0xff;
373 cdata[3] = usage&0xff;
378 context_derive_keys_des3(struct krb5_ctx *ctx, gfp_t gfp_mask)
380 struct xdr_netobj c, keyin, keyout;
381 u8 cdata[GSS_KRB5_K5CLENGTH];
384 c.len = GSS_KRB5_K5CLENGTH;
387 keyin.data = ctx->Ksess;
388 keyin.len = ctx->gk5e->keylength;
389 keyout.len = ctx->gk5e->keylength;
391 /* seq uses the raw key */
392 ctx->seq = context_v2_alloc_cipher(ctx, ctx->gk5e->encrypt_name,
394 if (ctx->seq == NULL)
397 ctx->enc = context_v2_alloc_cipher(ctx, ctx->gk5e->encrypt_name,
399 if (ctx->enc == NULL)
403 set_cdata(cdata, KG_USAGE_SIGN, KEY_USAGE_SEED_CHECKSUM);
404 keyout.data = ctx->cksum;
405 err = krb5_derive_key(ctx->gk5e, &keyin, &keyout, &c, gfp_mask);
407 dprintk("%s: Error %d deriving cksum key\n",
415 crypto_free_blkcipher(ctx->enc);
417 crypto_free_blkcipher(ctx->seq);
423 * Note that RC4 depends on deriving keys using the sequence
424 * number or the checksum of a token. Therefore, the final keys
425 * cannot be calculated until the token is being constructed!
428 context_derive_keys_rc4(struct krb5_ctx *ctx)
430 struct crypto_hash *hmac;
431 char sigkeyconstant[] = "signaturekey";
432 int slen = strlen(sigkeyconstant) + 1; /* include null terminator */
433 struct hash_desc desc;
434 struct scatterlist sg[1];
437 dprintk("RPC: %s: entered\n", __func__);
439 * derive cksum (aka Ksign) key
441 hmac = crypto_alloc_hash(ctx->gk5e->cksum_name, 0, CRYPTO_ALG_ASYNC);
443 dprintk("%s: error %ld allocating hash '%s'\n",
444 __func__, PTR_ERR(hmac), ctx->gk5e->cksum_name);
449 err = crypto_hash_setkey(hmac, ctx->Ksess, ctx->gk5e->keylength);
451 goto out_err_free_hmac;
453 sg_init_table(sg, 1);
454 sg_set_buf(sg, sigkeyconstant, slen);
459 err = crypto_hash_init(&desc);
461 goto out_err_free_hmac;
463 err = crypto_hash_digest(&desc, sg, slen, ctx->cksum);
465 goto out_err_free_hmac;
467 * allocate hash, and blkciphers for data and seqnum encryption
469 ctx->enc = crypto_alloc_blkcipher(ctx->gk5e->encrypt_name, 0,
471 if (IS_ERR(ctx->enc)) {
472 err = PTR_ERR(ctx->enc);
473 goto out_err_free_hmac;
476 ctx->seq = crypto_alloc_blkcipher(ctx->gk5e->encrypt_name, 0,
478 if (IS_ERR(ctx->seq)) {
479 crypto_free_blkcipher(ctx->enc);
480 err = PTR_ERR(ctx->seq);
481 goto out_err_free_hmac;
484 dprintk("RPC: %s: returning success\n", __func__);
489 crypto_free_hash(hmac);
491 dprintk("RPC: %s: returning %d\n", __func__, err);
496 context_derive_keys_new(struct krb5_ctx *ctx, gfp_t gfp_mask)
498 struct xdr_netobj c, keyin, keyout;
499 u8 cdata[GSS_KRB5_K5CLENGTH];
502 c.len = GSS_KRB5_K5CLENGTH;
505 keyin.data = ctx->Ksess;
506 keyin.len = ctx->gk5e->keylength;
507 keyout.len = ctx->gk5e->keylength;
509 /* initiator seal encryption */
510 set_cdata(cdata, KG_USAGE_INITIATOR_SEAL, KEY_USAGE_SEED_ENCRYPTION);
511 keyout.data = ctx->initiator_seal;
512 err = krb5_derive_key(ctx->gk5e, &keyin, &keyout, &c, gfp_mask);
514 dprintk("%s: Error %d deriving initiator_seal key\n",
518 ctx->initiator_enc = context_v2_alloc_cipher(ctx,
519 ctx->gk5e->encrypt_name,
520 ctx->initiator_seal);
521 if (ctx->initiator_enc == NULL)
524 /* acceptor seal encryption */
525 set_cdata(cdata, KG_USAGE_ACCEPTOR_SEAL, KEY_USAGE_SEED_ENCRYPTION);
526 keyout.data = ctx->acceptor_seal;
527 err = krb5_derive_key(ctx->gk5e, &keyin, &keyout, &c, gfp_mask);
529 dprintk("%s: Error %d deriving acceptor_seal key\n",
531 goto out_free_initiator_enc;
533 ctx->acceptor_enc = context_v2_alloc_cipher(ctx,
534 ctx->gk5e->encrypt_name,
536 if (ctx->acceptor_enc == NULL)
537 goto out_free_initiator_enc;
539 /* initiator sign checksum */
540 set_cdata(cdata, KG_USAGE_INITIATOR_SIGN, KEY_USAGE_SEED_CHECKSUM);
541 keyout.data = ctx->initiator_sign;
542 err = krb5_derive_key(ctx->gk5e, &keyin, &keyout, &c, gfp_mask);
544 dprintk("%s: Error %d deriving initiator_sign key\n",
546 goto out_free_acceptor_enc;
549 /* acceptor sign checksum */
550 set_cdata(cdata, KG_USAGE_ACCEPTOR_SIGN, KEY_USAGE_SEED_CHECKSUM);
551 keyout.data = ctx->acceptor_sign;
552 err = krb5_derive_key(ctx->gk5e, &keyin, &keyout, &c, gfp_mask);
554 dprintk("%s: Error %d deriving acceptor_sign key\n",
556 goto out_free_acceptor_enc;
559 /* initiator seal integrity */
560 set_cdata(cdata, KG_USAGE_INITIATOR_SEAL, KEY_USAGE_SEED_INTEGRITY);
561 keyout.data = ctx->initiator_integ;
562 err = krb5_derive_key(ctx->gk5e, &keyin, &keyout, &c, gfp_mask);
564 dprintk("%s: Error %d deriving initiator_integ key\n",
566 goto out_free_acceptor_enc;
569 /* acceptor seal integrity */
570 set_cdata(cdata, KG_USAGE_ACCEPTOR_SEAL, KEY_USAGE_SEED_INTEGRITY);
571 keyout.data = ctx->acceptor_integ;
572 err = krb5_derive_key(ctx->gk5e, &keyin, &keyout, &c, gfp_mask);
574 dprintk("%s: Error %d deriving acceptor_integ key\n",
576 goto out_free_acceptor_enc;
579 switch (ctx->enctype) {
580 case ENCTYPE_AES128_CTS_HMAC_SHA1_96:
581 case ENCTYPE_AES256_CTS_HMAC_SHA1_96:
582 ctx->initiator_enc_aux =
583 context_v2_alloc_cipher(ctx, "cbc(aes)",
584 ctx->initiator_seal);
585 if (ctx->initiator_enc_aux == NULL)
586 goto out_free_acceptor_enc;
587 ctx->acceptor_enc_aux =
588 context_v2_alloc_cipher(ctx, "cbc(aes)",
590 if (ctx->acceptor_enc_aux == NULL) {
591 crypto_free_blkcipher(ctx->initiator_enc_aux);
592 goto out_free_acceptor_enc;
598 out_free_acceptor_enc:
599 crypto_free_blkcipher(ctx->acceptor_enc);
600 out_free_initiator_enc:
601 crypto_free_blkcipher(ctx->initiator_enc);
607 gss_import_v2_context(const void *p, const void *end, struct krb5_ctx *ctx,
612 p = simple_get_bytes(p, end, &ctx->flags, sizeof(ctx->flags));
615 ctx->initiate = ctx->flags & KRB5_CTX_FLAG_INITIATOR;
617 p = simple_get_bytes(p, end, &ctx->endtime, sizeof(ctx->endtime));
620 p = simple_get_bytes(p, end, &ctx->seq_send64, sizeof(ctx->seq_send64));
623 /* set seq_send for use by "older" enctypes */
624 ctx->seq_send = ctx->seq_send64;
625 if (ctx->seq_send64 != ctx->seq_send) {
626 dprintk("%s: seq_send64 %lx, seq_send %x overflow?\n", __func__,
627 (unsigned long)ctx->seq_send64, ctx->seq_send);
628 p = ERR_PTR(-EINVAL);
631 p = simple_get_bytes(p, end, &ctx->enctype, sizeof(ctx->enctype));
634 /* Map ENCTYPE_DES3_CBC_SHA1 to ENCTYPE_DES3_CBC_RAW */
635 if (ctx->enctype == ENCTYPE_DES3_CBC_SHA1)
636 ctx->enctype = ENCTYPE_DES3_CBC_RAW;
637 ctx->gk5e = get_gss_krb5_enctype(ctx->enctype);
638 if (ctx->gk5e == NULL) {
639 dprintk("gss_kerberos_mech: unsupported krb5 enctype %u\n",
641 p = ERR_PTR(-EINVAL);
644 keylen = ctx->gk5e->keylength;
646 p = simple_get_bytes(p, end, ctx->Ksess, keylen);
651 p = ERR_PTR(-EINVAL);
655 ctx->mech_used.data = kmemdup(gss_kerberos_mech.gm_oid.data,
656 gss_kerberos_mech.gm_oid.len, gfp_mask);
657 if (unlikely(ctx->mech_used.data == NULL)) {
658 p = ERR_PTR(-ENOMEM);
661 ctx->mech_used.len = gss_kerberos_mech.gm_oid.len;
663 switch (ctx->enctype) {
664 case ENCTYPE_DES3_CBC_RAW:
665 return context_derive_keys_des3(ctx, gfp_mask);
666 case ENCTYPE_ARCFOUR_HMAC:
667 return context_derive_keys_rc4(ctx);
668 case ENCTYPE_AES128_CTS_HMAC_SHA1_96:
669 case ENCTYPE_AES256_CTS_HMAC_SHA1_96:
670 return context_derive_keys_new(ctx, gfp_mask);
680 gss_import_sec_context_kerberos(const void *p, size_t len,
681 struct gss_ctx *ctx_id,
685 const void *end = (const void *)((const char *)p + len);
686 struct krb5_ctx *ctx;
689 ctx = kzalloc(sizeof(*ctx), gfp_mask);
694 ret = gss_import_v1_context(p, end, ctx);
696 ret = gss_import_v2_context(p, end, ctx, gfp_mask);
699 ctx_id->internal_ctx_id = ctx;
701 *endtime = ctx->endtime;
705 dprintk("RPC: %s: returning %d\n", __func__, ret);
710 gss_delete_sec_context_kerberos(void *internal_ctx) {
711 struct krb5_ctx *kctx = internal_ctx;
713 crypto_free_blkcipher(kctx->seq);
714 crypto_free_blkcipher(kctx->enc);
715 crypto_free_blkcipher(kctx->acceptor_enc);
716 crypto_free_blkcipher(kctx->initiator_enc);
717 crypto_free_blkcipher(kctx->acceptor_enc_aux);
718 crypto_free_blkcipher(kctx->initiator_enc_aux);
719 kfree(kctx->mech_used.data);
723 static const struct gss_api_ops gss_kerberos_ops = {
724 .gss_import_sec_context = gss_import_sec_context_kerberos,
725 .gss_get_mic = gss_get_mic_kerberos,
726 .gss_verify_mic = gss_verify_mic_kerberos,
727 .gss_wrap = gss_wrap_kerberos,
728 .gss_unwrap = gss_unwrap_kerberos,
729 .gss_delete_sec_context = gss_delete_sec_context_kerberos,
732 static struct pf_desc gss_kerberos_pfs[] = {
734 .pseudoflavor = RPC_AUTH_GSS_KRB5,
735 .qop = GSS_C_QOP_DEFAULT,
736 .service = RPC_GSS_SVC_NONE,
740 .pseudoflavor = RPC_AUTH_GSS_KRB5I,
741 .qop = GSS_C_QOP_DEFAULT,
742 .service = RPC_GSS_SVC_INTEGRITY,
746 .pseudoflavor = RPC_AUTH_GSS_KRB5P,
747 .qop = GSS_C_QOP_DEFAULT,
748 .service = RPC_GSS_SVC_PRIVACY,
753 MODULE_ALIAS("rpc-auth-gss-krb5");
754 MODULE_ALIAS("rpc-auth-gss-krb5i");
755 MODULE_ALIAS("rpc-auth-gss-krb5p");
756 MODULE_ALIAS("rpc-auth-gss-390003");
757 MODULE_ALIAS("rpc-auth-gss-390004");
758 MODULE_ALIAS("rpc-auth-gss-390005");
759 MODULE_ALIAS("rpc-auth-gss-1.2.840.113554.1.2.2");
761 static struct gss_api_mech gss_kerberos_mech = {
763 .gm_owner = THIS_MODULE,
764 .gm_oid = { 9, "\x2a\x86\x48\x86\xf7\x12\x01\x02\x02" },
765 .gm_ops = &gss_kerberos_ops,
766 .gm_pf_num = ARRAY_SIZE(gss_kerberos_pfs),
767 .gm_pfs = gss_kerberos_pfs,
768 .gm_upcall_enctypes = KRB5_SUPPORTED_ENCTYPES,
771 static int __init init_kerberos_module(void)
775 status = gss_mech_register(&gss_kerberos_mech);
777 printk("Failed to register kerberos gss mechanism!\n");
781 static void __exit cleanup_kerberos_module(void)
783 gss_mech_unregister(&gss_kerberos_mech);
786 MODULE_LICENSE("GPL");
787 module_init(init_kerberos_module);
788 module_exit(cleanup_kerberos_module);