1 // SPDX-License-Identifier: BSD-3-Clause
3 * linux/net/sunrpc/gss_krb5_mech.c
5 * Copyright (c) 2001-2008 The Regents of the University of Michigan.
8 * Andy Adamson <andros@umich.edu>
9 * J. Bruce Fields <bfields@umich.edu>
12 #include <crypto/hash.h>
13 #include <crypto/skcipher.h>
14 #include <linux/err.h>
15 #include <linux/module.h>
16 #include <linux/init.h>
17 #include <linux/types.h>
18 #include <linux/slab.h>
19 #include <linux/sunrpc/auth.h>
20 #include <linux/sunrpc/gss_krb5.h>
21 #include <linux/sunrpc/xdr.h>
22 #include <linux/sunrpc/gss_krb5_enctypes.h>
24 #if IS_ENABLED(CONFIG_SUNRPC_DEBUG)
25 # define RPCDBG_FACILITY RPCDBG_AUTH
28 static struct gss_api_mech gss_kerberos_mech; /* forward declaration */
30 static const struct gss_krb5_enctype supported_gss_krb5_enctypes[] = {
31 #ifndef CONFIG_SUNRPC_DISABLE_INSECURE_ENCTYPES
33 * DES (All DES enctypes are mapped to the same gss functionality)
36 .etype = ENCTYPE_DES_CBC_RAW,
37 .ctype = CKSUMTYPE_RSA_MD5,
38 .name = "des-cbc-crc",
39 .encrypt_name = "cbc(des)",
41 .encrypt = krb5_encrypt,
42 .decrypt = krb5_decrypt,
44 .signalg = SGN_ALG_DES_MAC_MD5,
45 .sealalg = SEAL_ALG_DES,
53 #endif /* CONFIG_SUNRPC_DISABLE_INSECURE_ENCTYPES */
58 .etype = ENCTYPE_ARCFOUR_HMAC,
59 .ctype = CKSUMTYPE_HMAC_MD5_ARCFOUR,
61 .encrypt_name = "ecb(arc4)",
62 .cksum_name = "hmac(md5)",
63 .encrypt = krb5_encrypt,
64 .decrypt = krb5_decrypt,
66 .signalg = SGN_ALG_HMAC_MD5,
67 .sealalg = SEAL_ALG_MICROSOFT_RC4,
79 .etype = ENCTYPE_DES3_CBC_RAW,
80 .ctype = CKSUMTYPE_HMAC_SHA1_DES3,
81 .name = "des3-hmac-sha1",
82 .encrypt_name = "cbc(des3_ede)",
83 .cksum_name = "hmac(sha1)",
84 .encrypt = krb5_encrypt,
85 .decrypt = krb5_decrypt,
86 .mk_key = gss_krb5_des3_make_key,
87 .signalg = SGN_ALG_HMAC_SHA1_DES3_KD,
88 .sealalg = SEAL_ALG_DES3KD,
100 .etype = ENCTYPE_AES128_CTS_HMAC_SHA1_96,
101 .ctype = CKSUMTYPE_HMAC_SHA1_96_AES128,
102 .name = "aes128-cts",
103 .encrypt_name = "cts(cbc(aes))",
104 .cksum_name = "hmac(sha1)",
105 .encrypt = krb5_encrypt,
106 .decrypt = krb5_decrypt,
107 .mk_key = gss_krb5_aes_make_key,
108 .encrypt_v2 = gss_krb5_aes_encrypt,
109 .decrypt_v2 = gss_krb5_aes_decrypt,
123 .etype = ENCTYPE_AES256_CTS_HMAC_SHA1_96,
124 .ctype = CKSUMTYPE_HMAC_SHA1_96_AES256,
125 .name = "aes256-cts",
126 .encrypt_name = "cts(cbc(aes))",
127 .cksum_name = "hmac(sha1)",
128 .encrypt = krb5_encrypt,
129 .decrypt = krb5_decrypt,
130 .mk_key = gss_krb5_aes_make_key,
131 .encrypt_v2 = gss_krb5_aes_encrypt,
132 .decrypt_v2 = gss_krb5_aes_decrypt,
144 static const int num_supported_enctypes =
145 ARRAY_SIZE(supported_gss_krb5_enctypes);
148 supported_gss_krb5_enctype(int etype)
151 for (i = 0; i < num_supported_enctypes; i++)
152 if (supported_gss_krb5_enctypes[i].etype == etype)
157 static const struct gss_krb5_enctype *
158 get_gss_krb5_enctype(int etype)
161 for (i = 0; i < num_supported_enctypes; i++)
162 if (supported_gss_krb5_enctypes[i].etype == etype)
163 return &supported_gss_krb5_enctypes[i];
168 simple_get_bytes(const void *p, const void *end, void *res, int len)
170 const void *q = (const void *)((const char *)p + len);
171 if (unlikely(q > end || q < p))
172 return ERR_PTR(-EFAULT);
178 simple_get_netobj(const void *p, const void *end, struct xdr_netobj *res)
183 p = simple_get_bytes(p, end, &len, sizeof(len));
186 q = (const void *)((const char *)p + len);
187 if (unlikely(q > end || q < p))
188 return ERR_PTR(-EFAULT);
189 res->data = kmemdup(p, len, GFP_NOFS);
190 if (unlikely(res->data == NULL))
191 return ERR_PTR(-ENOMEM);
196 static inline const void *
197 get_key(const void *p, const void *end,
198 struct krb5_ctx *ctx, struct crypto_sync_skcipher **res)
200 struct xdr_netobj key;
203 p = simple_get_bytes(p, end, &alg, sizeof(alg));
208 case ENCTYPE_DES_CBC_CRC:
209 case ENCTYPE_DES_CBC_MD4:
210 case ENCTYPE_DES_CBC_MD5:
211 /* Map all these key types to ENCTYPE_DES_CBC_RAW */
212 alg = ENCTYPE_DES_CBC_RAW;
216 if (!supported_gss_krb5_enctype(alg)) {
217 printk(KERN_WARNING "gss_kerberos_mech: unsupported "
218 "encryption key algorithm %d\n", alg);
219 p = ERR_PTR(-EINVAL);
222 p = simple_get_netobj(p, end, &key);
226 *res = crypto_alloc_sync_skcipher(ctx->gk5e->encrypt_name, 0, 0);
228 printk(KERN_WARNING "gss_kerberos_mech: unable to initialize "
229 "crypto algorithm %s\n", ctx->gk5e->encrypt_name);
231 goto out_err_free_key;
233 if (crypto_sync_skcipher_setkey(*res, key.data, key.len)) {
234 printk(KERN_WARNING "gss_kerberos_mech: error setting key for "
235 "crypto algorithm %s\n", ctx->gk5e->encrypt_name);
236 goto out_err_free_tfm;
243 crypto_free_sync_skcipher(*res);
246 p = ERR_PTR(-EINVAL);
252 gss_import_v1_context(const void *p, const void *end, struct krb5_ctx *ctx)
257 p = simple_get_bytes(p, end, &ctx->initiate, sizeof(ctx->initiate));
261 /* Old format supports only DES! Any other enctype uses new format */
262 ctx->enctype = ENCTYPE_DES_CBC_RAW;
264 ctx->gk5e = get_gss_krb5_enctype(ctx->enctype);
265 if (ctx->gk5e == NULL) {
266 p = ERR_PTR(-EINVAL);
270 /* The downcall format was designed before we completely understood
271 * the uses of the context fields; so it includes some stuff we
272 * just give some minimal sanity-checking, and some we ignore
273 * completely (like the next twenty bytes): */
274 if (unlikely(p + 20 > end || p + 20 < p)) {
275 p = ERR_PTR(-EFAULT);
279 p = simple_get_bytes(p, end, &tmp, sizeof(tmp));
282 if (tmp != SGN_ALG_DES_MAC_MD5) {
283 p = ERR_PTR(-ENOSYS);
286 p = simple_get_bytes(p, end, &tmp, sizeof(tmp));
289 if (tmp != SEAL_ALG_DES) {
290 p = ERR_PTR(-ENOSYS);
293 p = simple_get_bytes(p, end, &ctx->endtime, sizeof(ctx->endtime));
296 p = simple_get_bytes(p, end, &seq_send, sizeof(seq_send));
299 atomic_set(&ctx->seq_send, seq_send);
300 p = simple_get_netobj(p, end, &ctx->mech_used);
303 p = get_key(p, end, ctx, &ctx->enc);
305 goto out_err_free_mech;
306 p = get_key(p, end, ctx, &ctx->seq);
308 goto out_err_free_key1;
310 p = ERR_PTR(-EFAULT);
311 goto out_err_free_key2;
317 crypto_free_sync_skcipher(ctx->seq);
319 crypto_free_sync_skcipher(ctx->enc);
321 kfree(ctx->mech_used.data);
326 static struct crypto_sync_skcipher *
327 context_v2_alloc_cipher(struct krb5_ctx *ctx, const char *cname, u8 *key)
329 struct crypto_sync_skcipher *cp;
331 cp = crypto_alloc_sync_skcipher(cname, 0, 0);
333 dprintk("gss_kerberos_mech: unable to initialize "
334 "crypto algorithm %s\n", cname);
337 if (crypto_sync_skcipher_setkey(cp, key, ctx->gk5e->keylength)) {
338 dprintk("gss_kerberos_mech: error setting key for "
339 "crypto algorithm %s\n", cname);
340 crypto_free_sync_skcipher(cp);
347 set_cdata(u8 cdata[GSS_KRB5_K5CLENGTH], u32 usage, u8 seed)
349 cdata[0] = (usage>>24)&0xff;
350 cdata[1] = (usage>>16)&0xff;
351 cdata[2] = (usage>>8)&0xff;
352 cdata[3] = usage&0xff;
357 context_derive_keys_des3(struct krb5_ctx *ctx, gfp_t gfp_mask)
359 struct xdr_netobj c, keyin, keyout;
360 u8 cdata[GSS_KRB5_K5CLENGTH];
363 c.len = GSS_KRB5_K5CLENGTH;
366 keyin.data = ctx->Ksess;
367 keyin.len = ctx->gk5e->keylength;
368 keyout.len = ctx->gk5e->keylength;
370 /* seq uses the raw key */
371 ctx->seq = context_v2_alloc_cipher(ctx, ctx->gk5e->encrypt_name,
373 if (ctx->seq == NULL)
376 ctx->enc = context_v2_alloc_cipher(ctx, ctx->gk5e->encrypt_name,
378 if (ctx->enc == NULL)
382 set_cdata(cdata, KG_USAGE_SIGN, KEY_USAGE_SEED_CHECKSUM);
383 keyout.data = ctx->cksum;
384 err = krb5_derive_key(ctx->gk5e, &keyin, &keyout, &c, gfp_mask);
386 dprintk("%s: Error %d deriving cksum key\n",
394 crypto_free_sync_skcipher(ctx->enc);
396 crypto_free_sync_skcipher(ctx->seq);
402 * Note that RC4 depends on deriving keys using the sequence
403 * number or the checksum of a token. Therefore, the final keys
404 * cannot be calculated until the token is being constructed!
407 context_derive_keys_rc4(struct krb5_ctx *ctx)
409 struct crypto_shash *hmac;
410 char sigkeyconstant[] = "signaturekey";
411 int slen = strlen(sigkeyconstant) + 1; /* include null terminator */
412 struct shash_desc *desc;
415 dprintk("RPC: %s: entered\n", __func__);
417 * derive cksum (aka Ksign) key
419 hmac = crypto_alloc_shash(ctx->gk5e->cksum_name, 0, 0);
421 dprintk("%s: error %ld allocating hash '%s'\n",
422 __func__, PTR_ERR(hmac), ctx->gk5e->cksum_name);
427 err = crypto_shash_setkey(hmac, ctx->Ksess, ctx->gk5e->keylength);
429 goto out_err_free_hmac;
432 desc = kmalloc(sizeof(*desc) + crypto_shash_descsize(hmac), GFP_NOFS);
434 dprintk("%s: failed to allocate hash descriptor for '%s'\n",
435 __func__, ctx->gk5e->cksum_name);
437 goto out_err_free_hmac;
442 err = crypto_shash_digest(desc, sigkeyconstant, slen, ctx->cksum);
445 goto out_err_free_hmac;
447 * allocate hash, and skciphers for data and seqnum encryption
449 ctx->enc = crypto_alloc_sync_skcipher(ctx->gk5e->encrypt_name, 0, 0);
450 if (IS_ERR(ctx->enc)) {
451 err = PTR_ERR(ctx->enc);
452 goto out_err_free_hmac;
455 ctx->seq = crypto_alloc_sync_skcipher(ctx->gk5e->encrypt_name, 0, 0);
456 if (IS_ERR(ctx->seq)) {
457 crypto_free_sync_skcipher(ctx->enc);
458 err = PTR_ERR(ctx->seq);
459 goto out_err_free_hmac;
462 dprintk("RPC: %s: returning success\n", __func__);
467 crypto_free_shash(hmac);
469 dprintk("RPC: %s: returning %d\n", __func__, err);
474 context_derive_keys_new(struct krb5_ctx *ctx, gfp_t gfp_mask)
476 struct xdr_netobj c, keyin, keyout;
477 u8 cdata[GSS_KRB5_K5CLENGTH];
480 c.len = GSS_KRB5_K5CLENGTH;
483 keyin.data = ctx->Ksess;
484 keyin.len = ctx->gk5e->keylength;
485 keyout.len = ctx->gk5e->keylength;
487 /* initiator seal encryption */
488 set_cdata(cdata, KG_USAGE_INITIATOR_SEAL, KEY_USAGE_SEED_ENCRYPTION);
489 keyout.data = ctx->initiator_seal;
490 err = krb5_derive_key(ctx->gk5e, &keyin, &keyout, &c, gfp_mask);
492 dprintk("%s: Error %d deriving initiator_seal key\n",
496 ctx->initiator_enc = context_v2_alloc_cipher(ctx,
497 ctx->gk5e->encrypt_name,
498 ctx->initiator_seal);
499 if (ctx->initiator_enc == NULL)
502 /* acceptor seal encryption */
503 set_cdata(cdata, KG_USAGE_ACCEPTOR_SEAL, KEY_USAGE_SEED_ENCRYPTION);
504 keyout.data = ctx->acceptor_seal;
505 err = krb5_derive_key(ctx->gk5e, &keyin, &keyout, &c, gfp_mask);
507 dprintk("%s: Error %d deriving acceptor_seal key\n",
509 goto out_free_initiator_enc;
511 ctx->acceptor_enc = context_v2_alloc_cipher(ctx,
512 ctx->gk5e->encrypt_name,
514 if (ctx->acceptor_enc == NULL)
515 goto out_free_initiator_enc;
517 /* initiator sign checksum */
518 set_cdata(cdata, KG_USAGE_INITIATOR_SIGN, KEY_USAGE_SEED_CHECKSUM);
519 keyout.data = ctx->initiator_sign;
520 err = krb5_derive_key(ctx->gk5e, &keyin, &keyout, &c, gfp_mask);
522 dprintk("%s: Error %d deriving initiator_sign key\n",
524 goto out_free_acceptor_enc;
527 /* acceptor sign checksum */
528 set_cdata(cdata, KG_USAGE_ACCEPTOR_SIGN, KEY_USAGE_SEED_CHECKSUM);
529 keyout.data = ctx->acceptor_sign;
530 err = krb5_derive_key(ctx->gk5e, &keyin, &keyout, &c, gfp_mask);
532 dprintk("%s: Error %d deriving acceptor_sign key\n",
534 goto out_free_acceptor_enc;
537 /* initiator seal integrity */
538 set_cdata(cdata, KG_USAGE_INITIATOR_SEAL, KEY_USAGE_SEED_INTEGRITY);
539 keyout.data = ctx->initiator_integ;
540 err = krb5_derive_key(ctx->gk5e, &keyin, &keyout, &c, gfp_mask);
542 dprintk("%s: Error %d deriving initiator_integ key\n",
544 goto out_free_acceptor_enc;
547 /* acceptor seal integrity */
548 set_cdata(cdata, KG_USAGE_ACCEPTOR_SEAL, KEY_USAGE_SEED_INTEGRITY);
549 keyout.data = ctx->acceptor_integ;
550 err = krb5_derive_key(ctx->gk5e, &keyin, &keyout, &c, gfp_mask);
552 dprintk("%s: Error %d deriving acceptor_integ key\n",
554 goto out_free_acceptor_enc;
557 switch (ctx->enctype) {
558 case ENCTYPE_AES128_CTS_HMAC_SHA1_96:
559 case ENCTYPE_AES256_CTS_HMAC_SHA1_96:
560 ctx->initiator_enc_aux =
561 context_v2_alloc_cipher(ctx, "cbc(aes)",
562 ctx->initiator_seal);
563 if (ctx->initiator_enc_aux == NULL)
564 goto out_free_acceptor_enc;
565 ctx->acceptor_enc_aux =
566 context_v2_alloc_cipher(ctx, "cbc(aes)",
568 if (ctx->acceptor_enc_aux == NULL) {
569 crypto_free_sync_skcipher(ctx->initiator_enc_aux);
570 goto out_free_acceptor_enc;
576 out_free_acceptor_enc:
577 crypto_free_sync_skcipher(ctx->acceptor_enc);
578 out_free_initiator_enc:
579 crypto_free_sync_skcipher(ctx->initiator_enc);
585 gss_import_v2_context(const void *p, const void *end, struct krb5_ctx *ctx,
591 p = simple_get_bytes(p, end, &ctx->flags, sizeof(ctx->flags));
594 ctx->initiate = ctx->flags & KRB5_CTX_FLAG_INITIATOR;
596 p = simple_get_bytes(p, end, &ctx->endtime, sizeof(ctx->endtime));
599 p = simple_get_bytes(p, end, &seq_send64, sizeof(seq_send64));
602 atomic64_set(&ctx->seq_send64, seq_send64);
603 /* set seq_send for use by "older" enctypes */
604 atomic_set(&ctx->seq_send, seq_send64);
605 if (seq_send64 != atomic_read(&ctx->seq_send)) {
606 dprintk("%s: seq_send64 %llx, seq_send %x overflow?\n", __func__,
607 seq_send64, atomic_read(&ctx->seq_send));
608 p = ERR_PTR(-EINVAL);
611 p = simple_get_bytes(p, end, &ctx->enctype, sizeof(ctx->enctype));
614 /* Map ENCTYPE_DES3_CBC_SHA1 to ENCTYPE_DES3_CBC_RAW */
615 if (ctx->enctype == ENCTYPE_DES3_CBC_SHA1)
616 ctx->enctype = ENCTYPE_DES3_CBC_RAW;
617 ctx->gk5e = get_gss_krb5_enctype(ctx->enctype);
618 if (ctx->gk5e == NULL) {
619 dprintk("gss_kerberos_mech: unsupported krb5 enctype %u\n",
621 p = ERR_PTR(-EINVAL);
624 keylen = ctx->gk5e->keylength;
626 p = simple_get_bytes(p, end, ctx->Ksess, keylen);
631 p = ERR_PTR(-EINVAL);
635 ctx->mech_used.data = kmemdup(gss_kerberos_mech.gm_oid.data,
636 gss_kerberos_mech.gm_oid.len, gfp_mask);
637 if (unlikely(ctx->mech_used.data == NULL)) {
638 p = ERR_PTR(-ENOMEM);
641 ctx->mech_used.len = gss_kerberos_mech.gm_oid.len;
643 switch (ctx->enctype) {
644 case ENCTYPE_DES3_CBC_RAW:
645 return context_derive_keys_des3(ctx, gfp_mask);
646 case ENCTYPE_ARCFOUR_HMAC:
647 return context_derive_keys_rc4(ctx);
648 case ENCTYPE_AES128_CTS_HMAC_SHA1_96:
649 case ENCTYPE_AES256_CTS_HMAC_SHA1_96:
650 return context_derive_keys_new(ctx, gfp_mask);
660 gss_import_sec_context_kerberos(const void *p, size_t len,
661 struct gss_ctx *ctx_id,
665 const void *end = (const void *)((const char *)p + len);
666 struct krb5_ctx *ctx;
669 ctx = kzalloc(sizeof(*ctx), gfp_mask);
674 ret = gss_import_v1_context(p, end, ctx);
676 ret = gss_import_v2_context(p, end, ctx, gfp_mask);
679 ctx_id->internal_ctx_id = ctx;
681 *endtime = ctx->endtime;
685 dprintk("RPC: %s: returning %d\n", __func__, ret);
690 gss_delete_sec_context_kerberos(void *internal_ctx) {
691 struct krb5_ctx *kctx = internal_ctx;
693 crypto_free_sync_skcipher(kctx->seq);
694 crypto_free_sync_skcipher(kctx->enc);
695 crypto_free_sync_skcipher(kctx->acceptor_enc);
696 crypto_free_sync_skcipher(kctx->initiator_enc);
697 crypto_free_sync_skcipher(kctx->acceptor_enc_aux);
698 crypto_free_sync_skcipher(kctx->initiator_enc_aux);
699 kfree(kctx->mech_used.data);
703 static const struct gss_api_ops gss_kerberos_ops = {
704 .gss_import_sec_context = gss_import_sec_context_kerberos,
705 .gss_get_mic = gss_get_mic_kerberos,
706 .gss_verify_mic = gss_verify_mic_kerberos,
707 .gss_wrap = gss_wrap_kerberos,
708 .gss_unwrap = gss_unwrap_kerberos,
709 .gss_delete_sec_context = gss_delete_sec_context_kerberos,
712 static struct pf_desc gss_kerberos_pfs[] = {
714 .pseudoflavor = RPC_AUTH_GSS_KRB5,
715 .qop = GSS_C_QOP_DEFAULT,
716 .service = RPC_GSS_SVC_NONE,
720 .pseudoflavor = RPC_AUTH_GSS_KRB5I,
721 .qop = GSS_C_QOP_DEFAULT,
722 .service = RPC_GSS_SVC_INTEGRITY,
727 .pseudoflavor = RPC_AUTH_GSS_KRB5P,
728 .qop = GSS_C_QOP_DEFAULT,
729 .service = RPC_GSS_SVC_PRIVACY,
735 MODULE_ALIAS("rpc-auth-gss-krb5");
736 MODULE_ALIAS("rpc-auth-gss-krb5i");
737 MODULE_ALIAS("rpc-auth-gss-krb5p");
738 MODULE_ALIAS("rpc-auth-gss-390003");
739 MODULE_ALIAS("rpc-auth-gss-390004");
740 MODULE_ALIAS("rpc-auth-gss-390005");
741 MODULE_ALIAS("rpc-auth-gss-1.2.840.113554.1.2.2");
743 static struct gss_api_mech gss_kerberos_mech = {
745 .gm_owner = THIS_MODULE,
746 .gm_oid = { 9, "\x2a\x86\x48\x86\xf7\x12\x01\x02\x02" },
747 .gm_ops = &gss_kerberos_ops,
748 .gm_pf_num = ARRAY_SIZE(gss_kerberos_pfs),
749 .gm_pfs = gss_kerberos_pfs,
750 .gm_upcall_enctypes = KRB5_SUPPORTED_ENCTYPES,
753 static int __init init_kerberos_module(void)
757 status = gss_mech_register(&gss_kerberos_mech);
759 printk("Failed to register kerberos gss mechanism!\n");
763 static void __exit cleanup_kerberos_module(void)
765 gss_mech_unregister(&gss_kerberos_mech);
768 MODULE_LICENSE("GPL");
769 module_init(init_kerberos_module);
770 module_exit(cleanup_kerberos_module);