2 * ppp_mppe.c - interface MPPE to the PPP code.
3 * This version is for use with Linux kernel 2.6.14+
5 * By Frank Cusack <fcusack@fcusack.com>.
6 * Copyright (c) 2002,2003,2004 Google, Inc.
10 * Permission to use, copy, modify, and distribute this software and its
11 * documentation is hereby granted, provided that the above copyright
12 * notice appears in all copies. This software is provided without any
13 * warranty, express or implied.
15 * ALTERNATIVELY, provided that this notice is retained in full, this product
16 * may be distributed under the terms of the GNU General Public License (GPL),
17 * in which case the provisions of the GPL apply INSTEAD OF those given above.
19 * This program is free software; you can redistribute it and/or modify
20 * it under the terms of the GNU General Public License as published by
21 * the Free Software Foundation; either version 2 of the License, or
22 * (at your option) any later version.
24 * This program is distributed in the hope that it will be useful,
25 * but WITHOUT ANY WARRANTY; without even the implied warranty of
26 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
27 * GNU General Public License for more details.
29 * You should have received a copy of the GNU General Public License
30 * along with this program; if not, write to the Free Software
31 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
35 * 08/12/05 - Matt Domsch <Matt_Domsch@dell.com>
36 * Only need extra skb padding on transmit, not receive.
37 * 06/18/04 - Matt Domsch <Matt_Domsch@dell.com>, Oleg Makarenko <mole@quadra.ru>
38 * Use Linux kernel 2.6 arc4 and sha1 routines rather than
40 * 2/15/04 - TS: added #include <version.h> and testing for Kernel
41 * version before using
42 * MOD_DEC_USAGE_COUNT/MOD_INC_USAGE_COUNT which are
46 #include <linux/err.h>
47 #include <linux/module.h>
48 #include <linux/kernel.h>
49 #include <linux/version.h>
50 #include <linux/init.h>
51 #include <linux/types.h>
52 #include <linux/slab.h>
53 #include <linux/string.h>
54 #include <linux/crypto.h>
56 #include <linux/ppp_defs.h>
57 #include <linux/ppp-comp.h>
58 #include <asm/scatterlist.h>
62 MODULE_AUTHOR("Frank Cusack <fcusack@fcusack.com>");
63 MODULE_DESCRIPTION("Point-to-Point Protocol Microsoft Point-to-Point Encryption support");
64 MODULE_LICENSE("Dual BSD/GPL");
65 MODULE_ALIAS("ppp-compress-" __stringify(CI_MPPE));
66 MODULE_VERSION("1.0.2");
69 setup_sg(struct scatterlist *sg, const void *address, unsigned int length)
71 sg[0].page = virt_to_page(address);
72 sg[0].offset = offset_in_page(address);
73 sg[0].length = length;
77 #define SHA1_PAD_SIZE 40
80 * kernel crypto API needs its arguments to be in kmalloc'd memory, not in the module
81 * static data area. That means sha_pad needs to be kmalloc'd.
85 unsigned char sha_pad1[SHA1_PAD_SIZE];
86 unsigned char sha_pad2[SHA1_PAD_SIZE];
88 static struct sha_pad *sha_pad;
90 static inline void sha_pad_init(struct sha_pad *shapad)
92 memset(shapad->sha_pad1, 0x00, sizeof(shapad->sha_pad1));
93 memset(shapad->sha_pad2, 0xF2, sizeof(shapad->sha_pad2));
97 * State for an MPPE (de)compressor.
99 struct ppp_mppe_state {
100 struct crypto_blkcipher *arc4;
101 struct crypto_hash *sha1;
102 unsigned char *sha1_digest;
103 unsigned char master_key[MPPE_MAX_KEY_LEN];
104 unsigned char session_key[MPPE_MAX_KEY_LEN];
105 unsigned keylen; /* key length in bytes */
106 /* NB: 128-bit == 16, 40-bit == 8! */
107 /* If we want to support 56-bit, */
108 /* the unit has to change to bits */
109 unsigned char bits; /* MPPE control bits */
110 unsigned ccount; /* 12-bit coherency count (seqno) */
111 unsigned stateful; /* stateful mode flag */
112 int discard; /* stateful mode packet loss flag */
113 int sanity_errors; /* take down LCP if too many */
116 struct compstat stats;
119 /* struct ppp_mppe_state.bits definitions */
120 #define MPPE_BIT_A 0x80 /* Encryption table were (re)inititalized */
121 #define MPPE_BIT_B 0x40 /* MPPC only (not implemented) */
122 #define MPPE_BIT_C 0x20 /* MPPC only (not implemented) */
123 #define MPPE_BIT_D 0x10 /* This is an encrypted frame */
125 #define MPPE_BIT_FLUSHED MPPE_BIT_A
126 #define MPPE_BIT_ENCRYPTED MPPE_BIT_D
128 #define MPPE_BITS(p) ((p)[4] & 0xf0)
129 #define MPPE_CCOUNT(p) ((((p)[4] & 0x0f) << 8) + (p)[5])
130 #define MPPE_CCOUNT_SPACE 0x1000 /* The size of the ccount space */
132 #define MPPE_OVHD 2 /* MPPE overhead/packet */
133 #define SANITY_MAX 1600 /* Max bogon factor we will tolerate */
136 * Key Derivation, from RFC 3078, RFC 3079.
137 * Equivalent to Get_Key() for MS-CHAP as described in RFC 3079.
139 static void get_new_key_from_sha(struct ppp_mppe_state * state)
141 struct hash_desc desc;
142 struct scatterlist sg[4];
145 nbytes = setup_sg(&sg[0], state->master_key, state->keylen);
146 nbytes += setup_sg(&sg[1], sha_pad->sha_pad1,
147 sizeof(sha_pad->sha_pad1));
148 nbytes += setup_sg(&sg[2], state->session_key, state->keylen);
149 nbytes += setup_sg(&sg[3], sha_pad->sha_pad2,
150 sizeof(sha_pad->sha_pad2));
152 desc.tfm = state->sha1;
155 crypto_hash_digest(&desc, sg, nbytes, state->sha1_digest);
159 * Perform the MPPE rekey algorithm, from RFC 3078, sec. 7.3.
160 * Well, not what's written there, but rather what they meant.
162 static void mppe_rekey(struct ppp_mppe_state * state, int initial_key)
164 struct scatterlist sg_in[1], sg_out[1];
165 struct blkcipher_desc desc = { .tfm = state->arc4 };
167 get_new_key_from_sha(state);
169 crypto_blkcipher_setkey(state->arc4, state->sha1_digest,
171 setup_sg(sg_in, state->sha1_digest, state->keylen);
172 setup_sg(sg_out, state->session_key, state->keylen);
173 if (crypto_blkcipher_encrypt(&desc, sg_out, sg_in,
174 state->keylen) != 0) {
175 printk(KERN_WARNING "mppe_rekey: cipher_encrypt failed\n");
178 memcpy(state->session_key, state->sha1_digest, state->keylen);
180 if (state->keylen == 8) {
182 state->session_key[0] = 0xd1;
183 state->session_key[1] = 0x26;
184 state->session_key[2] = 0x9e;
186 crypto_blkcipher_setkey(state->arc4, state->session_key, state->keylen);
190 * Allocate space for a (de)compressor.
192 static void *mppe_alloc(unsigned char *options, int optlen)
194 struct ppp_mppe_state *state;
195 unsigned int digestsize;
197 if (optlen != CILEN_MPPE + sizeof(state->master_key)
198 || options[0] != CI_MPPE || options[1] != CILEN_MPPE)
201 state = kzalloc(sizeof(*state), GFP_KERNEL);
206 state->arc4 = crypto_alloc_blkcipher("ecb(arc4)", 0, CRYPTO_ALG_ASYNC);
207 if (IS_ERR(state->arc4)) {
212 state->sha1 = crypto_alloc_hash("sha1", 0, CRYPTO_ALG_ASYNC);
213 if (IS_ERR(state->sha1)) {
218 digestsize = crypto_hash_digestsize(state->sha1);
219 if (digestsize < MPPE_MAX_KEY_LEN)
222 state->sha1_digest = kmalloc(digestsize, GFP_KERNEL);
223 if (!state->sha1_digest)
227 memcpy(state->master_key, &options[CILEN_MPPE],
228 sizeof(state->master_key));
229 memcpy(state->session_key, state->master_key,
230 sizeof(state->master_key));
233 * We defer initial key generation until mppe_init(), as mppe_alloc()
234 * is called frequently during negotiation.
237 return (void *)state;
240 if (state->sha1_digest)
241 kfree(state->sha1_digest);
243 crypto_free_hash(state->sha1);
245 crypto_free_blkcipher(state->arc4);
252 * Deallocate space for a (de)compressor.
254 static void mppe_free(void *arg)
256 struct ppp_mppe_state *state = (struct ppp_mppe_state *) arg;
258 if (state->sha1_digest)
259 kfree(state->sha1_digest);
261 crypto_free_hash(state->sha1);
263 crypto_free_blkcipher(state->arc4);
269 * Initialize (de)compressor state.
272 mppe_init(void *arg, unsigned char *options, int optlen, int unit, int debug,
273 const char *debugstr)
275 struct ppp_mppe_state *state = (struct ppp_mppe_state *) arg;
276 unsigned char mppe_opts;
278 if (optlen != CILEN_MPPE
279 || options[0] != CI_MPPE || options[1] != CILEN_MPPE)
282 MPPE_CI_TO_OPTS(&options[2], mppe_opts);
283 if (mppe_opts & MPPE_OPT_128)
285 else if (mppe_opts & MPPE_OPT_40)
288 printk(KERN_WARNING "%s[%d]: unknown key length\n", debugstr,
292 if (mppe_opts & MPPE_OPT_STATEFUL)
295 /* Generate the initial session key. */
296 mppe_rekey(state, 1);
300 char mkey[sizeof(state->master_key) * 2 + 1];
301 char skey[sizeof(state->session_key) * 2 + 1];
303 printk(KERN_DEBUG "%s[%d]: initialized with %d-bit %s mode\n",
304 debugstr, unit, (state->keylen == 16) ? 128 : 40,
305 (state->stateful) ? "stateful" : "stateless");
307 for (i = 0; i < sizeof(state->master_key); i++)
308 sprintf(mkey + i * 2, "%02x", state->master_key[i]);
309 for (i = 0; i < sizeof(state->session_key); i++)
310 sprintf(skey + i * 2, "%02x", state->session_key[i]);
312 "%s[%d]: keys: master: %s initial session: %s\n",
313 debugstr, unit, mkey, skey);
317 * Initialize the coherency count. The initial value is not specified
318 * in RFC 3078, but we can make a reasonable assumption that it will
319 * start at 0. Setting it to the max here makes the comp/decomp code
320 * do the right thing (determined through experiment).
322 state->ccount = MPPE_CCOUNT_SPACE - 1;
325 * Note that even though we have initialized the key table, we don't
326 * set the FLUSHED bit. This is contrary to RFC 3078, sec. 3.1.
328 state->bits = MPPE_BIT_ENCRYPTED;
331 state->debug = debug;
337 mppe_comp_init(void *arg, unsigned char *options, int optlen, int unit,
338 int hdrlen, int debug)
341 return mppe_init(arg, options, optlen, unit, debug, "mppe_comp_init");
345 * We received a CCP Reset-Request (actually, we are sending a Reset-Ack),
346 * tell the compressor to rekey. Note that we MUST NOT rekey for
347 * every CCP Reset-Request; we only rekey on the next xmit packet.
348 * We might get multiple CCP Reset-Requests if our CCP Reset-Ack is lost.
349 * So, rekeying for every CCP Reset-Request is broken as the peer will not
350 * know how many times we've rekeyed. (If we rekey and THEN get another
351 * CCP Reset-Request, we must rekey again.)
353 static void mppe_comp_reset(void *arg)
355 struct ppp_mppe_state *state = (struct ppp_mppe_state *) arg;
357 state->bits |= MPPE_BIT_FLUSHED;
361 * Compress (encrypt) a packet.
362 * It's strange to call this a compressor, since the output is always
363 * MPPE_OVHD + 2 bytes larger than the input.
366 mppe_compress(void *arg, unsigned char *ibuf, unsigned char *obuf,
367 int isize, int osize)
369 struct ppp_mppe_state *state = (struct ppp_mppe_state *) arg;
370 struct blkcipher_desc desc = { .tfm = state->arc4 };
372 struct scatterlist sg_in[1], sg_out[1];
375 * Check that the protocol is in the range we handle.
377 proto = PPP_PROTOCOL(ibuf);
378 if (proto < 0x0021 || proto > 0x00fa)
381 /* Make sure we have enough room to generate an encrypted packet. */
382 if (osize < isize + MPPE_OVHD + 2) {
383 /* Drop the packet if we should encrypt it, but can't. */
384 printk(KERN_DEBUG "mppe_compress[%d]: osize too small! "
385 "(have: %d need: %d)\n", state->unit,
386 osize, osize + MPPE_OVHD + 2);
390 osize = isize + MPPE_OVHD + 2;
393 * Copy over the PPP header and set control bits.
395 obuf[0] = PPP_ADDRESS(ibuf);
396 obuf[1] = PPP_CONTROL(ibuf);
397 obuf[2] = PPP_COMP >> 8; /* isize + MPPE_OVHD + 1 */
398 obuf[3] = PPP_COMP; /* isize + MPPE_OVHD + 2 */
401 state->ccount = (state->ccount + 1) % MPPE_CCOUNT_SPACE;
402 if (state->debug >= 7)
403 printk(KERN_DEBUG "mppe_compress[%d]: ccount %d\n", state->unit,
405 obuf[0] = state->ccount >> 8;
406 obuf[1] = state->ccount & 0xff;
408 if (!state->stateful || /* stateless mode */
409 ((state->ccount & 0xff) == 0xff) || /* "flag" packet */
410 (state->bits & MPPE_BIT_FLUSHED)) { /* CCP Reset-Request */
412 if (state->debug && state->stateful)
413 printk(KERN_DEBUG "mppe_compress[%d]: rekeying\n",
415 mppe_rekey(state, 0);
416 state->bits |= MPPE_BIT_FLUSHED;
418 obuf[0] |= state->bits;
419 state->bits &= ~MPPE_BIT_FLUSHED; /* reset for next xmit */
422 ibuf += 2; /* skip to proto field */
426 setup_sg(sg_in, ibuf, isize);
427 setup_sg(sg_out, obuf, osize);
428 if (crypto_blkcipher_encrypt(&desc, sg_out, sg_in, isize) != 0) {
429 printk(KERN_DEBUG "crypto_cypher_encrypt failed\n");
433 state->stats.unc_bytes += isize;
434 state->stats.unc_packets++;
435 state->stats.comp_bytes += osize;
436 state->stats.comp_packets++;
442 * Since every frame grows by MPPE_OVHD + 2 bytes, this is always going
443 * to look bad ... and the longer the link is up the worse it will get.
445 static void mppe_comp_stats(void *arg, struct compstat *stats)
447 struct ppp_mppe_state *state = (struct ppp_mppe_state *) arg;
449 *stats = state->stats;
453 mppe_decomp_init(void *arg, unsigned char *options, int optlen, int unit,
454 int hdrlen, int mru, int debug)
457 return mppe_init(arg, options, optlen, unit, debug, "mppe_decomp_init");
461 * We received a CCP Reset-Ack. Just ignore it.
463 static void mppe_decomp_reset(void *arg)
470 * Decompress (decrypt) an MPPE packet.
473 mppe_decompress(void *arg, unsigned char *ibuf, int isize, unsigned char *obuf,
476 struct ppp_mppe_state *state = (struct ppp_mppe_state *) arg;
477 struct blkcipher_desc desc = { .tfm = state->arc4 };
479 int flushed = MPPE_BITS(ibuf) & MPPE_BIT_FLUSHED;
481 struct scatterlist sg_in[1], sg_out[1];
483 if (isize <= PPP_HDRLEN + MPPE_OVHD) {
486 "mppe_decompress[%d]: short pkt (%d)\n",
492 * Make sure we have enough room to decrypt the packet.
493 * Note that for our test we only subtract 1 byte whereas in
494 * mppe_compress() we added 2 bytes (+MPPE_OVHD);
495 * this is to account for possible PFC.
497 if (osize < isize - MPPE_OVHD - 1) {
498 printk(KERN_DEBUG "mppe_decompress[%d]: osize too small! "
499 "(have: %d need: %d)\n", state->unit,
500 osize, isize - MPPE_OVHD - 1);
503 osize = isize - MPPE_OVHD - 2; /* assume no PFC */
505 ccount = MPPE_CCOUNT(ibuf);
506 if (state->debug >= 7)
507 printk(KERN_DEBUG "mppe_decompress[%d]: ccount %d\n",
508 state->unit, ccount);
510 /* sanity checks -- terminate with extreme prejudice */
511 if (!(MPPE_BITS(ibuf) & MPPE_BIT_ENCRYPTED)) {
513 "mppe_decompress[%d]: ENCRYPTED bit not set!\n",
515 state->sanity_errors += 100;
518 if (!state->stateful && !flushed) {
519 printk(KERN_DEBUG "mppe_decompress[%d]: FLUSHED bit not set in "
520 "stateless mode!\n", state->unit);
521 state->sanity_errors += 100;
524 if (state->stateful && ((ccount & 0xff) == 0xff) && !flushed) {
525 printk(KERN_DEBUG "mppe_decompress[%d]: FLUSHED bit not set on "
526 "flag packet!\n", state->unit);
527 state->sanity_errors += 100;
532 if (state->sanity_errors < SANITY_MAX)
536 * Take LCP down if the peer is sending too many bogons.
537 * We don't want to do this for a single or just a few
538 * instances since it could just be due to packet corruption.
540 return DECOMP_FATALERROR;
544 * Check the coherency count.
547 if (!state->stateful) {
548 /* RFC 3078, sec 8.1. Rekey for every packet. */
549 while (state->ccount != ccount) {
550 mppe_rekey(state, 0);
551 state->ccount = (state->ccount + 1) % MPPE_CCOUNT_SPACE;
554 /* RFC 3078, sec 8.2. */
555 if (!state->discard) {
557 state->ccount = (state->ccount + 1) % MPPE_CCOUNT_SPACE;
558 if (ccount != state->ccount) {
560 * (ccount > state->ccount)
561 * Packet loss detected, enter the discard state.
562 * Signal the peer to rekey (by sending a CCP Reset-Request).
570 /* ccp.c will be silent (no additional CCP Reset-Requests). */
573 /* Rekey for every missed "flag" packet. */
574 while ((ccount & ~0xff) !=
575 (state->ccount & ~0xff)) {
576 mppe_rekey(state, 0);
579 256) % MPPE_CCOUNT_SPACE;
584 state->ccount = ccount;
586 * Another problem with RFC 3078 here. It implies that the
587 * peer need not send a Reset-Ack packet. But RFC 1962
588 * requires it. Hopefully, M$ does send a Reset-Ack; even
589 * though it isn't required for MPPE synchronization, it is
590 * required to reset CCP state.
595 mppe_rekey(state, 0);
599 * Fill in the first part of the PPP header. The protocol field
600 * comes from the decrypted data.
602 obuf[0] = PPP_ADDRESS(ibuf); /* +1 */
603 obuf[1] = PPP_CONTROL(ibuf); /* +1 */
605 ibuf += PPP_HDRLEN + MPPE_OVHD;
606 isize -= PPP_HDRLEN + MPPE_OVHD; /* -6 */
607 /* net osize: isize-4 */
610 * Decrypt the first byte in order to check if it is
611 * a compressed or uncompressed protocol field.
613 setup_sg(sg_in, ibuf, 1);
614 setup_sg(sg_out, obuf, 1);
615 if (crypto_blkcipher_decrypt(&desc, sg_out, sg_in, 1) != 0) {
616 printk(KERN_DEBUG "crypto_cypher_decrypt failed\n");
621 * Do PFC decompression.
622 * This would be nicer if we were given the actual sk_buff
623 * instead of a char *.
625 if ((obuf[0] & 0x01) != 0) {
632 /* And finally, decrypt the rest of the packet. */
633 setup_sg(sg_in, ibuf + 1, isize - 1);
634 setup_sg(sg_out, obuf + 1, osize - 1);
635 if (crypto_blkcipher_decrypt(&desc, sg_out, sg_in, isize - 1)) {
636 printk(KERN_DEBUG "crypto_cypher_decrypt failed\n");
640 state->stats.unc_bytes += osize;
641 state->stats.unc_packets++;
642 state->stats.comp_bytes += isize;
643 state->stats.comp_packets++;
645 /* good packet credit */
646 state->sanity_errors >>= 1;
652 * Incompressible data has arrived (this should never happen!).
653 * We should probably drop the link if the protocol is in the range
654 * of what should be encrypted. At the least, we should drop this
655 * packet. (How to do this?)
657 static void mppe_incomp(void *arg, unsigned char *ibuf, int icnt)
659 struct ppp_mppe_state *state = (struct ppp_mppe_state *) arg;
662 (PPP_PROTOCOL(ibuf) >= 0x0021 && PPP_PROTOCOL(ibuf) <= 0x00fa))
664 "mppe_incomp[%d]: incompressible (unencrypted) data! "
665 "(proto %04x)\n", state->unit, PPP_PROTOCOL(ibuf));
667 state->stats.inc_bytes += icnt;
668 state->stats.inc_packets++;
669 state->stats.unc_bytes += icnt;
670 state->stats.unc_packets++;
673 /*************************************************************
674 * Module interface table
675 *************************************************************/
678 * Procedures exported to if_ppp.c.
680 static struct compressor ppp_mppe = {
681 .compress_proto = CI_MPPE,
682 .comp_alloc = mppe_alloc,
683 .comp_free = mppe_free,
684 .comp_init = mppe_comp_init,
685 .comp_reset = mppe_comp_reset,
686 .compress = mppe_compress,
687 .comp_stat = mppe_comp_stats,
688 .decomp_alloc = mppe_alloc,
689 .decomp_free = mppe_free,
690 .decomp_init = mppe_decomp_init,
691 .decomp_reset = mppe_decomp_reset,
692 .decompress = mppe_decompress,
693 .incomp = mppe_incomp,
694 .decomp_stat = mppe_comp_stats,
695 .owner = THIS_MODULE,
696 .comp_extra = MPPE_PAD,
702 * Prior to allowing load, try to load the arc4 and sha1 crypto
703 * libraries. The actual use will be allocated later, but
704 * this way the module will fail to insmod if they aren't available.
707 static int __init ppp_mppe_init(void)
710 if (!(crypto_has_blkcipher("ecb(arc4)", 0, CRYPTO_ALG_ASYNC) &&
711 crypto_has_hash("sha1", 0, CRYPTO_ALG_ASYNC)))
714 sha_pad = kmalloc(sizeof(struct sha_pad), GFP_KERNEL);
717 sha_pad_init(sha_pad);
719 answer = ppp_register_compressor(&ppp_mppe);
722 printk(KERN_INFO "PPP MPPE Compression module registered\n");
729 static void __exit ppp_mppe_cleanup(void)
731 ppp_unregister_compressor(&ppp_mppe);
735 module_init(ppp_mppe_init);
736 module_exit(ppp_mppe_cleanup);