xref: /netbsd/libexec/ftpd/extern.h (revision bf9ec67e)
1 /*	$NetBSD: extern.h,v 1.43 2001/12/04 13:54:12 lukem Exp $	*/
2 
3 /*-
4  * Copyright (c) 1992, 1993
5  *	The Regents of the University of California.  All rights reserved.
6  *
7  * Redistribution and use in source and binary forms, with or without
8  * modification, are permitted provided that the following conditions
9  * are met:
10  * 1. Redistributions of source code must retain the above copyright
11  *    notice, this list of conditions and the following disclaimer.
12  * 2. Redistributions in binary form must reproduce the above copyright
13  *    notice, this list of conditions and the following disclaimer in the
14  *    documentation and/or other materials provided with the distribution.
15  * 3. All advertising materials mentioning features or use of this software
16  *    must display the following acknowledgement:
17  *	This product includes software developed by the University of
18  *	California, Berkeley and its contributors.
19  * 4. Neither the name of the University nor the names of its contributors
20  *    may be used to endorse or promote products derived from this software
21  *    without specific prior written permission.
22  *
23  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
24  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
25  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
26  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
27  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
28  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
29  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
30  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
31  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
32  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
33  * SUCH DAMAGE.
34  *
35  *	@(#)extern.h	8.2 (Berkeley) 4/4/94
36  */
37 
38 /*-
39  * Copyright (c) 1997-2001 The NetBSD Foundation, Inc.
40  * All rights reserved.
41  *
42  * This code is derived from software contributed to The NetBSD Foundation
43  * by Luke Mewburn.
44  *
45  * Redistribution and use in source and binary forms, with or without
46  * modification, are permitted provided that the following conditions
47  * are met:
48  * 1. Redistributions of source code must retain the above copyright
49  *    notice, this list of conditions and the following disclaimer.
50  * 2. Redistributions in binary form must reproduce the above copyright
51  *    notice, this list of conditions and the following disclaimer in the
52  *    documentation and/or other materials provided with the distribution.
53  * 3. All advertising materials mentioning features or use of this software
54  *    must display the following acknowledgement:
55  *        This product includes software developed by the NetBSD
56  *        Foundation, Inc. and its contributors.
57  * 4. Neither the name of The NetBSD Foundation nor the names of its
58  *    contributors may be used to endorse or promote products derived
59  *    from this software without specific prior written permission.
60  *
61  * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
62  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
63  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
64  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
65  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
66  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
67  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
68  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
69  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
70  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
71  * POSSIBILITY OF SUCH DAMAGE.
72  */
73 
74 /*
75  * Copyright (C) 1997 and 1998 WIDE Project.
76  * All rights reserved.
77  *
78  * Redistribution and use in source and binary forms, with or without
79  * modification, are permitted provided that the following conditions
80  * are met:
81  * 1. Redistributions of source code must retain the above copyright
82  *    notice, this list of conditions and the following disclaimer.
83  * 2. Redistributions in binary form must reproduce the above copyright
84  *    notice, this list of conditions and the following disclaimer in the
85  *    documentation and/or other materials provided with the distribution.
86  * 3. Neither the name of the project nor the names of its contributors
87  *    may be used to endorse or promote products derived from this software
88  *    without specific prior written permission.
89  *
90  * THIS SOFTWARE IS PROVIDED BY THE PROJECT AND CONTRIBUTORS ``AS IS'' AND
91  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
92  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
93  * ARE DISCLAIMED.  IN NO EVENT SHALL THE PROJECT OR CONTRIBUTORS BE LIABLE
94  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
95  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
96  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
97  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
98  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
99  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
100  * SUCH DAMAGE.
101  */
102 
103 #ifdef NO_LONG_LONG
104 # define LLF		"%ld"
105 # define LLFP(x)	"%" x "ld"
106 # define LLT		long
107 # define ULLF		"%lu"
108 # define ULLFP(x)	"%" x "lu"
109 # define ULLT		unsigned long
110 # define STRTOLL(x,y,z)	strtol(x,y,z)
111 #else
112 # define LLF		"%lld"
113 # define LLFP(x)	"%" x "lld"
114 # define LLT		long long
115 # define ULLF		"%llu"
116 # define ULLFP(x)	"%" x "llu"
117 # define ULLT		unsigned long long
118 # define STRTOLL(x,y,z)	strtoll(x,y,z)
119 #endif
120 
121 #define FTP_BUFLEN	512
122 
123 void	abor(void);
124 void	blkfree(char **);
125 void	closedataconn(FILE *);
126 char   *conffilename(const char *);
127 char  **copyblk(char **);
128 void	count_users(void);
129 void	cprintf(FILE *, const char *, ...)
130 	    __attribute__((__format__(__printf__, 2, 3)));
131 void	cwd(const char *);
132 FILE   *dataconn(const char *, off_t, const char *);
133 void	delete(const char *);
134 int	display_file(const char *, int);
135 char  **do_conversion(const char *);
136 void	dologout(int);
137 void	fatal(const char *);
138 void	feat(void);
139 void	format_path(char *, const char *);
140 int	ftpd_pclose(FILE *);
141 FILE   *ftpd_popen(char *[], const char *, int);
142 char   *getline(char *, int, FILE *);
143 void	init_curclass(void);
144 void	logxfer(const char *, off_t, const char *, const char *,
145 	    const struct timeval *, const char *);
146 #if 0
147 void	logwtmp(const char *, const char *, const char *);
148 #endif
149 struct tab *lookup(struct tab *, const char *);
150 void	makedir(const char *);
151 void	mlsd(const char *);
152 void	mlst(const char *);
153 void	opts(const char *);
154 void	parse_conf(const char *);
155 void	pass(const char *);
156 void	passive(void);
157 int	lpsvproto2af(int);
158 int	af2lpsvproto(int);
159 int	epsvproto2af(int);
160 int	af2epsvproto(int);
161 void	long_passive(char *, int);
162 int	extended_port(const char *);
163 void	epsv_protounsupp(const char *);
164 void	perror_reply(int, const char *);
165 void	pwd(void);
166 void	removedir(const char *);
167 void	renamecmd(const char *, const char *);
168 char   *renamefrom(const char *);
169 void	reply(int, const char *, ...)
170 	    __attribute__((__format__(__printf__, 2, 3)));
171 void	retrieve(char *[], const char *);
172 void	send_file_list(const char *);
173 void	show_chdir_messages(int);
174 void	sizecmd(const char *);
175 void	statcmd(void);
176 void	statfilecmd(const char *);
177 void	statxfer(void);
178 void	store(const char *, const char *, int);
179 LLT	strsuftoll(const char *);
180 void	user(const char *);
181 char   *xstrdup(const char *);
182 void	yyerror(char *);
183 
184 #include <netinet/in.h>
185 
186 #if defined(__NetBSD__)
187 # define HAVE_SETPROCTITLE	1
188 # define HAVE_SOCKADDR_SA_LEN	1
189 #endif
190 
191 struct sockinet {
192 	union sockunion {
193 		struct sockaddr_in  su_sin;
194 #ifdef INET6
195 		struct sockaddr_in6 su_sin6;
196 #endif
197 	} si_su;
198 #if !HAVE_SOCKADDR_SA_LEN
199 	int	si_len;
200 #endif
201 };
202 
203 #if !HAVE_SOCKADDR_SA_LEN
204 # define su_len		si_len
205 #else
206 # define su_len		si_su.su_sin.sin_len
207 #endif
208 #define su_addr		si_su.su_sin.sin_addr
209 #define su_family	si_su.su_sin.sin_family
210 #define su_port		si_su.su_sin.sin_port
211 #ifdef INET6
212 # define su_6addr	si_su.su_sin6.sin6_addr
213 # define su_scope_id	si_su.su_sin6.sin6_scope_id
214 #endif
215 
216 struct tab {
217 	char	*name;
218 	short	 token;
219 	short	 state;
220 	short	 flags;	/* 1 if command implemented, 2 if has options,
221 	                   4 if can occur OOB */
222 	char	*help;
223 	char	*options;
224 };
225 
226 struct ftpconv {
227 	struct ftpconv	*next;
228 	char		*suffix;	/* Suffix of requested name */
229 	char		*types;		/* Valid file types */
230 	char		*disable;	/* File to disable conversions */
231 	char		*command;	/* Command to do the conversion */
232 };
233 
234 typedef enum {
235 	CLASS_GUEST,
236 	CLASS_CHROOT,
237 	CLASS_REAL
238 } class_ft;
239 
240 typedef enum {
241 	FLAG_checkportcmd =	1<<0,	/* Check port commands */
242 	FLAG_denyquick =	1<<1,	/* Check ftpusers(5) before PASS */
243 	FLAG_modify =		1<<2,	/* Allow CHMOD, DELE, MKD, RMD, RNFR,
244 					   UMASK */
245 	FLAG_passive =		1<<3,	/* Allow PASV mode */
246 	FLAG_private =		1<<4,	/* Don't publish class info in STAT */
247 	FLAG_sanenames =	1<<5,	/* Restrict names of uploaded files */
248 	FLAG_upload =		1<<6,	/* As per modify, but also allow
249 					   APPE, STOR, STOU */
250 } classflag_t;
251 
252 #define CURCLASS_FLAGS_SET(x)	(curclass.flags |=  (FLAG_ ## x))
253 #define CURCLASS_FLAGS_CLR(x)	(curclass.flags &= ~(FLAG_ ## x))
254 #define CURCLASS_FLAGS_ISSET(x)	(curclass.flags &   (FLAG_ ## x))
255 
256 struct ftpclass {
257 	struct sockinet	 advertise;	/* PASV address to advertise as */
258 	char		*chroot;	/* Directory to chroot(2) to at login */
259 	char		*classname;	/* Current class */
260 	struct ftpconv	*conversions;	/* List of conversions */
261 	char		*display;	/* File to display upon chdir */
262 	char		*homedir;	/* Directory to chdir(2) to at login */
263 	classflag_t	 flags;		/* Flags; see classflag_t above */
264 	int	 	 limit;		/* Max connections (-1 = unlimited) */
265 	char		*limitfile;	/* File to display if limit reached */
266 	LLT		 maxfilesize;	/* Maximum file size of uploads */
267 	LLT		 maxrateget;	/* Maximum get transfer rate throttle */
268 	LLT		 maxrateput;	/* Maximum put transfer rate throttle */
269 	unsigned int	 maxtimeout;	/* Maximum permitted timeout */
270 	char		*motd;		/* MotD file to display after login */
271 	char		*notify;	/* Files to notify about upon chdir */
272 	int		 portmin;	/* Minumum port for passive mode */
273 	int		 portmax;	/* Maximum port for passive mode */
274 	LLT		 rateget;	/* Get (RETR) transfer rate throttle */
275 	LLT		 rateput;	/* Put (STOR) transfer rate throttle */
276 	unsigned int	 timeout;	/* Default timeout */
277 	class_ft	 type;		/* Class type */
278 	mode_t		 umask;		/* Umask to use */
279 };
280 
281 extern void		ftp_loop(void) __attribute__ ((noreturn));
282 extern void		ftp_handle_line(char *);
283 
284 #ifndef	GLOBAL
285 #define	GLOBAL	extern
286 #endif
287 
288 
289 GLOBAL	struct sockinet ctrl_addr;
290 GLOBAL	struct sockinet	data_dest;
291 GLOBAL	struct sockinet	data_source;
292 GLOBAL	struct sockinet	his_addr;
293 GLOBAL	struct sockinet	pasv_addr;
294 GLOBAL	int		connections;
295 GLOBAL	struct ftpclass	curclass;
296 GLOBAL	int		debug;
297 GLOBAL	jmp_buf		errcatch;
298 GLOBAL	char		*emailaddr;
299 GLOBAL	int		form;
300 GLOBAL	int		gidcount;	/* number of entries in gidlist[] */
301 GLOBAL	gid_t		gidlist[NGROUPS_MAX];
302 GLOBAL	int		hasyyerrored;
303 GLOBAL	char		hostname[MAXHOSTNAMELEN+1];
304 GLOBAL	char		homedir[MAXPATHLEN];
305 #ifdef KERBEROS5
306 GLOBAL	krb5_context	kcontext;
307 #endif
308 GLOBAL	int		logged_in;
309 GLOBAL	int		logging;
310 GLOBAL	int		pdata;			/* for passive mode */
311 #if HAVE_SETPROCTITLE
312 GLOBAL	char		proctitle[BUFSIZ];	/* initial part of title */
313 #endif
314 GLOBAL	struct passwd  *pw;
315 GLOBAL	int		quietmessages;
316 GLOBAL	char		remotehost[MAXHOSTNAMELEN+1];
317 GLOBAL	off_t		restart_point;
318 GLOBAL	char		tmpline[FTP_BUFLEN];
319 GLOBAL	sig_atomic_t	transflag;
320 GLOBAL	int		type;
321 GLOBAL	int		usedefault;		/* for data transfers */
322 GLOBAL	const char     *version;
323 GLOBAL	int		is_oob;
324 
325 						/* total file data bytes */
326 GLOBAL	off_t		total_data_in,  total_data_out,  total_data;
327 						/* total number of data files */
328 GLOBAL	off_t		total_files_in, total_files_out, total_files;
329 						/* total bytes */
330 GLOBAL	off_t		total_bytes_in, total_bytes_out, total_bytes;
331 						/* total number of xfers */
332 GLOBAL	off_t		total_xfers_in, total_xfers_out, total_xfers;
333 
334 extern	struct tab	cmdtab[];
335 
336 #define	INTERNAL_LS	"/bin/ls"
337 
338 
339 #define CMD_IMPLEMENTED(x)	((x)->flags != 0)
340 #define CMD_HAS_OPTIONS(x)	((x)->flags & 0x2)
341 #define CMD_OOB(x)		((x)->flags & 0x4)
342 
343 #define	CPUTC(c, f)	do { \
344 				putc(c, f); total_bytes++; total_bytes_out++; \
345 			} while (0);
346 
347 #define CURCLASSTYPE	curclass.type == CLASS_GUEST  ? "GUEST"  : \
348 		    	curclass.type == CLASS_CHROOT ? "CHROOT" : \
349 		    	curclass.type == CLASS_REAL   ? "REAL"   : \
350 			"<unknown>"
351 
352 #define ISDOTDIR(x)	(x[0] == '.' && x[1] == '\0')
353 #define ISDOTDOTDIR(x)	(x[0] == '.' && x[1] == '.' && x[2] == '\0')
354 
355 #define EMPTYSTR(p)	((p) == NULL || *(p) == '\0')
356 #define NEXTWORD(P, W)	do { \
357 				(W) = strsep(&(P), " \t"); \
358 			} while ((W) != NULL && *(W) == '\0')
359 #define PLURAL(s)	((s) == 1 ? "" : "s")
360 #define REASSIGN(X,Y)	do { if (X) free(X); (X)=(Y); } while (/*CONSTCOND*/0)
361 
362 #ifndef IPPORT_ANONMAX
363 # define IPPORT_ANONMAX	65535
364 #endif
365