jcs.org
jcs's openbsd hax
openbsd
1/* $OpenBSD: misc.h,v 1.114 2025/12/05 07:43:12 djm 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#include <stdio.h>
22#include <signal.h>
23
24/* special-case port number meaning allow any port */
25#define FWD_PERMIT_ANY_PORT 0
26
27/* special-case wildcard meaning allow any host */
28#define FWD_PERMIT_ANY_HOST "*"
29
30/* Data structure for representing a forwarding request. */
31struct Forward {
32 char *listen_host; /* Host (address) to listen on. */
33 int listen_port; /* Port to forward. */
34 char *listen_path; /* Path to bind domain socket. */
35 char *connect_host; /* Host to connect. */
36 int connect_port; /* Port to connect on connect_host. */
37 char *connect_path; /* Path to connect domain socket. */
38 int allocated_port; /* Dynamically allocated listen port */
39 int handle; /* Handle for dynamic listen ports */
40};
41
42int forward_equals(const struct Forward *, const struct Forward *);
43int permitopen_port(const char *p);
44
45int daemonized(void);
46
47/* Common server and client forwarding options. */
48struct ForwardOptions {
49 int gateway_ports; /* Allow remote connects to forwarded ports. */
50 mode_t streamlocal_bind_mask; /* umask for streamlocal binds */
51 int streamlocal_bind_unlink; /* unlink socket before bind */
52};
53
54/* misc.c */
55
56char *chop(char *);
57void rtrim(char *);
58void skip_space(char **);
59const char *strprefix(const char *, const char *, int);
60char *strdelim(char **);
61char *strdelimw(char **);
62void stringlist_append(char ***listp, const char *s);
63void stringlist_free(char **list);
64int set_nonblock(int);
65int unset_nonblock(int);
66void set_nodelay(int);
67int set_reuseaddr(int);
68char *get_rdomain(int);
69int set_rdomain(int, const char *);
70int get_sock_af(int);
71void set_sock_tos(int, int);
72int waitrfd(int, int *, volatile sig_atomic_t *);
73int timeout_connect(int, const struct sockaddr *, socklen_t, int *);
74int a2port(const char *);
75int a2tun(const char *, int *);
76char *put_host_port(const char *, u_short);
77char *hpdelim2(char **, char *);
78char *hpdelim(char **);
79char *cleanhostname(char *);
80char *colon(char *);
81int parse_user_host_path(const char *, char **, char **, char **);
82int parse_user_host_port(const char *, char **, char **, int *);
83int parse_uri(const char *, const char *, char **, char **, int *, char **);
84double convtime_double(const char *);
85int convtime(const char *);
86double convtime_double(const char *);
87const char *fmt_timeframe(time_t t);
88int tilde_expand(const char *, uid_t, char **);
89char *tilde_expand_filename(const char *, uid_t);
90
91char *dollar_expand(int *, const char *string, ...);
92char *percent_expand(const char *, ...) __attribute__((__sentinel__));
93char *percent_dollar_expand(const char *, ...) __attribute__((__sentinel__));
94char *tohex(const void *, size_t);
95void xextendf(char **s, const char *sep, const char *fmt, ...)
96 __attribute__((__format__ (printf, 3, 4))) __attribute__((__nonnull__ (3)));
97void sanitise_stdfd(void);
98void ms_subtract_diff(struct timeval *, int *);
99void ms_to_timespec(struct timespec *, int);
100void monotime_ts(struct timespec *);
101void monotime_tv(struct timeval *);
102time_t monotime(void);
103double monotime_double(void);
104void lowercase(char *s);
105int unix_listener(const char *, int, int);
106int valid_domain(char *, int, const char **);
107int valid_env_name(const char *);
108const char *atoi_err(const char *, int *);
109int parse_absolute_time(const char *, uint64_t *);
110void format_absolute_time(uint64_t, char *, size_t);
111int parse_pattern_interval(const char *, char **, int *);
112int path_absolute(const char *);
113int stdfd_devnull(int, int, int);
114int lib_contains_symbol(const char *, const char *);
115char *get_homedir(void);
116
117struct passwd *pwcopy(struct passwd *);
118void pwfree(struct passwd *); /* NB. only use with pwcopy */
119
120const char *ssh_gai_strerror(int);
121
122typedef void privdrop_fn(struct passwd *);
123typedef void privrestore_fn(void);
124#define SSH_SUBPROCESS_STDOUT_DISCARD (1) /* Discard stdout */
125#define SSH_SUBPROCESS_STDOUT_CAPTURE (1<<1) /* Redirect stdout */
126#define SSH_SUBPROCESS_STDERR_DISCARD (1<<2) /* Discard stderr */
127#define SSH_SUBPROCESS_UNSAFE_PATH (1<<3) /* Don't check for safe cmd */
128#define SSH_SUBPROCESS_PRESERVE_ENV (1<<4) /* Keep parent environment */
129pid_t subprocess(const char *, const char *, int, char **, FILE **, u_int,
130 struct passwd *, privdrop_fn *, privrestore_fn *);
131
132typedef struct arglist arglist;
133struct arglist {
134 char **list;
135 u_int num;
136 u_int nalloc;
137};
138void addargs(arglist *, char *, ...)
139 __attribute__((format(printf, 2, 3)));
140void replacearg(arglist *, u_int, char *, ...)
141 __attribute__((format(printf, 3, 4)));
142void freeargs(arglist *);
143
144int tun_open(int, int, char **);
145
146/* Common definitions for ssh tunnel device forwarding */
147#define SSH_TUNMODE_NO 0x00
148#define SSH_TUNMODE_POINTOPOINT 0x01
149#define SSH_TUNMODE_ETHERNET 0x02
150#define SSH_TUNMODE_DEFAULT SSH_TUNMODE_POINTOPOINT
151#define SSH_TUNMODE_YES (SSH_TUNMODE_POINTOPOINT|SSH_TUNMODE_ETHERNET)
152
153#define SSH_TUNID_ANY 0x7fffffff
154#define SSH_TUNID_ERR (SSH_TUNID_ANY - 1)
155#define SSH_TUNID_MAX (SSH_TUNID_ANY - 2)
156
157/* Fake port to indicate that host field is really a path. */
158#define PORT_STREAMLOCAL -2
159
160/* Functions to extract or store big-endian words of various sizes */
161u_int64_t get_u64(const void *)
162 __attribute__((__bounded__( __minbytes__, 1, 8)));
163u_int32_t get_u32(const void *)
164 __attribute__((__bounded__( __minbytes__, 1, 4)));
165u_int16_t get_u16(const void *)
166 __attribute__((__bounded__( __minbytes__, 1, 2)));
167void put_u64(void *, u_int64_t)
168 __attribute__((__bounded__( __minbytes__, 1, 8)));
169void put_u32(void *, u_int32_t)
170 __attribute__((__bounded__( __minbytes__, 1, 4)));
171void put_u16(void *, u_int16_t)
172 __attribute__((__bounded__( __minbytes__, 1, 2)));
173
174/* Little-endian store/load, used by umac.c */
175u_int32_t get_u32_le(const void *)
176 __attribute__((__bounded__(__minbytes__, 1, 4)));
177void put_u32_le(void *, u_int32_t)
178 __attribute__((__bounded__(__minbytes__, 1, 4)));
179
180struct bwlimit {
181 size_t buflen;
182 u_int64_t rate; /* desired rate in kbit/s */
183 u_int64_t thresh; /* threshold after which we'll check timers */
184 u_int64_t lamt; /* amount written in last timer interval */
185 struct timeval bwstart, bwend;
186};
187
188void bandwidth_limit_init(struct bwlimit *, u_int64_t, size_t);
189void bandwidth_limit(struct bwlimit *, size_t);
190
191int parse_ipqos(const char *);
192const char *iptos2str(int);
193void mktemp_proto(char *, size_t);
194
195void child_set_env(char ***envp, u_int *envsizep, const char *name,
196 const char *value);
197const char *lookup_env_in_list(const char *env,
198 char * const *envs, size_t nenvs);
199const char *lookup_setenv_in_list(const char *env,
200 char * const *envs, size_t nenvs);
201
202int argv_split(const char *, int *, char ***, int);
203char *argv_assemble(int, char **argv);
204char *argv_next(int *, char ***);
205void argv_consume(int *);
206void argv_free(char **, int);
207
208int exited_cleanly(pid_t, const char *, const char *, int);
209
210struct stat;
211int safe_path(const char *, struct stat *, const char *, uid_t,
212 char *, size_t);
213int safe_path_fd(int, const char *, struct passwd *,
214 char *err, size_t errlen);
215
216/* authorized_key-style options parsing helpers */
217int opt_flag(const char *opt, int allow_negate, const char **optsp);
218char *opt_dequote(const char **sp, const char **errstrp);
219int opt_match(const char **opts, const char *term);
220
221/* readconf/servconf option lists */
222void opt_array_append(const char *file, const int line,
223 const char *directive, char ***array, u_int *lp, const char *s);
224void opt_array_append2(const char *file, const int line,
225 const char *directive, char ***array, int **iarray, u_int *lp,
226 const char *s, int i);
227void opt_array_free2(char **array, int **iarray, u_int l);
228
229struct timespec;
230void ptimeout_init(struct timespec *pt);
231void ptimeout_deadline_sec(struct timespec *pt, long sec);
232void ptimeout_deadline_ms(struct timespec *pt, long ms);
233void ptimeout_deadline_monotime_tsp(struct timespec *pt, struct timespec *when);
234void ptimeout_deadline_monotime(struct timespec *pt, time_t when);
235int ptimeout_get_ms(struct timespec *pt);
236struct timespec *ptimeout_get_tsp(struct timespec *pt);
237int ptimeout_isset(struct timespec *pt);
238
239/* misc-agent.c */
240char *agent_hostname_hash(void);
241int agent_listener(const char *, const char *, int *, char **);
242void agent_cleanup_stale(const char *, int);
243
244/* readpass.c */
245
246#define RP_ECHO 0x0001
247#define RP_ALLOW_STDIN 0x0002
248#define RP_ALLOW_EOF 0x0004
249#define RP_USE_ASKPASS 0x0008
250
251struct notifier_ctx;
252
253char *read_passphrase(const char *, int);
254int ask_permission(const char *, ...) __attribute__((format(printf, 1, 2)));
255struct notifier_ctx *notify_start(int, const char *, ...)
256 __attribute__((format(printf, 2, 3)));
257void notify_complete(struct notifier_ctx *, const char *, ...)
258 __attribute__((format(printf, 2, 3)));
259
260#define MINIMUM(a, b) (((a) < (b)) ? (a) : (b))
261#define MAXIMUM(a, b) (((a) > (b)) ? (a) : (b))
262#define ROUNDUP(x, y) ((((x)+((y)-1))/(y))*(y))
263
264typedef void (*sshsig_t)(int);
265sshsig_t ssh_signal(int, sshsig_t);
266int signal_is_crash(int);
267
268/* On OpenBSD time_t is int64_t which is long long. */
269#define SSH_TIME_T_MAX LLONG_MAX
270
271#endif /* _MISC_H */