ppp.h
上传用户:yyhongfa
上传日期:2013-01-18
资源大小:267k
文件大小:15k
开发平台:

C/C++

  1. /*****************************************************************************
  2. * ppp.h - Network Point to Point Protocol header file.
  3. *
  4. * Copyright (c) 2003 by Marc Boucher, Services Informatiques (MBSI) inc.
  5. * portions Copyright (c) 1997 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@mbsi.ca>
  29. *   Ported to lwIP.
  30. * 97-11-05 Guy Lancaster <glanca@gesn.com>, Global Election Systems Inc.
  31. * Original derived from BSD codes.
  32. *****************************************************************************/
  33. #ifndef PPP_H
  34. #define PPP_H
  35. #include "lwip/opt.h"
  36. #if PPP_SUPPORT > 0
  37. #include "lwip/sio.h"
  38. #include "lwip/api.h"
  39. #include "lwip/sockets.h"
  40. #include "lwip/stats.h"
  41. #include "lwip/mem.h"
  42. #include "lwip/tcpip.h"
  43. #include "lwip/netif.h"
  44. /*
  45.  * pppd.h - PPP daemon global declarations.
  46.  *
  47.  * Copyright (c) 1989 Carnegie Mellon University.
  48.  * All rights reserved.
  49.  *
  50.  * Redistribution and use in source and binary forms are permitted
  51.  * provided that the above copyright notice and this paragraph are
  52.  * duplicated in all such forms and that any documentation,
  53.  * advertising materials, and other materials related to such
  54.  * distribution and use acknowledge that the software was developed
  55.  * by Carnegie Mellon University.  The name of the
  56.  * University may not be used to endorse or promote products derived
  57.  * from this software without specific prior written permission.
  58.  * THIS SOFTWARE IS PROVIDED ``AS IS'' AND WITHOUT ANY EXPRESS OR
  59.  * IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED
  60.  * WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR A PARTICULAR PURPOSE.
  61.  *
  62.  */
  63. /*
  64.  * ppp_defs.h - PPP definitions.
  65.  *
  66.  * Copyright (c) 1994 The Australian National University.
  67.  * All rights reserved.
  68.  *
  69.  * Permission to use, copy, modify, and distribute this software and its
  70.  * documentation is hereby granted, provided that the above copyright
  71.  * notice appears in all copies.  This software is provided without any
  72.  * warranty, express or implied. The Australian National University
  73.  * makes no representations about the suitability of this software for
  74.  * any purpose.
  75.  *
  76.  * IN NO EVENT SHALL THE AUSTRALIAN NATIONAL UNIVERSITY BE LIABLE TO ANY
  77.  * PARTY FOR DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES
  78.  * ARISING OUT OF THE USE OF THIS SOFTWARE AND ITS DOCUMENTATION, EVEN IF
  79.  * THE AUSTRALIAN NATIONAL UNIVERSITY HAVE BEEN ADVISED OF THE POSSIBILITY
  80.  * OF SUCH DAMAGE.
  81.  *
  82.  * THE AUSTRALIAN NATIONAL UNIVERSITY SPECIFICALLY DISCLAIMS ANY WARRANTIES,
  83.  * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY
  84.  * AND FITNESS FOR A PARTICULAR PURPOSE.  THE SOFTWARE PROVIDED HEREUNDER IS
  85.  * ON AN "AS IS" BASIS, AND THE AUSTRALIAN NATIONAL UNIVERSITY HAS NO
  86.  * OBLIGATION TO PROVIDE MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS,
  87.  * OR MODIFICATIONS.
  88.  */
  89. //#define TIMEOUT(f, a, t)    sys_untimeout((f), (a)), sys_timeout((t)*1000, (f), (a))
  90. #define TIMEOUT(f, a, t)      sys_timer_start((t)*1000, (f), (a))
  91. #define UNTIMEOUT(f, a)     sys_timer_stop((f), (a))
  92. # ifndef __u_char_defined
  93. /* Type definitions for BSD code. */
  94. typedef unsigned long u_long;
  95. typedef unsigned int u_int;
  96. typedef unsigned short u_short;
  97. typedef unsigned char u_char;
  98. typedef unsigned int u32_t;
  99. #endif
  100. /*
  101.  * Constants and structures defined by the internet system,
  102.  * Per RFC 790, September 1981, and numerous additions.
  103.  */
  104. /*
  105.  * The basic PPP frame.
  106.  */
  107. #define PPP_HDRLEN  4       /* octets for standard ppp header */
  108. #define PPP_FCSLEN  2       /* octets for FCS */
  109. /*
  110.  * Significant octet values.
  111.  */
  112. #define PPP_ALLSTATIONS 0xff    /* All-Stations broadcast address */
  113. #define PPP_UI          0x03    /* Unnumbered Information */
  114. #define PPP_FLAG        0x7e    /* Flag Sequence */
  115. #define PPP_ESCAPE      0x7d    /* Asynchronous Control Escape */
  116. #define PPP_TRANS       0x20    /* Asynchronous transparency modifier */
  117. /*
  118.  * Protocol field values.
  119.  */
  120. #define PPP_IP          0x21    /* Internet Protocol */
  121. #define PPP_AT          0x29    /* AppleTalk Protocol */
  122. #define PPP_VJC_COMP    0x2d    /* VJ compressed TCP */
  123. #define PPP_VJC_UNCOMP  0x2f    /* VJ uncompressed TCP */
  124. #define PPP_COMP        0xfd    /* compressed packet */
  125. #define PPP_IPCP        0x8021  /* IP Control Protocol */
  126. #define PPP_ATCP        0x8029  /* AppleTalk Control Protocol */
  127. #define PPP_CCP         0x80fd  /* Compression Control Protocol */
  128. #define PPP_LCP         0xc021  /* Link Control Protocol */
  129. #define PPP_PAP         0xc023  /* Password Authentication Protocol */
  130. #define PPP_LQR         0xc025  /* Link Quality Report protocol */
  131. #define PPP_CHAP        0xc223  /* Cryptographic Handshake Auth. Protocol */
  132. #define PPP_CBCP        0xc029  /* Callback Control Protocol */
  133. /*
  134.  * Values for FCS calculations.
  135.  */
  136. #define PPP_INITFCS 0xffff  /* Initial FCS value */
  137. #define PPP_GOODFCS 0xf0b8  /* Good final FCS value */
  138. #define PPP_FCS(fcs, c) (((fcs) >> 8) ^ fcstab[((fcs) ^ (c)) & 0xff])
  139. /*
  140.  * Extended asyncmap - allows any character to be escaped.
  141.  */
  142. typedef u_char  ext_accm[32];
  143. /*
  144.  * What to do with network protocol (NP) packets.
  145.  */
  146. enum NPmode {
  147.     NPMODE_PASS,        /* pass the packet through */
  148.     NPMODE_DROP,        /* silently drop the packet */
  149.     NPMODE_ERROR,       /* return an error */
  150.     NPMODE_QUEUE        /* save it up for later. */
  151. };
  152. /*
  153.  * Inline versions of get/put char/short/long.
  154.  * Pointer is advanced; we assume that both arguments
  155.  * are lvalues and will already be in registers.
  156.  * cp MUST be u_char *.
  157.  */
  158. #define GETCHAR(c, cp) { 
  159.     (c) = *(cp)++; 
  160. }
  161. #define PUTCHAR(c, cp) { 
  162.     *(cp)++ = (u_char) (c); 
  163. }
  164. #define GETSHORT(s, cp) { 
  165.     (s) = *(cp)++ << 8; 
  166.     (s) |= *(cp)++; 
  167. }
  168. #define PUTSHORT(s, cp) { 
  169.     *(cp)++ = (u_char) ((s) >> 8); 
  170.     *(cp)++ = (u_char) (s); 
  171. }
  172. #define GETLONG(l, cp) { 
  173.     (l) = *(cp)++ << 8; 
  174.     (l) |= *(cp)++; (l) <<= 8; 
  175.     (l) |= *(cp)++; (l) <<= 8; 
  176.     (l) |= *(cp)++; 
  177. }
  178. #define PUTLONG(l, cp) { 
  179.     *(cp)++ = (u_char) ((l) >> 24); 
  180.     *(cp)++ = (u_char) ((l) >> 16); 
  181.     *(cp)++ = (u_char) ((l) >> 8); 
  182.     *(cp)++ = (u_char) (l); 
  183. }
  184. #define INCPTR(n, cp)   ((cp) += (n))
  185. #define DECPTR(n, cp)   ((cp) -= (n))
  186. #define BCMP(s0, s1, l)     memcmp((u_char *)(s0), (u_char *)(s1), (l))
  187. #define BCOPY(s, d, l)      memcpy((d), (s), (l))
  188. #define BZERO(s, n)         memset(s, 0, n)
  189. #if PPP_DEBUG
  190. #define PRINTMSG(m, l)  { m[l] = ''; ppp_trace(LOG_INFO, "Remote message: %sn", m); }
  191. #else
  192. #define PRINTMSG(m, l)
  193. #endif
  194. /*
  195.  * MAKEHEADER - Add PPP Header fields to a packet.
  196.  */
  197. #define MAKEHEADER(p, t) { 
  198.     PUTCHAR(PPP_ALLSTATIONS, p); 
  199.     PUTCHAR(PPP_UI, p); 
  200.     PUTSHORT(t, p); }
  201. /*************************
  202. *** PUBLIC DEFINITIONS ***
  203. *************************/
  204. /* Error codes. */
  205. #define PPPERR_NONE 0 /* No error. */
  206. #define PPPERR_PARAM -1 /* Invalid parameter. */
  207. #define PPPERR_OPEN -2 /* Unable to open PPP session. */
  208. #define PPPERR_DEVICE -3 /* Invalid I/O device for PPP. */
  209. #define PPPERR_ALLOC -4 /* Unable to allocate resources. */
  210. #define PPPERR_USER -5 /* User interrupt. */
  211. #define PPPERR_CONNECT -6 /* Connection lost. */
  212. #define PPPERR_AUTHFAIL -7 /* Failed authentication challenge. */
  213. #define PPPERR_PROTOCOL -8 /* Failed to meet protocol. */
  214. /*
  215.  * PPP IOCTL commands.
  216.  */
  217. /*
  218.  * Get the up status - 0 for down, non-zero for up.  The argument must
  219.  * point to an int.
  220.  */
  221. #define PPPCTLG_UPSTATUS 100 /* Get the up status - 0 down else up */
  222. #define PPPCTLS_ERRCODE 101 /* Set the error code */
  223. #define PPPCTLG_ERRCODE 102 /* Get the error code */
  224. #define PPPCTLG_FD 103 /* Get the fd associated with the ppp */
  225. /************************
  226. *** PUBLIC DATA TYPES ***
  227. ************************/
  228. /*
  229.  * The following struct gives the addresses of procedures to call
  230.  * for a particular protocol.
  231.  */
  232. struct protent {
  233.     u_short protocol;       /* PPP protocol number */
  234.     /* Initialization procedure */
  235.     void (*init) (int unit);
  236.     /* Process a received packet */
  237.     void (*input) (int unit, u_char *pkt, int len);
  238.     /* Process a received protocol-reject */
  239.     void (*protrej) (int unit);
  240.     /* Lower layer has come up */
  241.     void (*lowerup) (int unit);
  242.     /* Lower layer has gone down */
  243.     void (*lowerdown) (int unit);
  244.     /* Open the protocol */
  245.     void (*open) (int unit);
  246.     /* Close the protocol */
  247.     void (*close) (int unit, char *reason);
  248. #if 0
  249.     /* Print a packet in readable form */
  250.     int  (*printpkt) (u_char *pkt, int len,
  251.               void (*printer) (void *, char *, ...),
  252.               void *arg);
  253.     /* Process a received data packet */
  254.     void (*datainput) (int unit, u_char *pkt, int len);
  255. #endif
  256.     int  enabled_flag;      /* 0 iff protocol is disabled */
  257.     char *name;         /* Text name of protocol */
  258. #if 0
  259.     /* Check requested options, assign defaults */
  260.     void (*check_options) (u_long);
  261.     /* Configure interface for demand-dial */
  262.     int  (*demand_conf) (int unit);
  263.     /* Say whether to bring up link for this pkt */
  264.     int  (*active_pkt) (u_char *pkt, int len);
  265. #endif
  266. };
  267. /*
  268.  * The following structure records the time in seconds since
  269.  * the last NP packet was sent or received.
  270.  */
  271. struct ppp_idle {
  272.     u_short xmit_idle;      /* seconds since last NP packet sent */
  273.     u_short recv_idle;      /* seconds since last NP packet received */
  274. };
  275. /*
  276. *defined by skier 2006.01.30
  277. */
  278. #define USER             "gprs"
  279. #define PASSWORD   "gprs"
  280. struct ppp_settings {
  281. u_int  disable_defaultip : 1;   /* Don't use hostname for default IP addrs */
  282. u_int  auth_required : 1;      /* Peer is required to authenticate */
  283. u_int  explicit_remote : 1;    /* remote_name specified with remotename opt */
  284. u_int  refuse_pap : 1;         /* Don't wanna auth. ourselves with PAP */
  285. u_int  refuse_chap : 1;        /* Don't wanna auth. ourselves with CHAP */
  286. u_int  usehostname : 1;        /* Use hostname for our_name */
  287. u_int  usepeerdns : 1;         /* Ask peer for DNS adds */
  288. u_short idle_time_limit; /* Shut down link if idle for this long */
  289. int  maxconnect;         /* Maximum connect time (seconds) */
  290. char user[MAXNAMELEN + 1];/* Username for PAP */
  291. char passwd[MAXSECRETLEN + 1];           /* Password for PAP, secret for CHAP */
  292. char our_name[MAXNAMELEN + 1];         /* Our name for authentication purposes */
  293. char remote_name[MAXNAMELEN + 1];      /* Peer's name for authentication */
  294. };
  295. struct ppp_addrs {
  296.     struct ip_addr our_ipaddr, his_ipaddr, netmask, dns1, dns2;
  297. };
  298. /*****************************
  299. *** PUBLIC DATA STRUCTURES ***
  300. *****************************/
  301. /* Buffers for outgoing packets. */
  302. extern u_char outpacket_buf[NUM_PPP][PPP_MRU+PPP_HDRLEN];
  303. extern struct ppp_settings ppp_settings;
  304. extern struct protent *ppp_protocols[];/* Table of pointers to supported protocols */
  305. /***********************
  306. *** PUBLIC FUNCTIONS ***
  307. ***********************/
  308. /* Initialize the PPP subsystem. */
  309. void pppInit(void);
  310. /* Warning: Using PPPAUTHTYPE_ANY might have security consequences.
  311.  * RFC 1994 says:
  312.  *
  313.  * In practice, within or associated with each PPP server, there is a
  314.  * database which associates "user" names with authentication
  315.  * information ("secrets").  It is not anticipated that a particular
  316.  * named user would be authenticated by multiple methods.  This would
  317.  * make the user vulnerable to attacks which negotiate the least secure
  318.  * method from among a set (such as PAP rather than CHAP).  If the same
  319.  * secret was used, PAP would reveal the secret to be used later with
  320.  * CHAP.
  321.  *
  322.  * Instead, for each user name there should be an indication of exactly
  323.  * one method used to authenticate that user name.  If a user needs to
  324.  * make use of different authentication methods under different
  325.  * circumstances, then distinct user names SHOULD be employed, each of
  326.  * which identifies exactly one authentication method.
  327.  *
  328.  */
  329. enum pppAuthType {
  330.     PPPAUTHTYPE_NONE,
  331.     PPPAUTHTYPE_ANY,
  332.     PPPAUTHTYPE_PAP,
  333.     PPPAUTHTYPE_CHAP
  334. };
  335. void pppSetAuth(enum pppAuthType authType, const char *user, const char *passwd);
  336. /*
  337.  * Open a new PPP connection using the given I/O device.
  338.  * This initializes the PPP control block but does not
  339.  * attempt to negotiate the LCP session.
  340.  * Return a new PPP connection descriptor on success or
  341.  * an error code (negative) on failure. 
  342.  */
  343. int pppOpen(sio_fd_t fd, void (*linkStatusCB)(void *ctx, int errCode, void *arg), void *linkStatusCtx);
  344. /*
  345. * added by zhouzhigang
  346. */
  347. static void pppStartCB(void *arg);
  348. /*
  349.  * Close a PPP connection and release the descriptor. 
  350.  * Any outstanding packets in the queues are dropped.
  351.  * Return 0 on success, an error code on failure. 
  352.  */
  353. int pppClose(int pd);
  354. /*
  355.  * Indicate to the PPP process that the line has disconnected.
  356.  */
  357. void pppSigHUP(int pd);
  358. /*
  359.  * Get and set parameters for the given connection.
  360.  * Return 0 on success, an error code on failure. 
  361.  */
  362. int  pppIOCtl(int pd, int cmd, void *arg);
  363. /*
  364.  * Return the Maximum Transmission Unit for the given PPP connection.
  365.  */
  366. u_int pppMTU(int pd);
  367. /*
  368.  * Write n characters to a ppp link.
  369.  * RETURN: >= 0 Number of characters written
  370.  *    -1 Failed to write to device
  371.  */
  372. int pppWrite(int pd, const u_char *s, int n);
  373. void pppMainWakeup(int pd);
  374. /* Configure i/f transmit parameters */
  375. void ppp_send_config (int, int, u32_t, int, int);
  376. /* Set extended transmit ACCM */
  377. void ppp_set_xaccm (int, ext_accm *);
  378. /* Configure i/f receive parameters */
  379. void ppp_recv_config (int, int, u32_t, int, int);
  380. /* Find out how long link has been idle */
  381. int  get_idle_time (int, struct ppp_idle *);
  382. /* Configure VJ TCP header compression */
  383. int  sifvjcomp (int, int, int, int);
  384. /* Configure i/f down (for IP) */
  385. int  sifup (int);
  386. /* Set mode for handling packets for proto */
  387. int  sifnpmode (int u, int proto, enum NPmode mode);
  388. /* Configure i/f down (for IP) */
  389. int  sifdown (int);
  390. /* Configure IP addresses for i/f */
  391. int  sifaddr (int, u32_t, u32_t, u32_t, u32_t, u32_t);
  392. /* Reset i/f IP addresses */
  393. int  cifaddr (int, u32_t, u32_t);
  394. /* Create default route through i/f */
  395. int  sifdefaultroute (int, u32_t, u32_t);
  396. /* Delete default route through i/f */
  397. int  cifdefaultroute (int, u32_t, u32_t);
  398. /* Get appropriate netmask for address */
  399. u32_t GetMask (u32_t); 
  400. #endif /* PPP_SUPPORT */
  401. #endif /* PPP_H */