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@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.91 2005/08/25 23:59:34 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 88typedef unsigned char bool; 89 90enum 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 100typedef 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. */ 160struct 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 */ 172struct 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. */ 180struct 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 */ 187struct 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 201typedef void (*notify_func) __P((void *, int)); 202 203struct notifier { 204 struct notifier *next; 205 notify_func func; 206 void *arg; 207}; 208 209/* 210 * Global variables. 211 */ 212 213extern int hungup; /* Physical layer has disconnected */ 214extern int ifunit; /* Interface unit number */ 215extern char ifname[]; /* Interface name */ 216extern char hostname[]; /* Our hostname */ 217extern u_char outpacket_buf[]; /* Buffer for outgoing packets */ 218extern int devfd; /* fd of underlying device */ 219extern int fd_ppp; /* fd for talking PPP */ 220extern int phase; /* Current state of link - see values below */ 221extern int baud_rate; /* Current link speed in bits/sec */ 222extern char *progname; /* Name of this program */ 223extern int redirect_stderr;/* Connector's stderr should go to file */ 224extern char peer_authname[];/* Authenticated name of peer */ 225extern int auth_done[NUM_PPP]; /* Methods actually used for auth */ 226extern int privileged; /* We were run by real-uid root */ 227extern int need_holdoff; /* Need holdoff period after link terminates */ 228extern char **script_env; /* Environment variables for scripts */ 229extern int detached; /* Have detached from controlling tty */ 230extern GIDSET_TYPE groups[NGROUPS_MAX]; /* groups the user is in */ 231extern int ngroups; /* How many groups valid in groups */ 232extern struct pppd_stats link_stats; /* byte/packet counts etc. for link */ 233extern int link_stats_valid; /* set if link_stats is valid */ 234extern unsigned link_connect_time; /* time the link was up for */ 235extern int using_pty; /* using pty as device (notty or pty opt.) */ 236extern int log_to_fd; /* logging to this fd as well as syslog */ 237extern bool log_default; /* log_to_fd is default (stdout) */ 238extern char *no_ppp_msg; /* message to print if ppp not in kernel */ 239extern volatile int status; /* exit status for pppd */ 240extern bool devnam_fixed; /* can no longer change devnam */ 241extern int unsuccess; /* # unsuccessful connection attempts */ 242extern int do_callback; /* set if we want to do callback next */ 243extern int doing_callback; /* set if this is a callback */ 244extern int error_count; /* # of times error() has been called */ 245extern char ppp_devnam[MAXPATHLEN]; 246extern char remote_number[MAXNAMELEN]; /* Remote telephone number, if avail. */ 247extern int ppp_session_number; /* Session number (eg PPPoE session) */ 248extern int fd_devnull; /* fd open to /dev/null */ 249 250extern int listen_time; /* time to listen first (ms) */ 251extern bool doing_multilink; 252extern bool multilink_master; 253extern bool bundle_eof; 254extern bool bundle_terminating; 255 256extern struct notifier *pidchange; /* for notifications of pid changing */ 257extern struct notifier *phasechange; /* for notifications of phase changes */ 258extern struct notifier *exitnotify; /* for notification that we're exiting */ 259extern struct notifier *sigreceived; /* notification of received signal */ 260extern struct notifier *ip_up_notifier; /* IPCP has come up */ 261extern struct notifier *ip_down_notifier; /* IPCP has gone down */ 262extern struct notifier *auth_up_notifier; /* peer has authenticated */ 263extern struct notifier *link_down_notifier; /* link has gone down */ 264extern 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 /* Foxconn add start, Adams 12/20/2007 */ 275#ifdef SUPPORT_PPP_DEBUG 276extern int debug_level; /* Debug level for syslogd */ 277#endif 278 /* Foxconn add end, Adams 12/20/2007 */ 279 280extern int debug; /* Debug flag */ 281extern int kdebugflag; /* Tell kernel to print debug messages */ 282extern int default_device; /* Using /dev/tty or equivalent */ 283extern char devnam[MAXPATHLEN]; /* Device name */ 284extern int crtscts; /* Use hardware flow control */ 285extern bool modem; /* Use modem control lines */ 286extern int inspeed; /* Input/Output speed requested */ 287extern u_int32_t netmask; /* IP netmask to set on interface */ 288extern bool lockflag; /* Create lock file to lock the serial dev */ 289extern bool nodetach; /* Don't detach from controlling tty */ 290extern bool updetach; /* Detach from controlling tty when link up */ 291extern char *initializer; /* Script to initialize physical link */ 292extern char *connect_script; /* Script to establish physical link */ 293extern char *disconnect_script; /* Script to disestablish physical link */ 294extern char *welcomer; /* Script to welcome client after connection */ 295extern char *ptycommand; /* Command to run on other side of pty */ 296extern int maxconnect; /* Maximum connect time (seconds) */ 297extern char user[MAXNAMELEN];/* Our name for authenticating ourselves */ 298extern char passwd[MAXSECRETLEN]; /* Password for PAP or CHAP */ 299extern bool auth_required; /* Peer is required to authenticate */ 300extern bool persist; /* Reopen link after it goes down */ 301extern bool uselogin; /* Use /etc/passwd for checking PAP */ 302extern char our_name[MAXNAMELEN];/* Our name for authentication purposes */ 303extern char remote_name[MAXNAMELEN]; /* Peer's name for authentication */ 304extern bool explicit_remote;/* remote_name specified with remotename opt */ 305extern bool demand; /* Do dial-on-demand */ 306extern char *ipparam; /* Extra parameter for ip up/down scripts */ 307extern bool cryptpap; /* Others' PAP passwords are encrypted */ 308extern int idle_time_limit;/* Shut down link if idle for this long */ 309extern int holdoff; /* Dead time before restarting */ 310extern bool holdoff_specified; /* true if user gave a holdoff value */ 311extern bool notty; /* Stdin/out is not a tty */ 312extern char *pty_socket; /* Socket to connect to pty */ 313extern char *record_file; /* File to record chars sent/received */ 314extern bool sync_serial; /* Device is synchronous serial device */ 315extern int maxfail; /* Max # of unsuccessful connection attempts */ 316extern char linkname[MAXPATHLEN]; /* logical name for link */ 317extern bool tune_kernel; /* May alter kernel settings as necessary */ 318extern int connect_delay; /* Time to delay after connect script */ 319extern int max_data_rate; /* max bytes/sec through charshunt */ 320extern int req_unit; /* interface unit number to use */ 321extern bool multilink; /* enable multilink operation */ 322extern bool noendpoint; /* don't send or accept endpt. discrim. */ 323extern char *bundle_name; /* bundle name for multilink */ 324extern bool dump_options; /* print out option values */ 325extern bool dryrun; /* check everything, print options, exit */ 326extern int child_wait; /* # seconds to wait for children at end */ 327 328#ifdef MAXOCTETS 329extern unsigned int maxoctets; /* Maximum octetes per session (in bytes) */ 330extern int maxoctets_dir; /* Direction : 331 0 - in+out (default) 332 1 - in 333 2 - out 334 3 - max(in,out) */ 335extern int maxoctets_timeout; /* Timeout for check of octets limit */ 336#define PPP_OCTETS_DIRECTION_SUM 0 337#define PPP_OCTETS_DIRECTION_IN 1 338#define PPP_OCTETS_DIRECTION_OUT 2 339#define PPP_OCTETS_DIRECTION_MAXOVERAL 3 340/* same as previos, but little different on RADIUS side */ 341#define PPP_OCTETS_DIRECTION_MAXSESSION 4 342#endif 343 344#ifdef PPP_FILTER 345extern struct bpf_program pass_filter; /* Filter for pkts to pass */ 346extern struct bpf_program active_filter; /* Filter for link-active pkts */ 347#endif 348 349#ifdef MSLANMAN 350extern bool ms_lanman; /* Use LanMan password instead of NT */ 351 /* Has meaning only with MS-CHAP challenges */ 352#endif 353 354/* Values for auth_pending, auth_done */ 355#define PAP_WITHPEER 0x1 356#define PAP_PEER 0x2 357#define CHAP_WITHPEER 0x4 358#define CHAP_PEER 0x8 359#define EAP_WITHPEER 0x10 360#define EAP_PEER 0x20 361 362/* Values for auth_done only */ 363#define CHAP_MD5_WITHPEER 0x40 364#define CHAP_MD5_PEER 0x80 365#define CHAP_MS_SHIFT 8 /* LSB position for MS auths */ 366#define CHAP_MS_WITHPEER 0x100 367#define CHAP_MS_PEER 0x200 368#define CHAP_MS2_WITHPEER 0x400 369#define CHAP_MS2_PEER 0x800 370 371extern char *current_option; /* the name of the option being parsed */ 372extern int privileged_option; /* set iff the current option came from root */ 373extern char *option_source; /* string saying where the option came from */ 374extern int option_priority; /* priority of current options */ 375 376/* 377 * Values for phase. 378 */ 379#define PHASE_DEAD 0 380#define PHASE_INITIALIZE 1 381#define PHASE_SERIALCONN 2 382#define PHASE_DORMANT 3 383#define PHASE_ESTABLISH 4 384#define PHASE_AUTHENTICATE 5 385#define PHASE_CALLBACK 6 386#define PHASE_NETWORK 7 387#define PHASE_RUNNING 8 388#define PHASE_TERMINATE 9 389#define PHASE_DISCONNECT 10 390#define PHASE_HOLDOFF 11 391#define PHASE_MASTER 12 392 393/* 394 * The following struct gives the addresses of procedures to call 395 * for a particular protocol. 396 */ 397struct protent { 398 u_short protocol; /* PPP protocol number */ 399 /* Initialization procedure */ 400 void (*init) __P((int unit)); 401 /* Process a received packet */ 402 void (*input) __P((int unit, u_char *pkt, int len)); 403 /* Process a received protocol-reject */ 404 void (*protrej) __P((int unit)); 405 /* Lower layer has come up */ 406 void (*lowerup) __P((int unit)); 407 /* Lower layer has gone down */ 408 void (*lowerdown) __P((int unit)); 409 /* Open the protocol */ 410 void (*open) __P((int unit)); 411 /* Close the protocol */ 412 void (*close) __P((int unit, char *reason)); 413 /* Print a packet in readable form */ 414 int (*printpkt) __P((u_char *pkt, int len, 415 void (*printer) __P((void *, char *, ...)), 416 void *arg)); 417 /* Process a received data packet */ 418 void (*datainput) __P((int unit, u_char *pkt, int len)); 419 bool enabled_flag; /* 0 iff protocol is disabled */ 420 char *name; /* Text name of protocol */ 421 char *data_name; /* Text name of corresponding data protocol */ 422 option_t *options; /* List of command-line options */ 423 /* Check requested options, assign defaults */ 424 void (*check_options) __P((void)); 425 /* Configure interface for demand-dial */ 426 int (*demand_conf) __P((int unit)); 427 /* Say whether to bring up link for this pkt */ 428 int (*active_pkt) __P((u_char *pkt, int len)); 429}; 430 431/* Table of pointers to supported protocols */ 432extern struct protent *protocols[]; 433 434/* 435 * This struct contains pointers to a set of procedures for 436 * doing operations on a "channel". A channel provides a way 437 * to send and receive PPP packets - the canonical example is 438 * a serial port device in PPP line discipline (or equivalently 439 * with PPP STREAMS modules pushed onto it). 440 */ 441struct channel { 442 /* set of options for this channel */ 443 option_t *options; 444 /* find and process a per-channel options file */ 445 void (*process_extra_options) __P((void)); 446 /* check all the options that have been given */ 447 void (*check_options) __P((void)); 448 /* get the channel ready to do PPP, return a file descriptor */ 449 int (*connect) __P((void)); 450 /* we're finished with the channel */ 451 void (*disconnect) __P((void)); 452 /* put the channel into PPP `mode' */ 453 int (*establish_ppp) __P((int)); 454 /* take the channel out of PPP `mode', restore loopback if demand */ 455 void (*disestablish_ppp) __P((int)); 456 /* set the transmit-side PPP parameters of the channel */ 457 void (*send_config) __P((int, u_int32_t, int, int)); 458 /* set the receive-side PPP parameters of the channel */ 459 void (*recv_config) __P((int, u_int32_t, int, int)); 460 /* cleanup on error or normal exit */ 461 void (*cleanup) __P((void)); 462 /* close the device, called in children after fork */ 463 void (*close) __P((void)); 464}; 465 466extern struct channel *the_channel; 467 468/* 469 * Prototypes. 470 */ 471 472/* Procedures exported from main.c. */ 473void set_ifunit __P((int)); /* set stuff that depends on ifunit */ 474void detach __P((void)); /* Detach from controlling tty */ 475void die __P((int)); /* Cleanup and exit */ 476void quit __P((void)); /* like die(1) */ 477void novm __P((char *)); /* Say we ran out of memory, and die */ 478void timeout __P((void (*func)(void *), void *arg, int s, int us)); 479 /* Call func(arg) after s.us seconds */ 480void untimeout __P((void (*func)(void *), void *arg)); 481 /* Cancel call to func(arg) */ 482void record_child __P((int, char *, void (*) (void *), void *)); 483pid_t safe_fork __P((int, int, int)); /* Fork & close stuff in child */ 484int device_script __P((char *cmd, int in, int out, int dont_wait)); 485 /* Run `cmd' with given stdin and stdout */ 486pid_t run_program __P((char *prog, char **args, int must_exist, 487 void (*done)(void *), void *arg, int wait)); 488 /* Run program prog with args in child */ 489void reopen_log __P((void)); /* (re)open the connection to syslog */ 490void print_link_stats __P((void)); /* Print stats, if available */ 491void reset_link_stats __P((int)); /* Reset (init) stats when link goes up */ 492void update_link_stats __P((int)); /* Get stats at link termination */ 493void script_setenv __P((char *, char *, int)); /* set script env var */ 494void script_unsetenv __P((char *)); /* unset script env var */ 495void new_phase __P((int)); /* signal start of new phase */ 496void add_notifier __P((struct notifier **, notify_func, void *)); 497void remove_notifier __P((struct notifier **, notify_func, void *)); 498void notify __P((struct notifier *, int)); 499int ppp_send_config __P((int, int, u_int32_t, int, int)); 500int ppp_recv_config __P((int, int, u_int32_t, int, int)); 501const char *protocol_name __P((int)); 502void remove_pidfiles __P((void)); 503void lock_db __P((void)); 504void unlock_db __P((void)); 505 506/* Procedures exported from tty.c. */ 507void tty_init __P((void)); 508 509/* Procedures exported from utils.c. */ 510void log_packet __P((u_char *, int, char *, int)); 511 /* Format a packet and log it with syslog */ 512void print_string __P((char *, int, void (*) (void *, char *, ...), 513 void *)); /* Format a string for output */ 514int slprintf __P((char *, int, char *, ...)); /* sprintf++ */ 515int vslprintf __P((char *, int, char *, va_list)); /* vsprintf++ */ 516size_t strlcpy __P((char *, const char *, size_t)); /* safe strcpy */ 517size_t strlcat __P((char *, const char *, size_t)); /* safe strncpy */ 518void dbglog __P((char *, ...)); /* log a debug message */ 519void info __P((char *, ...)); /* log an informational message */ 520void notice __P((char *, ...)); /* log a notice-level message */ 521void warn __P((char *, ...)); /* log a warning message */ 522void error __P((char *, ...)); /* log an error message */ 523void fatal __P((char *, ...)); /* log an error message and die(1) */ 524void init_pr_log __P((char *, int)); /* initialize for using pr_log */ 525void pr_log __P((void *, char *, ...)); /* printer fn, output to syslog */ 526void end_pr_log __P((void)); /* finish up after using pr_log */ 527void dump_packet __P((const char *, u_char *, int)); 528 /* dump packet to debug log if interesting */ 529ssize_t complete_read __P((int, void *, size_t)); 530 /* read a complete buffer */ 531 532/* Procedures exported from auth.c */ 533void link_required __P((int)); /* we are starting to use the link */ 534void start_link __P((int)); /* bring the link up now */ 535void link_terminated __P((int)); /* we are finished with the link */ 536void link_down __P((int)); /* the LCP layer has left the Opened state */ 537void upper_layers_down __P((int));/* take all NCPs down */ 538void link_established __P((int)); /* the link is up; authenticate now */ 539void start_networks __P((int)); /* start all the network control protos */ 540void continue_networks __P((int)); /* start network [ip, etc] control protos */ 541void np_up __P((int, int)); /* a network protocol has come up */ 542void np_down __P((int, int)); /* a network protocol has gone down */ 543void np_finished __P((int, int)); /* a network protocol no longer needs link */ 544void auth_peer_fail __P((int, int)); 545 /* peer failed to authenticate itself */ 546void auth_peer_success __P((int, int, int, char *, int)); 547 /* peer successfully authenticated itself */ 548void auth_withpeer_fail __P((int, int)); 549 /* we failed to authenticate ourselves */ 550void auth_withpeer_success __P((int, int, int)); 551 /* we successfully authenticated ourselves */ 552void auth_check_options __P((void)); 553 /* check authentication options supplied */ 554void auth_reset __P((int)); /* check what secrets we have */ 555int check_passwd __P((int, char *, int, char *, int, char **)); 556 /* Check peer-supplied username/password */ 557int get_secret __P((int, char *, char *, char *, int *, int)); 558 /* get "secret" for chap */ 559int get_srp_secret __P((int unit, char *client, char *server, char *secret, 560 int am_server)); 561int auth_ip_addr __P((int, u_int32_t)); 562 /* check if IP address is authorized */ 563int auth_number __P((void)); /* check if remote number is authorized */ 564int bad_ip_adrs __P((u_int32_t)); 565 /* check if IP address is unreasonable */ 566 567/* Procedures exported from demand.c */ 568void demand_conf __P((void)); /* config interface(s) for demand-dial */ 569void demand_block __P((void)); /* set all NPs to queue up packets */ 570void demand_unblock __P((void)); /* set all NPs to pass packets */ 571void demand_discard __P((void)); /* set all NPs to discard packets */ 572/* Foxconn added, Winster Chan, 12/23/2005, demand_discard2() */ 573void demand_discard2 __P((void)); /* set all NPs to discard packets without errors */ 574void demand_rexmit __P((int)); /* retransmit saved frames for an NP */ 575int loop_chars __P((unsigned char *, int)); /* process chars from loopback */ 576int loop_frame __P((unsigned char *, int)); /* should we bring link up? */ 577 578/* Procedures exported from multilink.c */ 579#ifdef HAVE_MULTILINK 580void mp_check_options __P((void)); /* Check multilink-related options */ 581int mp_join_bundle __P((void)); /* join our link to an appropriate bundle */ 582void mp_exit_bundle __P((void)); /* have disconnected our link from bundle */ 583void mp_bundle_terminated __P((void)); 584char *epdisc_to_str __P((struct epdisc *)); /* string from endpoint discrim. */ 585int str_to_epdisc __P((struct epdisc *, char *)); /* endpt disc. from str */ 586#else 587#define mp_bundle_terminated() /* nothing */ 588#define mp_exit_bundle() /* nothing */ 589#define doing_multilink 0 590#define multilink_master 0 591#endif 592 593/* Procedures exported from sys-*.c */ 594void sys_init __P((void)); /* Do system-dependent initialization */ 595void sys_cleanup __P((void)); /* Restore system state before exiting */ 596int sys_check_options __P((void)); /* Check options specified */ 597void sys_close __P((void)); /* Clean up in a child before execing */ 598int ppp_available __P((void)); /* Test whether ppp kernel support exists */ 599int get_pty __P((int *, int *, char *, int)); /* Get pty master/slave */ 600int open_ppp_loopback __P((void)); /* Open loopback for demand-dialling */ 601int tty_establish_ppp __P((int)); /* Turn serial port into a ppp interface */ 602void tty_disestablish_ppp __P((int)); /* Restore port to normal operation */ 603void generic_disestablish_ppp __P((int dev_fd)); /* Restore device setting */ 604int generic_establish_ppp __P((int dev_fd)); /* Make a ppp interface */ 605void make_new_bundle __P((int, int, int, int)); /* Create new bundle */ 606int bundle_attach __P((int)); /* Attach link to existing bundle */ 607void cfg_bundle __P((int, int, int, int)); /* Configure existing bundle */ 608void destroy_bundle __P((void)); /* Tell driver to destroy bundle */ 609void clean_check __P((void)); /* Check if line was 8-bit clean */ 610void set_up_tty __P((int, int)); /* Set up port's speed, parameters, etc. */ 611void restore_tty __P((int)); /* Restore port's original parameters */ 612void setdtr __P((int, int)); /* Raise or lower port's DTR line */ 613void output __P((int, u_char *, int)); /* Output a PPP packet */ 614void wait_input __P((struct timeval *)); 615 /* Wait for input, with timeout */ 616void add_fd __P((int)); /* Add fd to set to wait for */ 617void remove_fd __P((int)); /* Remove fd from set to wait for */ 618int read_packet __P((u_char *)); /* Read PPP packet */ 619int get_loop_output __P((void)); /* Read pkts from loopback */ 620void tty_send_config __P((int, u_int32_t, int, int)); 621 /* Configure i/f transmit parameters */ 622void tty_set_xaccm __P((ext_accm)); 623 /* Set extended transmit ACCM */ 624void tty_recv_config __P((int, u_int32_t, int, int)); 625 /* Configure i/f receive parameters */ 626int ccp_test __P((int, u_char *, int, int)); 627 /* Test support for compression scheme */ 628void ccp_flags_set __P((int, int, int)); 629 /* Set kernel CCP state */ 630int ccp_fatal_error __P((int)); /* Test for fatal decomp error in kernel */ 631int get_idle_time __P((int, struct ppp_idle *)); 632 /* Find out how long link has been idle */ 633int get_ppp_stats __P((int, struct pppd_stats *)); 634 /* Return link statistics */ 635void netif_set_mtu __P((int, int)); /* Set PPP interface MTU */ 636int netif_get_mtu __P((int)); /* Get PPP interface MTU */ 637int sifvjcomp __P((int, int, int, int)); 638 /* Configure VJ TCP header compression */ 639int sifup __P((int)); /* Configure i/f up for one protocol */ 640int sifnpmode __P((int u, int proto, enum NPmode mode)); 641 /* Set mode for handling packets for proto */ 642int sifdown __P((int)); /* Configure i/f down for one protocol */ 643int sifaddr __P((int, u_int32_t, u_int32_t, u_int32_t)); 644 /* Configure IPv4 addresses for i/f */ 645int cifaddr __P((int, u_int32_t, u_int32_t)); 646 /* Reset i/f IP addresses */ 647#ifdef INET6 648int sif6addr __P((int, eui64_t, eui64_t)); 649 /* Configure IPv6 addresses for i/f */ 650int cif6addr __P((int, eui64_t, eui64_t)); 651 /* Remove an IPv6 address from i/f */ 652#endif 653int sifdefaultroute __P((int, u_int32_t, u_int32_t)); 654 /* Create default route through i/f */ 655int cifdefaultroute __P((int, u_int32_t, u_int32_t)); 656 /* Delete default route through i/f */ 657int sifproxyarp __P((int, u_int32_t)); 658 /* Add proxy ARP entry for peer */ 659int cifproxyarp __P((int, u_int32_t)); 660 /* Delete proxy ARP entry for peer */ 661u_int32_t GetMask __P((u_int32_t)); /* Get appropriate netmask for address */ 662int lock __P((char *)); /* Create lock file for device */ 663int relock __P((int)); /* Rewrite lock file with new pid */ 664void unlock __P((void)); /* Delete previously-created lock file */ 665void logwtmp __P((const char *, const char *, const char *)); 666 /* Write entry to wtmp file */ 667int get_host_seed __P((void)); /* Get host-dependent random number seed */ 668int have_route_to __P((u_int32_t)); /* Check if route to addr exists */ 669#ifdef PPP_FILTER 670int set_filters __P((struct bpf_program *pass, struct bpf_program *active)); 671 /* Set filter programs in kernel */ 672#endif 673#ifdef IPX_CHANGE 674int sipxfaddr __P((int, unsigned long, unsigned char *)); 675int cipxfaddr __P((int)); 676#endif 677int get_if_hwaddr __P((u_char *addr, char *name)); 678char *get_first_ethernet __P((void)); 679 680/* Procedures exported from options.c */ 681int setipaddr __P((char *, char **, int)); /* Set local/remote ip addresses */ 682int parse_args __P((int argc, char **argv)); 683 /* Parse options from arguments given */ 684int options_from_file __P((char *filename, int must_exist, int check_prot, 685 int privileged)); 686 /* Parse options from an options file */ 687int options_from_user __P((void)); /* Parse options from user's .ppprc */ 688int options_for_tty __P((void)); /* Parse options from /etc/ppp/options.tty */ 689int options_from_list __P((struct wordlist *, int privileged)); 690 /* Parse options from a wordlist */ 691int getword __P((FILE *f, char *word, int *newlinep, char *filename)); 692 /* Read a word from a file */ 693void option_error __P((char *fmt, ...)); 694 /* Print an error message about an option */ 695int int_option __P((char *, int *)); 696 /* Simplified number_option for decimal ints */ 697void add_options __P((option_t *)); /* Add extra options */ 698void check_options __P((void)); /* check values after all options parsed */ 699int override_value __P((const char *, int, const char *)); 700 /* override value if permitted by priority */ 701void print_options __P((void (*) __P((void *, char *, ...)), void *)); 702 /* print out values of all options */ 703 704int parse_dotted_ip __P((char *, u_int32_t *)); 705 706/* 707 * Hooks to enable plugins to change various things. 708 */ 709extern int (*new_phase_hook) __P((int)); 710extern int (*idle_time_hook) __P((struct ppp_idle *)); 711extern int (*holdoff_hook) __P((void)); 712extern int (*pap_check_hook) __P((void)); 713extern int (*pap_auth_hook) __P((char *user, char *passwd, char **msgp, 714 struct wordlist **paddrs, 715 struct wordlist **popts)); 716extern void (*pap_logout_hook) __P((void)); 717extern int (*pap_passwd_hook) __P((char *user, char *passwd)); 718extern int (*allowed_address_hook) __P((u_int32_t addr)); 719extern void (*ip_up_hook) __P((void)); 720extern void (*ip_down_hook) __P((void)); 721extern void (*ip_choose_hook) __P((u_int32_t *)); 722 723extern int (*chap_check_hook) __P((void)); 724extern int (*chap_passwd_hook) __P((char *user, char *passwd)); 725 726/* Let a plugin snoop sent and received packets. Useful for L2TP */ 727extern void (*snoop_recv_hook) __P((unsigned char *p, int len)); 728extern void (*snoop_send_hook) __P((unsigned char *p, int len)); 729 730/* 731 * Inline versions of get/put char/short/long. 732 * Pointer is advanced; we assume that both arguments 733 * are lvalues and will already be in registers. 734 * cp MUST be u_char *. 735 */ 736#define GETCHAR(c, cp) { \ 737 (c) = *(cp)++; \ 738} 739#define PUTCHAR(c, cp) { \ 740 *(cp)++ = (u_char) (c); \ 741} 742 743 744#define GETSHORT(s, cp) { \ 745 (s) = *(cp)++ << 8; \ 746 (s) |= *(cp)++; \ 747} 748#define PUTSHORT(s, cp) { \ 749 *(cp)++ = (u_char) ((s) >> 8); \ 750 *(cp)++ = (u_char) (s); \ 751} 752 753#define GETLONG(l, cp) { \ 754 (l) = *(cp)++ << 8; \ 755 (l) |= *(cp)++; (l) <<= 8; \ 756 (l) |= *(cp)++; (l) <<= 8; \ 757 (l) |= *(cp)++; \ 758} 759#define PUTLONG(l, cp) { \ 760 *(cp)++ = (u_char) ((l) >> 24); \ 761 *(cp)++ = (u_char) ((l) >> 16); \ 762 *(cp)++ = (u_char) ((l) >> 8); \ 763 *(cp)++ = (u_char) (l); \ 764} 765 766#define INCPTR(n, cp) ((cp) += (n)) 767#define DECPTR(n, cp) ((cp) -= (n)) 768 769/* 770 * System dependent definitions for user-level 4.3BSD UNIX implementation. 771 */ 772 773#define TIMEOUT(r, f, t) timeout((r), (f), (t), 0) 774#define UNTIMEOUT(r, f) untimeout((r), (f)) 775 776#define BCOPY(s, d, l) memcpy(d, s, l) 777#define BZERO(s, n) memset(s, 0, n) 778#define BCMP(s1, s2, l) memcmp(s1, s2, l) 779 780#define PRINTMSG(m, l) { info("Remote message: %0.*v", l, m); } 781 782/* 783 * MAKEHEADER - Add Header fields to a packet. 784 */ 785#define MAKEHEADER(p, t) { \ 786 PUTCHAR(PPP_ALLSTATIONS, p); \ 787 PUTCHAR(PPP_UI, p); \ 788 PUTSHORT(t, p); } 789 790/* 791 * Exit status values. 792 */ 793#define EXIT_OK 0 794#define EXIT_FATAL_ERROR 1 795#define EXIT_OPTION_ERROR 2 796#define EXIT_NOT_ROOT 3 797#define EXIT_NO_KERNEL_SUPPORT 4 798#define EXIT_USER_REQUEST 5 799#define EXIT_LOCK_FAILED 6 800#define EXIT_OPEN_FAILED 7 801#define EXIT_CONNECT_FAILED 8 802#define EXIT_PTYCMD_FAILED 9 803#define EXIT_NEGOTIATION_FAILED 10 804#define EXIT_PEER_AUTH_FAILED 11 805#define EXIT_IDLE_TIMEOUT 12 806#define EXIT_CONNECT_TIME 13 807#define EXIT_CALLBACK 14 808#define EXIT_PEER_DEAD 15 809#define EXIT_HANGUP 16 810#define EXIT_LOOPBACK 17 811#define EXIT_INIT_FAILED 18 812#define EXIT_AUTH_TOPEER_FAILED 19 813#ifdef MAXOCTETS 814#define EXIT_TRAFFIC_LIMIT 20 815#endif 816#define EXIT_CNID_AUTH_FAILED 21 817 818/* 819 * Debug macros. Slightly useful for finding bugs in pppd, not particularly 820 * useful for finding out why your connection isn't being established. 821 */ 822#ifdef DEBUGALL 823#define DEBUGMAIN 1 824#define DEBUGFSM 1 825#define DEBUGLCP 1 826#define DEBUGIPCP 1 827#define DEBUGIPV6CP 1 828#define DEBUGUPAP 1 829#define DEBUGCHAP 1 830#endif 831 832#ifndef LOG_PPP /* we use LOG_LOCAL2 for syslog by default */ 833#if defined(DEBUGMAIN) || defined(DEBUGFSM) || defined(DEBUGSYS) \ 834 || defined(DEBUGLCP) || defined(DEBUGIPCP) || defined(DEBUGUPAP) \ 835 || defined(DEBUGCHAP) || defined(DEBUG) || defined(DEBUGIPV6CP) 836#define LOG_PPP LOG_LOCAL2 837#else 838#define LOG_PPP LOG_DAEMON 839#endif 840#endif /* LOG_PPP */ 841 842#ifdef DEBUGMAIN 843#define MAINDEBUG(x) if (debug) dbglog x 844#else 845#define MAINDEBUG(x) 846#endif 847 848#ifdef DEBUGSYS 849#define SYSDEBUG(x) if (debug) dbglog x 850#else 851#define SYSDEBUG(x) 852#endif 853 854#ifdef DEBUGFSM 855#define FSMDEBUG(x) if (debug) dbglog x 856#else 857#define FSMDEBUG(x) 858#endif 859 860#ifdef DEBUGLCP 861#define LCPDEBUG(x) if (debug) dbglog x 862#else 863#define LCPDEBUG(x) 864#endif 865 866#ifdef DEBUGIPCP 867#define IPCPDEBUG(x) if (debug) dbglog x 868#else 869#define IPCPDEBUG(x) 870#endif 871 872#ifdef DEBUGIPV6CP 873#define IPV6CPDEBUG(x) if (debug) dbglog x 874#else 875#define IPV6CPDEBUG(x) 876#endif 877 878#ifdef DEBUGUPAP 879#define UPAPDEBUG(x) if (debug) dbglog x 880#else 881#define UPAPDEBUG(x) 882#endif 883 884#ifdef DEBUGCHAP 885#define CHAPDEBUG(x) if (debug) dbglog x 886#else 887#define CHAPDEBUG(x) 888#endif 889 890#ifdef DEBUGIPXCP 891#define IPXCPDEBUG(x) if (debug) dbglog x 892#else 893#define IPXCPDEBUG(x) 894#endif 895 896#ifndef SIGTYPE 897#if defined(sun) || defined(SYSV) || defined(POSIX_SOURCE) 898#define SIGTYPE void 899#else 900#define SIGTYPE int 901#endif /* defined(sun) || defined(SYSV) || defined(POSIX_SOURCE) */ 902#endif /* SIGTYPE */ 903 904#ifndef MIN 905#define MIN(a, b) ((a) < (b)? (a): (b)) 906#endif 907#ifndef MAX 908#define MAX(a, b) ((a) > (b)? (a): (b)) 909#endif 910 911#ifndef offsetof 912#define offsetof(type, member) ((size_t) &((type *)0)->member) 913#endif 914 915#endif /* __PPP_H__ */ 916