pppd/pppd.h

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