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