extern.h revision 79968
1/*	$NetBSD: extern.h,v 1.41 2001/04/25 01:46:25 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#if HAVE_PRINTF_QD
113# define LLF		"%qd"
114# define LLFP(x)	"%" x "qd"
115# define LLT		long long
116# define ULLF		"%qu"
117# define ULLFP(x)	"%" x "qu"
118# define ULLT		unsigned long long
119# define STRTOLL(x,y,z)	strtoll(x,y,z)
120#else
121# define LLF		"%lld"
122# define LLFP(x)	"%" x "lld"
123# define LLT		long long
124# define ULLF		"%llu"
125# define ULLFP(x)	"%" x "llu"
126# define ULLT		unsigned long long
127# define STRTOLL(x,y,z)	strtoll(x,y,z)
128#endif
129#endif
130
131#define FTP_BUFLEN	512
132
133void	abor(void);
134void	blkfree(char **);
135void	closedataconn(FILE *);
136char   *conffilename(const char *);
137char  **copyblk(char **);
138void	count_users(void);
139void	cprintf(FILE *, const char *, ...)
140	    ;
141void	cwd(const char *);
142FILE   *dataconn(const char *, off_t, const char *);
143void	delete(const char *);
144int	display_file(const char *, int);
145char  **do_conversion(const char *);
146void	dologout(int);
147void	fatal(const char *);
148void	feat(void);
149void	format_path(char *, const char *);
150int	ftpd_pclose(FILE *);
151FILE   *ftpd_popen(char *[], const char *, int);
152char   *getline(char *, int, FILE *);
153void	init_curclass(void);
154void	logxfer(const char *, off_t, const char *, const char *,
155	    const struct timeval *, const char *);
156#if 0
157void	logwtmp(const char *, const char *, const char *);
158#endif
159struct tab *lookup(struct tab *, const char *);
160void	makedir(const char *);
161void	mlsd(const char *);
162void	mlst(const char *);
163void	opts(const char *);
164void	parse_conf(const char *);
165void	pass(const char *);
166void	passive(void);
167int	lpsvproto2af(int);
168int	af2lpsvproto(int);
169int	epsvproto2af(int);
170int	af2epsvproto(int);
171void	long_passive(char *, int);
172int	extended_port(const char *);
173void	epsv_protounsupp(const char *);
174void	perror_reply(int, const char *);
175void	pwd(void);
176void	removedir(const char *);
177void	renamecmd(const char *, const char *);
178char   *renamefrom(const char *);
179void	reply(int, const char *, ...)
180	    ;
181void	retrieve(char *[], const char *);
182void	send_file_list(const char *);
183void	show_chdir_messages(int);
184void	sizecmd(const char *);
185void	statcmd(void);
186void	statfilecmd(const char *);
187void	statxfer(void);
188void	store(const char *, const char *, int);
189LLT	strsuftoll(const char *);
190void	user(const char *);
191char   *xstrdup(const char *);
192void	yyerror(char *);
193
194#include <netinet/in.h>
195
196#ifdef BSD4_4
197# define HAVE_SETPROCTITLE	1
198# define HAVE_SOCKADDR_SA_LEN	1
199#endif
200
201struct sockinet {
202	union sockunion {
203		struct sockaddr_in  su_sin;
204#ifdef INET6
205		struct sockaddr_in6 su_sin6;
206#endif
207	} si_su;
208#if !HAVE_SOCKADDR_SA_LEN
209	int	si_len;
210#endif
211};
212
213#if !HAVE_SOCKADDR_SA_LEN
214# define su_len		si_len
215#else
216# define su_len		si_su.su_sin.sin_len
217#endif
218#define su_addr		si_su.su_sin.sin_addr
219#define su_family	si_su.su_sin.sin_family
220#define su_port		si_su.su_sin.sin_port
221#ifdef INET6
222# define su_6addr	si_su.su_sin6.sin6_addr
223# define su_scope_id	si_su.su_sin6.sin6_scope_id
224#endif
225
226struct tab {
227	char	*name;
228	short	 token;
229	short	 state;
230	short	 flags;	/* 1 if command implemented, 2 if has options,
231	                   4 if can occur OOB */
232	char	*help;
233	char	*options;
234};
235
236struct ftpconv {
237	struct ftpconv	*next;
238	char		*suffix;	/* Suffix of requested name */
239	char		*types;		/* Valid file types */
240	char		*disable;	/* File to disable conversions */
241	char		*command;	/* Command to do the conversion */
242};
243
244typedef enum {
245	CLASS_GUEST,
246	CLASS_CHROOT,
247	CLASS_REAL
248} class_ft;
249
250typedef enum {
251	FLAG_checkportcmd =	1<<0,	/* Check port commands */
252	FLAG_modify =		1<<1,	/* Allow CHMOD, DELE, MKD, RMD, RNFR,
253					   UMASK */
254	FLAG_passive =		1<<2,	/* Allow PASV mode */
255	FLAG_sanenames =	1<<3,	/* Restrict names of uploaded files */
256	FLAG_upload =		1<<4	/* As per modify, but also allow
257					   APPE, STOR, STOU */
258} classflag_t;
259
260#define CURCLASS_FLAGS_SET(x)	(curclass.flags |=  (FLAG_ ## x))
261#define CURCLASS_FLAGS_CLR(x)	(curclass.flags &= ~(FLAG_ ## x))
262#define CURCLASS_FLAGS_ISSET(x)	(curclass.flags &   (FLAG_ ## x))
263
264struct ftpclass {
265	struct sockinet	 advertise;	/* PASV address to advertise as */
266	char		*chroot;	/* Directory to chroot(2) to at login */
267	char		*classname;	/* Current class */
268	struct ftpconv	*conversions;	/* List of conversions */
269	char		*display;	/* File to display upon chdir */
270	char		*homedir;	/* Directory to chdir(2) to at login */
271	classflag_t	 flags;		/* Flags; see classflag_t above */
272	int	 	 limit;		/* Max connections (-1 = unlimited) */
273	char		*limitfile;	/* File to display if limit reached */
274	LLT		 maxfilesize;	/* Maximum file size of uploads */
275	LLT		 maxrateget;	/* Maximum get transfer rate throttle */
276	LLT		 maxrateput;	/* Maximum put transfer rate throttle */
277	unsigned int	 maxtimeout;	/* Maximum permitted timeout */
278	char		*motd;		/* MotD file to display after login */
279	char		*notify;	/* Files to notify about upon chdir */
280	int		 portmin;	/* Minumum port for passive mode */
281	int		 portmax;	/* Maximum port for passive mode */
282	LLT		 rateget;	/* Get (RETR) transfer rate throttle */
283	LLT		 rateput;	/* Put (STOR) transfer rate throttle */
284	unsigned int	 timeout;	/* Default timeout */
285	class_ft	 type;		/* Class type */
286	mode_t		 umask;		/* Umask to use */
287};
288
289extern void		ftp_loop(void) __attribute__ ((noreturn));
290extern void		ftp_handle_line(char *);
291
292#ifndef	GLOBAL
293#define	GLOBAL	extern
294#endif
295
296
297GLOBAL	struct sockinet ctrl_addr;
298GLOBAL	struct sockinet	data_dest;
299GLOBAL	struct sockinet	data_source;
300GLOBAL	struct sockinet	his_addr;
301GLOBAL	struct sockinet	pasv_addr;
302GLOBAL	int		connections;
303GLOBAL	struct ftpclass	curclass;
304GLOBAL	int		debug;
305GLOBAL	jmp_buf		errcatch;
306GLOBAL	char		*emailaddr;
307GLOBAL	int		form;
308GLOBAL	int		gidcount;	/* number of entries in gidlist[] */
309GLOBAL	gid_t		gidlist[NGROUPS_MAX];
310GLOBAL	int		hasyyerrored;
311GLOBAL	char		hostname[MAXHOSTNAMELEN+1];
312GLOBAL	char		homedir[MAXPATHLEN];
313#ifdef KERBEROS5
314GLOBAL	krb5_context	kcontext;
315#endif
316GLOBAL	int		logged_in;
317GLOBAL	int		logging;
318GLOBAL	int		pdata;			/* for passive mode */
319#if HAVE_SETPROCTITLE
320GLOBAL	char		proctitle[BUFSIZ];	/* initial part of title */
321#endif
322GLOBAL	struct passwd  *pw;
323GLOBAL	int		quietmessages;
324GLOBAL	char		remotehost[MAXHOSTNAMELEN+1];
325GLOBAL	off_t		restart_point;
326GLOBAL	char		tmpline[FTP_BUFLEN];
327GLOBAL	sig_atomic_t	transflag;
328GLOBAL	int		type;
329GLOBAL	int		usedefault;		/* for data transfers */
330GLOBAL	const char     *version;
331GLOBAL	int		is_oob;
332
333						/* total file data bytes */
334GLOBAL	off_t		total_data_in,  total_data_out,  total_data;
335						/* total number of data files */
336GLOBAL	off_t		total_files_in, total_files_out, total_files;
337						/* total bytes */
338GLOBAL	off_t		total_bytes_in, total_bytes_out, total_bytes;
339						/* total number of xfers */
340GLOBAL	off_t		total_xfers_in, total_xfers_out, total_xfers;
341
342extern	struct tab	cmdtab[];
343
344#define	INTERNAL_LS	"/bin/ls"
345
346
347#define CMD_IMPLEMENTED(x)	((x)->flags != 0)
348#define CMD_HAS_OPTIONS(x)	((x)->flags & 0x2)
349#define CMD_OOB(x)		((x)->flags & 0x4)
350
351#define	CPUTC(c, f)	do { \
352				putc(c, f); total_bytes++; total_bytes_out++; \
353			} while (0);
354
355#define CURCLASSTYPE	curclass.type == CLASS_GUEST  ? "GUEST"  : \
356		    	curclass.type == CLASS_CHROOT ? "CHROOT" : \
357		    	curclass.type == CLASS_REAL   ? "REAL"   : \
358			"<unknown>"
359
360#define ISDOTDIR(x)	(x[0] == '.' && x[1] == '\0')
361#define ISDOTDOTDIR(x)	(x[0] == '.' && x[1] == '.' && x[2] == '\0')
362
363#define EMPTYSTR(p)	((p) == NULL || *(p) == '\0')
364#define NEXTWORD(P, W)	do { \
365				(W) = strsep(&(P), " \t"); \
366			} while ((W) != NULL && *(W) == '\0')
367#define PLURAL(s)	((s) == 1 ? "" : "s")
368#define REASSIGN(X,Y)	do { if (X) free(X); (X)=(Y); } while (/*CONSTCOND*/0)
369
370#ifndef IPPORT_ANONMAX
371# define IPPORT_ANONMAX	65535
372#endif
373