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