git.sur5r.net Git - freertos/blob - FreeRTOS/Demo/Common/ethernet/lwIP_130/src/netif/ppp/pap.h

   1 /*****************************************************************************\r
   2 * pap.h -  PPP Password Authentication Protocol header file.\r
   3 *\r
   4 * Copyright (c) 2003 by Marc Boucher, Services Informatiques (MBSI) inc.\r
   5 * portions Copyright (c) 1997 Global Election Systems Inc.\r
   6 *\r
   7 * The authors hereby grant permission to use, copy, modify, distribute,\r
   8 * and license this software and its documentation for any purpose, provided\r
   9 * that existing copyright notices are retained in all copies and that this\r
  10 * notice and the following disclaimer are included verbatim in any \r
  11 * distributions. No written agreement, license, or royalty fee is required\r
  12 * for any of the authorized uses.\r
  13 *\r
  14 * THIS SOFTWARE IS PROVIDED BY THE CONTRIBUTORS *AS IS* AND ANY EXPRESS OR\r
  15 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES\r
  16 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. \r
  17 * IN NO EVENT SHALL THE CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,\r
  18 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT\r
  19 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,\r
  20 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY\r
  21 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT\r
  22 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF\r
  23 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.\r
  24 *\r
  25 ******************************************************************************\r
  26 * REVISION HISTORY\r
  27 *\r
  28 * 03-01-01 Marc Boucher <marc@mbsi.ca>\r
  29 *   Ported to lwIP.\r
  30 * 97-12-04 Guy Lancaster <glanca@gesn.com>, Global Election Systems Inc.\r
  31 *   Original derived from BSD codes.\r
  32 *****************************************************************************/\r
  33 /*\r
  34  * upap.h - User/Password Authentication Protocol definitions.\r
  35  *\r
  36  * Copyright (c) 1989 Carnegie Mellon University.\r
  37  * All rights reserved.\r
  38  *\r
  39  * Redistribution and use in source and binary forms are permitted\r
  40  * provided that the above copyright notice and this paragraph are\r
  41  * duplicated in all such forms and that any documentation,\r
  42  * advertising materials, and other materials related to such\r
  43  * distribution and use acknowledge that the software was developed\r
  44  * by Carnegie Mellon University.  The name of the\r
  45  * University may not be used to endorse or promote products derived\r
  46  * from this software without specific prior written permission.\r
  47  * THIS SOFTWARE IS PROVIDED ``AS IS'' AND WITHOUT ANY EXPRESS OR\r
  48  * IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED\r
  49  * WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR A PARTICULAR PURPOSE.\r
  50  */\r
  51 \r
  52 #ifndef PAP_H\r
  53 #define PAP_H\r
  54 \r
  55 #if PAP_SUPPORT /* don't build if not configured for use in lwipopts.h */\r
  56 \r
  57 /*************************\r
  58 *** PUBLIC DEFINITIONS ***\r
  59 *************************/\r
  60 /*\r
  61  * Packet header = Code, id, length.\r
  62  */\r
  63 #define UPAP_HEADERLEN (sizeof (u_char) + sizeof (u_char) + sizeof (u_short))\r
  64 \r
  65 \r
  66 /*\r
  67  * UPAP codes.\r
  68  */\r
  69 #define UPAP_AUTHREQ 1 /* Authenticate-Request */\r
  70 #define UPAP_AUTHACK 2 /* Authenticate-Ack */\r
  71 #define UPAP_AUTHNAK 3 /* Authenticate-Nak */\r
  72 \r
  73 /*\r
  74  * Client states.\r
  75  */\r
  76 #define UPAPCS_INITIAL 0 /* Connection down */\r
  77 #define UPAPCS_CLOSED  1 /* Connection up, haven't requested auth */\r
  78 #define UPAPCS_PENDING 2 /* Connection down, have requested auth */\r
  79 #define UPAPCS_AUTHREQ 3 /* We've sent an Authenticate-Request */\r
  80 #define UPAPCS_OPEN    4 /* We've received an Ack */\r
  81 #define UPAPCS_BADAUTH 5 /* We've received a Nak */\r
  82 \r
  83 /*\r
  84  * Server states.\r
  85  */\r
  86 #define UPAPSS_INITIAL 0 /* Connection down */\r
  87 #define UPAPSS_CLOSED  1 /* Connection up, haven't requested auth */\r
  88 #define UPAPSS_PENDING 2 /* Connection down, have requested auth */\r
  89 #define UPAPSS_LISTEN  3 /* Listening for an Authenticate */\r
  90 #define UPAPSS_OPEN    4 /* We've sent an Ack */\r
  91 #define UPAPSS_BADAUTH 5 /* We've sent a Nak */\r
  92 \r
  93 \r
  94 /************************\r
  95 *** PUBLIC DATA TYPES ***\r
  96 ************************/\r
  97 \r
  98 /*\r
  99  * Each interface is described by upap structure.\r
 100  */\r
 101 typedef struct upap_state {\r
 102   int us_unit;           /* Interface unit number */\r
 103   const char *us_user;   /* User */\r
 104   int us_userlen;        /* User length */\r
 105   const char *us_passwd; /* Password */\r
 106   int us_passwdlen;      /* Password length */\r
 107   int us_clientstate;    /* Client state */\r
 108   int us_serverstate;    /* Server state */\r
 109   u_char us_id;          /* Current id */\r
 110   int us_timeouttime;    /* Timeout (seconds) for auth-req retrans. */\r
 111   int us_transmits;      /* Number of auth-reqs sent */\r
 112   int us_maxtransmits;   /* Maximum number of auth-reqs to send */\r
 113   int us_reqtimeout;     /* Time to wait for auth-req from peer */\r
 114 } upap_state;\r
 115 \r
 116 \r
 117 /***********************\r
 118 *** PUBLIC FUNCTIONS ***\r
 119 ***********************/\r
 120 \r
 121 extern upap_state upap[];\r
 122 \r
 123 void upap_setloginpasswd(int unit, const char *luser, const char *lpassword);\r
 124 void upap_authwithpeer  (int, char *, char *);\r
 125 void upap_authpeer      (int);\r
 126 \r
 127 extern struct protent pap_protent;\r
 128 \r
 129 #endif /* PAP_SUPPORT */\r
 130 \r
 131 #endif /* PAP_H */\r