2 * pppd.h - PPP daemon global declarations.
4 * Copyright (c) 1989 Carnegie Mellon University.
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.
19 * $Id: pppd.h,v 1.35 1999/03/24 05:05:25 paulus Exp $
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>
41 #define __V(x) (va_alist) va_dcl
49 #define NUM_PPP 1 /* One PPP interface supported (per process) */
50 #define MAXWORDLEN 1024 /* max length of word in file (incl null) */
51 #define MAXARGS 1 /* max # args to a command */
52 #define MAXNAMELEN 256 /* max length of hostname or name for auth */
53 #define MAXSECRETLEN 256 /* max length of password or secret */
56 * Option descriptor structure.
59 typedef unsigned char bool;
71 char *name; /* name of the option */
81 /* Values for flags */
82 #define OPT_VALUE 0xff /* mask for presupplied value */
83 #define OPT_HEX 0x100 /* int option is in hex */
84 #define OPT_NOARG 0x200 /* option doesn't take argument */
85 #define OPT_OR 0x400 /* OR in argument to value */
86 #define OPT_INC 0x800 /* increment value */
87 #define OPT_PRIV 0x1000 /* privileged option */
88 #define OPT_STATIC 0x2000 /* string option goes into static array */
89 #define OPT_LLIMIT 0x4000 /* check value against lower limit */
90 #define OPT_ULIMIT 0x8000 /* check value against upper limit */
91 #define OPT_LIMITS (OPT_LLIMIT|OPT_ULIMIT)
92 #define OPT_ZEROOK 0x10000 /* 0 value is OK even if not within limits */
93 #define OPT_NOINCR 0x20000 /* value mustn't be increased */
94 #define OPT_ZEROINF 0x40000 /* with OPT_NOINCR, 0 == infinity */
95 #define OPT_A2INFO 0x100000 /* addr2 -> option_info to update */
96 #define OPT_A2COPY 0x200000 /* addr2 -> second location to rcv value */
97 #define OPT_ENABLE 0x400000 /* use *addr2 as enable for option */
98 #define OPT_PRIVFIX 0x800000 /* can't be overridden if noauth */
100 #define OPT_VAL(x) ((x) & OPT_VALUE)
103 #define GIDSET_TYPE gid_t
106 /* Structure representing a list of permitted IP addresses. */
107 struct permitted_ip {
108 int permit; /* 1 = permit, 0 = forbid */
109 u_int32_t base; /* match if (addr & mask) == base */
110 u_int32_t mask; /* base and mask are in network byte order */
114 * Unfortunately, the linux kernel driver uses a different structure
115 * for statistics from the rest of the ports.
116 * This structure serves as a common representation for the bits
120 unsigned int bytes_in;
121 unsigned int bytes_out;
128 extern int hungup; /* Physical layer has disconnected */
129 extern int ifunit; /* Interface unit number */
130 extern char ifname[]; /* Interface name */
131 extern int ttyfd; /* Serial device file descriptor */
132 extern char hostname[]; /* Our hostname */
133 extern u_char outpacket_buf[]; /* Buffer for outgoing packets */
134 extern int phase; /* Current state of link - see values below */
135 extern int baud_rate; /* Current link speed in bits/sec */
136 extern char *progname; /* Name of this program */
137 extern int redirect_stderr;/* Connector's stderr should go to file */
138 extern char peer_authname[];/* Authenticated name of peer */
139 extern int privileged; /* We were run by real-uid root */
140 extern int need_holdoff; /* Need holdoff period after link terminates */
141 extern char **script_env; /* Environment variables for scripts */
142 extern int detached; /* Have detached from controlling tty */
143 extern GIDSET_TYPE groups[NGROUPS_MAX]; /* groups the user is in */
144 extern int ngroups; /* How many groups valid in groups */
145 extern struct pppd_stats link_stats; /* byte/packet counts etc. for link */
146 extern int link_stats_valid; /* set if link_stats is valid */
147 extern int using_pty; /* using pty as device (notty or pty opt.) */
150 * Variables set by command-line options.
153 extern int debug; /* Debug flag */
154 extern int kdebugflag; /* Tell kernel to print debug messages */
155 extern int default_device; /* Using /dev/tty or equivalent */
156 extern char devnam[MAXPATHLEN]; /* Device name */
157 extern int crtscts; /* Use hardware flow control */
158 extern bool modem; /* Use modem control lines */
159 extern int inspeed; /* Input/Output speed requested */
160 extern u_int32_t netmask; /* IP netmask to set on interface */
161 extern bool lockflag; /* Create lock file to lock the serial dev */
162 extern bool nodetach; /* Don't detach from controlling tty */
163 extern bool updetach; /* Detach from controlling tty when link up */
164 extern char *connector; /* Script to establish physical link */
165 extern char *disconnector; /* Script to disestablish physical link */
166 extern char *welcomer; /* Script to welcome client after connection */
167 extern char *ptycommand; /* Command to run on other side of pty */
168 extern int maxconnect; /* Maximum connect time (seconds) */
169 extern char user[MAXNAMELEN];/* Our name for authenticating ourselves */
170 extern char passwd[MAXSECRETLEN]; /* Password for PAP */
171 extern bool auth_required; /* Peer is required to authenticate */
172 extern bool persist; /* Reopen link after it goes down */
173 extern bool uselogin; /* Use /etc/passwd for checking PAP */
174 extern char our_name[MAXNAMELEN];/* Our name for authentication purposes */
175 extern char remote_name[MAXNAMELEN]; /* Peer's name for authentication */
176 extern bool explicit_remote;/* remote_name specified with remotename opt */
177 extern bool demand; /* Do dial-on-demand */
178 extern char *ipparam; /* Extra parameter for ip up/down scripts */
179 extern bool cryptpap; /* Others' PAP passwords are encrypted */
180 extern int idle_time_limit;/* Shut down link if idle for this long */
181 extern int holdoff; /* Dead time before restarting */
182 extern bool notty; /* Stdin/out is not a tty */
183 extern char *record_file; /* File to record chars sent/received */
186 extern struct bpf_program pass_filter; /* Filter for pkts to pass */
187 extern struct bpf_program active_filter; /* Filter for link-active pkts */
190 char *current_option; /* the name of the option being parsed */
191 int privileged_option; /* set iff the current option came from root */
192 char *option_source; /* string saying where the option came from */
195 extern bool ms_lanman; /* Use LanMan password instead of NT */
196 /* Has meaning only with MS-CHAP challenges */
203 #define PHASE_INITIALIZE 1
204 #define PHASE_DORMANT 2
205 #define PHASE_ESTABLISH 3
206 #define PHASE_AUTHENTICATE 4
207 #define PHASE_CALLBACK 5
208 #define PHASE_NETWORK 6
209 #define PHASE_TERMINATE 7
210 #define PHASE_HOLDOFF 8
213 * The following struct gives the addresses of procedures to call
214 * for a particular protocol.
217 u_short protocol; /* PPP protocol number */
218 /* Initialization procedure */
219 void (*init) __P((int unit));
220 /* Process a received packet */
221 void (*input) __P((int unit, u_char *pkt, int len));
222 /* Process a received protocol-reject */
223 void (*protrej) __P((int unit));
224 /* Lower layer has come up */
225 void (*lowerup) __P((int unit));
226 /* Lower layer has gone down */
227 void (*lowerdown) __P((int unit));
228 /* Open the protocol */
229 void (*open) __P((int unit));
230 /* Close the protocol */
231 void (*close) __P((int unit, char *reason));
232 /* Print a packet in readable form */
233 int (*printpkt) __P((u_char *pkt, int len,
234 void (*printer) __P((void *, char *, ...)),
236 /* Process a received data packet */
237 void (*datainput) __P((int unit, u_char *pkt, int len));
238 bool enabled_flag; /* 0 iff protocol is disabled */
239 char *name; /* Text name of protocol */
240 char *data_name; /* Text name of corresponding data protocol */
241 option_t *options; /* List of command-line options */
242 /* Check requested options, assign defaults */
243 void (*check_options) __P((void));
244 /* Configure interface for demand-dial */
245 int (*demand_conf) __P((int unit));
246 /* Say whether to bring up link for this pkt */
247 int (*active_pkt) __P((u_char *pkt, int len));
250 /* Table of pointers to supported protocols */
251 extern struct protent *protocols[];
257 /* Procedures exported from main.c. */
258 void detach __P((void)); /* Detach from controlling tty */
259 void die __P((int)); /* Cleanup and exit */
260 void quit __P((void)); /* like die(1) */
261 void novm __P((char *)); /* Say we ran out of memory, and die */
262 void timeout __P((void (*func)(void *), void *arg, int t));
263 /* Call func(arg) after t seconds */
264 void untimeout __P((void (*func)(void *), void *arg));
265 /* Cancel call to func(arg) */
266 pid_t run_program __P((char *prog, char **args, int must_exist,
267 void (*done)(void *), void *arg));
268 /* Run program prog with args in child */
269 void demuxprotrej __P((int, int));
270 /* Demultiplex a Protocol-Reject */
271 void log_packet __P((u_char *, int, char *, int));
272 /* Format a packet and log it with syslog */
273 void print_string __P((char *, int, void (*) (void *, char *, ...),
274 void *)); /* Format a string for output */
275 int slprintf __P((char *, int, char *, ...)); /* sprintf++ */
276 int vslprintf __P((char *, int, char *, va_list)); /* vsprintf++ */
277 void script_setenv __P((char *, char *)); /* set script env var */
278 void script_unsetenv __P((char *)); /* unset script env var */
279 size_t strlcpy __P((char *, const char *, size_t)); /* safe strcpy */
280 size_t strlcat __P((char *, const char *, size_t)); /* safe strncpy */
281 void dbglog __P((char *, ...)); /* log a debug message */
282 void info __P((char *, ...)); /* log an informational message */
283 void notice __P((char *, ...)); /* log a notice-level message */
284 void warn __P((char *, ...)); /* log a warning message */
285 void error __P((char *, ...)); /* log an error message */
286 void fatal __P((char *, ...)); /* log an error message and die(1) */
288 /* Procedures exported from auth.c */
289 void link_required __P((int)); /* we are starting to use the link */
290 void link_terminated __P((int)); /* we are finished with the link */
291 void link_down __P((int)); /* the LCP layer has left the Opened state */
292 void link_established __P((int)); /* the link is up; authenticate now */
293 void np_up __P((int, int)); /* a network protocol has come up */
294 void np_down __P((int, int)); /* a network protocol has gone down */
295 void np_finished __P((int, int)); /* a network protocol no longer needs link */
296 void auth_peer_fail __P((int, int));
297 /* peer failed to authenticate itself */
298 void auth_peer_success __P((int, int, char *, int));
299 /* peer successfully authenticated itself */
300 void auth_withpeer_fail __P((int, int));
301 /* we failed to authenticate ourselves */
302 void auth_withpeer_success __P((int, int));
303 /* we successfully authenticated ourselves */
304 void auth_check_options __P((void));
305 /* check authentication options supplied */
306 void auth_reset __P((int)); /* check what secrets we have */
307 int check_passwd __P((int, char *, int, char *, int, char **, int *));
308 /* Check peer-supplied username/password */
309 int get_secret __P((int, char *, char *, char *, int *, int));
310 /* get "secret" for chap */
311 int auth_ip_addr __P((int, u_int32_t));
312 /* check if IP address is authorized */
313 int bad_ip_adrs __P((u_int32_t));
314 /* check if IP address is unreasonable */
316 /* Procedures exported from demand.c */
317 void demand_conf __P((void)); /* config interface(s) for demand-dial */
318 void demand_block __P((void)); /* set all NPs to queue up packets */
319 void demand_unblock __P((void)); /* set all NPs to pass packets */
320 void demand_discard __P((void)); /* set all NPs to discard packets */
321 void demand_rexmit __P((int)); /* retransmit saved frames for an NP */
322 int loop_chars __P((unsigned char *, int)); /* process chars from loopback */
323 int loop_frame __P((unsigned char *, int)); /* should we bring link up? */
325 /* Procedures exported from sys-*.c */
326 void sys_init __P((void)); /* Do system-dependent initialization */
327 void sys_cleanup __P((void)); /* Restore system state before exiting */
328 int sys_check_options __P((void)); /* Check options specified */
329 void sys_close __P((void)); /* Clean up in a child before execing */
330 int ppp_available __P((void)); /* Test whether ppp kernel support exists */
331 int get_pty __P((int *, int *, char *, int)); /* Get pty master/slave */
332 int open_ppp_loopback __P((void)); /* Open loopback for demand-dialling */
333 int establish_ppp __P((int)); /* Turn serial port into a ppp interface */
334 void restore_loop __P((void)); /* Transfer ppp unit back to loopback */
335 void disestablish_ppp __P((int)); /* Restore port to normal operation */
336 void clean_check __P((void)); /* Check if line was 8-bit clean */
337 void set_up_tty __P((int, int)); /* Set up port's speed, parameters, etc. */
338 void restore_tty __P((int)); /* Restore port's original parameters */
339 void setdtr __P((int, int)); /* Raise or lower port's DTR line */
340 void output __P((int, u_char *, int)); /* Output a PPP packet */
341 void wait_input __P((struct timeval *));
342 /* Wait for input, with timeout */
343 void add_fd __P((int)); /* Add fd to set to wait for */
344 void remove_fd __P((int)); /* Remove fd from set to wait for */
345 int read_packet __P((u_char *)); /* Read PPP packet */
346 int get_loop_output __P((void)); /* Read pkts from loopback */
347 void ppp_send_config __P((int, int, u_int32_t, int, int));
348 /* Configure i/f transmit parameters */
349 void ppp_set_xaccm __P((int, ext_accm));
350 /* Set extended transmit ACCM */
351 void ppp_recv_config __P((int, int, u_int32_t, int, int));
352 /* Configure i/f receive parameters */
353 int ccp_test __P((int, u_char *, int, int));
354 /* Test support for compression scheme */
355 void ccp_flags_set __P((int, int, int));
356 /* Set kernel CCP state */
357 int ccp_fatal_error __P((int)); /* Test for fatal decomp error in kernel */
358 int get_idle_time __P((int, struct ppp_idle *));
359 /* Find out how long link has been idle */
360 int get_ppp_stats __P((int, struct pppd_stats *));
361 /* Return link statistics */
362 int sifvjcomp __P((int, int, int, int));
363 /* Configure VJ TCP header compression */
364 int sifup __P((int)); /* Configure i/f up (for IP) */
365 int sifnpmode __P((int u, int proto, enum NPmode mode));
366 /* Set mode for handling packets for proto */
367 int sifdown __P((int)); /* Configure i/f down (for IP) */
368 int sifaddr __P((int, u_int32_t, u_int32_t, u_int32_t));
369 /* Configure IP addresses for i/f */
370 int cifaddr __P((int, u_int32_t, u_int32_t));
371 /* Reset i/f IP addresses */
372 int sifdefaultroute __P((int, u_int32_t, u_int32_t));
373 /* Create default route through i/f */
374 int cifdefaultroute __P((int, u_int32_t, u_int32_t));
375 /* Delete default route through i/f */
376 int sifproxyarp __P((int, u_int32_t));
377 /* Add proxy ARP entry for peer */
378 int cifproxyarp __P((int, u_int32_t));
379 /* Delete proxy ARP entry for peer */
380 u_int32_t GetMask __P((u_int32_t)); /* Get appropriate netmask for address */
381 int lock __P((char *)); /* Create lock file for device */
382 void unlock __P((void)); /* Delete previously-created lock file */
383 int daemon __P((int, int)); /* Detach us from terminal session */
384 void logwtmp __P((const char *, const char *, const char *));
385 /* Write entry to wtmp file */
386 int get_host_seed __P((void)); /* Get host-dependent random number seed */
387 int have_route_to __P((u_int32_t)); /* Check if route to addr exists */
389 int set_filters __P((struct bpf_program *pass, struct bpf_program *active));
390 /* Set filter programs in kernel */
393 int sipxfaddr __P((int, unsigned long, unsigned char *));
394 int cipxfaddr __P((int));
397 /* Procedures exported from options.c */
398 int parse_args __P((int argc, char **argv));
399 /* Parse options from arguments given */
400 int options_from_file __P((char *filename, int must_exist, int check_prot,
402 /* Parse options from an options file */
403 int options_from_user __P((void)); /* Parse options from user's .ppprc */
404 int options_for_tty __P((void)); /* Parse options from /etc/ppp/options.tty */
405 void scan_args __P((int argc, char **argv));
406 /* Look for tty name in command-line args */
407 int getword __P((FILE *f, char *word, int *newlinep, char *filename));
408 /* Read a word from a file */
409 void option_error __P((char *fmt, ...));
410 /* Print an error message about an option */
411 int int_option __P((char *, int *));
412 /* Simplified number_option for decimal ints */
415 * This structure is used to store information about certain
416 * options, such as where the option value came from (/etc/ppp/options,
417 * command line, etc.) and whether it came from a privileged source.
421 int priv; /* was value set by sysadmin? */
422 char *source; /* where option came from */
425 extern struct option_info devnam_info;
426 extern struct option_info connector_info;
427 extern struct option_info disconnector_info;
428 extern struct option_info welcomer_info;
429 extern struct option_info ptycommand_info;
432 * Inline versions of get/put char/short/long.
433 * Pointer is advanced; we assume that both arguments
434 * are lvalues and will already be in registers.
435 * cp MUST be u_char *.
437 #define GETCHAR(c, cp) { \
440 #define PUTCHAR(c, cp) { \
441 *(cp)++ = (u_char) (c); \
445 #define GETSHORT(s, cp) { \
446 (s) = *(cp)++ << 8; \
449 #define PUTSHORT(s, cp) { \
450 *(cp)++ = (u_char) ((s) >> 8); \
451 *(cp)++ = (u_char) (s); \
454 #define GETLONG(l, cp) { \
455 (l) = *(cp)++ << 8; \
456 (l) |= *(cp)++; (l) <<= 8; \
457 (l) |= *(cp)++; (l) <<= 8; \
460 #define PUTLONG(l, cp) { \
461 *(cp)++ = (u_char) ((l) >> 24); \
462 *(cp)++ = (u_char) ((l) >> 16); \
463 *(cp)++ = (u_char) ((l) >> 8); \
464 *(cp)++ = (u_char) (l); \
467 #define INCPTR(n, cp) ((cp) += (n))
468 #define DECPTR(n, cp) ((cp) -= (n))
471 * System dependent definitions for user-level 4.3BSD UNIX implementation.
474 #define TIMEOUT(r, f, t) timeout((r), (f), (t))
475 #define UNTIMEOUT(r, f) untimeout((r), (f))
477 #define BCOPY(s, d, l) memcpy(d, s, l)
478 #define BZERO(s, n) memset(s, 0, n)
480 #define PRINTMSG(m, l) { info("Remote message: %0.*v", l, m); }
483 * MAKEHEADER - Add Header fields to a packet.
485 #define MAKEHEADER(p, t) { \
486 PUTCHAR(PPP_ALLSTATIONS, p); \
487 PUTCHAR(PPP_UI, p); \
500 #ifndef LOG_PPP /* we use LOG_LOCAL2 for syslog by default */
501 #if defined(DEBUGMAIN) || defined(DEBUGFSM) || defined(DEBUGSYS) \
502 || defined(DEBUGLCP) || defined(DEBUGIPCP) || defined(DEBUGUPAP) \
503 || defined(DEBUGCHAP) || defined(DEBUG)
504 #define LOG_PPP LOG_LOCAL2
506 #define LOG_PPP LOG_DAEMON
511 #define MAINDEBUG(x) if (debug) dbglog x
517 #define SYSDEBUG(x) if (debug) dbglog x
523 #define FSMDEBUG(x) if (debug) dbglog x
529 #define LCPDEBUG(x) if (debug) dbglog x
535 #define IPCPDEBUG(x) if (debug) dbglog x
541 #define UPAPDEBUG(x) if (debug) dbglog x
547 #define CHAPDEBUG(x) if (debug) dbglog x
553 #define IPXCPDEBUG(x) if (debug) dbglog x
555 #define IPXCPDEBUG(x)
559 #if defined(sun) || defined(SYSV) || defined(POSIX_SOURCE)
563 #endif /* defined(sun) || defined(SYSV) || defined(POSIX_SOURCE) */
567 #define MIN(a, b) ((a) < (b)? (a): (b))
570 #define MAX(a, b) ((a) > (b)? (a): (b))
573 #endif /* __PPP_H__ */