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