Home | History | Annotate | Download | only in ppp
      1 /*****************************************************************************
      2 * chap.h - Network Challenge Handshake Authentication Protocol header file.
      3 *
      4 * Copyright (c) 2003 by Marc Boucher, Services Informatiques (MBSI) inc.
      5 * portions Copyright (c) 1998 Global Election Systems Inc.
      6 *
      7 * The authors hereby grant permission to use, copy, modify, distribute,
      8 * and license this software and its documentation for any purpose, provided
      9 * that existing copyright notices are retained in all copies and that this
     10 * notice and the following disclaimer are included verbatim in any
     11 * distributions. No written agreement, license, or royalty fee is required
     12 * for any of the authorized uses.
     13 *
     14 * THIS SOFTWARE IS PROVIDED BY THE CONTRIBUTORS *AS IS* AND ANY EXPRESS OR
     15 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
     16 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
     17 * IN NO EVENT SHALL THE CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
     18 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
     19 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
     20 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
     21 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
     22 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
     23 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
     24 *
     25 ******************************************************************************
     26 * REVISION HISTORY
     27 *
     28 * 03-01-01 Marc Boucher <marc (at) mbsi.ca>
     29 *   Ported to lwIP.
     30 * 97-12-03 Guy Lancaster <lancasterg (at) acm.org>, Global Election Systems Inc.
     31 *   Original built from BSD network code.
     32 ******************************************************************************/
     33 /*
     34  * chap.h - Challenge Handshake Authentication Protocol definitions.
     35  *
     36  * Copyright (c) 1993 The Australian National University.
     37  * All rights reserved.
     38  *
     39  * Redistribution and use in source and binary forms are permitted
     40  * provided that the above copyright notice and this paragraph are
     41  * duplicated in all such forms and that any documentation,
     42  * advertising materials, and other materials related to such
     43  * distribution and use acknowledge that the software was developed
     44  * by the Australian National University.  The name of the University
     45  * may not be used to endorse or promote products derived from this
     46  * software without specific prior written permission.
     47  * THIS SOFTWARE IS PROVIDED ``AS IS'' AND WITHOUT ANY EXPRESS OR
     48  * IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED
     49  * WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR A PARTICULAR PURPOSE.
     50  *
     51  * Copyright (c) 1991 Gregory M. Christy
     52  * All rights reserved.
     53  *
     54  * Redistribution and use in source and binary forms are permitted
     55  * provided that the above copyright notice and this paragraph are
     56  * duplicated in all such forms and that any documentation,
     57  * advertising materials, and other materials related to such
     58  * distribution and use acknowledge that the software was developed
     59  * by the author.
     60  *
     61  * THIS SOFTWARE IS PROVIDED ``AS IS'' AND WITHOUT ANY EXPRESS OR
     62  * IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED
     63  * WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR A PARTICULAR PURPOSE.
     64  *
     65  * $Id: chap.h,v 1.6 2010/01/24 13:19:34 goldsimon Exp $
     66  */
     67 
     68 #ifndef CHAP_H
     69 #define CHAP_H
     70 
     71 /* Code + ID + length */
     72 #define CHAP_HEADERLEN 4
     73 
     74 /*
     75  * CHAP codes.
     76  */
     77 
     78 #define CHAP_DIGEST_MD5      5    /* use MD5 algorithm */
     79 #define MD5_SIGNATURE_SIZE   16   /* 16 bytes in a MD5 message digest */
     80 #define CHAP_MICROSOFT       0x80 /* use Microsoft-compatible alg. */
     81 #define MS_CHAP_RESPONSE_LEN 49   /* Response length for MS-CHAP */
     82 
     83 #define CHAP_CHALLENGE       1
     84 #define CHAP_RESPONSE        2
     85 #define CHAP_SUCCESS         3
     86 #define CHAP_FAILURE         4
     87 
     88 /*
     89  *  Challenge lengths (for challenges we send) and other limits.
     90  */
     91 #define MIN_CHALLENGE_LENGTH 32
     92 #define MAX_CHALLENGE_LENGTH 64
     93 #define MAX_RESPONSE_LENGTH  64 /* sufficient for MD5 or MS-CHAP */
     94 
     95 /*
     96  * Each interface is described by a chap structure.
     97  */
     98 
     99 typedef struct chap_state {
    100   int unit;                               /* Interface unit number */
    101   int clientstate;                        /* Client state */
    102   int serverstate;                        /* Server state */
    103   u_char challenge[MAX_CHALLENGE_LENGTH]; /* last challenge string sent */
    104   u_char chal_len;                        /* challenge length */
    105   u_char chal_id;                         /* ID of last challenge */
    106   u_char chal_type;                       /* hash algorithm for challenges */
    107   u_char id;                              /* Current id */
    108   char *chal_name;                        /* Our name to use with challenge */
    109   int chal_interval;                      /* Time until we challenge peer again */
    110   int timeouttime;                        /* Timeout time in seconds */
    111   int max_transmits;                      /* Maximum # of challenge transmissions */
    112   int chal_transmits;                     /* Number of transmissions of challenge */
    113   int resp_transmits;                     /* Number of transmissions of response */
    114   u_char response[MAX_RESPONSE_LENGTH];   /* Response to send */
    115   u_char resp_length;                     /* length of response */
    116   u_char resp_id;                         /* ID for response messages */
    117   u_char resp_type;                       /* hash algorithm for responses */
    118   char *resp_name;                        /* Our name to send with response */
    119 } chap_state;
    120 
    121 
    122 /*
    123  * Client (peer) states.
    124  */
    125 #define CHAPCS_INITIAL       0 /* Lower layer down, not opened */
    126 #define CHAPCS_CLOSED        1 /* Lower layer up, not opened */
    127 #define CHAPCS_PENDING       2 /* Auth us to peer when lower up */
    128 #define CHAPCS_LISTEN        3 /* Listening for a challenge */
    129 #define CHAPCS_RESPONSE      4 /* Sent response, waiting for status */
    130 #define CHAPCS_OPEN          5 /* We've received Success */
    131 
    132 /*
    133  * Server (authenticator) states.
    134  */
    135 #define CHAPSS_INITIAL       0 /* Lower layer down, not opened */
    136 #define CHAPSS_CLOSED        1 /* Lower layer up, not opened */
    137 #define CHAPSS_PENDING       2 /* Auth peer when lower up */
    138 #define CHAPSS_INITIAL_CHAL  3 /* We've sent the first challenge */
    139 #define CHAPSS_OPEN          4 /* We've sent a Success msg */
    140 #define CHAPSS_RECHALLENGE   5 /* We've sent another challenge */
    141 #define CHAPSS_BADAUTH       6 /* We've sent a Failure msg */
    142 
    143 extern chap_state chap[];
    144 
    145 void ChapAuthWithPeer (int, char *, u_char);
    146 void ChapAuthPeer (int, char *, u_char);
    147 
    148 extern struct protent chap_protent;
    149 
    150 #endif /* CHAP_H */
    151