xref: /openssh-portable/misc.h (revision d05ea255)
1 /* $OpenBSD: misc.h,v 1.79 2019/01/23 21:50:56 dtucker Exp $ */
2 
3 /*
4  * Author: Tatu Ylonen <ylo@cs.hut.fi>
5  * Copyright (c) 1995 Tatu Ylonen <ylo@cs.hut.fi>, Espoo, Finland
6  *                    All rights reserved
7  *
8  * As far as I am concerned, the code I have written for this software
9  * can be used freely for any purpose.  Any derived versions of this
10  * software must be clearly marked as such, and if the derived work is
11  * incompatible with the protocol description in the RFC file, it must be
12  * called by a name other than "ssh" or "Secure Shell".
13  */
14 
15 #ifndef _MISC_H
16 #define _MISC_H
17 
18 #include <sys/time.h>
19 #include <sys/types.h>
20 #include <sys/socket.h>
21 
22 /* Data structure for representing a forwarding request. */
23 struct Forward {
24 	char	 *listen_host;		/* Host (address) to listen on. */
25 	int	  listen_port;		/* Port to forward. */
26 	char	 *listen_path;		/* Path to bind domain socket. */
27 	char	 *connect_host;		/* Host to connect. */
28 	int	  connect_port;		/* Port to connect on connect_host. */
29 	char	 *connect_path;		/* Path to connect domain socket. */
30 	int	  allocated_port;	/* Dynamically allocated listen port */
31 	int	  handle;		/* Handle for dynamic listen ports */
32 };
33 
34 int forward_equals(const struct Forward *, const struct Forward *);
35 int daemonized(void);
36 
37 /* Common server and client forwarding options. */
38 struct ForwardOptions {
39 	int	 gateway_ports; /* Allow remote connects to forwarded ports. */
40 	mode_t	 streamlocal_bind_mask; /* umask for streamlocal binds */
41 	int	 streamlocal_bind_unlink; /* unlink socket before bind */
42 };
43 
44 /* misc.c */
45 
46 char	*chop(char *);
47 char	*strdelim(char **);
48 char	*strdelimw(char **);
49 int	 set_nonblock(int);
50 int	 unset_nonblock(int);
51 void	 set_nodelay(int);
52 int	 set_reuseaddr(int);
53 char	*get_rdomain(int);
54 int	 set_rdomain(int, const char *);
55 int	 waitrfd(int, int *);
56 int	 timeout_connect(int, const struct sockaddr *, socklen_t, int *);
57 int	 a2port(const char *);
58 int	 a2tun(const char *, int *);
59 char	*put_host_port(const char *, u_short);
60 char	*hpdelim2(char **, char *);
61 char	*hpdelim(char **);
62 char	*cleanhostname(char *);
63 char	*colon(char *);
64 int	 parse_user_host_path(const char *, char **, char **, char **);
65 int	 parse_user_host_port(const char *, char **, char **, int *);
66 int	 parse_uri(const char *, const char *, char **, char **, int *, char **);
67 long	 convtime(const char *);
68 char	*tilde_expand_filename(const char *, uid_t);
69 char	*percent_expand(const char *, ...) __attribute__((__sentinel__));
70 char	*tohex(const void *, size_t);
71 void	 sanitise_stdfd(void);
72 void	 ms_subtract_diff(struct timeval *, int *);
73 void	 ms_to_timeval(struct timeval *, int);
74 void	 monotime_ts(struct timespec *);
75 void	 monotime_tv(struct timeval *);
76 time_t	 monotime(void);
77 double	 monotime_double(void);
78 void	 lowercase(char *s);
79 int	 unix_listener(const char *, int, int);
80 int	 valid_domain(char *, int, const char **);
81 int	 valid_env_name(const char *);
82 const char *atoi_err(const char *, int *);
83 int	 parse_absolute_time(const char *, uint64_t *);
84 void	 format_absolute_time(uint64_t, char *, size_t);
85 int	 path_absolute(const char *);
86 
87 void	 sock_set_v6only(int);
88 
89 struct passwd *pwcopy(struct passwd *);
90 const char *ssh_gai_strerror(int);
91 
92 typedef struct arglist arglist;
93 struct arglist {
94 	char    **list;
95 	u_int   num;
96 	u_int   nalloc;
97 };
98 void	 addargs(arglist *, char *, ...)
99 	     __attribute__((format(printf, 2, 3)));
100 void	 replacearg(arglist *, u_int, char *, ...)
101 	     __attribute__((format(printf, 3, 4)));
102 void	 freeargs(arglist *);
103 
104 int	 tun_open(int, int, char **);
105 
106 /* Common definitions for ssh tunnel device forwarding */
107 #define SSH_TUNMODE_NO		0x00
108 #define SSH_TUNMODE_POINTOPOINT	0x01
109 #define SSH_TUNMODE_ETHERNET	0x02
110 #define SSH_TUNMODE_DEFAULT	SSH_TUNMODE_POINTOPOINT
111 #define SSH_TUNMODE_YES		(SSH_TUNMODE_POINTOPOINT|SSH_TUNMODE_ETHERNET)
112 
113 #define SSH_TUNID_ANY		0x7fffffff
114 #define SSH_TUNID_ERR		(SSH_TUNID_ANY - 1)
115 #define SSH_TUNID_MAX		(SSH_TUNID_ANY - 2)
116 
117 /* Fake port to indicate that host field is really a path. */
118 #define PORT_STREAMLOCAL	-2
119 
120 /* Functions to extract or store big-endian words of various sizes */
121 u_int64_t	get_u64(const void *)
122     __attribute__((__bounded__( __minbytes__, 1, 8)));
123 u_int32_t	get_u32(const void *)
124     __attribute__((__bounded__( __minbytes__, 1, 4)));
125 u_int16_t	get_u16(const void *)
126     __attribute__((__bounded__( __minbytes__, 1, 2)));
127 void		put_u64(void *, u_int64_t)
128     __attribute__((__bounded__( __minbytes__, 1, 8)));
129 void		put_u32(void *, u_int32_t)
130     __attribute__((__bounded__( __minbytes__, 1, 4)));
131 void		put_u16(void *, u_int16_t)
132     __attribute__((__bounded__( __minbytes__, 1, 2)));
133 
134 /* Little-endian store/load, used by umac.c */
135 u_int32_t	get_u32_le(const void *)
136     __attribute__((__bounded__(__minbytes__, 1, 4)));
137 void		put_u32_le(void *, u_int32_t)
138     __attribute__((__bounded__(__minbytes__, 1, 4)));
139 
140 struct bwlimit {
141 	size_t buflen;
142 	u_int64_t rate;		/* desired rate in kbit/s */
143 	u_int64_t thresh;	/* threshold after which we'll check timers */
144 	u_int64_t lamt;		/* amount written in last timer interval */
145 	struct timeval bwstart, bwend;
146 };
147 
148 void bandwidth_limit_init(struct bwlimit *, u_int64_t, size_t);
149 void bandwidth_limit(struct bwlimit *, size_t);
150 
151 int parse_ipqos(const char *);
152 const char *iptos2str(int);
153 void mktemp_proto(char *, size_t);
154 
155 void	 child_set_env(char ***envp, u_int *envsizep, const char *name,
156 	     const char *value);
157 
158 int	 argv_split(const char *, int *, char ***);
159 char	*argv_assemble(int, char **argv);
160 int	 exited_cleanly(pid_t, const char *, const char *, int);
161 
162 struct stat;
163 int	 safe_path(const char *, struct stat *, const char *, uid_t,
164 	     char *, size_t);
165 int	 safe_path_fd(int, const char *, struct passwd *,
166 	     char *err, size_t errlen);
167 
168 /* readpass.c */
169 
170 #define RP_ECHO			0x0001
171 #define RP_ALLOW_STDIN		0x0002
172 #define RP_ALLOW_EOF		0x0004
173 #define RP_USE_ASKPASS		0x0008
174 
175 char	*read_passphrase(const char *, int);
176 int	 ask_permission(const char *, ...) __attribute__((format(printf, 1, 2)));
177 
178 #define MINIMUM(a, b)	(((a) < (b)) ? (a) : (b))
179 #define MAXIMUM(a, b)	(((a) > (b)) ? (a) : (b))
180 #define ROUNDUP(x, y)   ((((x)+((y)-1))/(y))*(y))
181 
182 #endif /* _MISC_H */
183