1 /* $OpenBSD: misc.h,v 1.104 2023/08/18 01:37:41 djm Exp $ */
4 * Author: Tatu Ylonen <ylo@cs.hut.fi>
5 * Copyright (c) 1995 Tatu Ylonen <ylo@cs.hut.fi>, Espoo, Finland
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".
19 #include <sys/types.h>
20 #include <sys/socket.h>
24 /* Data structure for representing a forwarding request. */
26 char *listen_host; /* Host (address) to listen on. */
27 int listen_port; /* Port to forward. */
28 char *listen_path; /* Path to bind domain socket. */
29 char *connect_host; /* Host to connect. */
30 int connect_port; /* Port to connect on connect_host. */
31 char *connect_path; /* Path to connect domain socket. */
32 int allocated_port; /* Dynamically allocated listen port */
33 int handle; /* Handle for dynamic listen ports */
36 int forward_equals(const struct Forward *, const struct Forward *);
39 /* Common server and client forwarding options. */
40 struct ForwardOptions {
41 int gateway_ports; /* Allow remote connects to forwarded ports. */
42 mode_t streamlocal_bind_mask; /* umask for streamlocal binds */
43 int streamlocal_bind_unlink; /* unlink socket before bind */
50 void skip_space(char **);
51 char *strdelim(char **);
52 char *strdelimw(char **);
53 int set_nonblock(int);
54 int unset_nonblock(int);
55 void set_nodelay(int);
56 int set_reuseaddr(int);
57 char *get_rdomain(int);
58 int set_rdomain(int, const char *);
60 void set_sock_tos(int, int);
61 int waitrfd(int, int *, volatile sig_atomic_t *);
62 int timeout_connect(int, const struct sockaddr *, socklen_t, int *);
63 int a2port(const char *);
64 int a2tun(const char *, int *);
65 char *put_host_port(const char *, u_short);
66 char *hpdelim2(char **, char *);
67 char *hpdelim(char **);
68 char *cleanhostname(char *);
70 int parse_user_host_path(const char *, char **, char **, char **);
71 int parse_user_host_port(const char *, char **, char **, int *);
72 int parse_uri(const char *, const char *, char **, char **, int *, char **);
73 int convtime(const char *);
74 const char *fmt_timeframe(time_t t);
75 int tilde_expand(const char *, uid_t, char **);
76 char *tilde_expand_filename(const char *, uid_t);
78 char *dollar_expand(int *, const char *string, ...);
79 char *percent_expand(const char *, ...) __attribute__((__sentinel__));
80 char *percent_dollar_expand(const char *, ...) __attribute__((__sentinel__));
81 char *tohex(const void *, size_t);
82 void xextendf(char **s, const char *sep, const char *fmt, ...)
83 __attribute__((__format__ (printf, 3, 4))) __attribute__((__nonnull__ (3)));
84 void sanitise_stdfd(void);
85 void ms_subtract_diff(struct timeval *, int *);
86 void ms_to_timespec(struct timespec *, int);
87 void monotime_ts(struct timespec *);
88 void monotime_tv(struct timeval *);
89 time_t monotime(void);
90 double monotime_double(void);
91 void lowercase(char *s);
92 int unix_listener(const char *, int, int);
93 int valid_domain(char *, int, const char **);
94 int valid_env_name(const char *);
95 const char *atoi_err(const char *, int *);
96 int parse_absolute_time(const char *, uint64_t *);
97 void format_absolute_time(uint64_t, char *, size_t);
98 int path_absolute(const char *);
99 int stdfd_devnull(int, int, int);
100 int lib_contains_symbol(const char *, const char *);
102 void sock_set_v6only(int);
104 struct passwd *pwcopy(struct passwd *);
105 const char *ssh_gai_strerror(int);
107 typedef void privdrop_fn(struct passwd *);
108 typedef void privrestore_fn(void);
109 #define SSH_SUBPROCESS_STDOUT_DISCARD (1) /* Discard stdout */
110 #define SSH_SUBPROCESS_STDOUT_CAPTURE (1<<1) /* Redirect stdout */
111 #define SSH_SUBPROCESS_STDERR_DISCARD (1<<2) /* Discard stderr */
112 #define SSH_SUBPROCESS_UNSAFE_PATH (1<<3) /* Don't check for safe cmd */
113 #define SSH_SUBPROCESS_PRESERVE_ENV (1<<4) /* Keep parent environment */
114 pid_t subprocess(const char *, const char *, int, char **, FILE **, u_int,
115 struct passwd *, privdrop_fn *, privrestore_fn *);
117 typedef struct arglist arglist;
123 void addargs(arglist *, char *, ...)
124 __attribute__((format(printf, 2, 3)));
125 void replacearg(arglist *, u_int, char *, ...)
126 __attribute__((format(printf, 3, 4)));
127 void freeargs(arglist *);
129 int tun_open(int, int, char **);
131 /* Common definitions for ssh tunnel device forwarding */
132 #define SSH_TUNMODE_NO 0x00
133 #define SSH_TUNMODE_POINTOPOINT 0x01
134 #define SSH_TUNMODE_ETHERNET 0x02
135 #define SSH_TUNMODE_DEFAULT SSH_TUNMODE_POINTOPOINT
136 #define SSH_TUNMODE_YES (SSH_TUNMODE_POINTOPOINT|SSH_TUNMODE_ETHERNET)
138 #define SSH_TUNID_ANY 0x7fffffff
139 #define SSH_TUNID_ERR (SSH_TUNID_ANY - 1)
140 #define SSH_TUNID_MAX (SSH_TUNID_ANY - 2)
142 /* Fake port to indicate that host field is really a path. */
143 #define PORT_STREAMLOCAL -2
145 /* Functions to extract or store big-endian words of various sizes */
146 u_int64_t get_u64(const void *)
147 __attribute__((__bounded__( __minbytes__, 1, 8)));
148 u_int32_t get_u32(const void *)
149 __attribute__((__bounded__( __minbytes__, 1, 4)));
150 u_int16_t get_u16(const void *)
151 __attribute__((__bounded__( __minbytes__, 1, 2)));
152 void put_u64(void *, u_int64_t)
153 __attribute__((__bounded__( __minbytes__, 1, 8)));
154 void put_u32(void *, u_int32_t)
155 __attribute__((__bounded__( __minbytes__, 1, 4)));
156 void put_u16(void *, u_int16_t)
157 __attribute__((__bounded__( __minbytes__, 1, 2)));
159 /* Little-endian store/load, used by umac.c */
160 u_int32_t get_u32_le(const void *)
161 __attribute__((__bounded__(__minbytes__, 1, 4)));
162 void put_u32_le(void *, u_int32_t)
163 __attribute__((__bounded__(__minbytes__, 1, 4)));
167 u_int64_t rate; /* desired rate in kbit/s */
168 u_int64_t thresh; /* threshold after which we'll check timers */
169 u_int64_t lamt; /* amount written in last timer interval */
170 struct timeval bwstart, bwend;
173 void bandwidth_limit_init(struct bwlimit *, u_int64_t, size_t);
174 void bandwidth_limit(struct bwlimit *, size_t);
176 int parse_ipqos(const char *);
177 const char *iptos2str(int);
178 void mktemp_proto(char *, size_t);
180 void child_set_env(char ***envp, u_int *envsizep, const char *name,
182 const char *lookup_env_in_list(const char *env,
183 char * const *envs, size_t nenvs);
184 const char *lookup_setenv_in_list(const char *env,
185 char * const *envs, size_t nenvs);
187 int argv_split(const char *, int *, char ***, int);
188 char *argv_assemble(int, char **argv);
189 char *argv_next(int *, char ***);
190 void argv_consume(int *);
191 void argv_free(char **, int);
193 int exited_cleanly(pid_t, const char *, const char *, int);
196 int safe_path(const char *, struct stat *, const char *, uid_t,
198 int safe_path_fd(int, const char *, struct passwd *,
199 char *err, size_t errlen);
201 /* authorized_key-style options parsing helpers */
202 int opt_flag(const char *opt, int allow_negate, const char **optsp);
203 char *opt_dequote(const char **sp, const char **errstrp);
204 int opt_match(const char **opts, const char *term);
206 /* readconf/servconf option lists */
207 void opt_array_append(const char *file, const int line,
208 const char *directive, char ***array, u_int *lp, const char *s);
209 void opt_array_append2(const char *file, const int line,
210 const char *directive, char ***array, int **iarray, u_int *lp,
211 const char *s, int i);
214 void ptimeout_init(struct timespec *pt);
215 void ptimeout_deadline_sec(struct timespec *pt, long sec);
216 void ptimeout_deadline_ms(struct timespec *pt, long ms);
217 void ptimeout_deadline_monotime(struct timespec *pt, time_t when);
218 int ptimeout_get_ms(struct timespec *pt);
219 struct timespec *ptimeout_get_tsp(struct timespec *pt);
220 int ptimeout_isset(struct timespec *pt);
224 #define RP_ECHO 0x0001
225 #define RP_ALLOW_STDIN 0x0002
226 #define RP_ALLOW_EOF 0x0004
227 #define RP_USE_ASKPASS 0x0008
231 char *read_passphrase(const char *, int);
232 int ask_permission(const char *, ...) __attribute__((format(printf, 1, 2)));
233 struct notifier_ctx *notify_start(int, const char *, ...)
234 __attribute__((format(printf, 2, 3)));
235 void notify_complete(struct notifier_ctx *, const char *, ...)
236 __attribute__((format(printf, 2, 3)));
238 #define MINIMUM(a, b) (((a) < (b)) ? (a) : (b))
239 #define MAXIMUM(a, b) (((a) > (b)) ? (a) : (b))
240 #define ROUNDUP(x, y) ((((x)+((y)-1))/(y))*(y))
242 typedef void (*sshsig_t)(int);
243 sshsig_t ssh_signal(int, sshsig_t);
245 /* On OpenBSD time_t is int64_t which is long long. */
246 /* #define SSH_TIME_T_MAX LLONG_MAX */