misc.h revision 1.20 
1/*	$NetBSD: misc.h,v 1.20 2021/03/05 17:47:16 christos Exp $	*/
2/* $OpenBSD: misc.h,v 1.93 2021/02/15 20:36:35 markus Exp $ */
3
4/*
5 * Author: Tatu Ylonen <ylo@cs.hut.fi>
6 * Copyright (c) 1995 Tatu Ylonen <ylo@cs.hut.fi>, Espoo, Finland
7 *                    All rights reserved
8 *
9 * As far as I am concerned, the code I have written for this software
10 * can be used freely for any purpose.  Any derived versions of this
11 * software must be clearly marked as such, and if the derived work is
12 * incompatible with the protocol description in the RFC file, it must be
13 * called by a name other than "ssh" or "Secure Shell".
14 */
15
16#ifndef _MISC_H
17#define _MISC_H
18
19#include <sys/time.h>
20#include <sys/types.h>
21#include <sys/socket.h>
22
23/* Data structure for representing a forwarding request. */
24struct Forward {
25	char	 *listen_host;		/* Host (address) to listen on. */
26	int	  listen_port;		/* Port to forward. */
27	char	 *listen_path;		/* Path to bind domain socket. */
28	char	 *connect_host;		/* Host to connect. */
29	int	  connect_port;		/* Port to connect on connect_host. */
30	char	 *connect_path;		/* Path to connect domain socket. */
31	int	  allocated_port;	/* Dynamically allocated listen port */
32	int	  handle;		/* Handle for dynamic listen ports */
33};
34
35int forward_equals(const struct Forward *, const struct Forward *);
36int daemonized(void);
37
38/* Common server and client forwarding options. */
39struct ForwardOptions {
40	int	 gateway_ports; /* Allow remote connects to forwarded ports. */
41	mode_t	 streamlocal_bind_mask; /* umask for streamlocal binds */
42	int	 streamlocal_bind_unlink; /* unlink socket before bind */
43};
44
45/* misc.c */
46
47char	*chop(char *);
48void	skip_space(char **);
49char	*strdelim(char **);
50char	*strdelimw(char **);
51int	 set_nonblock(int);
52int	 unset_nonblock(int);
53void	 set_nodelay(int);
54int	 set_reuseaddr(int);
55char	*get_rdomain(int);
56int	 set_rdomain(int, const char *);
57int	 get_sock_af(int);
58void	 set_sock_tos(int, int);
59int	 waitrfd(int, int *);
60int	 timeout_connect(int, const struct sockaddr *, socklen_t, int *);
61int	 a2port(const char *);
62int	 a2tun(const char *, int *);
63char	*put_host_port(const char *, u_short);
64char	*hpdelim2(char **, char *);
65char	*hpdelim(char **);
66char	*cleanhostname(char *);
67char	*colon(char *);
68int	 parse_user_host_path(const char *, char **, char **, char **);
69int	 parse_user_host_port(const char *, char **, char **, int *);
70int	 parse_uri(const char *, const char *, char **, char **, int *, char **);
71int	 convtime(const char *);
72const char *fmt_timeframe(time_t t);
73char	*tilde_expand_filename(const char *, uid_t);
74
75char	*dollar_expand(int *, const char *string, ...);
76char	*percent_expand(const char *, ...) __attribute__((__sentinel__));
77char	*percent_dollar_expand(const char *, ...) __attribute__((__sentinel__));
78char	*tohex(const void *, size_t);
79void	 xextendf(char **s, const char *sep, const char *fmt, ...)
80    __attribute__((__format__ (printf, 3, 4))) __attribute__((__nonnull__ (3)));
81void	 sanitise_stdfd(void);
82struct timeval;
83void	 ms_subtract_diff(struct timeval *, int *);
84void	 ms_to_timeval(struct timeval *, int);
85void	 monotime_ts(struct timespec *);
86void	 monotime_tv(struct timeval *);
87time_t	 monotime(void);
88double	 monotime_double(void);
89void	 lowercase(char *s);
90int	 unix_listener(const char *, int, int);
91int	 valid_domain(char *, int, const char **);
92int	 valid_env_name(const char *);
93const char *atoi_err(const char *, int *);
94int	 parse_absolute_time(const char *, uint64_t *);
95void	 format_absolute_time(uint64_t, char *, size_t);
96int	 path_absolute(const char *);
97int	 stdfd_devnull(int, int, int);
98
99int	bcrypt_pbkdf(const char *, size_t, const u_int8_t *, size_t,
100    u_int8_t *, size_t, unsigned int);
101
102struct passwd *pwcopy(struct passwd *);
103const char *ssh_gai_strerror(int);
104
105typedef void privdrop_fn(struct passwd *);
106typedef void privrestore_fn(void);
107#define	SSH_SUBPROCESS_STDOUT_DISCARD	(1)     /* Discard stdout */
108#define	SSH_SUBPROCESS_STDOUT_CAPTURE	(1<<1)  /* Redirect stdout */
109#define	SSH_SUBPROCESS_STDERR_DISCARD	(1<<2)  /* Discard stderr */
110#define	SSH_SUBPROCESS_UNSAFE_PATH	(1<<3)	/* Don't check for safe cmd */
111#define	SSH_SUBPROCESS_PRESERVE_ENV	(1<<4)	/* Keep parent environment */
112pid_t subprocess(const char *, const char *, int, char **, FILE **, u_int,
113    struct passwd *, privdrop_fn *, privrestore_fn *);
114
115typedef struct arglist arglist;
116struct arglist {
117	char    **list;
118	u_int   num;
119	u_int   nalloc;
120};
121void	 addargs(arglist *, const char *, ...)
122	     __attribute__((format(printf, 2, 3)));
123void	 replacearg(arglist *, u_int, const char *, ...)
124	     __attribute__((format(printf, 3, 4)));
125void	 freeargs(arglist *);
126
127int	 tun_open(int, int, char **);
128
129/* Common definitions for ssh tunnel device forwarding */
130#define SSH_TUNMODE_NO		0x00
131#define SSH_TUNMODE_POINTOPOINT	0x01
132#define SSH_TUNMODE_ETHERNET	0x02
133#define SSH_TUNMODE_DEFAULT	SSH_TUNMODE_POINTOPOINT
134#define SSH_TUNMODE_YES		(SSH_TUNMODE_POINTOPOINT|SSH_TUNMODE_ETHERNET)
135
136#define SSH_TUNID_ANY		0x7fffffff
137#define SSH_TUNID_ERR		(SSH_TUNID_ANY - 1)
138#define SSH_TUNID_MAX		(SSH_TUNID_ANY - 2)
139
140/* Fake port to indicate that host field is really a path. */
141#define PORT_STREAMLOCAL	-2
142
143/* Functions to extract or store big-endian words of various sizes */
144u_int64_t	get_u64(const void *)
145    __attribute__((__bounded__( __minbytes__, 1, 8)));
146u_int32_t	get_u32(const void *)
147    __attribute__((__bounded__( __minbytes__, 1, 4)));
148u_int16_t	get_u16(const void *)
149    __attribute__((__bounded__( __minbytes__, 1, 2)));
150void		put_u64(void *, u_int64_t)
151    __attribute__((__bounded__( __minbytes__, 1, 8)));
152void		put_u32(void *, u_int32_t)
153    __attribute__((__bounded__( __minbytes__, 1, 4)));
154void		put_u16(void *, u_int16_t)
155    __attribute__((__bounded__( __minbytes__, 1, 2)));
156
157/* Little-endian store/load, used by umac.c */
158u_int32_t	get_u32_le(const void *)
159    __attribute__((__bounded__(__minbytes__, 1, 4)));
160void		put_u32_le(void *, u_int32_t)
161    __attribute__((__bounded__(__minbytes__, 1, 4)));
162
163struct bwlimit {
164	size_t buflen;
165	u_int64_t rate;		/* desired rate in kbit/s */
166	u_int64_t thresh;	/* threshold after which we'll check timers */
167	u_int64_t lamt;		/* amount written in last timer interval */
168	struct timeval bwstart, bwend;
169};
170
171void bandwidth_limit_init(struct bwlimit *, u_int64_t, size_t);
172void bandwidth_limit(struct bwlimit *, size_t);
173
174int parse_ipqos(const char *);
175const char *iptos2str(int);
176void mktemp_proto(char *, size_t);
177
178void	 child_set_env(char ***envp, u_int *envsizep, const char *name,
179	     const char *value);
180
181int	 argv_split(const char *, int *, char ***);
182char	*argv_assemble(int, char **argv);
183int	 exited_cleanly(pid_t, const char *, const char *, int);
184
185struct stat;
186int	 safe_path(const char *, struct stat *, const char *, uid_t,
187	     char *, size_t);
188int	 safe_path_fd(int, const char *, struct passwd *,
189	     char *err, size_t errlen);
190
191/* authorized_key-style options parsing helpers */
192int	opt_flag(const char *opt, int allow_negate, const char **optsp);
193char	*opt_dequote(const char **sp, const char **errstrp);
194int	opt_match(const char **opts, const char *term);
195
196/* readconf/servconf option lists */
197void	opt_array_append(const char *file, const int line,
198	    const char *directive, char ***array, u_int *lp, const char *s);
199void	opt_array_append2(const char *file, const int line,
200	    const char *directive, char ***array, int **iarray, u_int *lp,
201	    const char *s, int i);
202
203/* readpass.c */
204
205#define RP_ECHO			0x0001
206#define RP_ALLOW_STDIN		0x0002
207#define RP_ALLOW_EOF		0x0004
208#define RP_USE_ASKPASS		0x0008
209
210struct notifier_ctx;
211
212char	*read_passphrase(const char *, int);
213int	 ask_permission(const char *, ...) __attribute__((format(printf, 1, 2)));
214struct notifier_ctx *notify_start(int, const char *, ...)
215	__attribute__((format(printf, 2, 3)));
216void	notify_complete(struct notifier_ctx *, const char *, ...)
217	__attribute__((format(printf, 2, 3)));
218
219#define MINIMUM(a, b)	(((a) < (b)) ? (a) : (b))
220#define MAXIMUM(a, b)	(((a) > (b)) ? (a) : (b))
221#define ROUNDUP(x, y)   ((((x)+((y)-1))/(y))*(y))
222
223typedef void (*sshsig_t)(int);
224sshsig_t ssh_signal(int, sshsig_t);
225
226#endif /* _MISC_H */
227