minor changes so it compiles with pre-ansi compiler;
[ppp.git] / pppd / pppd.h
1 /*
2  * pppd.h - PPP daemon global declarations.
3  *
4  * Copyright (c) 1989 Carnegie Mellon University.
5  * All rights reserved.
6  *
7  * Redistribution and use in source and binary forms are permitted
8  * provided that the above copyright notice and this paragraph are
9  * duplicated in all such forms and that any documentation,
10  * advertising materials, and other materials related to such
11  * distribution and use acknowledge that the software was developed
12  * by Carnegie Mellon University.  The name of the
13  * University may not be used to endorse or promote products derived
14  * from this software without specific prior written permission.
15  * THIS SOFTWARE IS PROVIDED ``AS IS'' AND WITHOUT ANY EXPRESS OR
16  * IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED
17  * WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR A PARTICULAR PURPOSE.
18  *
19  * $Id: pppd.h,v 1.28 1999/03/08 05:34:45 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 <sys/param.h>          /* for MAXPATHLEN and BSD4_4, if defined */
31 #include <sys/types.h>          /* for u_int32_t, if defined */
32 #include <sys/time.h>           /* for struct timeval */
33 #include <net/ppp_defs.h>
34
35 #if __STDC__
36 #include <stdarg.h>
37 #define __V(x)  x
38 #else
39 #include <varargs.h>
40 #define __V(x)  (va_alist) va_dcl
41 #define const
42 #endif
43
44 /*
45  * Limits.
46  */
47
48 #define NUM_PPP         1       /* One PPP interface supported (per process) */
49 #define MAXWORDLEN      1024    /* max length of word in file (incl null) */
50 #define MAXARGS         1       /* max # args to a command */
51 #define MAXNAMELEN      256     /* max length of hostname or name for auth */
52 #define MAXSECRETLEN    256     /* max length of password or secret */
53
54 /*
55  * Option descriptor structure.
56  */
57
58 typedef unsigned char   bool;
59
60 enum opt_type {
61         o_special_noarg = 0,
62         o_special = 1,
63         o_bool,
64         o_int,
65         o_uint32,
66         o_string,
67 };
68
69 typedef struct {
70         char    *name;          /* name of the option */
71         enum opt_type type;
72         void    *addr;
73         char    *description;
74         int     flags;
75         void    *addr2;
76         int     upper_limit;
77         int     lower_limit;
78 } option_t;
79
80 /* Values for flags */
81 #define OPT_VALUE       0xff    /* mask for presupplied value */
82 #define OPT_HEX         0x100   /* int option is in hex */
83 #define OPT_NOARG       0x200   /* option doesn't take argument */
84 #define OPT_OR          0x400   /* OR in argument to value */
85 #define OPT_INC         0x800   /* increment value */
86 #define OPT_PRIV        0x1000  /* privileged option */
87 #define OPT_STATIC      0x2000  /* string option goes into static array */
88 #define OPT_LLIMIT      0x4000  /* check value against lower limit */
89 #define OPT_ULIMIT      0x8000  /* check value against upper limit */
90 #define OPT_LIMITS      (OPT_LLIMIT|OPT_ULIMIT)
91 #define OPT_ZEROOK      0x10000 /* 0 value is OK even if not within limits */
92 #define OPT_NOINCR      0x20000 /* value mustn't be increased */
93 #define OPT_ZEROINF     0x40000 /* with OPT_NOINCR, 0 == infinity */
94 #define OPT_A2INFO      0x100000 /* addr2 -> option_info to update */
95 #define OPT_A2COPY      0x200000 /* addr2 -> second location to rcv value */
96 #define OPT_ENABLE      0x400000 /* use *addr2 as enable for option */
97
98 #define OPT_VAL(x)      ((x) & OPT_VALUE)
99
100 /*
101  * Global variables.
102  */
103
104 extern int      hungup;         /* Physical layer has disconnected */
105 extern int      ifunit;         /* Interface unit number */
106 extern char     ifname[];       /* Interface name */
107 extern int      ttyfd;          /* Serial device file descriptor */
108 extern char     hostname[];     /* Our hostname */
109 extern u_char   outpacket_buf[]; /* Buffer for outgoing packets */
110 extern int      phase;          /* Current state of link - see values below */
111 extern int      baud_rate;      /* Current link speed in bits/sec */
112 extern char     *progname;      /* Name of this program */
113 extern int      redirect_stderr;/* Connector's stderr should go to file */
114 extern char     peer_authname[];/* Authenticated name of peer */
115 extern int      privileged;     /* We were run by real-uid root */
116 extern int      need_holdoff;   /* Need holdoff period after link terminates */
117 extern char     **script_env;   /* Environment variables for scripts */
118 extern int      detached;       /* Have detached from controlling tty */
119
120 /*
121  * Variables set by command-line options.
122  */
123
124 extern int      debug;          /* Debug flag */
125 extern int      kdebugflag;     /* Tell kernel to print debug messages */
126 extern int      default_device; /* Using /dev/tty or equivalent */
127 extern char     devnam[];       /* Device name */
128 extern int      crtscts;        /* Use hardware flow control */
129 extern bool     modem;          /* Use modem control lines */
130 extern int      inspeed;        /* Input/Output speed requested */
131 extern u_int32_t netmask;       /* IP netmask to set on interface */
132 extern bool     lockflag;       /* Create lock file to lock the serial dev */
133 extern bool     nodetach;       /* Don't detach from controlling tty */
134 extern bool     updetach;       /* Detach from controlling tty when link up */
135 extern char     *connector;     /* Script to establish physical link */
136 extern char     *disconnector;  /* Script to disestablish physical link */
137 extern char     *welcomer;      /* Script to welcome client after connection */
138 extern int      maxconnect;     /* Maximum connect time (seconds) */
139 extern char     user[];         /* Our name for authenticating ourselves */
140 extern char     passwd[];       /* Password for PAP */
141 extern bool     auth_required;  /* Peer is required to authenticate */
142 extern bool     persist;        /* Reopen link after it goes down */
143 extern bool     uselogin;       /* Use /etc/passwd for checking PAP */
144 extern char     our_name[];     /* Our name for authentication purposes */
145 extern char     remote_name[];  /* Peer's name for authentication */
146 extern int      explicit_remote;/* remote_name specified with remotename opt */
147 extern bool     demand;         /* Do dial-on-demand */
148 extern char     *ipparam;       /* Extra parameter for ip up/down scripts */
149 extern bool     cryptpap;       /* Others' PAP passwords are encrypted */
150 extern int      idle_time_limit;/* Shut down link if idle for this long */
151 extern int      holdoff;        /* Dead time before restarting */
152 #ifdef PPP_FILTER
153 extern struct   bpf_program pass_filter;   /* Filter for pkts to pass */
154 extern struct   bpf_program active_filter; /* Filter for link-active pkts */
155 #endif
156
157 char *current_option;           /* the name of the option being parsed */
158 int  privileged_option;         /* set iff the current option came from root */
159 char *option_source;            /* string saying where the option came from */
160
161 #ifdef MSLANMAN
162 extern bool     ms_lanman;      /* Use LanMan password instead of NT */
163                                 /* Has meaning only with MS-CHAP challenges */
164 #endif
165
166 /*
167  * Values for phase.
168  */
169 #define PHASE_DEAD              0
170 #define PHASE_INITIALIZE        1
171 #define PHASE_DORMANT           2
172 #define PHASE_ESTABLISH         3
173 #define PHASE_AUTHENTICATE      4
174 #define PHASE_CALLBACK          5
175 #define PHASE_NETWORK           6
176 #define PHASE_TERMINATE         7
177 #define PHASE_HOLDOFF           8
178
179 /*
180  * The following struct gives the addresses of procedures to call
181  * for a particular protocol.
182  */
183 struct protent {
184     u_short protocol;           /* PPP protocol number */
185     /* Initialization procedure */
186     void (*init) __P((int unit));
187     /* Process a received packet */
188     void (*input) __P((int unit, u_char *pkt, int len));
189     /* Process a received protocol-reject */
190     void (*protrej) __P((int unit));
191     /* Lower layer has come up */
192     void (*lowerup) __P((int unit));
193     /* Lower layer has gone down */
194     void (*lowerdown) __P((int unit));
195     /* Open the protocol */
196     void (*open) __P((int unit));
197     /* Close the protocol */
198     void (*close) __P((int unit, char *reason));
199     /* Print a packet in readable form */
200     int  (*printpkt) __P((u_char *pkt, int len,
201                           void (*printer) __P((void *, char *, ...)),
202                           void *arg));
203     /* Process a received data packet */
204     void (*datainput) __P((int unit, u_char *pkt, int len));
205     bool enabled_flag;          /* 0 iff protocol is disabled */
206     char *name;                 /* Text name of protocol */
207     option_t *options;          /* List of command-line options */
208     /* Check requested options, assign defaults */
209     void (*check_options) __P((void));
210     /* Configure interface for demand-dial */
211     int  (*demand_conf) __P((int unit));
212     /* Say whether to bring up link for this pkt */
213     int  (*active_pkt) __P((u_char *pkt, int len));
214 };
215
216 /* Table of pointers to supported protocols */
217 extern struct protent *protocols[];
218
219 /*
220  * Prototypes.
221  */
222
223 /* Procedures exported from main.c. */
224 void detach __P((void));        /* Detach from controlling tty */
225 void die __P((int));            /* Cleanup and exit */
226 void quit __P((void));          /* like die(1) */
227 void novm __P((char *));        /* Say we ran out of memory, and die */
228 void timeout __P((void (*func)(void *), void *arg, int t));
229                                 /* Call func(arg) after t seconds */
230 void untimeout __P((void (*func)(void *), void *arg));
231                                 /* Cancel call to func(arg) */
232 pid_t run_program __P((char *prog, char **args, int must_exist,
233                        void (*done)(void *), void *arg));
234                                 /* Run program prog with args in child */
235 void demuxprotrej __P((int, int));
236                                 /* Demultiplex a Protocol-Reject */
237 void format_packet __P((u_char *, int, void (*) (void *, char *, ...),
238                 void *));       /* Format a packet in human-readable form */
239 void log_packet __P((u_char *, int, char *, int));
240                                 /* Format a packet and log it with syslog */
241 void print_string __P((char *, int,  void (*) (void *, char *, ...),
242                 void *));       /* Format a string for output */
243 int fmtmsg __P((char *, int, char *, ...));             /* sprintf++ */
244 int vfmtmsg __P((char *, int, char *, va_list));        /* vsprintf++ */
245 void script_setenv __P((char *, char *));       /* set script env var */
246 void script_unsetenv __P((char *));             /* unset script env var */
247 void hangup_modem __P((int));   /* Make modem hang up */
248
249 /* Procedures exported from auth.c */
250 void link_required __P((int));    /* we are starting to use the link */
251 void link_terminated __P((int));  /* we are finished with the link */
252 void link_down __P((int));        /* the LCP layer has left the Opened state */
253 void link_established __P((int)); /* the link is up; authenticate now */
254 void np_up __P((int, int));       /* a network protocol has come up */
255 void np_down __P((int, int));     /* a network protocol has gone down */
256 void np_finished __P((int, int)); /* a network protocol no longer needs link */
257 void auth_peer_fail __P((int, int));
258                                 /* peer failed to authenticate itself */
259 void auth_peer_success __P((int, int, char *, int));
260                                 /* peer successfully authenticated itself */
261 void auth_withpeer_fail __P((int, int));
262                                 /* we failed to authenticate ourselves */
263 void auth_withpeer_success __P((int, int));
264                                 /* we successfully authenticated ourselves */
265 void auth_check_options __P((void));
266                                 /* check authentication options supplied */
267 void auth_reset __P((int));     /* check what secrets we have */
268 int  check_passwd __P((int, char *, int, char *, int, char **, int *));
269                                 /* Check peer-supplied username/password */
270 int  get_secret __P((int, char *, char *, char *, int *, int));
271                                 /* get "secret" for chap */
272 int  auth_ip_addr __P((int, u_int32_t));
273                                 /* check if IP address is authorized */
274 int  bad_ip_adrs __P((u_int32_t));
275                                 /* check if IP address is unreasonable */
276 void check_access __P((FILE *, char *));
277                                 /* check permissions on secrets file */
278
279 /* Procedures exported from demand.c */
280 void demand_conf __P((void));   /* config interface(s) for demand-dial */
281 void demand_block __P((void));  /* set all NPs to queue up packets */
282 void demand_unblock __P((void)); /* set all NPs to pass packets */
283 void demand_discard __P((void)); /* set all NPs to discard packets */
284 void demand_rexmit __P((int));  /* retransmit saved frames for an NP */
285 int  loop_chars __P((unsigned char *, int)); /* process chars from loopback */
286 int  loop_frame __P((unsigned char *, int)); /* process frame from loopback */
287
288 /* Procedures exported from sys-*.c */
289 void sys_init __P((void));      /* Do system-dependent initialization */
290 void sys_cleanup __P((void));   /* Restore system state before exiting */
291 int  sys_check_options __P((void)); /* Check options specified */
292 void sys_close __P((void));     /* Clean up in a child before execing */
293 int  ppp_available __P((void)); /* Test whether ppp kernel support exists */
294 void open_ppp_loopback __P((void)); /* Open loopback for demand-dialling */
295 void establish_ppp __P((int));  /* Turn serial port into a ppp interface */
296 void restore_loop __P((void));  /* Transfer ppp unit back to loopback */
297 void disestablish_ppp __P((int)); /* Restore port to normal operation */
298 void clean_check __P((void));   /* Check if line was 8-bit clean */
299 void set_up_tty __P((int, int)); /* Set up port's speed, parameters, etc. */
300 void restore_tty __P((int));    /* Restore port's original parameters */
301 void setdtr __P((int, int));    /* Raise or lower port's DTR line */
302 void output __P((int, u_char *, int)); /* Output a PPP packet */
303 void wait_input __P((struct timeval *));
304                                 /* Wait for input, with timeout */
305 void wait_loop_output __P((struct timeval *));
306                                 /* Wait for pkt from loopback, with timeout */
307 void wait_time __P((struct timeval *)); /* Wait for given length of time */
308 int  read_packet __P((u_char *)); /* Read PPP packet */
309 int  get_loop_output __P((void)); /* Read pkts from loopback */
310 void ppp_send_config __P((int, int, u_int32_t, int, int));
311                                 /* Configure i/f transmit parameters */
312 void ppp_set_xaccm __P((int, ext_accm));
313                                 /* Set extended transmit ACCM */
314 void ppp_recv_config __P((int, int, u_int32_t, int, int));
315                                 /* Configure i/f receive parameters */
316 int  ccp_test __P((int, u_char *, int, int));
317                                 /* Test support for compression scheme */
318 void ccp_flags_set __P((int, int, int));
319                                 /* Set kernel CCP state */
320 int  ccp_fatal_error __P((int)); /* Test for fatal decomp error in kernel */
321 int  get_idle_time __P((int, struct ppp_idle *));
322                                 /* Find out how long link has been idle */
323 int  sifvjcomp __P((int, int, int, int));
324                                 /* Configure VJ TCP header compression */
325 int  sifup __P((int));          /* Configure i/f up (for IP) */
326 int  sifnpmode __P((int u, int proto, enum NPmode mode));
327                                 /* Set mode for handling packets for proto */
328 int  sifdown __P((int));        /* Configure i/f down (for IP) */
329 int  sifaddr __P((int, u_int32_t, u_int32_t, u_int32_t));
330                                 /* Configure IP addresses for i/f */
331 int  cifaddr __P((int, u_int32_t, u_int32_t));
332                                 /* Reset i/f IP addresses */
333 int  sifdefaultroute __P((int, u_int32_t, u_int32_t));
334                                 /* Create default route through i/f */
335 int  cifdefaultroute __P((int, u_int32_t, u_int32_t));
336                                 /* Delete default route through i/f */
337 int  sifproxyarp __P((int, u_int32_t));
338                                 /* Add proxy ARP entry for peer */
339 int  cifproxyarp __P((int, u_int32_t));
340                                 /* Delete proxy ARP entry for peer */
341 u_int32_t GetMask __P((u_int32_t)); /* Get appropriate netmask for address */
342 int  lock __P((char *));        /* Create lock file for device */
343 void unlock __P((void));        /* Delete previously-created lock file */
344 int  daemon __P((int, int));    /* Detach us from terminal session */
345 void logwtmp __P((const char *, const char *, const char *));
346                                 /* Write entry to wtmp file */
347 int  get_host_seed __P((void)); /* Get host-dependent random number seed */
348 int  have_route_to __P((u_int32_t)); /* Check if route to addr exists */
349 #ifdef PPP_FILTER
350 int  set_filters __P((struct bpf_program *pass, struct bpf_program *active));
351                                 /* Set filter programs in kernel */
352 #endif
353 #ifdef IPX_CHANGE
354 int  sipxfaddr __P((int, unsigned long, unsigned char *));
355 int  cipxfaddr __P((int));
356 #endif
357
358 /* Procedures exported from options.c */
359 int  parse_args __P((int argc, char **argv));
360                                 /* Parse options from arguments given */
361 void usage __P((void));         /* Print a usage message */
362 int  options_from_file __P((char *filename, int must_exist, int check_prot,
363                             int privileged));
364                                 /* Parse options from an options file */
365 int  options_from_user __P((void)); /* Parse options from user's .ppprc */
366 int  options_for_tty __P((void)); /* Parse options from /etc/ppp/options.tty */
367 void scan_args __P((int argc, char **argv));
368                                 /* Look for tty name in command-line args */
369 int  getword __P((FILE *f, char *word, int *newlinep, char *filename));
370                                 /* Read a word from a file */
371 void option_error __P((char *fmt, ...));
372                                 /* Print an error message about an option */
373 int readable __P((int fd));     /* Is fd readable by real user? */
374 int number_option __P((char *, u_int32_t *, int));
375                                 /* Parse a numerical option */
376 int int_option __P((char *, int *));
377                                 /* Simplified number_option for decimal ints */
378
379 /*
380  * This structure is used to store information about certain
381  * options, such as where the option value came from (/etc/ppp/options,
382  * command line, etc.) and whether it came from a privileged source.
383  */
384
385 struct option_info {
386     int     priv;               /* was value set by sysadmin? */
387     char    *source;            /* where option came from */
388 };
389
390 extern struct option_info devnam_info;
391 extern struct option_info connector_info;
392 extern struct option_info disconnector_info;
393 extern struct option_info welcomer_info;
394
395 /*
396  * Inline versions of get/put char/short/long.
397  * Pointer is advanced; we assume that both arguments
398  * are lvalues and will already be in registers.
399  * cp MUST be u_char *.
400  */
401 #define GETCHAR(c, cp) { \
402         (c) = *(cp)++; \
403 }
404 #define PUTCHAR(c, cp) { \
405         *(cp)++ = (u_char) (c); \
406 }
407
408
409 #define GETSHORT(s, cp) { \
410         (s) = *(cp)++ << 8; \
411         (s) |= *(cp)++; \
412 }
413 #define PUTSHORT(s, cp) { \
414         *(cp)++ = (u_char) ((s) >> 8); \
415         *(cp)++ = (u_char) (s); \
416 }
417
418 #define GETLONG(l, cp) { \
419         (l) = *(cp)++ << 8; \
420         (l) |= *(cp)++; (l) <<= 8; \
421         (l) |= *(cp)++; (l) <<= 8; \
422         (l) |= *(cp)++; \
423 }
424 #define PUTLONG(l, cp) { \
425         *(cp)++ = (u_char) ((l) >> 24); \
426         *(cp)++ = (u_char) ((l) >> 16); \
427         *(cp)++ = (u_char) ((l) >> 8); \
428         *(cp)++ = (u_char) (l); \
429 }
430
431 #define INCPTR(n, cp)   ((cp) += (n))
432 #define DECPTR(n, cp)   ((cp) -= (n))
433
434 #undef  FALSE
435 #define FALSE   0
436 #undef  TRUE
437 #define TRUE    1
438
439 /*
440  * System dependent definitions for user-level 4.3BSD UNIX implementation.
441  */
442
443 #define DEMUXPROTREJ(u, p)      demuxprotrej(u, p)
444
445 #define TIMEOUT(r, f, t)        timeout((r), (f), (t))
446 #define UNTIMEOUT(r, f)         untimeout((r), (f))
447
448 #define BCOPY(s, d, l)          memcpy(d, s, l)
449 #define BZERO(s, n)             memset(s, 0, n)
450 #define EXIT(u)                 quit()
451
452 #define PRINTMSG(m, l)  { m[l] = '\0'; syslog(LOG_INFO, "Remote message: %s", m); }
453
454 /*
455  * MAKEHEADER - Add Header fields to a packet.
456  */
457 #define MAKEHEADER(p, t) { \
458     PUTCHAR(PPP_ALLSTATIONS, p); \
459     PUTCHAR(PPP_UI, p); \
460     PUTSHORT(t, p); }
461
462
463 #ifdef DEBUGALL
464 #define DEBUGMAIN       1
465 #define DEBUGFSM        1
466 #define DEBUGLCP        1
467 #define DEBUGIPCP       1
468 #define DEBUGUPAP       1
469 #define DEBUGCHAP       1
470 #endif
471
472 #ifndef LOG_PPP                 /* we use LOG_LOCAL2 for syslog by default */
473 #if defined(DEBUGMAIN) || defined(DEBUGFSM) || defined(DEBUGSYS) \
474   || defined(DEBUGLCP) || defined(DEBUGIPCP) || defined(DEBUGUPAP) \
475   || defined(DEBUGCHAP) || defined(DEBUG)
476 #define LOG_PPP LOG_LOCAL2
477 #else
478 #define LOG_PPP LOG_DAEMON
479 #endif
480 #endif /* LOG_PPP */
481
482 #ifdef DEBUGMAIN
483 #define MAINDEBUG(x)    if (debug) syslog x
484 #else
485 #define MAINDEBUG(x)
486 #endif
487
488 #ifdef DEBUGSYS
489 #define SYSDEBUG(x)     if (debug) syslog x
490 #else
491 #define SYSDEBUG(x)
492 #endif
493
494 #ifdef DEBUGFSM
495 #define FSMDEBUG(x)     if (debug) syslog x
496 #else
497 #define FSMDEBUG(x)
498 #endif
499
500 #ifdef DEBUGLCP
501 #define LCPDEBUG(x)     if (debug) syslog x
502 #else
503 #define LCPDEBUG(x)
504 #endif
505
506 #ifdef DEBUGIPCP
507 #define IPCPDEBUG(x)    if (debug) syslog x
508 #else
509 #define IPCPDEBUG(x)
510 #endif
511
512 #ifdef DEBUGUPAP
513 #define UPAPDEBUG(x)    if (debug) syslog x
514 #else
515 #define UPAPDEBUG(x)
516 #endif
517
518 #ifdef DEBUGCHAP
519 #define CHAPDEBUG(x)    if (debug) syslog x
520 #else
521 #define CHAPDEBUG(x)
522 #endif
523
524 #ifdef DEBUGIPXCP
525 #define IPXCPDEBUG(x)   if (debug) syslog x
526 #else
527 #define IPXCPDEBUG(x)
528 #endif
529
530 #ifndef SIGTYPE
531 #if defined(sun) || defined(SYSV) || defined(POSIX_SOURCE)
532 #define SIGTYPE void
533 #else
534 #define SIGTYPE int
535 #endif /* defined(sun) || defined(SYSV) || defined(POSIX_SOURCE) */
536 #endif /* SIGTYPE */
537
538 #ifndef MIN
539 #define MIN(a, b)       ((a) < (b)? (a): (b))
540 #endif
541 #ifndef MAX
542 #define MAX(a, b)       ((a) > (b)? (a): (b))
543 #endif
544
545 #endif /* __PPP_H__ */