SAMV71 Xplained Ultra Software Package 1.4

ppp.h

00001 /*****************************************************************************
00002 * ppp.h - Network Point to Point Protocol header file.
00003 *
00004 * Copyright (c) 2003 by Marc Boucher, Services Informatiques (MBSI) inc.
00005 * portions Copyright (c) 1997 Global Election Systems Inc.
00006 *
00007 * The authors hereby grant permission to use, copy, modify, distribute,
00008 * and license this software and its documentation for any purpose, provided
00009 * that existing copyright notices are retained in all copies and that this
00010 * notice and the following disclaimer are included verbatim in any 
00011 * distributions. No written agreement, license, or royalty fee is required
00012 * for any of the authorized uses.
00013 *
00014 * THIS SOFTWARE IS PROVIDED BY THE CONTRIBUTORS *AS IS* AND ANY EXPRESS OR
00015 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
00016 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. 
00017 * IN NO EVENT SHALL THE CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
00018 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
00019 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
00020 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
00021 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
00022 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
00023 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
00024 *
00025 ******************************************************************************
00026 * REVISION HISTORY
00027 *
00028 * 03-01-01 Marc Boucher <marc@mbsi.ca>
00029 *   Ported to lwIP.
00030 * 97-11-05 Guy Lancaster <glanca@gesn.com>, Global Election Systems Inc.
00031 *   Original derived from BSD codes.
00032 *****************************************************************************/
00033 
00034 #ifndef PPP_H
00035 #define PPP_H
00036 
00037 #include "lwip/opt.h"
00038 
00039 #if PPP_SUPPORT /* don't build if not configured for use in lwipopts.h */
00040 
00041 #include "lwip/def.h"
00042 #include "lwip/sio.h"
00043 #include "lwip/api.h"
00044 #include "lwip/sockets.h"
00045 #include "lwip/stats.h"
00046 #include "lwip/mem.h"
00047 #include "lwip/tcpip.h"
00048 #include "lwip/netif.h"
00049 
00050 /*
00051  * pppd.h - PPP daemon global declarations.
00052  *
00053  * Copyright (c) 1989 Carnegie Mellon University.
00054  * All rights reserved.
00055  *
00056  * Redistribution and use in source and binary forms are permitted
00057  * provided that the above copyright notice and this paragraph are
00058  * duplicated in all such forms and that any documentation,
00059  * advertising materials, and other materials related to such
00060  * distribution and use acknowledge that the software was developed
00061  * by Carnegie Mellon University.  The name of the
00062  * University may not be used to endorse or promote products derived
00063  * from this software without specific prior written permission.
00064  * THIS SOFTWARE IS PROVIDED ``AS IS'' AND WITHOUT ANY EXPRESS OR
00065  * IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED
00066  * WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR A PARTICULAR PURPOSE.
00067  *
00068  */
00069 /*
00070  * ppp_defs.h - PPP definitions.
00071  *
00072  * Copyright (c) 1994 The Australian National University.
00073  * All rights reserved.
00074  *
00075  * Permission to use, copy, modify, and distribute this software and its
00076  * documentation is hereby granted, provided that the above copyright
00077  * notice appears in all copies.  This software is provided without any
00078  * warranty, express or implied. The Australian National University
00079  * makes no representations about the suitability of this software for
00080  * any purpose.
00081  *
00082  * IN NO EVENT SHALL THE AUSTRALIAN NATIONAL UNIVERSITY BE LIABLE TO ANY
00083  * PARTY FOR DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES
00084  * ARISING OUT OF THE USE OF THIS SOFTWARE AND ITS DOCUMENTATION, EVEN IF
00085  * THE AUSTRALIAN NATIONAL UNIVERSITY HAVE BEEN ADVISED OF THE POSSIBILITY
00086  * OF SUCH DAMAGE.
00087  *
00088  * THE AUSTRALIAN NATIONAL UNIVERSITY SPECIFICALLY DISCLAIMS ANY WARRANTIES,
00089  * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY
00090  * AND FITNESS FOR A PARTICULAR PURPOSE.  THE SOFTWARE PROVIDED HEREUNDER IS
00091  * ON AN "AS IS" BASIS, AND THE AUSTRALIAN NATIONAL UNIVERSITY HAS NO
00092  * OBLIGATION TO PROVIDE MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS,
00093  * OR MODIFICATIONS.
00094  */
00095 
00096 #define TIMEOUT(f, a, t)    sys_untimeout((f), (a)), sys_timeout((t)*1000, (f), (a))
00097 #define UNTIMEOUT(f, a)     sys_untimeout((f), (a))
00098 
00099 
00100 #ifndef __u_char_defined
00101 
00102 /* Type definitions for BSD code. */
00103 typedef unsigned long  u_long;
00104 typedef unsigned int   u_int;
00105 typedef unsigned short u_short;
00106 typedef unsigned char  u_char;
00107 
00108 #endif
00109 
00110 /*
00111  * Constants and structures defined by the internet system,
00112  * Per RFC 790, September 1981, and numerous additions.
00113  */
00114 
00115 /*
00116  * The basic PPP frame.
00117  */
00118 #define PPP_HDRLEN      4       /* octets for standard ppp header */
00119 #define PPP_FCSLEN      2       /* octets for FCS */
00120 
00121 
00122 /*
00123  * Significant octet values.
00124  */
00125 #define PPP_ALLSTATIONS 0xff    /* All-Stations broadcast address */
00126 #define PPP_UI          0x03    /* Unnumbered Information */
00127 #define PPP_FLAG        0x7e    /* Flag Sequence */
00128 #define PPP_ESCAPE      0x7d    /* Asynchronous Control Escape */
00129 #define PPP_TRANS       0x20    /* Asynchronous transparency modifier */
00130 
00131 /*
00132  * Protocol field values.
00133  */
00134 #define PPP_IP          0x21    /* Internet Protocol */
00135 #define PPP_AT          0x29    /* AppleTalk Protocol */
00136 #define PPP_VJC_COMP    0x2d    /* VJ compressed TCP */
00137 #define PPP_VJC_UNCOMP  0x2f    /* VJ uncompressed TCP */
00138 #define PPP_COMP        0xfd    /* compressed packet */
00139 #define PPP_IPCP        0x8021  /* IP Control Protocol */
00140 #define PPP_ATCP        0x8029  /* AppleTalk Control Protocol */
00141 #define PPP_CCP         0x80fd  /* Compression Control Protocol */
00142 #define PPP_LCP         0xc021  /* Link Control Protocol */
00143 #define PPP_PAP         0xc023  /* Password Authentication Protocol */
00144 #define PPP_LQR         0xc025  /* Link Quality Report protocol */
00145 #define PPP_CHAP        0xc223  /* Cryptographic Handshake Auth. Protocol */
00146 #define PPP_CBCP        0xc029  /* Callback Control Protocol */
00147 
00148 /*
00149  * Values for FCS calculations.
00150  */
00151 #define PPP_INITFCS     0xffff  /* Initial FCS value */
00152 #define PPP_GOODFCS     0xf0b8  /* Good final FCS value */
00153 #define PPP_FCS(fcs, c) (((fcs) >> 8) ^ fcstab[((fcs) ^ (c)) & 0xff])
00154 
00155 /*
00156  * Extended asyncmap - allows any character to be escaped.
00157  */
00158 typedef u_char  ext_accm[32];
00159 
00160 /*
00161  * What to do with network protocol (NP) packets.
00162  */
00163 enum NPmode {
00164   NPMODE_PASS,        /* pass the packet through */
00165   NPMODE_DROP,        /* silently drop the packet */
00166   NPMODE_ERROR,       /* return an error */
00167   NPMODE_QUEUE        /* save it up for later. */
00168 };
00169 
00170 /*
00171  * Inline versions of get/put char/short/long.
00172  * Pointer is advanced; we assume that both arguments
00173  * are lvalues and will already be in registers.
00174  * cp MUST be u_char *.
00175  */
00176 #define GETCHAR(c, cp) { \
00177     (c) = *(cp)++; \
00178 }
00179 #define PUTCHAR(c, cp) { \
00180     *(cp)++ = (u_char) (c); \
00181 }
00182 
00183 
00184 #define GETSHORT(s, cp) { \
00185     (s) = *(cp); (cp)++; (s) <<= 8; \
00186     (s) |= *(cp); (cp)++; \
00187 }
00188 #define PUTSHORT(s, cp) { \
00189     *(cp)++ = (u_char) ((s) >> 8); \
00190     *(cp)++ = (u_char) (s & 0xff); \
00191 }
00192 
00193 #define GETLONG(l, cp) { \
00194     (l) = *(cp); (cp)++; (l) <<= 8; \
00195     (l) |= *(cp); (cp)++; (l) <<= 8; \
00196     (l) |= *(cp); (cp)++; (l) <<= 8; \
00197     (l) |= *(cp); (cp)++; \
00198 }
00199 #define PUTLONG(l, cp) { \
00200     *(cp)++ = (u_char) ((l) >> 24); \
00201     *(cp)++ = (u_char) ((l) >> 16); \
00202     *(cp)++ = (u_char) ((l) >> 8); \
00203     *(cp)++ = (u_char) (l); \
00204 }
00205 
00206 
00207 #define INCPTR(n, cp)   ((cp) += (n))
00208 #define DECPTR(n, cp)   ((cp) -= (n))
00209 
00210 #define BCMP(s0, s1, l)     memcmp((u_char *)(s0), (u_char *)(s1), (l))
00211 #define BCOPY(s, d, l)      MEMCPY((d), (s), (l))
00212 #define BZERO(s, n)         memset(s, 0, n)
00213 
00214 #if PPP_DEBUG
00215 #define PRINTMSG(m, l)  { m[l] = '\0'; ppp_trace(LOG_INFO, "Remote message: %s\n", m); }
00216 #else  /* PPP_DEBUG */
00217 #define PRINTMSG(m, l)
00218 #endif /* PPP_DEBUG */
00219 
00220 /*
00221  * MAKEHEADER - Add PPP Header fields to a packet.
00222  */
00223 #define MAKEHEADER(p, t) { \
00224     PUTCHAR(PPP_ALLSTATIONS, p); \
00225     PUTCHAR(PPP_UI, p); \
00226     PUTSHORT(t, p); }
00227 
00228 /*************************
00229 *** PUBLIC DEFINITIONS ***
00230 *************************/
00231 
00232 /* Error codes. */
00233 #define PPPERR_NONE      0 /* No error. */
00234 #define PPPERR_PARAM    -1 /* Invalid parameter. */
00235 #define PPPERR_OPEN     -2 /* Unable to open PPP session. */
00236 #define PPPERR_DEVICE   -3 /* Invalid I/O device for PPP. */
00237 #define PPPERR_ALLOC    -4 /* Unable to allocate resources. */
00238 #define PPPERR_USER     -5 /* User interrupt. */
00239 #define PPPERR_CONNECT  -6 /* Connection lost. */
00240 #define PPPERR_AUTHFAIL -7 /* Failed authentication challenge. */
00241 #define PPPERR_PROTOCOL -8 /* Failed to meet protocol. */
00242 
00243 /*
00244  * PPP IOCTL commands.
00245  */
00246 /*
00247  * Get the up status - 0 for down, non-zero for up.  The argument must
00248  * point to an int.
00249  */
00250 #define PPPCTLG_UPSTATUS 100 /* Get the up status - 0 down else up */
00251 #define PPPCTLS_ERRCODE  101 /* Set the error code */
00252 #define PPPCTLG_ERRCODE  102 /* Get the error code */
00253 #define PPPCTLG_FD       103 /* Get the fd associated with the ppp */
00254 
00255 /************************
00256 *** PUBLIC DATA TYPES ***
00257 ************************/
00258 
00259 /*
00260  * The following struct gives the addresses of procedures to call
00261  * for a particular protocol.
00262  */
00263 struct protent {
00264     u_short protocol;       /* PPP protocol number */
00265     /* Initialization procedure */
00266     void (*init) (int unit);
00267     /* Process a received packet */
00268     void (*input) (int unit, u_char *pkt, int len);
00269     /* Process a received protocol-reject */
00270     void (*protrej) (int unit);
00271     /* Lower layer has come up */
00272     void (*lowerup) (int unit);
00273     /* Lower layer has gone down */
00274     void (*lowerdown) (int unit);
00275     /* Open the protocol */
00276     void (*open) (int unit);
00277     /* Close the protocol */
00278     void (*close) (int unit, char *reason);
00279 #if 0
00280     /* Print a packet in readable form */
00281     int  (*printpkt) (u_char *pkt, int len,
00282               void (*printer) (void *, char *, ...),
00283               void *arg);
00284     /* Process a received data packet */
00285     void (*datainput) (int unit, u_char *pkt, int len);
00286 #endif
00287     int  enabled_flag;      /* 0 iff protocol is disabled */
00288     char *name;         /* Text name of protocol */
00289 #if 0
00290     /* Check requested options, assign defaults */
00291     void (*check_options) (u_long);
00292     /* Configure interface for demand-dial */
00293     int  (*demand_conf) (int unit);
00294     /* Say whether to bring up link for this pkt */
00295     int  (*active_pkt) (u_char *pkt, int len);
00296 #endif
00297 };
00298 
00299 /*
00300  * The following structure records the time in seconds since
00301  * the last NP packet was sent or received.
00302  */
00303 struct ppp_idle {
00304   u_short xmit_idle;      /* seconds since last NP packet sent */
00305   u_short recv_idle;      /* seconds since last NP packet received */
00306 };
00307 
00308 struct ppp_settings {
00309 
00310   u_int  disable_defaultip : 1;       /* Don't use hostname for default IP addrs */
00311   u_int  auth_required     : 1;       /* Peer is required to authenticate */
00312   u_int  explicit_remote   : 1;       /* remote_name specified with remotename opt */
00313   u_int  refuse_pap        : 1;       /* Don't wanna auth. ourselves with PAP */
00314   u_int  refuse_chap       : 1;       /* Don't wanna auth. ourselves with CHAP */
00315   u_int  usehostname       : 1;       /* Use hostname for our_name */
00316   u_int  usepeerdns        : 1;       /* Ask peer for DNS adds */
00317 
00318   u_short idle_time_limit;            /* Shut down link if idle for this long */
00319   int  maxconnect;                    /* Maximum connect time (seconds) */
00320 
00321   char user       [MAXNAMELEN   + 1]; /* Username for PAP */
00322   char passwd     [MAXSECRETLEN + 1]; /* Password for PAP, secret for CHAP */
00323   char our_name   [MAXNAMELEN   + 1]; /* Our name for authentication purposes */
00324   char remote_name[MAXNAMELEN   + 1]; /* Peer's name for authentication */
00325 };
00326 
00327 struct ppp_addrs {
00328   struct ip_addr our_ipaddr, his_ipaddr, netmask, dns1, dns2;
00329 };
00330 
00331 /*****************************
00332 *** PUBLIC DATA STRUCTURES ***
00333 *****************************/
00334 
00335 /* Buffers for outgoing packets. */
00336 extern u_char outpacket_buf[NUM_PPP][PPP_MRU+PPP_HDRLEN];
00337 
00338 extern struct ppp_settings ppp_settings;
00339 
00340 extern struct protent *ppp_protocols[]; /* Table of pointers to supported protocols */
00341 
00342 
00343 /***********************
00344 *** PUBLIC FUNCTIONS ***
00345 ***********************/
00346 
00347 /* Initialize the PPP subsystem. */
00348 void pppInit(void);
00349 
00350 /* Warning: Using PPPAUTHTYPE_ANY might have security consequences.
00351  * RFC 1994 says:
00352  *
00353  * In practice, within or associated with each PPP server, there is a
00354  * database which associates "user" names with authentication
00355  * information ("secrets").  It is not anticipated that a particular
00356  * named user would be authenticated by multiple methods.  This would
00357  * make the user vulnerable to attacks which negotiate the least secure
00358  * method from among a set (such as PAP rather than CHAP).  If the same
00359  * secret was used, PAP would reveal the secret to be used later with
00360  * CHAP.
00361  *
00362  * Instead, for each user name there should be an indication of exactly
00363  * one method used to authenticate that user name.  If a user needs to
00364  * make use of different authentication methods under different
00365  * circumstances, then distinct user names SHOULD be employed, each of
00366  * which identifies exactly one authentication method.
00367  *
00368  */
00369 enum pppAuthType {
00370     PPPAUTHTYPE_NONE,
00371     PPPAUTHTYPE_ANY,
00372     PPPAUTHTYPE_PAP,
00373     PPPAUTHTYPE_CHAP
00374 };
00375 
00376 void pppSetAuth(enum pppAuthType authType, const char *user, const char *passwd);
00377 
00378 /*
00379  * Open a new PPP connection using the given serial I/O device.
00380  * This initializes the PPP control block but does not
00381  * attempt to negotiate the LCP session.
00382  * Return a new PPP connection descriptor on success or
00383  * an error code (negative) on failure. 
00384  */
00385 int pppOverSerialOpen(sio_fd_t fd, void (*linkStatusCB)(void *ctx, int errCode, void *arg), void *linkStatusCtx);
00386 
00387 /*
00388  * Open a new PPP Over Ethernet (PPPOE) connection.
00389  */
00390 int pppOverEthernetOpen(struct netif *ethif, const char *service_name, const char *concentrator_name, void (*linkStatusCB)(void *ctx, int errCode, void *arg), void *linkStatusCtx);
00391 
00392 /* for source code compatibility */
00393 #define pppOpen(fd,cb,ls) pppOverSerialOpen(fd,cb,ls)
00394 
00395 /*
00396  * Close a PPP connection and release the descriptor. 
00397  * Any outstanding packets in the queues are dropped.
00398  * Return 0 on success, an error code on failure. 
00399  */
00400 int pppClose(int pd);
00401 
00402 /*
00403  * Indicate to the PPP process that the line has disconnected.
00404  */
00405 void pppSigHUP(int pd);
00406 
00407 /*
00408  * Get and set parameters for the given connection.
00409  * Return 0 on success, an error code on failure. 
00410  */
00411 int  pppIOCtl(int pd, int cmd, void *arg);
00412 
00413 /*
00414  * Return the Maximum Transmission Unit for the given PPP connection.
00415  */
00416 u_int pppMTU(int pd);
00417 
00418 /*
00419  * Write n characters to a ppp link.
00420  * RETURN: >= 0 Number of characters written, -1 Failed to write to device.
00421  */
00422 int pppWrite(int pd, const u_char *s, int n);
00423 
00424 void pppInProcOverEthernet(int pd, struct pbuf *pb);
00425 
00426 struct pbuf *pppSingleBuf(struct pbuf *p);
00427 
00428 void pppLinkTerminated(int pd);
00429 
00430 void pppLinkDown(int pd);
00431 
00432 void pppMainWakeup(int pd);
00433 
00434 /* Configure i/f transmit parameters */
00435 void ppp_send_config (int, int, u32_t, int, int);
00436 /* Set extended transmit ACCM */
00437 void ppp_set_xaccm (int, ext_accm *);
00438 /* Configure i/f receive parameters */
00439 void ppp_recv_config (int, int, u32_t, int, int);
00440 /* Find out how long link has been idle */
00441 int  get_idle_time (int, struct ppp_idle *);
00442 
00443 /* Configure VJ TCP header compression */
00444 int  sifvjcomp (int, int, int, int);
00445 /* Configure i/f down (for IP) */
00446 int  sifup (int);
00447 /* Set mode for handling packets for proto */
00448 int  sifnpmode (int u, int proto, enum NPmode mode);
00449 /* Configure i/f down (for IP) */
00450 int  sifdown (int);
00451 /* Configure IP addresses for i/f */
00452 int  sifaddr (int, u32_t, u32_t, u32_t, u32_t, u32_t);
00453 /* Reset i/f IP addresses */
00454 int  cifaddr (int, u32_t, u32_t);
00455 /* Create default route through i/f */
00456 int  sifdefaultroute (int, u32_t, u32_t);
00457 /* Delete default route through i/f */
00458 int  cifdefaultroute (int, u32_t, u32_t);
00459 
00460 /* Get appropriate netmask for address */
00461 u32_t GetMask (u32_t); 
00462 
00463 #endif /* PPP_SUPPORT */
00464 
00465 #endif /* PPP_H */
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Defines