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