2 * mppe.h - Definitions for MPPE
4 * Copyright (c) 2008 Paul Mackerras. All rights reserved.
6 * Redistribution and use in source and binary forms, with or without
7 * modification, are permitted provided that the following conditions
10 * 1. Redistributions of source code must retain the above copyright
11 * notice, this list of conditions and the following disclaimer.
13 * 2. Redistributions in binary form must reproduce the above copyright
14 * notice, this list of conditions and the following disclaimer in
15 * the documentation and/or other materials provided with the
18 * 3. The name(s) of the authors of this software must not be used to
19 * endorse or promote products derived from this software without
20 * prior written permission.
22 * 4. Redistributions of any form whatsoever must retain the following
24 * "This product includes software developed by Paul Mackerras
25 * <paulus@ozlabs.org>".
27 * THE AUTHORS OF THIS SOFTWARE DISCLAIM ALL WARRANTIES WITH REGARD TO
28 * THIS SOFTWARE, INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
29 * AND FITNESS, IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY
30 * SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
31 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN
32 * AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING
33 * OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
45 #define MPPE_PAD 4 /* MPPE growth per frame */
46 #define MPPE_MAX_KEY_SIZE 32 /* Largest key length */
47 #define MPPE_MAX_KEY_LEN 16 /* Largest key size accepted by the kernel */
49 /* option bits for ccp_options.mppe */
50 #define MPPE_OPT_40 0x01 /* 40 bit */
51 #define MPPE_OPT_128 0x02 /* 128 bit */
52 #define MPPE_OPT_STATEFUL 0x04 /* stateful mode */
53 /* unsupported opts */
54 #define MPPE_OPT_56 0x08 /* 56 bit */
55 #define MPPE_OPT_MPPC 0x10 /* MPPC compression */
56 #define MPPE_OPT_D 0x20 /* Unknown */
57 #define MPPE_OPT_UNSUPPORTED (MPPE_OPT_56|MPPE_OPT_MPPC|MPPE_OPT_D)
58 #define MPPE_OPT_UNKNOWN 0x40 /* Bits !defined in RFC 3078 were set */
61 * This is not nice ... the alternative is a bitfield struct though.
62 * And unfortunately, we cannot share the same bits for the option
63 * names above since C and H are the same bit. We could do a u_int32
64 * but then we have to do a htonl() all the time and/or we still need
65 * to know which octet is which.
67 #define MPPE_C_BIT 0x01 /* MPPC */
68 #define MPPE_D_BIT 0x10 /* Obsolete, usage unknown */
69 #define MPPE_L_BIT 0x20 /* 40-bit */
70 #define MPPE_S_BIT 0x40 /* 128-bit */
71 #define MPPE_M_BIT 0x80 /* 56-bit, not supported */
72 #define MPPE_H_BIT 0x01 /* Stateless (in a different byte) */
74 /* Does not include H bit; used for least significant octet only. */
75 #define MPPE_ALL_BITS (MPPE_D_BIT|MPPE_L_BIT|MPPE_S_BIT|MPPE_M_BIT|MPPE_H_BIT)
77 /* Build a CI from mppe opts (see RFC 3078) */
78 #define MPPE_OPTS_TO_CI(opts, ci) \
80 unsigned char *ptr = ci; /* unsigned char[4] */ \
83 if (opts & MPPE_OPT_STATEFUL) \
86 *ptr++ = MPPE_H_BIT; \
92 if (opts & MPPE_OPT_128) \
94 if (opts & MPPE_OPT_40) \
96 /* M,D,C bits not supported */ \
97 } while (/* CONSTCOND */ 0)
99 /* The reverse of the above */
100 #define MPPE_CI_TO_OPTS(ci, opts) \
102 unsigned char *ptr = ci; /* unsigned char[4] */ \
107 if (!(ptr[0] & MPPE_H_BIT)) \
108 opts |= MPPE_OPT_STATEFUL; \
111 if (ptr[3] & MPPE_S_BIT) \
112 opts |= MPPE_OPT_128; \
113 if (ptr[3] & MPPE_L_BIT) \
114 opts |= MPPE_OPT_40; \
117 if (ptr[3] & MPPE_M_BIT) \
118 opts |= MPPE_OPT_56; \
119 if (ptr[3] & MPPE_D_BIT) \
120 opts |= MPPE_OPT_D; \
121 if (ptr[3] & MPPE_C_BIT) \
122 opts |= MPPE_OPT_MPPC; \
125 if (ptr[0] & ~MPPE_H_BIT) \
126 opts |= MPPE_OPT_UNKNOWN; \
127 if (ptr[1] || ptr[2]) \
128 opts |= MPPE_OPT_UNKNOWN; \
129 if (ptr[3] & ~MPPE_ALL_BITS) \
130 opts |= MPPE_OPT_UNKNOWN; \
131 } while (/* CONSTCOND */ 0)
136 /* These values are the RADIUS attribute values--see RFC 2548. */
137 #define MPPE_ENC_POL_ENC_ALLOWED 1
138 #define MPPE_ENC_POL_ENC_REQUIRED 2
139 #define MPPE_ENC_TYPES_RC4_40 2
140 #define MPPE_ENC_TYPES_RC4_128 4
142 /* used by plugins (using above values) */
143 void mppe_set_enc_types (int policy, int types);
146 * Set the MPPE send and recv keys. NULL values for keys are ignored
147 * and input values are cleared to avoid leaving them on the stack
149 void mppe_set_keys(unsigned char *send_key, unsigned char *recv_key, int keylen);
152 * Get the MPPE recv key
154 int mppe_get_recv_key(unsigned char *recv_key, int length);
157 * Get the MPPE send key
159 int mppe_get_send_key(unsigned char *send_key, int length);
162 * Clear the MPPE keys
164 void mppe_clear_keys(void);
167 * Check if the MPPE keys are set
169 bool mppe_keys_isset(void);
172 * Set mppe_xxxx_key from NT Password Hash Hash (MSCHAPv1), see RFC3079
174 void mppe_set_chapv1(unsigned char *rchallenge, unsigned char *PasswordHashHash);
177 * Set the mppe_xxxx_key from MS-CHAP-v2 credentials, see RFC3079
179 void mppe_set_chapv2(unsigned char *PasswordHashHash,
180 unsigned char *NTResponse, int IsServer);
182 #endif // #ifdef PPP_WITH_MPPE
188 #endif // #ifdef PPP_MPPE_H