gss_krb5: add support for triple-des encryption
[safe/jmp/linux-2.6] / net / sunrpc / auth_gss / gss_krb5_mech.c
1 /*
2  *  linux/net/sunrpc/gss_krb5_mech.c
3  *
4  *  Copyright (c) 2001-2008 The Regents of the University of Michigan.
5  *  All rights reserved.
6  *
7  *  Andy Adamson <andros@umich.edu>
8  *  J. Bruce Fields <bfields@umich.edu>
9  *
10  *  Redistribution and use in source and binary forms, with or without
11  *  modification, are permitted provided that the following conditions
12  *  are met:
13  *
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.
22  *
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.
34  *
35  */
36
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
47 #ifdef RPC_DEBUG
48 # define RPCDBG_FACILITY        RPCDBG_AUTH
49 #endif
50
51 static struct gss_api_mech gss_kerberos_mech;   /* forward declaration */
52
53 static const struct gss_krb5_enctype supported_gss_krb5_enctypes[] = {
54         /*
55          * DES (All DES enctypes are mapped to the same gss functionality)
56          */
57         {
58           .etype = ENCTYPE_DES_CBC_RAW,
59           .ctype = CKSUMTYPE_RSA_MD5,
60           .name = "des-cbc-crc",
61           .encrypt_name = "cbc(des)",
62           .cksum_name = "md5",
63           .encrypt = krb5_encrypt,
64           .decrypt = krb5_decrypt,
65           .mk_key = NULL,
66           .signalg = SGN_ALG_DES_MAC_MD5,
67           .sealalg = SEAL_ALG_DES,
68           .keybytes = 7,
69           .keylength = 8,
70           .blocksize = 8,
71           .cksumlength = 8,
72           .keyed_cksum = 0,
73         },
74         /*
75          * 3DES
76          */
77         {
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,
88           .keybytes = 21,
89           .keylength = 24,
90           .blocksize = 8,
91           .cksumlength = 20,
92           .keyed_cksum = 1,
93         },
94 };
95
96 static const int num_supported_enctypes =
97         ARRAY_SIZE(supported_gss_krb5_enctypes);
98
99 static int
100 supported_gss_krb5_enctype(int etype)
101 {
102         int i;
103         for (i = 0; i < num_supported_enctypes; i++)
104                 if (supported_gss_krb5_enctypes[i].etype == etype)
105                         return 1;
106         return 0;
107 }
108
109 static const struct gss_krb5_enctype *
110 get_gss_krb5_enctype(int etype)
111 {
112         int i;
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];
116         return NULL;
117 }
118
119 static const void *
120 simple_get_bytes(const void *p, const void *end, void *res, int len)
121 {
122         const void *q = (const void *)((const char *)p + len);
123         if (unlikely(q > end || q < p))
124                 return ERR_PTR(-EFAULT);
125         memcpy(res, p, len);
126         return q;
127 }
128
129 static const void *
130 simple_get_netobj(const void *p, const void *end, struct xdr_netobj *res)
131 {
132         const void *q;
133         unsigned int len;
134
135         p = simple_get_bytes(p, end, &len, sizeof(len));
136         if (IS_ERR(p))
137                 return p;
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);
144         res->len = len;
145         return q;
146 }
147
148 static inline const void *
149 get_key(const void *p, const void *end,
150         struct krb5_ctx *ctx, struct crypto_blkcipher **res)
151 {
152         struct xdr_netobj       key;
153         int                     alg;
154
155         p = simple_get_bytes(p, end, &alg, sizeof(alg));
156         if (IS_ERR(p))
157                 goto out_err;
158
159         switch (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;
165                 break;
166         }
167
168         if (!supported_gss_krb5_enctype(alg)) {
169                 printk(KERN_WARNING "gss_kerberos_mech: unsupported "
170                         "encryption key algorithm %d\n", alg);
171                 goto out_err;
172         }
173         p = simple_get_netobj(p, end, &key);
174         if (IS_ERR(p))
175                 goto out_err;
176
177         *res = crypto_alloc_blkcipher(ctx->gk5e->encrypt_name, 0,
178                                                         CRYPTO_ALG_ASYNC);
179         if (IS_ERR(*res)) {
180                 printk(KERN_WARNING "gss_kerberos_mech: unable to initialize "
181                         "crypto algorithm %s\n", ctx->gk5e->encrypt_name);
182                 *res = NULL;
183                 goto out_err_free_key;
184         }
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;
189         }
190
191         kfree(key.data);
192         return p;
193
194 out_err_free_tfm:
195         crypto_free_blkcipher(*res);
196 out_err_free_key:
197         kfree(key.data);
198         p = ERR_PTR(-EINVAL);
199 out_err:
200         return p;
201 }
202
203 static int
204 gss_import_v1_context(const void *p, const void *end, struct krb5_ctx *ctx)
205 {
206         int tmp;
207
208         p = simple_get_bytes(p, end, &ctx->initiate, sizeof(ctx->initiate));
209         if (IS_ERR(p))
210                 goto out_err;
211
212         /* Old format supports only DES!  Any other enctype uses new format */
213         ctx->enctype = ENCTYPE_DES_CBC_RAW;
214
215         ctx->gk5e = get_gss_krb5_enctype(ctx->enctype);
216         if (ctx->gk5e == NULL)
217                 goto out_err;
218
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))
224                 goto out_err;
225         p += 20;
226         p = simple_get_bytes(p, end, &tmp, sizeof(tmp));
227         if (IS_ERR(p))
228                 goto out_err;
229         if (tmp != SGN_ALG_DES_MAC_MD5) {
230                 p = ERR_PTR(-ENOSYS);
231                 goto out_err;
232         }
233         p = simple_get_bytes(p, end, &tmp, sizeof(tmp));
234         if (IS_ERR(p))
235                 goto out_err;
236         if (tmp != SEAL_ALG_DES) {
237                 p = ERR_PTR(-ENOSYS);
238                 goto out_err;
239         }
240         p = simple_get_bytes(p, end, &ctx->endtime, sizeof(ctx->endtime));
241         if (IS_ERR(p))
242                 goto out_err;
243         p = simple_get_bytes(p, end, &ctx->seq_send, sizeof(ctx->seq_send));
244         if (IS_ERR(p))
245                 goto out_err;
246         p = simple_get_netobj(p, end, &ctx->mech_used);
247         if (IS_ERR(p))
248                 goto out_err;
249         p = get_key(p, end, ctx, &ctx->enc);
250         if (IS_ERR(p))
251                 goto out_err_free_mech;
252         p = get_key(p, end, ctx, &ctx->seq);
253         if (IS_ERR(p))
254                 goto out_err_free_key1;
255         if (p != end) {
256                 p = ERR_PTR(-EFAULT);
257                 goto out_err_free_key2;
258         }
259
260         return 0;
261
262 out_err_free_key2:
263         crypto_free_blkcipher(ctx->seq);
264 out_err_free_key1:
265         crypto_free_blkcipher(ctx->enc);
266 out_err_free_mech:
267         kfree(ctx->mech_used.data);
268 out_err:
269         return PTR_ERR(p);
270 }
271
272 struct crypto_blkcipher *
273 context_v2_alloc_cipher(struct krb5_ctx *ctx, u8 *key)
274 {
275         struct crypto_blkcipher *cp;
276
277         cp = crypto_alloc_blkcipher(ctx->gk5e->encrypt_name,
278                                         0, CRYPTO_ALG_ASYNC);
279         if (IS_ERR(cp)) {
280                 dprintk("gss_kerberos_mech: unable to initialize "
281                         "crypto algorithm %s\n", ctx->gk5e->encrypt_name);
282                 return NULL;
283         }
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);
288                 return NULL;
289         }
290         return cp;
291 }
292
293 static inline void
294 set_cdata(u8 cdata[GSS_KRB5_K5CLENGTH], u32 usage, u8 seed)
295 {
296         cdata[0] = (usage>>24)&0xff;
297         cdata[1] = (usage>>16)&0xff;
298         cdata[2] = (usage>>8)&0xff;
299         cdata[3] = usage&0xff;
300         cdata[4] = seed;
301 }
302
303 static int
304 context_derive_keys_des3(struct krb5_ctx *ctx, u8 *rawkey, u32 keylen)
305 {
306         struct xdr_netobj c, keyin, keyout;
307         u8 cdata[GSS_KRB5_K5CLENGTH];
308         u32 err;
309
310         c.len = GSS_KRB5_K5CLENGTH;
311         c.data = cdata;
312
313         keyin.data = rawkey;
314         keyin.len = keylen;
315         keyout.len = keylen;
316
317         /* seq uses the raw key */
318         ctx->seq = context_v2_alloc_cipher(ctx, rawkey);
319         if (ctx->seq == NULL)
320                 goto out_err;
321
322         ctx->enc = context_v2_alloc_cipher(ctx, rawkey);
323         if (ctx->enc == NULL)
324                 goto out_free_seq;
325
326         /* derive cksum */
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);
330         if (err) {
331                 dprintk("%s: Error %d deriving cksum key\n",
332                         __func__, err);
333                 goto out_free_enc;
334         }
335
336         return 0;
337
338 out_free_enc:
339         crypto_free_blkcipher(ctx->enc);
340 out_free_seq:
341         crypto_free_blkcipher(ctx->seq);
342 out_err:
343         return -EINVAL;
344 }
345
346 static int
347 context_derive_keys_new(struct krb5_ctx *ctx, u8 *rawkey, u32 keylen)
348 {
349         struct xdr_netobj c, keyin, keyout;
350         u8 cdata[GSS_KRB5_K5CLENGTH];
351         u32 err;
352
353         c.len = GSS_KRB5_K5CLENGTH;
354         c.data = cdata;
355
356         keyin.data = rawkey;
357         keyin.len = keylen;
358         keyout.len = keylen;
359
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);
364         if (err) {
365                 dprintk("%s: Error %d deriving initiator_seal key\n",
366                         __func__, err);
367                 goto out_err;
368         }
369         ctx->initiator_enc = context_v2_alloc_cipher(ctx, ctx->initiator_seal);
370         if (ctx->initiator_enc == NULL)
371                 goto out_err;
372
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);
377         if (err) {
378                 dprintk("%s: Error %d deriving acceptor_seal key\n",
379                         __func__, err);
380                 goto out_free_initiator_enc;
381         }
382         ctx->acceptor_enc = context_v2_alloc_cipher(ctx, ctx->acceptor_seal);
383         if (ctx->acceptor_enc == NULL)
384                 goto out_free_initiator_enc;
385
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);
390         if (err) {
391                 dprintk("%s: Error %d deriving initiator_sign key\n",
392                         __func__, err);
393                 goto out_free_acceptor_enc;
394         }
395
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);
400         if (err) {
401                 dprintk("%s: Error %d deriving acceptor_sign key\n",
402                         __func__, err);
403                 goto out_free_acceptor_enc;
404         }
405
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);
410         if (err) {
411                 dprintk("%s: Error %d deriving initiator_integ key\n",
412                         __func__, err);
413                 goto out_free_acceptor_enc;
414         }
415
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);
420         if (err) {
421                 dprintk("%s: Error %d deriving acceptor_integ key\n",
422                         __func__, err);
423                 goto out_free_acceptor_enc;
424         }
425
426         return 0;
427
428 out_free_acceptor_enc:
429         crypto_free_blkcipher(ctx->acceptor_enc);
430 out_free_initiator_enc:
431         crypto_free_blkcipher(ctx->initiator_enc);
432 out_err:
433         return -EINVAL;
434 }
435
436 static int
437 gss_import_v2_context(const void *p, const void *end, struct krb5_ctx *ctx)
438 {
439         u8 rawkey[GSS_KRB5_MAX_KEYLEN];
440         int keylen;
441
442         p = simple_get_bytes(p, end, &ctx->flags, sizeof(ctx->flags));
443         if (IS_ERR(p))
444                 goto out_err;
445         ctx->initiate = ctx->flags & KRB5_CTX_FLAG_INITIATOR;
446
447         p = simple_get_bytes(p, end, &ctx->endtime, sizeof(ctx->endtime));
448         if (IS_ERR(p))
449                 goto out_err;
450         p = simple_get_bytes(p, end, &ctx->seq_send64, sizeof(ctx->seq_send64));
451         if (IS_ERR(p))
452                 goto out_err;
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);
458                 goto out_err;
459         }
460         p = simple_get_bytes(p, end, &ctx->enctype, sizeof(ctx->enctype));
461         if (IS_ERR(p))
462                 goto out_err;
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",
469                         ctx->enctype);
470                 p = ERR_PTR(-EINVAL);
471                 goto out_err;
472         }
473         keylen = ctx->gk5e->keylength;
474
475         p = simple_get_bytes(p, end, rawkey, keylen);
476         if (IS_ERR(p))
477                 goto out_err;
478
479         if (p != end) {
480                 p = ERR_PTR(-EINVAL);
481                 goto out_err;
482         }
483
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);
488                 goto out_err;
489         }
490         ctx->mech_used.len = gss_kerberos_mech.gm_oid.len;
491
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);
498         default:
499                 return -EINVAL;
500         }
501
502 out_err:
503         return PTR_ERR(p);
504 }
505
506 static int
507 gss_import_sec_context_kerberos(const void *p, size_t len,
508                                 struct gss_ctx *ctx_id)
509 {
510         const void *end = (const void *)((const char *)p + len);
511         struct  krb5_ctx *ctx;
512         int ret;
513
514         ctx = kzalloc(sizeof(*ctx), GFP_KERNEL);
515         if (ctx == NULL)
516                 return -ENOMEM;
517
518         if (len == 85)
519                 ret = gss_import_v1_context(p, end, ctx);
520         else
521                 ret = gss_import_v2_context(p, end, ctx);
522
523         if (ret == 0)
524                 ctx_id->internal_ctx_id = ctx;
525         else
526                 kfree(ctx);
527
528         dprintk("RPC:       %s: returning %d\n", __func__, ret);
529         return ret;
530 }
531
532 static void
533 gss_delete_sec_context_kerberos(void *internal_ctx) {
534         struct krb5_ctx *kctx = internal_ctx;
535
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);
541         kfree(kctx);
542 }
543
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,
551 };
552
553 static struct pf_desc gss_kerberos_pfs[] = {
554         [0] = {
555                 .pseudoflavor = RPC_AUTH_GSS_KRB5,
556                 .service = RPC_GSS_SVC_NONE,
557                 .name = "krb5",
558         },
559         [1] = {
560                 .pseudoflavor = RPC_AUTH_GSS_KRB5I,
561                 .service = RPC_GSS_SVC_INTEGRITY,
562                 .name = "krb5i",
563         },
564         [2] = {
565                 .pseudoflavor = RPC_AUTH_GSS_KRB5P,
566                 .service = RPC_GSS_SVC_PRIVACY,
567                 .name = "krb5p",
568         },
569 };
570
571 static struct gss_api_mech gss_kerberos_mech = {
572         .gm_name        = "krb5",
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=3,1,2 ",
579 };
580
581 static int __init init_kerberos_module(void)
582 {
583         int status;
584
585         status = gss_mech_register(&gss_kerberos_mech);
586         if (status)
587                 printk("Failed to register kerberos gss mechanism!\n");
588         return status;
589 }
590
591 static void __exit cleanup_kerberos_module(void)
592 {
593         gss_mech_unregister(&gss_kerberos_mech);
594 }
595
596 MODULE_LICENSE("GPL");
597 module_init(init_kerberos_module);
598 module_exit(cleanup_kerberos_module);