pppd/pppd.h

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