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