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