add /etc/ppp/peers
[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.14 1996/07/01 01:19:55 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 #endif
42
43 /*
44  * Limits.
45  */
46
47 #define NUM_PPP         1       /* One PPP interface supported (per process) */
48 #define MAXWORDLEN      1024    /* max length of word in file (incl null) */
49 #define MAXARGS         1       /* max # args to a command */
50 #define MAXNAMELEN      256     /* max length of hostname or name for auth */
51 #define MAXSECRETLEN    256     /* max length of password or secret */
52
53 /*
54  * Global variables.
55  */
56
57 extern int      hungup;         /* Physical layer has disconnected */
58 extern int      ifunit;         /* Interface unit number */
59 extern char     ifname[];       /* Interface name */
60 extern int      ttyfd;          /* Serial device file descriptor */
61 extern char     hostname[];     /* Our hostname */
62 extern u_char   outpacket_buf[]; /* Buffer for outgoing packets */
63 extern int      phase;          /* Current state of link - see values below */
64 extern int      baud_rate;      /* Current link speed in bits/sec */
65 extern char     *progname;      /* Name of this program */
66 extern int      redirect_stderr;/* Connector's stderr should go to file */
67 extern char     peer_authname[];/* Authenticated name of peer */
68
69 /*
70  * Variables set by command-line options.
71  */
72
73 extern int      debug;          /* Debug flag */
74 extern int      kdebugflag;     /* Tell kernel to print debug messages */
75 extern int      default_device; /* Using /dev/tty or equivalent */
76 extern char     devnam[];       /* Device name */
77 extern int      crtscts;        /* Use hardware flow control */
78 extern int      modem;          /* Use modem control lines */
79 extern int      inspeed;        /* Input/Output speed requested */
80 extern u_int32_t netmask;       /* IP netmask to set on interface */
81 extern int      lockflag;       /* Create lock file to lock the serial dev */
82 extern int      nodetach;       /* Don't detach from controlling tty */
83 extern char     *connector;     /* Script to establish physical link */
84 extern char     *disconnector;  /* Script to disestablish physical link */
85 extern char     *welcomer;      /* Script to welcome client after connection */
86 extern int      maxconnect;     /* Maximum connect time (seconds) */
87 extern char     user[];         /* Username for PAP */
88 extern char     passwd[];       /* Password for PAP */
89 extern int      auth_required;  /* Peer is required to authenticate */
90 extern int      proxyarp;       /* Set up proxy ARP entry for peer */
91 extern int      persist;        /* Reopen link after it goes down */
92 extern int      uselogin;       /* Use /etc/passwd for checking PAP */
93 extern int      lcp_echo_interval; /* Interval between LCP echo-requests */
94 extern int      lcp_echo_fails; /* Tolerance to unanswered echo-requests */
95 extern char     our_name[];     /* Our name for authentication purposes */
96 extern char     remote_name[];  /* Peer's name for authentication */
97 extern int      usehostname;    /* Use hostname for our_name */
98 extern int      disable_defaultip; /* Don't use hostname for default IP adrs */
99 extern int      demand;         /* Do dial-on-demand */
100 extern char     *ipparam;       /* Extra parameter for ip up/down scripts */
101 extern int      cryptpap;       /* Others' PAP passwords are encrypted */
102 extern int      idle_time_limit;/* Shut down link if idle for this long */
103 extern int      holdoff;        /* Dead time before restarting */
104 extern int      refuse_pap;     /* Don't wanna auth. ourselves with PAP */
105 extern int      refuse_chap;    /* Don't wanna auth. ourselves with CHAP */
106
107 /*
108  * Values for phase.
109  */
110 #define PHASE_DEAD              0
111 #define PHASE_INITIALIZE        1
112 #define PHASE_DORMANT           2
113 #define PHASE_ESTABLISH         3
114 #define PHASE_AUTHENTICATE      4
115 #define PHASE_NETWORK           5
116 #define PHASE_TERMINATE         6
117 #define PHASE_HOLDOFF           7
118
119 /*
120  * The following struct gives the addresses of procedures to call
121  * for a particular protocol.
122  */
123 struct protent {
124     u_short protocol;           /* PPP protocol number */
125     /* Initialization procedure */
126     void (*init) __P((int unit));
127     /* Process a received packet */
128     void (*input) __P((int unit, u_char *pkt, int len));
129     /* Process a received protocol-reject */
130     void (*protrej) __P((int unit));
131     /* Lower layer has come up */
132     void (*lowerup) __P((int unit));
133     /* Lower layer has gone down */
134     void (*lowerdown) __P((int unit));
135     /* Open the protocol */
136     void (*open) __P((int unit));
137     /* Close the protocol */
138     void (*close) __P((int unit, char *reason));
139     /* Print a packet in readable form */
140     int  (*printpkt) __P((u_char *pkt, int len,
141                           void (*printer) __P((void *, char *, ...)),
142                           void *arg));
143     /* Process a received data packet */
144     void (*datainput) __P((int unit, u_char *pkt, int len));
145     int  enabled_flag;          /* 0 iff protocol is disabled */
146     char *name;                 /* Text name of protocol */
147     /* Check requested options, assign defaults */
148     void (*check_options) __P((void));
149     /* Configure interface for demand-dial */
150     int  (*demand_conf) __P((int unit));
151     /* Say whether to bring up link for this pkt */
152     int  (*active_pkt) __P((u_char *pkt, int len));
153 };
154
155 /* Table of pointers to supported protocols */
156 extern struct protent *protocols[];
157
158 /*
159  * Prototypes.
160  */
161
162 /* Procedures exported from main.c. */
163 void die __P((int));            /* Cleanup and exit */
164 void quit __P((void));          /* like die(1) */
165 void novm __P((char *));        /* Say we ran out of memory, and die */
166 void timeout __P((void (*func)(), caddr_t arg, int t));
167                                 /* Call func(arg) after t seconds */
168 void untimeout __P((void (*func)(), caddr_t arg));
169                                 /* Cancel call to func(arg) */
170 int run_program __P((char *prog, char **args, int must_exist));
171                                 /* Run program prog with args in child */
172 void demuxprotrej __P((int, int));
173                                 /* Demultiplex a Protocol-Reject */
174 void format_packet __P((u_char *, int, void (*) (void *, char *, ...),
175                 void *));       /* Format a packet in human-readable form */
176 void log_packet __P((u_char *, int, char *));
177                                 /* Format a packet and log it with syslog */
178 void print_string __P((char *, int,  void (*) (void *, char *, ...),
179                 void *));       /* Format a string for output */
180 int fmtmsg __P((char *, int, char *, ...));             /* sprintf++ */
181 int vfmtmsg __P((char *, int, char *, va_list));        /* vsprintf++ */
182
183 /* Procedures exported from auth.c */
184 void link_required __P((int));    /* we are starting to use the link */
185 void link_terminated __P((int));  /* we are finished with the link */
186 void link_down __P((int));        /* the LCP layer has left the Opened state */
187 void link_established __P((int)); /* the link is up; authenticate now */
188 void np_up __P((int, int));       /* a network protocol has come up */
189 void np_down __P((int, int));     /* a network protocol has gone down */
190 void np_finished __P((int, int)); /* a network protocol no longer needs link */
191 void auth_peer_fail __P((int, int));
192                                 /* peer failed to authenticate itself */
193 void auth_peer_success __P((int, int, char *, int));
194                                 /* peer successfully authenticated itself */
195 void auth_withpeer_fail __P((int, int));
196                                 /* we failed to authenticate ourselves */
197 void auth_withpeer_success __P((int, int));
198                                 /* we successfully authenticated ourselves */
199 void auth_check_options __P((void));
200                                 /* check authentication options supplied */
201 void auth_reset __P((int));     /* check what secrets we have */
202 int  check_passwd __P((int, char *, int, char *, int, char **, int *));
203                                 /* Check peer-supplied username/password */
204 int  get_secret __P((int, char *, char *, char *, int *, int));
205                                 /* get "secret" for chap */
206 int  auth_ip_addr __P((int, u_int32_t));
207                                 /* check if IP address is authorized */
208 int  bad_ip_adrs __P((u_int32_t));
209                                 /* check if IP address is unreasonable */
210 void check_access __P((FILE *, char *));
211                                 /* check permissions on secrets file */
212
213 /* Procedures exported from demand.c */
214 void demand_conf __P((void));   /* config interface(s) for demand-dial */
215 void demand_block __P((void));  /* set all NPs to queue up packets */
216 void demand_unblock __P((void)); /* set all NPs to pass packets */
217 void demand_discard __P((void)); /* set all NPs to discard packets */
218 void demand_rexmit __P((int));  /* retransmit saved frames for an NP */
219 int  loop_chars __P((unsigned char *, int)); /* process chars from loopback */
220 int  loop_frame __P((unsigned char *, int)); /* process frame from loopback */
221
222 /* Procedures exported from sys-*.c */
223 void sys_init __P((void));      /* Do system-dependent initialization */
224 void sys_cleanup __P((void));   /* Restore system state before exiting */
225 void sys_check_options __P((void)); /* Check options specified */
226 void sys_close __P((void));     /* Clean up in a child before execing */
227 int  ppp_available __P((void)); /* Test whether ppp kernel support exists */
228 void open_ppp_loopback __P((void)); /* Open loopback for demand-dialling */
229 void establish_ppp __P((int));  /* Turn serial port into a ppp interface */
230 void restore_loop __P((void));  /* Transfer ppp unit back to loopback */
231 void disestablish_ppp __P((int)); /* Restore port to normal operation */
232 void clean_check __P((void));   /* Check if line was 8-bit clean */
233 void set_up_tty __P((int, int)); /* Set up port's speed, parameters, etc. */
234 void restore_tty __P((int));    /* Restore port's original parameters */
235 void setdtr __P((int, int));    /* Raise or lower port's DTR line */
236 void output __P((int, u_char *, int)); /* Output a PPP packet */
237 void wait_input __P((struct timeval *));
238                                 /* Wait for input, with timeout */
239 void wait_loop_output __P((struct timeval *));
240                                 /* Wait for pkt from loopback, with timeout */
241 void wait_time __P((struct timeval *)); /* Wait for given length of time */
242 int  read_packet __P((u_char *)); /* Read PPP packet */
243 int  get_loop_output __P((void)); /* Read pkts from loopback */
244 void ppp_send_config __P((int, int, u_int32_t, int, int));
245                                 /* Configure i/f transmit parameters */
246 void ppp_set_xaccm __P((int, ext_accm));
247                                 /* Set extended transmit ACCM */
248 void ppp_recv_config __P((int, int, u_int32_t, int, int));
249                                 /* Configure i/f receive parameters */
250 int  ccp_test __P((int, u_char *, int, int));
251                                 /* Test support for compression scheme */
252 void ccp_flags_set __P((int, int, int));
253                                 /* Set kernel CCP state */
254 int  ccp_fatal_error __P((int)); /* Test for fatal decomp error in kernel */
255 int  get_idle_time __P((int, struct ppp_idle *));
256                                 /* Find out how long link has been idle */
257 int  sifvjcomp __P((int, int, int, int));
258                                 /* Configure VJ TCP header compression */
259 int  sifup __P((int));          /* Configure i/f up (for IP) */
260 int  sifnpmode __P((int u, int proto, enum NPmode mode));
261                                 /* Set mode for handling packets for proto */
262 int  sifdown __P((int));        /* Configure i/f down (for IP) */
263 int  sifaddr __P((int, u_int32_t, u_int32_t, u_int32_t));
264                                 /* Configure IP addresses for i/f */
265 int  cifaddr __P((int, u_int32_t, u_int32_t));
266                                 /* Reset i/f IP addresses */
267 int  sifdefaultroute __P((int, u_int32_t));
268                                 /* Create default route through i/f */
269 int  cifdefaultroute __P((int, u_int32_t));
270                                 /* Delete default route through i/f */
271 int  sifproxyarp __P((int, u_int32_t));
272                                 /* Add proxy ARP entry for peer */
273 int  cifproxyarp __P((int, u_int32_t));
274                                 /* Delete proxy ARP entry for peer */
275 u_int32_t GetMask __P((u_int32_t)); /* Get appropriate netmask for address */
276 int  lock __P((char *));        /* Create lock file for device */
277 void unlock __P((void));        /* Delete previously-created lock file */
278 int  daemon __P((int, int));    /* Detach us from terminal session */
279 int  logwtmp __P((char *, char *, char *));
280                                 /* Write entry to wtmp file */
281
282 /* Procedures exported from options.c */
283 int  parse_args __P((int argc, char **argv));
284                                 /* Parse options from arguments given */
285 void usage __P((void));         /* Print a usage message */
286 int  options_from_file __P((char *filename, int must_exist, int check_prot));
287                                 /* Parse options from an options file */
288 int  options_from_user __P((void)); /* Parse options from user's .ppprc */
289 int  options_for_tty __P((void)); /* Parse options from /etc/ppp/options.tty */
290 void scan_args __P((int argc, char **argv));
291                                 /* Look for tty name in command-line args */
292 int  getword __P((FILE *f, char *word, int *newlinep, char *filename));
293                                 /* Read a word from a file */
294
295 /*
296  * Inline versions of get/put char/short/long.
297  * Pointer is advanced; we assume that both arguments
298  * are lvalues and will already be in registers.
299  * cp MUST be u_char *.
300  */
301 #define GETCHAR(c, cp) { \
302         (c) = *(cp)++; \
303 }
304 #define PUTCHAR(c, cp) { \
305         *(cp)++ = (u_char) (c); \
306 }
307
308
309 #define GETSHORT(s, cp) { \
310         (s) = *(cp)++ << 8; \
311         (s) |= *(cp)++; \
312 }
313 #define PUTSHORT(s, cp) { \
314         *(cp)++ = (u_char) ((s) >> 8); \
315         *(cp)++ = (u_char) (s); \
316 }
317
318 #define GETLONG(l, cp) { \
319         (l) = *(cp)++ << 8; \
320         (l) |= *(cp)++; (l) <<= 8; \
321         (l) |= *(cp)++; (l) <<= 8; \
322         (l) |= *(cp)++; \
323 }
324 #define PUTLONG(l, cp) { \
325         *(cp)++ = (u_char) ((l) >> 24); \
326         *(cp)++ = (u_char) ((l) >> 16); \
327         *(cp)++ = (u_char) ((l) >> 8); \
328         *(cp)++ = (u_char) (l); \
329 }
330
331 #define INCPTR(n, cp)   ((cp) += (n))
332 #define DECPTR(n, cp)   ((cp) -= (n))
333
334 #undef  FALSE
335 #define FALSE   0
336 #undef  TRUE
337 #define TRUE    1
338
339 /*
340  * System dependent definitions for user-level 4.3BSD UNIX implementation.
341  */
342
343 #define DEMUXPROTREJ(u, p)      demuxprotrej(u, p)
344
345 #define TIMEOUT(r, f, t)        timeout((r), (f), (t))
346 #define UNTIMEOUT(r, f)         untimeout((r), (f))
347
348 #define BCOPY(s, d, l)          memcpy(d, s, l)
349 #define BZERO(s, n)             memset(s, 0, n)
350 #define EXIT(u)                 quit()
351
352 #define PRINTMSG(m, l)  { m[l] = '\0'; syslog(LOG_INFO, "Remote message: %s", m); }
353
354 /*
355  * MAKEHEADER - Add Header fields to a packet.
356  */
357 #define MAKEHEADER(p, t) { \
358     PUTCHAR(PPP_ALLSTATIONS, p); \
359     PUTCHAR(PPP_UI, p); \
360     PUTSHORT(t, p); }
361
362
363 #ifdef DEBUGALL
364 #define DEBUGMAIN       1
365 #define DEBUGFSM        1
366 #define DEBUGLCP        1
367 #define DEBUGIPCP       1
368 #define DEBUGUPAP       1
369 #define DEBUGCHAP       1
370 #endif
371
372 #ifndef LOG_PPP                 /* we use LOG_LOCAL2 for syslog by default */
373 #if defined(DEBUGMAIN) || defined(DEBUGFSM) || defined(DEBUGSYS) \
374   || defined(DEBUGLCP) || defined(DEBUGIPCP) || defined(DEBUGUPAP) \
375   || defined(DEBUGCHAP) || defined(DEBUG)
376 #define LOG_PPP LOG_LOCAL2
377 #else
378 #define LOG_PPP LOG_DAEMON
379 #endif
380 #endif /* LOG_PPP */
381
382 #ifdef DEBUGMAIN
383 #define MAINDEBUG(x)    if (debug) syslog x
384 #else
385 #define MAINDEBUG(x)
386 #endif
387
388 #ifdef DEBUGSYS
389 #define SYSDEBUG(x)     if (debug) syslog x
390 #else
391 #define SYSDEBUG(x)
392 #endif
393
394 #ifdef DEBUGFSM
395 #define FSMDEBUG(x)     if (debug) syslog x
396 #else
397 #define FSMDEBUG(x)
398 #endif
399
400 #ifdef DEBUGLCP
401 #define LCPDEBUG(x)     if (debug) syslog x
402 #else
403 #define LCPDEBUG(x)
404 #endif
405
406 #ifdef DEBUGIPCP
407 #define IPCPDEBUG(x)    if (debug) syslog x
408 #else
409 #define IPCPDEBUG(x)
410 #endif
411
412 #ifdef DEBUGUPAP
413 #define UPAPDEBUG(x)    if (debug) syslog x
414 #else
415 #define UPAPDEBUG(x)
416 #endif
417
418 #ifdef DEBUGCHAP
419 #define CHAPDEBUG(x)    if (debug) syslog x
420 #else
421 #define CHAPDEBUG(x)
422 #endif
423
424 #ifndef SIGTYPE
425 #if defined(sun) || defined(SYSV) || defined(POSIX_SOURCE)
426 #define SIGTYPE void
427 #else
428 #define SIGTYPE int
429 #endif /* defined(sun) || defined(SYSV) || defined(POSIX_SOURCE) */
430 #endif /* SIGTYPE */
431
432 #ifndef MIN
433 #define MIN(a, b)       ((a) < (b)? (a): (b))
434 #endif
435 #ifndef MAX
436 #define MAX(a, b)       ((a) > (b)? (a): (b))
437 #endif
438
439 #endif /* __PPP_H__ */