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>
48 # define RPCDBG_FACILITY RPCDBG_AUTH
51 static struct gss_api_mech gss_kerberos_mech; /* forward declaration */
53 static const struct gss_krb5_enctype supported_gss_krb5_enctypes[] = {
55 * DES (All DES enctypes are mapped to the same gss functionality)
58 .etype = ENCTYPE_DES_CBC_RAW,
59 .ctype = CKSUMTYPE_RSA_MD5,
60 .name = "des-cbc-crc",
61 .encrypt_name = "cbc(des)",
63 .encrypt = krb5_encrypt,
64 .decrypt = krb5_decrypt,
66 .signalg = SGN_ALG_DES_MAC_MD5,
67 .sealalg = SEAL_ALG_DES,
78 .etype = ENCTYPE_DES3_CBC_RAW,
79 .ctype = CKSUMTYPE_HMAC_SHA1_DES3,
80 .name = "des3-hmac-sha1",
81 .encrypt_name = "cbc(des3_ede)",
82 .cksum_name = "hmac(sha1)",
83 .encrypt = krb5_encrypt,
84 .decrypt = krb5_decrypt,
85 .mk_key = gss_krb5_des3_make_key,
86 .signalg = SGN_ALG_HMAC_SHA1_DES3_KD,
87 .sealalg = SEAL_ALG_DES3KD,
96 static const int num_supported_enctypes =
97 ARRAY_SIZE(supported_gss_krb5_enctypes);
100 supported_gss_krb5_enctype(int etype)
103 for (i = 0; i < num_supported_enctypes; i++)
104 if (supported_gss_krb5_enctypes[i].etype == etype)
109 static const struct gss_krb5_enctype *
110 get_gss_krb5_enctype(int etype)
113 for (i = 0; i < num_supported_enctypes; i++)
114 if (supported_gss_krb5_enctypes[i].etype == etype)
115 return &supported_gss_krb5_enctypes[i];
120 simple_get_bytes(const void *p, const void *end, void *res, int len)
122 const void *q = (const void *)((const char *)p + len);
123 if (unlikely(q > end || q < p))
124 return ERR_PTR(-EFAULT);
130 simple_get_netobj(const void *p, const void *end, struct xdr_netobj *res)
135 p = simple_get_bytes(p, end, &len, sizeof(len));
138 q = (const void *)((const char *)p + len);
139 if (unlikely(q > end || q < p))
140 return ERR_PTR(-EFAULT);
141 res->data = kmemdup(p, len, GFP_NOFS);
142 if (unlikely(res->data == NULL))
143 return ERR_PTR(-ENOMEM);
148 static inline const void *
149 get_key(const void *p, const void *end,
150 struct krb5_ctx *ctx, struct crypto_blkcipher **res)
152 struct xdr_netobj key;
155 p = simple_get_bytes(p, end, &alg, sizeof(alg));
160 case ENCTYPE_DES_CBC_CRC:
161 case ENCTYPE_DES_CBC_MD4:
162 case ENCTYPE_DES_CBC_MD5:
163 /* Map all these key types to ENCTYPE_DES_CBC_RAW */
164 alg = ENCTYPE_DES_CBC_RAW;
168 if (!supported_gss_krb5_enctype(alg)) {
169 printk(KERN_WARNING "gss_kerberos_mech: unsupported "
170 "encryption key algorithm %d\n", alg);
173 p = simple_get_netobj(p, end, &key);
177 *res = crypto_alloc_blkcipher(ctx->gk5e->encrypt_name, 0,
180 printk(KERN_WARNING "gss_kerberos_mech: unable to initialize "
181 "crypto algorithm %s\n", ctx->gk5e->encrypt_name);
183 goto out_err_free_key;
185 if (crypto_blkcipher_setkey(*res, key.data, key.len)) {
186 printk(KERN_WARNING "gss_kerberos_mech: error setting key for "
187 "crypto algorithm %s\n", ctx->gk5e->encrypt_name);
188 goto out_err_free_tfm;
195 crypto_free_blkcipher(*res);
198 p = ERR_PTR(-EINVAL);
204 gss_import_v1_context(const void *p, const void *end, struct krb5_ctx *ctx)
208 p = simple_get_bytes(p, end, &ctx->initiate, sizeof(ctx->initiate));
212 /* Old format supports only DES! Any other enctype uses new format */
213 ctx->enctype = ENCTYPE_DES_CBC_RAW;
215 ctx->gk5e = get_gss_krb5_enctype(ctx->enctype);
216 if (ctx->gk5e == NULL)
219 /* The downcall format was designed before we completely understood
220 * the uses of the context fields; so it includes some stuff we
221 * just give some minimal sanity-checking, and some we ignore
222 * completely (like the next twenty bytes): */
223 if (unlikely(p + 20 > end || p + 20 < p))
226 p = simple_get_bytes(p, end, &tmp, sizeof(tmp));
229 if (tmp != SGN_ALG_DES_MAC_MD5) {
230 p = ERR_PTR(-ENOSYS);
233 p = simple_get_bytes(p, end, &tmp, sizeof(tmp));
236 if (tmp != SEAL_ALG_DES) {
237 p = ERR_PTR(-ENOSYS);
240 p = simple_get_bytes(p, end, &ctx->endtime, sizeof(ctx->endtime));
243 p = simple_get_bytes(p, end, &ctx->seq_send, sizeof(ctx->seq_send));
246 p = simple_get_netobj(p, end, &ctx->mech_used);
249 p = get_key(p, end, ctx, &ctx->enc);
251 goto out_err_free_mech;
252 p = get_key(p, end, ctx, &ctx->seq);
254 goto out_err_free_key1;
256 p = ERR_PTR(-EFAULT);
257 goto out_err_free_key2;
263 crypto_free_blkcipher(ctx->seq);
265 crypto_free_blkcipher(ctx->enc);
267 kfree(ctx->mech_used.data);
272 struct crypto_blkcipher *
273 context_v2_alloc_cipher(struct krb5_ctx *ctx, u8 *key)
275 struct crypto_blkcipher *cp;
277 cp = crypto_alloc_blkcipher(ctx->gk5e->encrypt_name,
278 0, CRYPTO_ALG_ASYNC);
280 dprintk("gss_kerberos_mech: unable to initialize "
281 "crypto algorithm %s\n", ctx->gk5e->encrypt_name);
284 if (crypto_blkcipher_setkey(cp, key, ctx->gk5e->keylength)) {
285 dprintk("gss_kerberos_mech: error setting key for "
286 "crypto algorithm %s\n", ctx->gk5e->encrypt_name);
287 crypto_free_blkcipher(cp);
294 set_cdata(u8 cdata[GSS_KRB5_K5CLENGTH], u32 usage, u8 seed)
296 cdata[0] = (usage>>24)&0xff;
297 cdata[1] = (usage>>16)&0xff;
298 cdata[2] = (usage>>8)&0xff;
299 cdata[3] = usage&0xff;
304 context_derive_keys_des3(struct krb5_ctx *ctx, u8 *rawkey, u32 keylen)
306 struct xdr_netobj c, keyin, keyout;
307 u8 cdata[GSS_KRB5_K5CLENGTH];
310 c.len = GSS_KRB5_K5CLENGTH;
317 /* seq uses the raw key */
318 ctx->seq = context_v2_alloc_cipher(ctx, rawkey);
319 if (ctx->seq == NULL)
322 ctx->enc = context_v2_alloc_cipher(ctx, rawkey);
323 if (ctx->enc == NULL)
327 set_cdata(cdata, KG_USAGE_SIGN, KEY_USAGE_SEED_CHECKSUM);
328 keyout.data = ctx->cksum;
329 err = krb5_derive_key(ctx->gk5e, &keyin, &keyout, &c);
331 dprintk("%s: Error %d deriving cksum key\n",
339 crypto_free_blkcipher(ctx->enc);
341 crypto_free_blkcipher(ctx->seq);
347 context_derive_keys_new(struct krb5_ctx *ctx, u8 *rawkey, u32 keylen)
349 struct xdr_netobj c, keyin, keyout;
350 u8 cdata[GSS_KRB5_K5CLENGTH];
353 c.len = GSS_KRB5_K5CLENGTH;
360 /* initiator seal encryption */
361 set_cdata(cdata, KG_USAGE_INITIATOR_SEAL, KEY_USAGE_SEED_ENCRYPTION);
362 keyout.data = ctx->initiator_seal;
363 err = krb5_derive_key(ctx->gk5e, &keyin, &keyout, &c);
365 dprintk("%s: Error %d deriving initiator_seal key\n",
369 ctx->initiator_enc = context_v2_alloc_cipher(ctx, ctx->initiator_seal);
370 if (ctx->initiator_enc == NULL)
373 /* acceptor seal encryption */
374 set_cdata(cdata, KG_USAGE_ACCEPTOR_SEAL, KEY_USAGE_SEED_ENCRYPTION);
375 keyout.data = ctx->acceptor_seal;
376 err = krb5_derive_key(ctx->gk5e, &keyin, &keyout, &c);
378 dprintk("%s: Error %d deriving acceptor_seal key\n",
380 goto out_free_initiator_enc;
382 ctx->acceptor_enc = context_v2_alloc_cipher(ctx, ctx->acceptor_seal);
383 if (ctx->acceptor_enc == NULL)
384 goto out_free_initiator_enc;
386 /* initiator sign checksum */
387 set_cdata(cdata, KG_USAGE_INITIATOR_SIGN, KEY_USAGE_SEED_CHECKSUM);
388 keyout.data = ctx->initiator_sign;
389 err = krb5_derive_key(ctx->gk5e, &keyin, &keyout, &c);
391 dprintk("%s: Error %d deriving initiator_sign key\n",
393 goto out_free_acceptor_enc;
396 /* acceptor sign checksum */
397 set_cdata(cdata, KG_USAGE_ACCEPTOR_SIGN, KEY_USAGE_SEED_CHECKSUM);
398 keyout.data = ctx->acceptor_sign;
399 err = krb5_derive_key(ctx->gk5e, &keyin, &keyout, &c);
401 dprintk("%s: Error %d deriving acceptor_sign key\n",
403 goto out_free_acceptor_enc;
406 /* initiator seal integrity */
407 set_cdata(cdata, KG_USAGE_INITIATOR_SEAL, KEY_USAGE_SEED_INTEGRITY);
408 keyout.data = ctx->initiator_integ;
409 err = krb5_derive_key(ctx->gk5e, &keyin, &keyout, &c);
411 dprintk("%s: Error %d deriving initiator_integ key\n",
413 goto out_free_acceptor_enc;
416 /* acceptor seal integrity */
417 set_cdata(cdata, KG_USAGE_ACCEPTOR_SEAL, KEY_USAGE_SEED_INTEGRITY);
418 keyout.data = ctx->acceptor_integ;
419 err = krb5_derive_key(ctx->gk5e, &keyin, &keyout, &c);
421 dprintk("%s: Error %d deriving acceptor_integ key\n",
423 goto out_free_acceptor_enc;
428 out_free_acceptor_enc:
429 crypto_free_blkcipher(ctx->acceptor_enc);
430 out_free_initiator_enc:
431 crypto_free_blkcipher(ctx->initiator_enc);
437 gss_import_v2_context(const void *p, const void *end, struct krb5_ctx *ctx)
439 u8 rawkey[GSS_KRB5_MAX_KEYLEN];
442 p = simple_get_bytes(p, end, &ctx->flags, sizeof(ctx->flags));
445 ctx->initiate = ctx->flags & KRB5_CTX_FLAG_INITIATOR;
447 p = simple_get_bytes(p, end, &ctx->endtime, sizeof(ctx->endtime));
450 p = simple_get_bytes(p, end, &ctx->seq_send64, sizeof(ctx->seq_send64));
453 /* set seq_send for use by "older" enctypes */
454 ctx->seq_send = ctx->seq_send64;
455 if (ctx->seq_send64 != ctx->seq_send) {
456 dprintk("%s: seq_send64 %lx, seq_send %x overflow?\n", __func__,
457 (long unsigned)ctx->seq_send64, ctx->seq_send);
460 p = simple_get_bytes(p, end, &ctx->enctype, sizeof(ctx->enctype));
463 /* Map ENCTYPE_DES3_CBC_SHA1 to ENCTYPE_DES3_CBC_RAW */
464 if (ctx->enctype == ENCTYPE_DES3_CBC_SHA1)
465 ctx->enctype = ENCTYPE_DES3_CBC_RAW;
466 ctx->gk5e = get_gss_krb5_enctype(ctx->enctype);
467 if (ctx->gk5e == NULL) {
468 dprintk("gss_kerberos_mech: unsupported krb5 enctype %u\n",
470 p = ERR_PTR(-EINVAL);
473 keylen = ctx->gk5e->keylength;
475 p = simple_get_bytes(p, end, rawkey, keylen);
480 p = ERR_PTR(-EINVAL);
484 ctx->mech_used.data = kmemdup(gss_kerberos_mech.gm_oid.data,
485 gss_kerberos_mech.gm_oid.len, GFP_KERNEL);
486 if (unlikely(ctx->mech_used.data == NULL)) {
487 p = ERR_PTR(-ENOMEM);
490 ctx->mech_used.len = gss_kerberos_mech.gm_oid.len;
492 switch (ctx->enctype) {
493 case ENCTYPE_DES3_CBC_RAW:
494 return context_derive_keys_des3(ctx, rawkey, keylen);
495 case ENCTYPE_AES128_CTS_HMAC_SHA1_96:
496 case ENCTYPE_AES256_CTS_HMAC_SHA1_96:
497 return context_derive_keys_new(ctx, rawkey, keylen);
507 gss_import_sec_context_kerberos(const void *p, size_t len,
508 struct gss_ctx *ctx_id)
510 const void *end = (const void *)((const char *)p + len);
511 struct krb5_ctx *ctx;
514 ctx = kzalloc(sizeof(*ctx), GFP_KERNEL);
519 ret = gss_import_v1_context(p, end, ctx);
521 ret = gss_import_v2_context(p, end, ctx);
524 ctx_id->internal_ctx_id = ctx;
528 dprintk("RPC: %s: returning %d\n", __func__, ret);
533 gss_delete_sec_context_kerberos(void *internal_ctx) {
534 struct krb5_ctx *kctx = internal_ctx;
536 crypto_free_blkcipher(kctx->seq);
537 crypto_free_blkcipher(kctx->enc);
538 crypto_free_blkcipher(kctx->acceptor_enc);
539 crypto_free_blkcipher(kctx->initiator_enc);
540 kfree(kctx->mech_used.data);
544 static const struct gss_api_ops gss_kerberos_ops = {
545 .gss_import_sec_context = gss_import_sec_context_kerberos,
546 .gss_get_mic = gss_get_mic_kerberos,
547 .gss_verify_mic = gss_verify_mic_kerberos,
548 .gss_wrap = gss_wrap_kerberos,
549 .gss_unwrap = gss_unwrap_kerberos,
550 .gss_delete_sec_context = gss_delete_sec_context_kerberos,
553 static struct pf_desc gss_kerberos_pfs[] = {
555 .pseudoflavor = RPC_AUTH_GSS_KRB5,
556 .service = RPC_GSS_SVC_NONE,
560 .pseudoflavor = RPC_AUTH_GSS_KRB5I,
561 .service = RPC_GSS_SVC_INTEGRITY,
565 .pseudoflavor = RPC_AUTH_GSS_KRB5P,
566 .service = RPC_GSS_SVC_PRIVACY,
571 static struct gss_api_mech gss_kerberos_mech = {
573 .gm_owner = THIS_MODULE,
574 .gm_oid = {9, (void *)"\x2a\x86\x48\x86\xf7\x12\x01\x02\x02"},
575 .gm_ops = &gss_kerberos_ops,
576 .gm_pf_num = ARRAY_SIZE(gss_kerberos_pfs),
577 .gm_pfs = gss_kerberos_pfs,
578 .gm_upcall_enctypes = "enctypes=16,3,1,2 ",
581 static int __init init_kerberos_module(void)
585 status = gss_mech_register(&gss_kerberos_mech);
587 printk("Failed to register kerberos gss mechanism!\n");
591 static void __exit cleanup_kerberos_module(void)
593 gss_mech_unregister(&gss_kerberos_mech);
596 MODULE_LICENSE("GPL");
597 module_init(init_kerberos_module);
598 module_exit(cleanup_kerberos_module);