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