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