xref: /openbsd-src/usr.bin/ftp/ftp_var.h (revision 7350f337b9e3eb4461d99580e625c7ef148d107c)
1 /*	$OpenBSD: ftp_var.h,v 1.43 2019/05/16 12:44:18 florian Exp $	*/
2 /*	$NetBSD: ftp_var.h,v 1.18 1997/08/18 10:20:25 lukem Exp $	*/
3 
4 /*
5  * Copyright (C) 1997 and 1998 WIDE Project.
6  * All rights reserved.
7  *
8  * Redistribution and use in source and binary forms, with or without
9  * modification, are permitted provided that the following conditions
10  * are met:
11  * 1. Redistributions of source code must retain the above copyright
12  *    notice, this list of conditions and the following disclaimer.
13  * 2. Redistributions in binary form must reproduce the above copyright
14  *    notice, this list of conditions and the following disclaimer in the
15  *    documentation and/or other materials provided with the distribution.
16  * 3. Neither the name of the project nor the names of its contributors
17  *    may be used to endorse or promote products derived from this software
18  *    without specific prior written permission.
19  *
20  * THIS SOFTWARE IS PROVIDED BY THE PROJECT AND CONTRIBUTORS ``AS IS'' AND
21  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23  * ARE DISCLAIMED.  IN NO EVENT SHALL THE PROJECT OR CONTRIBUTORS BE LIABLE
24  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
25  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
26  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
27  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
28  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
29  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
30  * SUCH DAMAGE.
31  */
32 
33 /*
34  * Copyright (c) 1985, 1989, 1993, 1994
35  *	The Regents of the University of California.  All rights reserved.
36  *
37  * Redistribution and use in source and binary forms, with or without
38  * modification, are permitted provided that the following conditions
39  * are met:
40  * 1. Redistributions of source code must retain the above copyright
41  *    notice, this list of conditions and the following disclaimer.
42  * 2. Redistributions in binary form must reproduce the above copyright
43  *    notice, this list of conditions and the following disclaimer in the
44  *    documentation and/or other materials provided with the distribution.
45  * 3. Neither the name of the University nor the names of its contributors
46  *    may be used to endorse or promote products derived from this software
47  *    without specific prior written permission.
48  *
49  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
50  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
51  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
52  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
53  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
54  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
55  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
56  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
57  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
58  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
59  * SUCH DAMAGE.
60  *
61  *	@(#)ftp_var.h	8.4 (Berkeley) 10/9/94
62  */
63 
64 /*
65  * FTP global variables.
66  */
67 
68 #include <sys/signal.h>
69 #include <limits.h>
70 #include <setjmp.h>
71 
72 #ifndef SMALL
73 #include <histedit.h>
74 #endif /* !SMALL */
75 
76 #include <tls.h>
77 
78 #include "stringlist.h"
79 #include "extern.h"
80 #include "small.h"
81 
82 #define HASHBYTES	1024
83 #define FTPBUFLEN	PATH_MAX + 200
84 
85 #define STALLTIME	5	/* # of seconds of no xfer before "stalling" */
86 
87 #define	FTP_PORT	21	/* default if ! getservbyname("ftp/tcp") */
88 #define	GATE_PORT	21	/* default if ! getservbyname("ftpgate/tcp") */
89 #define	HTTP_PORT	80	/* default if ! getservbyname("http/tcp") */
90 #define	HTTPS_PORT	443	/* default if ! getservbyname("https/tcp") */
91 #define	HTTP_USER_AGENT	"User-Agent: OpenBSD ftp"	/* User-Agent string sent to web server */
92 
93 #define PAGER		"more"	/* default pager if $PAGER isn't set */
94 
95 /*
96  * Options and other state info.
97  */
98 int	trace;			/* trace packets exchanged */
99 int	hash;			/* print # for each buffer transferred */
100 int	mark;			/* number of bytes between hashes */
101 int	sendport;		/* use PORT/LPRT cmd for each data connection */
102 int	verbose;		/* print messages coming back from server */
103 int	connected;		/* 1 = connected to server, -1 = logged in */
104 int	fromatty;		/* input is from a terminal */
105 int	interactive;		/* interactively prompt on m* cmds */
106 #ifndef SMALL
107 int	confirmrest;		/* confirm rest of current m* cmd */
108 int	debug;			/* debugging level */
109 int	bell;			/* ring bell on cmd completion */
110 char   *altarg;			/* argv[1] with no shell-like preprocessing  */
111 #endif /* !SMALL */
112 int	doglob;			/* glob local file names */
113 int	autologin;		/* establish user account on connection */
114 int	proxy;			/* proxy server connection active */
115 int	proxflag;		/* proxy connection exists */
116 int	gatemode;		/* use gate-ftp */
117 char   *gateserver;		/* server to use for gate-ftp */
118 int	sunique;		/* store files on server with unique name */
119 int	runique;		/* store local files with unique name */
120 int	mcase;			/* map upper to lower case for mget names */
121 int	ntflag;			/* use ntin ntout tables for name translation */
122 int	mapflag;		/* use mapin mapout templates on file names */
123 int	preserve;		/* preserve modification time on files */
124 int	progress;		/* display transfer progress bar */
125 int	code;			/* return/reply code for ftp command */
126 int	crflag;			/* if 1, strip car. rets. on ascii gets */
127 char	pasv[BUFSIZ];		/* passive port for proxy data connection */
128 int	passivemode;		/* passive mode enabled */
129 int	activefallback;		/* fall back to active mode if passive fails */
130 char	ntin[17];		/* input translation table */
131 char	ntout[17];		/* output translation table */
132 char	mapin[PATH_MAX];	/* input map template */
133 char	mapout[PATH_MAX];	/* output map template */
134 char	typename[32];		/* name of file transfer type */
135 int	type;			/* requested file transfer type */
136 int	curtype;		/* current file transfer type */
137 char	structname[32];		/* name of file transfer structure */
138 int	stru;			/* file transfer structure */
139 char	formname[32];		/* name of file transfer format */
140 int	form;			/* file transfer format */
141 char	modename[32];		/* name of file transfer mode */
142 int	mode;			/* file transfer mode */
143 char	bytename[32];		/* local byte size in ascii */
144 int	bytesize;		/* local byte size in binary */
145 int	anonftp;		/* automatic anonymous login */
146 int	dirchange;		/* remote directory changed by cd command */
147 unsigned int retry_connect;	/* retry connect if failed */
148 int	ttywidth;		/* width of tty */
149 int	epsv4;			/* use EPSV/EPRT on IPv4 connections */
150 int	epsv4bad;		/* EPSV doesn't work on the current server */
151 
152 #ifndef SMALL
153 int	  editing;		/* command line editing enabled */
154 EditLine *el;			/* editline(3) status structure */
155 History  *hist;			/* editline(3) history structure */
156 char	 *cursor_pos;		/* cursor position we're looking for */
157 size_t	  cursor_argc;		/* location of cursor in margv */
158 size_t	  cursor_argo;		/* offset of cursor in margv[cursor_argc] */
159 int	  resume;		/* continue transfer */
160 char	 *srcaddr;		/* source address to bind to */
161 #endif /* !SMALL */
162 
163 char	 *cookiefile;		/* cookie jar to use */
164 
165 off_t	bytes;			/* current # of bytes read */
166 off_t	filesize;		/* size of file being transferred */
167 char   *direction;		/* direction transfer is occurring */
168 
169 char   *hostname;		/* name of host connected to */
170 int	unix_server;		/* server is unix, can use binary for ascii */
171 int	unix_proxy;		/* proxy is unix, can use binary for ascii */
172 
173 char *ftpport;			/* port number to use for ftp connections */
174 char *httpport;			/* port number to use for http connections */
175 #ifndef NOSSL
176 char *httpsport;		/* port number to use for https connections */
177 #endif /* !SMALL */
178 char *httpuseragent;		/* user agent for http(s) connections */
179 char *gateport;			/* port number to use for gateftp connections */
180 
181 jmp_buf	toplevel;		/* non-local goto stuff for cmd scanner */
182 
183 #ifndef SMALL
184 char	line[FTPBUFLEN];	/* input line buffer */
185 char	*argbase;		/* current storage point in arg buffer */
186 char	*stringbase;		/* current scan point in line buffer */
187 char	argbuf[FTPBUFLEN];	/* argument storage buffer */
188 StringList *marg_sl;		/* stringlist containing margv */
189 int	margc;			/* count of arguments on input line */
190 int	options;		/* used during socket creation */
191 #endif /* !SMALL */
192 
193 #define margv (marg_sl->sl_str)	/* args parsed from input line */
194 int     cpend;                  /* flag: if != 0, then pending server reply */
195 int	mflag;			/* flag: if != 0, then active multi command */
196 
197 /*
198  * Format of command table.
199  */
200 struct cmd {
201 	char	*c_name;	/* name of command */
202 	char	*c_help;	/* help string */
203 	char	 c_bell;	/* give bell when command completes */
204 	char	 c_conn;	/* must be connected to use command */
205 	char	 c_proxy;	/* proxy server may execute */
206 #ifndef SMALL
207 	char	*c_complete;	/* context sensitive completion list */
208 #endif /* !SMALL */
209 	void	(*c_handler)(int, char **); /* function to call */
210 };
211 
212 struct macel {
213 	char mac_name[9];	/* macro name */
214 	char *mac_start;	/* start of macro in macbuf */
215 	char *mac_end;		/* end of macro in macbuf */
216 };
217 
218 #ifndef SMALL
219 int macnum;			/* number of defined macros */
220 struct macel macros[16];
221 char macbuf[4096];
222 #endif /* !SMALL */
223 
224 FILE	*ttyout;		/* stdout or stderr, depending on interactive */
225 
226 extern struct cmd cmdtab[];
227 
228 #ifndef NOSSL
229 extern struct tls_config *tls_config;
230 extern int tls_session_fd;
231 #endif /* !NOSSL */
232