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