1 /* 2 * pppd.h - PPP daemon global declarations. 3 * 4 * Copyright (c) 1984-2000 Carnegie Mellon University. All rights reserved. 5 * 6 * Redistribution and use in source and binary forms, with or without 7 * modification, are permitted provided that the following conditions 8 * are met: 9 * 10 * 1. Redistributions of source code must retain the above copyright 11 * notice, this list of conditions and the following disclaimer. 12 * 13 * 2. Redistributions in binary form must reproduce the above copyright 14 * notice, this list of conditions and the following disclaimer in 15 * the documentation and/or other materials provided with the 16 * distribution. 17 * 18 * 3. The name "Carnegie Mellon University" must not be used to 19 * endorse or promote products derived from this software without 20 * prior written permission. For permission or any legal 21 * details, please contact 22 * Office of Technology Transfer 23 * Carnegie Mellon University 24 * 5000 Forbes Avenue 25 * Pittsburgh, PA 15213-3890 26 * (412) 268-4387, fax: (412) 268-7395 27 * tech-transfer (at) andrew.cmu.edu 28 * 29 * 4. Redistributions of any form whatsoever must retain the following 30 * acknowledgment: 31 * "This product includes software developed by Computing Services 32 * at Carnegie Mellon University (http://www.cmu.edu/computing/)." 33 * 34 * CARNEGIE MELLON UNIVERSITY DISCLAIMS ALL WARRANTIES WITH REGARD TO 35 * THIS SOFTWARE, INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY 36 * AND FITNESS, IN NO EVENT SHALL CARNEGIE MELLON UNIVERSITY BE LIABLE 37 * FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES 38 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN 39 * AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING 40 * OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. 41 * 42 * $Id: pppd.h,v 1.88 2004/11/13 12:02:22 paulus Exp $ 43 */ 44 45 /* 46 * TODO: 47 */ 48 49 #ifndef __PPPD_H__ 50 #define __PPPD_H__ 51 52 #include <stdio.h> /* for FILE */ 53 #include <limits.h> /* for NGROUPS_MAX */ 54 #include <sys/param.h> /* for MAXPATHLEN and BSD4_4, if defined */ 55 #include <sys/types.h> /* for u_int32_t, if defined */ 56 #include <sys/time.h> /* for struct timeval */ 57 #include <net/ppp_defs.h> 58 #include "patchlevel.h" 59 60 #if defined(__STDC__) 61 #include <stdarg.h> 62 #define __V(x) x 63 #else 64 #include <varargs.h> 65 #define __V(x) (va_alist) va_dcl 66 #define const 67 #define volatile 68 #endif 69 70 #ifdef INET6 71 #include "eui64.h" 72 #endif 73 74 /* 75 * Limits. 76 */ 77 78 #define NUM_PPP 1 /* One PPP interface supported (per process) */ 79 #define MAXWORDLEN 1024 /* max length of word in file (incl null) */ 80 #define MAXARGS 1 /* max # args to a command */ 81 #define MAXNAMELEN 256 /* max length of hostname or name for auth */ 82 #define MAXSECRETLEN 256 /* max length of password or secret */ 83 84 /* 85 * Option descriptor structure. 86 */ 87 88 typedef unsigned char bool; 89 90 enum opt_type { 91 o_special_noarg = 0, 92 o_special = 1, 93 o_bool, 94 o_int, 95 o_uint32, 96 o_string, 97 o_wild 98 }; 99 100 typedef struct { 101 char *name; /* name of the option */ 102 enum opt_type type; 103 void *addr; 104 char *description; 105 unsigned int flags; 106 void *addr2; 107 int upper_limit; 108 int lower_limit; 109 const char *source; 110 short int priority; 111 short int winner; 112 } option_t; 113 114 /* Values for flags */ 115 #define OPT_VALUE 0xff /* mask for presupplied value */ 116 #define OPT_HEX 0x100 /* int option is in hex */ 117 #define OPT_NOARG 0x200 /* option doesn't take argument */ 118 #define OPT_OR 0x400 /* OR in argument to value */ 119 #define OPT_INC 0x800 /* increment value */ 120 #define OPT_A2OR 0x800 /* for o_bool, OR arg to *(u_char *)addr2 */ 121 #define OPT_PRIV 0x1000 /* privileged option */ 122 #define OPT_STATIC 0x2000 /* string option goes into static array */ 123 #define OPT_LLIMIT 0x4000 /* check value against lower limit */ 124 #define OPT_ULIMIT 0x8000 /* check value against upper limit */ 125 #define OPT_LIMITS (OPT_LLIMIT|OPT_ULIMIT) 126 #define OPT_ZEROOK 0x10000 /* 0 value is OK even if not within limits */ 127 #define OPT_HIDE 0x10000 /* for o_string, print value as ?????? */ 128 #define OPT_A2LIST 0x10000 /* for o_special, keep list of values */ 129 #define OPT_A2CLRB 0x10000 /* o_bool, clr val bits in *(u_char *)addr2 */ 130 #define OPT_NOINCR 0x20000 /* value mustn't be increased */ 131 #define OPT_ZEROINF 0x40000 /* with OPT_NOINCR, 0 == infinity */ 132 #define OPT_PRIO 0x80000 /* process option priorities for this option */ 133 #define OPT_PRIOSUB 0x100000 /* subsidiary member of priority group */ 134 #define OPT_ALIAS 0x200000 /* option is alias for previous option */ 135 #define OPT_A2COPY 0x400000 /* addr2 -> second location to rcv value */ 136 #define OPT_ENABLE 0x800000 /* use *addr2 as enable for option */ 137 #define OPT_A2CLR 0x1000000 /* clear *(bool *)addr2 */ 138 #define OPT_PRIVFIX 0x2000000 /* user can't override if set by root */ 139 #define OPT_INITONLY 0x4000000 /* option can only be set in init phase */ 140 #define OPT_DEVEQUIV 0x8000000 /* equiv to device name */ 141 #define OPT_DEVNAM (OPT_INITONLY | OPT_DEVEQUIV) 142 #define OPT_A2PRINTER 0x10000000 /* *addr2 is a fn for printing option */ 143 #define OPT_A2STRVAL 0x20000000 /* *addr2 points to current string value */ 144 #define OPT_NOPRINT 0x40000000 /* don't print this option at all */ 145 146 #define OPT_VAL(x) ((x) & OPT_VALUE) 147 148 /* Values for priority */ 149 #define OPRIO_DEFAULT 0 /* a default value */ 150 #define OPRIO_CFGFILE 1 /* value from a configuration file */ 151 #define OPRIO_CMDLINE 2 /* value from the command line */ 152 #define OPRIO_SECFILE 3 /* value from options in a secrets file */ 153 #define OPRIO_ROOT 100 /* added to priority if OPT_PRIVFIX && root */ 154 155 #ifndef GIDSET_TYPE 156 #define GIDSET_TYPE gid_t 157 #endif 158 159 /* Structure representing a list of permitted IP addresses. */ 160 struct permitted_ip { 161 int permit; /* 1 = permit, 0 = forbid */ 162 u_int32_t base; /* match if (addr & mask) == base */ 163 u_int32_t mask; /* base and mask are in network byte order */ 164 }; 165 166 /* 167 * Unfortunately, the linux kernel driver uses a different structure 168 * for statistics from the rest of the ports. 169 * This structure serves as a common representation for the bits 170 * pppd needs. 171 */ 172 struct pppd_stats { 173 unsigned int bytes_in; 174 unsigned int bytes_out; 175 unsigned int pkts_in; 176 unsigned int pkts_out; 177 }; 178 179 /* Used for storing a sequence of words. Usually malloced. */ 180 struct wordlist { 181 struct wordlist *next; 182 char *word; 183 }; 184 185 /* An endpoint discriminator, used with multilink. */ 186 #define MAX_ENDP_LEN 20 /* maximum length of discriminator value */ 187 struct epdisc { 188 unsigned char class; 189 unsigned char length; 190 unsigned char value[MAX_ENDP_LEN]; 191 }; 192 193 /* values for epdisc.class */ 194 #define EPD_NULL 0 /* null discriminator, no data */ 195 #define EPD_LOCAL 1 196 #define EPD_IP 2 197 #define EPD_MAC 3 198 #define EPD_MAGIC 4 199 #define EPD_PHONENUM 5 200 201 typedef void (*notify_func) __P((void *, int)); 202 203 struct notifier { 204 struct notifier *next; 205 notify_func func; 206 void *arg; 207 }; 208 209 /* 210 * Global variables. 211 */ 212 213 extern int hungup; /* Physical layer has disconnected */ 214 extern int ifunit; /* Interface unit number */ 215 extern char ifname[]; /* Interface name */ 216 extern char hostname[]; /* Our hostname */ 217 extern u_char outpacket_buf[]; /* Buffer for outgoing packets */ 218 extern int devfd; /* fd of underlying device */ 219 extern int fd_ppp; /* fd for talking PPP */ 220 extern int phase; /* Current state of link - see values below */ 221 extern int baud_rate; /* Current link speed in bits/sec */ 222 extern char *progname; /* Name of this program */ 223 extern int redirect_stderr;/* Connector's stderr should go to file */ 224 extern char peer_authname[];/* Authenticated name of peer */ 225 extern int auth_done[NUM_PPP]; /* Methods actually used for auth */ 226 extern int privileged; /* We were run by real-uid root */ 227 extern int need_holdoff; /* Need holdoff period after link terminates */ 228 extern char **script_env; /* Environment variables for scripts */ 229 extern int detached; /* Have detached from controlling tty */ 230 extern GIDSET_TYPE groups[NGROUPS_MAX]; /* groups the user is in */ 231 extern int ngroups; /* How many groups valid in groups */ 232 extern struct pppd_stats link_stats; /* byte/packet counts etc. for link */ 233 extern int link_stats_valid; /* set if link_stats is valid */ 234 extern unsigned link_connect_time; /* time the link was up for */ 235 extern int using_pty; /* using pty as device (notty or pty opt.) */ 236 extern int log_to_fd; /* logging to this fd as well as syslog */ 237 extern bool log_default; /* log_to_fd is default (stdout) */ 238 extern char *no_ppp_msg; /* message to print if ppp not in kernel */ 239 extern volatile int status; /* exit status for pppd */ 240 extern bool devnam_fixed; /* can no longer change devnam */ 241 extern int unsuccess; /* # unsuccessful connection attempts */ 242 extern int do_callback; /* set if we want to do callback next */ 243 extern int doing_callback; /* set if this is a callback */ 244 extern int error_count; /* # of times error() has been called */ 245 extern char ppp_devnam[MAXPATHLEN]; 246 extern char remote_number[MAXNAMELEN]; /* Remote telephone number, if avail. */ 247 extern int ppp_session_number; /* Session number (eg PPPoE session) */ 248 extern int fd_devnull; /* fd open to /dev/null */ 249 250 extern int listen_time; /* time to listen first (ms) */ 251 extern bool doing_multilink; 252 extern bool multilink_master; 253 extern bool bundle_eof; 254 extern bool bundle_terminating; 255 256 extern struct notifier *pidchange; /* for notifications of pid changing */ 257 extern struct notifier *phasechange; /* for notifications of phase changes */ 258 extern struct notifier *exitnotify; /* for notification that we're exiting */ 259 extern struct notifier *sigreceived; /* notification of received signal */ 260 extern struct notifier *ip_up_notifier; /* IPCP has come up */ 261 extern struct notifier *ip_down_notifier; /* IPCP has gone down */ 262 extern struct notifier *auth_up_notifier; /* peer has authenticated */ 263 extern struct notifier *link_down_notifier; /* link has gone down */ 264 extern struct notifier *fork_notifier; /* we are a new child process */ 265 266 /* Values for do_callback and doing_callback */ 267 #define CALLBACK_DIALIN 1 /* we are expecting the call back */ 268 #define CALLBACK_DIALOUT 2 /* we are dialling out to call back */ 269 270 /* 271 * Variables set by command-line options. 272 */ 273 274 extern int debug; /* Debug flag */ 275 extern int kdebugflag; /* Tell kernel to print debug messages */ 276 extern int default_device; /* Using /dev/tty or equivalent */ 277 extern char devnam[MAXPATHLEN]; /* Device name */ 278 extern int crtscts; /* Use hardware flow control */ 279 extern bool modem; /* Use modem control lines */ 280 extern int inspeed; /* Input/Output speed requested */ 281 extern u_int32_t netmask; /* IP netmask to set on interface */ 282 extern bool lockflag; /* Create lock file to lock the serial dev */ 283 extern bool nodetach; /* Don't detach from controlling tty */ 284 extern bool updetach; /* Detach from controlling tty when link up */ 285 extern char *initializer; /* Script to initialize physical link */ 286 extern char *connect_script; /* Script to establish physical link */ 287 extern char *disconnect_script; /* Script to disestablish physical link */ 288 extern char *welcomer; /* Script to welcome client after connection */ 289 extern char *ptycommand; /* Command to run on other side of pty */ 290 extern int maxconnect; /* Maximum connect time (seconds) */ 291 extern char user[MAXNAMELEN];/* Our name for authenticating ourselves */ 292 extern char passwd[MAXSECRETLEN]; /* Password for PAP or CHAP */ 293 extern bool auth_required; /* Peer is required to authenticate */ 294 extern bool persist; /* Reopen link after it goes down */ 295 extern bool uselogin; /* Use /etc/passwd for checking PAP */ 296 extern char our_name[MAXNAMELEN];/* Our name for authentication purposes */ 297 extern char remote_name[MAXNAMELEN]; /* Peer's name for authentication */ 298 extern bool explicit_remote;/* remote_name specified with remotename opt */ 299 extern bool demand; /* Do dial-on-demand */ 300 extern char *ipparam; /* Extra parameter for ip up/down scripts */ 301 extern bool cryptpap; /* Others' PAP passwords are encrypted */ 302 extern int idle_time_limit;/* Shut down link if idle for this long */ 303 extern int holdoff; /* Dead time before restarting */ 304 extern bool holdoff_specified; /* true if user gave a holdoff value */ 305 extern bool notty; /* Stdin/out is not a tty */ 306 extern char *pty_socket; /* Socket to connect to pty */ 307 extern char *record_file; /* File to record chars sent/received */ 308 extern bool sync_serial; /* Device is synchronous serial device */ 309 extern int maxfail; /* Max # of unsuccessful connection attempts */ 310 extern char linkname[MAXPATHLEN]; /* logical name for link */ 311 extern bool tune_kernel; /* May alter kernel settings as necessary */ 312 extern int connect_delay; /* Time to delay after connect script */ 313 extern int max_data_rate; /* max bytes/sec through charshunt */ 314 extern int req_unit; /* interface unit number to use */ 315 extern bool multilink; /* enable multilink operation */ 316 extern bool noendpoint; /* don't send or accept endpt. discrim. */ 317 extern char *bundle_name; /* bundle name for multilink */ 318 extern bool dump_options; /* print out option values */ 319 extern bool dryrun; /* check everything, print options, exit */ 320 extern int child_wait; /* # seconds to wait for children at end */ 321 322 #ifdef MAXOCTETS 323 extern unsigned int maxoctets; /* Maximum octetes per session (in bytes) */ 324 extern int maxoctets_dir; /* Direction : 325 0 - in+out (default) 326 1 - in 327 2 - out 328 3 - max(in,out) */ 329 extern int maxoctets_timeout; /* Timeout for check of octets limit */ 330 #define PPP_OCTETS_DIRECTION_SUM 0 331 #define PPP_OCTETS_DIRECTION_IN 1 332 #define PPP_OCTETS_DIRECTION_OUT 2 333 #define PPP_OCTETS_DIRECTION_MAXOVERAL 3 334 /* same as previos, but little different on RADIUS side */ 335 #define PPP_OCTETS_DIRECTION_MAXSESSION 4 336 #endif 337 338 #ifdef PPP_FILTER 339 extern struct bpf_program pass_filter; /* Filter for pkts to pass */ 340 extern struct bpf_program active_filter; /* Filter for link-active pkts */ 341 #endif 342 343 #ifdef MSLANMAN 344 extern bool ms_lanman; /* Use LanMan password instead of NT */ 345 /* Has meaning only with MS-CHAP challenges */ 346 #endif 347 348 /* Values for auth_pending, auth_done */ 349 #define PAP_WITHPEER 0x1 350 #define PAP_PEER 0x2 351 #define CHAP_WITHPEER 0x4 352 #define CHAP_PEER 0x8 353 #define EAP_WITHPEER 0x10 354 #define EAP_PEER 0x20 355 356 /* Values for auth_done only */ 357 #define CHAP_MD5_WITHPEER 0x40 358 #define CHAP_MD5_PEER 0x80 359 #define CHAP_MS_SHIFT 8 /* LSB position for MS auths */ 360 #define CHAP_MS_WITHPEER 0x100 361 #define CHAP_MS_PEER 0x200 362 #define CHAP_MS2_WITHPEER 0x400 363 #define CHAP_MS2_PEER 0x800 364 365 extern char *current_option; /* the name of the option being parsed */ 366 extern int privileged_option; /* set iff the current option came from root */ 367 extern char *option_source; /* string saying where the option came from */ 368 extern int option_priority; /* priority of current options */ 369 370 /* 371 * Values for phase. 372 */ 373 #define PHASE_DEAD 0 374 #define PHASE_INITIALIZE 1 375 #define PHASE_SERIALCONN 2 376 #define PHASE_DORMANT 3 377 #define PHASE_ESTABLISH 4 378 #define PHASE_AUTHENTICATE 5 379 #define PHASE_CALLBACK 6 380 #define PHASE_NETWORK 7 381 #define PHASE_RUNNING 8 382 #define PHASE_TERMINATE 9 383 #define PHASE_DISCONNECT 10 384 #define PHASE_HOLDOFF 11 385 #define PHASE_MASTER 12 386 387 /* 388 * The following struct gives the addresses of procedures to call 389 * for a particular protocol. 390 */ 391 struct protent { 392 u_short protocol; /* PPP protocol number */ 393 /* Initialization procedure */ 394 void (*init) __P((int unit)); 395 /* Process a received packet */ 396 void (*input) __P((int unit, u_char *pkt, int len)); 397 /* Process a received protocol-reject */ 398 void (*protrej) __P((int unit)); 399 /* Lower layer has come up */ 400 void (*lowerup) __P((int unit)); 401 /* Lower layer has gone down */ 402 void (*lowerdown) __P((int unit)); 403 /* Open the protocol */ 404 void (*open) __P((int unit)); 405 /* Close the protocol */ 406 void (*close) __P((int unit, char *reason)); 407 /* Print a packet in readable form */ 408 int (*printpkt) __P((u_char *pkt, int len, 409 void (*printer) __P((void *, char *, ...)), 410 void *arg)); 411 /* Process a received data packet */ 412 void (*datainput) __P((int unit, u_char *pkt, int len)); 413 bool enabled_flag; /* 0 iff protocol is disabled */ 414 char *name; /* Text name of protocol */ 415 char *data_name; /* Text name of corresponding data protocol */ 416 option_t *options; /* List of command-line options */ 417 /* Check requested options, assign defaults */ 418 void (*check_options) __P((void)); 419 /* Configure interface for demand-dial */ 420 int (*demand_conf) __P((int unit)); 421 /* Say whether to bring up link for this pkt */ 422 int (*active_pkt) __P((u_char *pkt, int len)); 423 }; 424 425 /* Table of pointers to supported protocols */ 426 extern struct protent *protocols[]; 427 428 /* 429 * This struct contains pointers to a set of procedures for 430 * doing operations on a "channel". A channel provides a way 431 * to send and receive PPP packets - the canonical example is 432 * a serial port device in PPP line discipline (or equivalently 433 * with PPP STREAMS modules pushed onto it). 434 */ 435 struct channel { 436 /* set of options for this channel */ 437 option_t *options; 438 /* find and process a per-channel options file */ 439 void (*process_extra_options) __P((void)); 440 /* check all the options that have been given */ 441 void (*check_options) __P((void)); 442 /* get the channel ready to do PPP, return a file descriptor */ 443 int (*connect) __P((void)); 444 /* we're finished with the channel */ 445 void (*disconnect) __P((void)); 446 /* put the channel into PPP `mode' */ 447 int (*establish_ppp) __P((int)); 448 /* take the channel out of PPP `mode', restore loopback if demand */ 449 void (*disestablish_ppp) __P((int)); 450 /* set the transmit-side PPP parameters of the channel */ 451 void (*send_config) __P((int, u_int32_t, int, int)); 452 /* set the receive-side PPP parameters of the channel */ 453 void (*recv_config) __P((int, u_int32_t, int, int)); 454 /* cleanup on error or normal exit */ 455 void (*cleanup) __P((void)); 456 /* close the device, called in children after fork */ 457 void (*close) __P((void)); 458 }; 459 460 extern struct channel *the_channel; 461 462 /* 463 * Prototypes. 464 */ 465 466 /* Procedures exported from main.c. */ 467 void set_ifunit __P((int)); /* set stuff that depends on ifunit */ 468 void detach __P((void)); /* Detach from controlling tty */ 469 void die __P((int)); /* Cleanup and exit */ 470 void quit __P((void)); /* like die(1) */ 471 void novm __P((char *)); /* Say we ran out of memory, and die */ 472 void timeout __P((void (*func)(void *), void *arg, int s, int us)); 473 /* Call func(arg) after s.us seconds */ 474 void untimeout __P((void (*func)(void *), void *arg)); 475 /* Cancel call to func(arg) */ 476 void record_child __P((int, char *, void (*) (void *), void *)); 477 pid_t safe_fork __P((int, int, int)); /* Fork & close stuff in child */ 478 int device_script __P((char *cmd, int in, int out, int dont_wait)); 479 /* Run `cmd' with given stdin and stdout */ 480 pid_t run_program __P((char *prog, char **args, int must_exist, 481 void (*done)(void *), void *arg)); 482 /* Run program prog with args in child */ 483 void reopen_log __P((void)); /* (re)open the connection to syslog */ 484 void print_link_stats __P((void)); /* Print stats, if available */ 485 void reset_link_stats __P((int)); /* Reset (init) stats when link goes up */ 486 void update_link_stats __P((int)); /* Get stats at link termination */ 487 void script_setenv __P((char *, char *, int)); /* set script env var */ 488 void script_unsetenv __P((char *)); /* unset script env var */ 489 void new_phase __P((int)); /* signal start of new phase */ 490 void add_notifier __P((struct notifier **, notify_func, void *)); 491 void remove_notifier __P((struct notifier **, notify_func, void *)); 492 void notify __P((struct notifier *, int)); 493 int ppp_send_config __P((int, int, u_int32_t, int, int)); 494 int ppp_recv_config __P((int, int, u_int32_t, int, int)); 495 void remove_pidfiles __P((void)); 496 void lock_db __P((void)); 497 void unlock_db __P((void)); 498 499 /* Procedures exported from tty.c. */ 500 void tty_init __P((void)); 501 502 /* Procedures exported from utils.c. */ 503 void log_packet __P((u_char *, int, char *, int)); 504 /* Format a packet and log it with syslog */ 505 void print_string __P((char *, int, void (*) (void *, char *, ...), 506 void *)); /* Format a string for output */ 507 int slprintf __P((char *, int, char *, ...)); /* sprintf++ */ 508 int vslprintf __P((char *, int, char *, va_list)); /* vsprintf++ */ 509 size_t strlcpy __P((char *, const char *, size_t)); /* safe strcpy */ 510 size_t strlcat __P((char *, const char *, size_t)); /* safe strncpy */ 511 void dbglog __P((char *, ...)); /* log a debug message */ 512 void info __P((char *, ...)); /* log an informational message */ 513 void notice __P((char *, ...)); /* log a notice-level message */ 514 void warn __P((char *, ...)); /* log a warning message */ 515 void error __P((char *, ...)); /* log an error message */ 516 void fatal __P((char *, ...)); /* log an error message and die(1) */ 517 void init_pr_log __P((char *, int)); /* initialize for using pr_log */ 518 void pr_log __P((void *, char *, ...)); /* printer fn, output to syslog */ 519 void end_pr_log __P((void)); /* finish up after using pr_log */ 520 void dump_packet __P((const char *, u_char *, int)); 521 /* dump packet to debug log if interesting */ 522 ssize_t complete_read __P((int, void *, size_t)); 523 /* read a complete buffer */ 524 525 /* Procedures exported from auth.c */ 526 void link_required __P((int)); /* we are starting to use the link */ 527 void link_terminated __P((int)); /* we are finished with the link */ 528 void link_down __P((int)); /* the LCP layer has left the Opened state */ 529 void upper_layers_down __P((int));/* take all NCPs down */ 530 void link_established __P((int)); /* the link is up; authenticate now */ 531 void start_networks __P((int)); /* start all the network control protos */ 532 void continue_networks __P((int)); /* start network [ip, etc] control protos */ 533 void np_up __P((int, int)); /* a network protocol has come up */ 534 void np_down __P((int, int)); /* a network protocol has gone down */ 535 void np_finished __P((int, int)); /* a network protocol no longer needs link */ 536 void auth_peer_fail __P((int, int)); 537 /* peer failed to authenticate itself */ 538 void auth_peer_success __P((int, int, int, char *, int)); 539 /* peer successfully authenticated itself */ 540 void auth_withpeer_fail __P((int, int)); 541 /* we failed to authenticate ourselves */ 542 void auth_withpeer_success __P((int, int, int)); 543 /* we successfully authenticated ourselves */ 544 void auth_check_options __P((void)); 545 /* check authentication options supplied */ 546 void auth_reset __P((int)); /* check what secrets we have */ 547 int check_passwd __P((int, char *, int, char *, int, char **)); 548 /* Check peer-supplied username/password */ 549 int get_secret __P((int, char *, char *, char *, int *, int)); 550 /* get "secret" for chap */ 551 int get_srp_secret __P((int unit, char *client, char *server, char *secret, 552 int am_server)); 553 int auth_ip_addr __P((int, u_int32_t)); 554 /* check if IP address is authorized */ 555 int auth_number __P((void)); /* check if remote number is authorized */ 556 int bad_ip_adrs __P((u_int32_t)); 557 /* check if IP address is unreasonable */ 558 559 /* Procedures exported from demand.c */ 560 void demand_conf __P((void)); /* config interface(s) for demand-dial */ 561 void demand_block __P((void)); /* set all NPs to queue up packets */ 562 void demand_unblock __P((void)); /* set all NPs to pass packets */ 563 void demand_discard __P((void)); /* set all NPs to discard packets */ 564 void demand_rexmit __P((int)); /* retransmit saved frames for an NP */ 565 int loop_chars __P((unsigned char *, int)); /* process chars from loopback */ 566 int loop_frame __P((unsigned char *, int)); /* should we bring link up? */ 567 568 /* Procedures exported from multilink.c */ 569 #ifdef HAVE_MULTILINK 570 void mp_check_options __P((void)); /* Check multilink-related options */ 571 int mp_join_bundle __P((void)); /* join our link to an appropriate bundle */ 572 void mp_exit_bundle __P((void)); /* have disconnected our link from bundle */ 573 void mp_bundle_terminated __P((void)); 574 char *epdisc_to_str __P((struct epdisc *)); /* string from endpoint discrim. */ 575 int str_to_epdisc __P((struct epdisc *, char *)); /* endpt disc. from str */ 576 #else 577 #define mp_bundle_terminated() /* nothing */ 578 #define mp_exit_bundle() /* nothing */ 579 #define doing_multilink 0 580 #define multilink_master 0 581 #endif 582 583 /* Procedures exported from sys-*.c */ 584 void sys_init __P((void)); /* Do system-dependent initialization */ 585 void sys_cleanup __P((void)); /* Restore system state before exiting */ 586 int sys_check_options __P((void)); /* Check options specified */ 587 void sys_close __P((void)); /* Clean up in a child before execing */ 588 int ppp_available __P((void)); /* Test whether ppp kernel support exists */ 589 int get_pty __P((int *, int *, char *, int)); /* Get pty master/slave */ 590 int open_ppp_loopback __P((void)); /* Open loopback for demand-dialling */ 591 int tty_establish_ppp __P((int)); /* Turn serial port into a ppp interface */ 592 void tty_disestablish_ppp __P((int)); /* Restore port to normal operation */ 593 void generic_disestablish_ppp __P((int dev_fd)); /* Restore device setting */ 594 int generic_establish_ppp __P((int dev_fd)); /* Make a ppp interface */ 595 void make_new_bundle __P((int, int, int, int)); /* Create new bundle */ 596 int bundle_attach __P((int)); /* Attach link to existing bundle */ 597 void cfg_bundle __P((int, int, int, int)); /* Configure existing bundle */ 598 void destroy_bundle __P((void)); /* Tell driver to destroy bundle */ 599 void clean_check __P((void)); /* Check if line was 8-bit clean */ 600 void set_up_tty __P((int, int)); /* Set up port's speed, parameters, etc. */ 601 void restore_tty __P((int)); /* Restore port's original parameters */ 602 void setdtr __P((int, int)); /* Raise or lower port's DTR line */ 603 void output __P((int, u_char *, int)); /* Output a PPP packet */ 604 void wait_input __P((struct timeval *)); 605 /* Wait for input, with timeout */ 606 void add_fd __P((int)); /* Add fd to set to wait for */ 607 void remove_fd __P((int)); /* Remove fd from set to wait for */ 608 int read_packet __P((u_char *)); /* Read PPP packet */ 609 int get_loop_output __P((void)); /* Read pkts from loopback */ 610 void tty_send_config __P((int, u_int32_t, int, int)); 611 /* Configure i/f transmit parameters */ 612 void tty_set_xaccm __P((ext_accm)); 613 /* Set extended transmit ACCM */ 614 void tty_recv_config __P((int, u_int32_t, int, int)); 615 /* Configure i/f receive parameters */ 616 int ccp_test __P((int, u_char *, int, int)); 617 /* Test support for compression scheme */ 618 void ccp_flags_set __P((int, int, int)); 619 /* Set kernel CCP state */ 620 int ccp_fatal_error __P((int)); /* Test for fatal decomp error in kernel */ 621 int get_idle_time __P((int, struct ppp_idle *)); 622 /* Find out how long link has been idle */ 623 int get_ppp_stats __P((int, struct pppd_stats *)); 624 /* Return link statistics */ 625 void netif_set_mtu __P((int, int)); /* Set PPP interface MTU */ 626 int netif_get_mtu __P((int)); /* Get PPP interface MTU */ 627 int sifvjcomp __P((int, int, int, int)); 628 /* Configure VJ TCP header compression */ 629 int sifup __P((int)); /* Configure i/f up for one protocol */ 630 int sifnpmode __P((int u, int proto, enum NPmode mode)); 631 /* Set mode for handling packets for proto */ 632 int sifdown __P((int)); /* Configure i/f down for one protocol */ 633 int sifaddr __P((int, u_int32_t, u_int32_t, u_int32_t)); 634 /* Configure IPv4 addresses for i/f */ 635 int cifaddr __P((int, u_int32_t, u_int32_t)); 636 /* Reset i/f IP addresses */ 637 #ifdef INET6 638 int sif6addr __P((int, eui64_t, eui64_t)); 639 /* Configure IPv6 addresses for i/f */ 640 int cif6addr __P((int, eui64_t, eui64_t)); 641 /* Remove an IPv6 address from i/f */ 642 #endif 643 int sifdefaultroute __P((int, u_int32_t, u_int32_t)); 644 /* Create default route through i/f */ 645 int cifdefaultroute __P((int, u_int32_t, u_int32_t)); 646 /* Delete default route through i/f */ 647 int sifproxyarp __P((int, u_int32_t)); 648 /* Add proxy ARP entry for peer */ 649 int cifproxyarp __P((int, u_int32_t)); 650 /* Delete proxy ARP entry for peer */ 651 u_int32_t GetMask __P((u_int32_t)); /* Get appropriate netmask for address */ 652 int lock __P((char *)); /* Create lock file for device */ 653 int relock __P((int)); /* Rewrite lock file with new pid */ 654 void unlock __P((void)); /* Delete previously-created lock file */ 655 void logwtmp __P((const char *, const char *, const char *)); 656 /* Write entry to wtmp file */ 657 int get_host_seed __P((void)); /* Get host-dependent random number seed */ 658 int have_route_to __P((u_int32_t)); /* Check if route to addr exists */ 659 #ifdef PPP_FILTER 660 int set_filters __P((struct bpf_program *pass, struct bpf_program *active)); 661 /* Set filter programs in kernel */ 662 #endif 663 #ifdef IPX_CHANGE 664 int sipxfaddr __P((int, unsigned long, unsigned char *)); 665 int cipxfaddr __P((int)); 666 #endif 667 int get_if_hwaddr __P((u_char *addr, char *name)); 668 char *get_first_ethernet __P((void)); 669 670 /* Procedures exported from options.c */ 671 int setipaddr __P((char *, char **, int)); /* Set local/remote ip addresses */ 672 int parse_args __P((int argc, char **argv)); 673 /* Parse options from arguments given */ 674 int options_from_file __P((char *filename, int must_exist, int check_prot, 675 int privileged)); 676 /* Parse options from an options file */ 677 int options_from_user __P((void)); /* Parse options from user's .ppprc */ 678 int options_for_tty __P((void)); /* Parse options from /etc/ppp/options.tty */ 679 int options_from_list __P((struct wordlist *, int privileged)); 680 /* Parse options from a wordlist */ 681 int getword __P((FILE *f, char *word, int *newlinep, char *filename)); 682 /* Read a word from a file */ 683 void option_error __P((char *fmt, ...)); 684 /* Print an error message about an option */ 685 int int_option __P((char *, int *)); 686 /* Simplified number_option for decimal ints */ 687 void add_options __P((option_t *)); /* Add extra options */ 688 void check_options __P((void)); /* check values after all options parsed */ 689 int override_value __P((const char *, int, const char *)); 690 /* override value if permitted by priority */ 691 void print_options __P((void (*) __P((void *, char *, ...)), void *)); 692 /* print out values of all options */ 693 694 int parse_dotted_ip __P((char *, u_int32_t *)); 695 696 /* 697 * Hooks to enable plugins to change various things. 698 */ 699 extern int (*new_phase_hook) __P((int)); 700 extern int (*idle_time_hook) __P((struct ppp_idle *)); 701 extern int (*holdoff_hook) __P((void)); 702 extern int (*pap_check_hook) __P((void)); 703 extern int (*pap_auth_hook) __P((char *user, char *passwd, char **msgp, 704 struct wordlist **paddrs, 705 struct wordlist **popts)); 706 extern void (*pap_logout_hook) __P((void)); 707 extern int (*pap_passwd_hook) __P((char *user, char *passwd)); 708 extern int (*allowed_address_hook) __P((u_int32_t addr)); 709 extern void (*ip_up_hook) __P((void)); 710 extern void (*ip_down_hook) __P((void)); 711 extern void (*ip_choose_hook) __P((u_int32_t *)); 712 713 extern int (*chap_check_hook) __P((void)); 714 extern int (*chap_passwd_hook) __P((char *user, char *passwd)); 715 716 /* Let a plugin snoop sent and received packets. Useful for L2TP */ 717 extern void (*snoop_recv_hook) __P((unsigned char *p, int len)); 718 extern void (*snoop_send_hook) __P((unsigned char *p, int len)); 719 720 /* 721 * Inline versions of get/put char/short/long. 722 * Pointer is advanced; we assume that both arguments 723 * are lvalues and will already be in registers. 724 * cp MUST be u_char *. 725 */ 726 #define GETCHAR(c, cp) { \ 727 (c) = *(cp)++; \ 728 } 729 #define PUTCHAR(c, cp) { \ 730 *(cp)++ = (u_char) (c); \ 731 } 732 733 734 #define GETSHORT(s, cp) { \ 735 (s) = *(cp)++ << 8; \ 736 (s) |= *(cp)++; \ 737 } 738 #define PUTSHORT(s, cp) { \ 739 *(cp)++ = (u_char) ((s) >> 8); \ 740 *(cp)++ = (u_char) (s); \ 741 } 742 743 #define GETLONG(l, cp) { \ 744 (l) = *(cp)++ << 8; \ 745 (l) |= *(cp)++; (l) <<= 8; \ 746 (l) |= *(cp)++; (l) <<= 8; \ 747 (l) |= *(cp)++; \ 748 } 749 #define PUTLONG(l, cp) { \ 750 *(cp)++ = (u_char) ((l) >> 24); \ 751 *(cp)++ = (u_char) ((l) >> 16); \ 752 *(cp)++ = (u_char) ((l) >> 8); \ 753 *(cp)++ = (u_char) (l); \ 754 } 755 756 #define INCPTR(n, cp) ((cp) += (n)) 757 #define DECPTR(n, cp) ((cp) -= (n)) 758 759 /* 760 * System dependent definitions for user-level 4.3BSD UNIX implementation. 761 */ 762 763 #define TIMEOUT(r, f, t) timeout((r), (f), (t), 0) 764 #define UNTIMEOUT(r, f) untimeout((r), (f)) 765 766 #define BCOPY(s, d, l) memcpy(d, s, l) 767 #define BZERO(s, n) memset(s, 0, n) 768 #define BCMP(s1, s2, l) memcmp(s1, s2, l) 769 770 #define PRINTMSG(m, l) { info("Remote message: %0.*v", l, m); } 771 772 /* 773 * MAKEHEADER - Add Header fields to a packet. 774 */ 775 #define MAKEHEADER(p, t) { \ 776 PUTCHAR(PPP_ALLSTATIONS, p); \ 777 PUTCHAR(PPP_UI, p); \ 778 PUTSHORT(t, p); } 779 780 /* 781 * Exit status values. 782 */ 783 #define EXIT_OK 0 784 #define EXIT_FATAL_ERROR 1 785 #define EXIT_OPTION_ERROR 2 786 #define EXIT_NOT_ROOT 3 787 #define EXIT_NO_KERNEL_SUPPORT 4 788 #define EXIT_USER_REQUEST 5 789 #define EXIT_LOCK_FAILED 6 790 #define EXIT_OPEN_FAILED 7 791 #define EXIT_CONNECT_FAILED 8 792 #define EXIT_PTYCMD_FAILED 9 793 #define EXIT_NEGOTIATION_FAILED 10 794 #define EXIT_PEER_AUTH_FAILED 11 795 #define EXIT_IDLE_TIMEOUT 12 796 #define EXIT_CONNECT_TIME 13 797 #define EXIT_CALLBACK 14 798 #define EXIT_PEER_DEAD 15 799 #define EXIT_HANGUP 16 800 #define EXIT_LOOPBACK 17 801 #define EXIT_INIT_FAILED 18 802 #define EXIT_AUTH_TOPEER_FAILED 19 803 #ifdef MAXOCTETS 804 #define EXIT_TRAFFIC_LIMIT 20 805 #endif 806 #define EXIT_CNID_AUTH_FAILED 21 807 808 /* 809 * Debug macros. Slightly useful for finding bugs in pppd, not particularly 810 * useful for finding out why your connection isn't being established. 811 */ 812 #ifdef DEBUGALL 813 #define DEBUGMAIN 1 814 #define DEBUGFSM 1 815 #define DEBUGLCP 1 816 #define DEBUGIPCP 1 817 #define DEBUGIPV6CP 1 818 #define DEBUGUPAP 1 819 #define DEBUGCHAP 1 820 #endif 821 822 #ifndef LOG_PPP /* we use LOG_LOCAL2 for syslog by default */ 823 #if defined(DEBUGMAIN) || defined(DEBUGFSM) || defined(DEBUGSYS) \ 824 || defined(DEBUGLCP) || defined(DEBUGIPCP) || defined(DEBUGUPAP) \ 825 || defined(DEBUGCHAP) || defined(DEBUG) || defined(DEBUGIPV6CP) 826 #define LOG_PPP LOG_LOCAL2 827 #else 828 #define LOG_PPP LOG_DAEMON 829 #endif 830 #endif /* LOG_PPP */ 831 832 #ifdef DEBUGMAIN 833 #define MAINDEBUG(x) if (debug) dbglog x 834 #else 835 #define MAINDEBUG(x) 836 #endif 837 838 #ifdef DEBUGSYS 839 #define SYSDEBUG(x) if (debug) dbglog x 840 #else 841 #define SYSDEBUG(x) 842 #endif 843 844 #ifdef DEBUGFSM 845 #define FSMDEBUG(x) if (debug) dbglog x 846 #else 847 #define FSMDEBUG(x) 848 #endif 849 850 #ifdef DEBUGLCP 851 #define LCPDEBUG(x) if (debug) dbglog x 852 #else 853 #define LCPDEBUG(x) 854 #endif 855 856 #ifdef DEBUGIPCP 857 #define IPCPDEBUG(x) if (debug) dbglog x 858 #else 859 #define IPCPDEBUG(x) 860 #endif 861 862 #ifdef DEBUGIPV6CP 863 #define IPV6CPDEBUG(x) if (debug) dbglog x 864 #else 865 #define IPV6CPDEBUG(x) 866 #endif 867 868 #ifdef DEBUGUPAP 869 #define UPAPDEBUG(x) if (debug) dbglog x 870 #else 871 #define UPAPDEBUG(x) 872 #endif 873 874 #ifdef DEBUGCHAP 875 #define CHAPDEBUG(x) if (debug) dbglog x 876 #else 877 #define CHAPDEBUG(x) 878 #endif 879 880 #ifdef DEBUGIPXCP 881 #define IPXCPDEBUG(x) if (debug) dbglog x 882 #else 883 #define IPXCPDEBUG(x) 884 #endif 885 886 #ifndef SIGTYPE 887 #if defined(sun) || defined(SYSV) || defined(POSIX_SOURCE) 888 #define SIGTYPE void 889 #else 890 #define SIGTYPE int 891 #endif /* defined(sun) || defined(SYSV) || defined(POSIX_SOURCE) */ 892 #endif /* SIGTYPE */ 893 894 #ifndef MIN 895 #define MIN(a, b) ((a) < (b)? (a): (b)) 896 #endif 897 #ifndef MAX 898 #define MAX(a, b) ((a) > (b)? (a): (b)) 899 #endif 900 901 #ifndef offsetof 902 #define offsetof(type, member) ((size_t) &((type *)0)->member) 903 #endif 904 905 #endif /* __PPP_H__ */ 906
