removed s, added ipparam
[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.7 1995/04/24 05:52:37 paulus Exp $
20  */
21
22 /*
23  * TODO:
24  */
25
26 #ifndef __PPPD_H__
27 #define __PPPD_H__
28
29 #include <sys/param.h>          /* for MAXPATHLEN and BSD4_4, if defined */
30 #include <sys/types.h>          /* for u_int32_t, if defined */
31 #include <net/ppp_defs.h>
32
33 #define NUM_PPP 1               /* One PPP interface supported (per process) */
34
35 /*
36  * Limits.
37  */
38
39 #define MAXWORDLEN      1024    /* max length of word in file (incl null) */
40 #define MAXARGS         1       /* max # args to a command */
41 #define MAXNAMELEN      256     /* max length of hostname or name for auth */
42 #define MAXSECRETLEN    256     /* max length of password or secret */
43
44 /*
45  * Global variables.
46  */
47
48 extern int      hungup;         /* Physical layer has disconnected */
49 extern int      ifunit;         /* Interface unit number */
50 extern char     ifname[];       /* Interface name */
51 extern int      fd;             /* Serial device file descriptor */
52 extern char     hostname[];     /* Our hostname */
53 extern u_char   outpacket_buf[]; /* Buffer for outgoing packets */
54 extern int      phase;          /* Current state of link - see values below */
55 extern int      baud_rate;      /* Current link speed in bits/sec */
56 extern char     *progname;      /* Name of this program */
57
58 /*
59  * Variables set by command-line options.
60  */
61
62 extern int      debug;          /* Debug flag */
63 extern int      kdebugflag;     /* Tell kernel to print debug messages */
64 extern int      default_device; /* Using /dev/tty or equivalent */
65 extern char     devnam[];       /* Device name */
66 extern int      crtscts;        /* Use hardware flow control */
67 extern int      modem;          /* Use modem control lines */
68 extern int      inspeed;        /* Input/Output speed requested */
69 extern u_int32_t netmask;       /* IP netmask to set on interface */
70 extern int      lockflag;       /* Create lock file to lock the serial dev */
71 extern int      nodetach;       /* Don't detach from controlling tty */
72 extern char     *connector;     /* Script to establish physical link */
73 extern char     *disconnector;  /* Script to disestablish physical link */
74 extern char     user[];         /* Username for PAP */
75 extern char     passwd[];       /* Password for PAP */
76 extern int      auth_required;  /* Peer is required to authenticate */
77 extern int      proxyarp;       /* Set up proxy ARP entry for peer */
78 extern int      persist;        /* Reopen link after it goes down */
79 extern int      uselogin;       /* Use /etc/passwd for checking PAP */
80 extern int      lcp_echo_interval; /* Interval between LCP echo-requests */
81 extern int      lcp_echo_fails; /* Tolerance to unanswered echo-requests */
82 extern char     our_name[];     /* Our name for authentication purposes */
83 extern char     remote_name[];  /* Peer's name for authentication */
84 extern int      usehostname;    /* Use hostname for our_name */
85 extern int      disable_defaultip; /* Don't use hostname for default IP adrs */
86 extern char     *ipparam;       /* Extra parameter for ip up/down scripts */
87
88 /*
89  * Values for phase.
90  */
91 #define PHASE_DEAD              0
92 #define PHASE_ESTABLISH         1
93 #define PHASE_AUTHENTICATE      2
94 #define PHASE_NETWORK           3
95 #define PHASE_TERMINATE         4
96
97 /*
98  * Prototypes.
99  */
100 void quit __P((void));  /* Cleanup and exit */
101 void timeout __P((void (*)(), caddr_t, int));
102                                 /* Look-alike of kernel's timeout() */
103 void untimeout __P((void (*)(), caddr_t));
104                                 /* Look-alike of kernel's untimeout() */
105 void output __P((int, u_char *, int));
106                                 /* Output a PPP packet */
107 void demuxprotrej __P((int, int));
108                                 /* Demultiplex a Protocol-Reject */
109 int  check_passwd __P((int, char *, int, char *, int, char **, int *));
110                                 /* Check peer-supplied username/password */
111 int  get_secret __P((int, char *, char *, char *, int *, int));
112                                 /* get "secret" for chap */
113 u_int32_t GetMask __P((u_int32_t)); /* get netmask for address */
114 void die __P((int));
115
116 /*
117  * Inline versions of get/put char/short/long.
118  * Pointer is advanced; we assume that both arguments
119  * are lvalues and will already be in registers.
120  * cp MUST be u_char *.
121  */
122 #define GETCHAR(c, cp) { \
123         (c) = *(cp)++; \
124 }
125 #define PUTCHAR(c, cp) { \
126         *(cp)++ = (u_char) (c); \
127 }
128
129
130 #define GETSHORT(s, cp) { \
131         (s) = *(cp)++ << 8; \
132         (s) |= *(cp)++; \
133 }
134 #define PUTSHORT(s, cp) { \
135         *(cp)++ = (u_char) ((s) >> 8); \
136         *(cp)++ = (u_char) (s); \
137 }
138
139 #define GETLONG(l, cp) { \
140         (l) = *(cp)++ << 8; \
141         (l) |= *(cp)++; (l) <<= 8; \
142         (l) |= *(cp)++; (l) <<= 8; \
143         (l) |= *(cp)++; \
144 }
145 #define PUTLONG(l, cp) { \
146         *(cp)++ = (u_char) ((l) >> 24); \
147         *(cp)++ = (u_char) ((l) >> 16); \
148         *(cp)++ = (u_char) ((l) >> 8); \
149         *(cp)++ = (u_char) (l); \
150 }
151
152 #define INCPTR(n, cp)   ((cp) += (n))
153 #define DECPTR(n, cp)   ((cp) -= (n))
154
155 #undef  FALSE
156 #define FALSE   0
157 #undef  TRUE
158 #define TRUE    1
159
160 /*
161  * System dependent definitions for user-level 4.3BSD UNIX implementation.
162  */
163
164 #define DEMUXPROTREJ(u, p)      demuxprotrej(u, p)
165
166 #define TIMEOUT(r, f, t)        timeout((r), (f), (t))
167 #define UNTIMEOUT(r, f)         untimeout((r), (f))
168
169 #define BCOPY(s, d, l)          memcpy(d, s, l)
170 #define BZERO(s, n)             memset(s, 0, n)
171 #define EXIT(u)                 quit()
172
173 #define PRINTMSG(m, l)  { m[l] = '\0'; syslog(LOG_INFO, "Remote message: %s", m); }
174
175 /*
176  * MAKEHEADER - Add Header fields to a packet.
177  */
178 #define MAKEHEADER(p, t) { \
179     PUTCHAR(PPP_ALLSTATIONS, p); \
180     PUTCHAR(PPP_UI, p); \
181     PUTSHORT(t, p); }
182
183
184 #ifdef DEBUGALL
185 #define DEBUGMAIN       1
186 #define DEBUGFSM        1
187 #define DEBUGLCP        1
188 #define DEBUGIPCP       1
189 #define DEBUGUPAP       1
190 #define DEBUGCHAP       1
191 #endif
192
193 #ifndef LOG_PPP                 /* we use LOG_LOCAL2 for syslog by default */
194 #if defined(DEBUGMAIN) || defined(DEBUGFSM) || defined(DEBUG) \
195   || defined(DEBUGLCP) || defined(DEBUGIPCP) || defined(DEBUGUPAP) \
196   || defined(DEBUGCHAP) 
197 #define LOG_PPP LOG_LOCAL2
198 #else
199 #define LOG_PPP LOG_DAEMON
200 #endif
201 #endif /* LOG_PPP */
202
203 #ifdef DEBUGMAIN
204 #define MAINDEBUG(x)    if (debug) syslog x
205 #else
206 #define MAINDEBUG(x)
207 #endif
208
209 #ifdef DEBUGFSM
210 #define FSMDEBUG(x)     if (debug) syslog x
211 #else
212 #define FSMDEBUG(x)
213 #endif
214
215 #ifdef DEBUGLCP
216 #define LCPDEBUG(x)     if (debug) syslog x
217 #else
218 #define LCPDEBUG(x)
219 #endif
220
221 #ifdef DEBUGIPCP
222 #define IPCPDEBUG(x)    if (debug) syslog x
223 #else
224 #define IPCPDEBUG(x)
225 #endif
226
227 #ifdef DEBUGUPAP
228 #define UPAPDEBUG(x)    if (debug) syslog x
229 #else
230 #define UPAPDEBUG(x)
231 #endif
232
233 #ifdef DEBUGCHAP
234 #define CHAPDEBUG(x)    if (debug) syslog x
235 #else
236 #define CHAPDEBUG(x)
237 #endif
238
239 #ifndef SIGTYPE
240 #if defined(sun) || defined(SYSV) || defined(POSIX_SOURCE)
241 #define SIGTYPE void
242 #else
243 #define SIGTYPE int
244 #endif /* defined(sun) || defined(SYSV) || defined(POSIX_SOURCE) */
245 #endif /* SIGTYPE */
246
247 #ifndef MIN
248 #define MIN(a, b)       ((a) < (b)? (a): (b))
249 #endif
250 #ifndef MAX
251 #define MAX(a, b)       ((a) > (b)? (a): (b))
252 #endif
253
254 #endif /* __PPP_H__ */