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