1 /* $OpenBSD: misc.h,v 1.100 2022/06/03 04:30:47 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 23 /* Data structure for representing a forwarding request. */ 24 struct 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 35 int forward_equals(const struct Forward *, const struct Forward *); 36 int daemonized(void); 37 38 /* Common server and client forwarding options. */ 39 struct 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 47 char *chop(char *); 48 void rtrim(char *); 49 void skip_space(char **); 50 char *strdelim(char **); 51 char *strdelimw(char **); 52 int set_nonblock(int); 53 int unset_nonblock(int); 54 void set_nodelay(int); 55 int set_reuseaddr(int); 56 char *get_rdomain(int); 57 int set_rdomain(int, const char *); 58 int get_sock_af(int); 59 void set_sock_tos(int, int); 60 int waitrfd(int, int *); 61 int timeout_connect(int, const struct sockaddr *, socklen_t, int *); 62 int a2port(const char *); 63 int a2tun(const char *, int *); 64 char *put_host_port(const char *, u_short); 65 char *hpdelim2(char **, char *); 66 char *hpdelim(char **); 67 char *cleanhostname(char *); 68 char *colon(char *); 69 int parse_user_host_path(const char *, char **, char **, char **); 70 int parse_user_host_port(const char *, char **, char **, int *); 71 int parse_uri(const char *, const char *, char **, char **, int *, char **); 72 int convtime(const char *); 73 const char *fmt_timeframe(time_t t); 74 int tilde_expand(const char *, uid_t, char **); 75 char *tilde_expand_filename(const char *, uid_t); 76 77 char *dollar_expand(int *, const char *string, ...); 78 char *percent_expand(const char *, ...) __attribute__((__sentinel__)); 79 char *percent_dollar_expand(const char *, ...) __attribute__((__sentinel__)); 80 char *tohex(const void *, size_t); 81 void xextendf(char **s, const char *sep, const char *fmt, ...) 82 __attribute__((__format__ (printf, 3, 4))) __attribute__((__nonnull__ (3))); 83 void sanitise_stdfd(void); 84 void ms_subtract_diff(struct timeval *, int *); 85 void ms_to_timespec(struct timespec *, int); 86 void monotime_ts(struct timespec *); 87 void monotime_tv(struct timeval *); 88 time_t monotime(void); 89 double monotime_double(void); 90 void lowercase(char *s); 91 int unix_listener(const char *, int, int); 92 int valid_domain(char *, int, const char **); 93 int valid_env_name(const char *); 94 const char *atoi_err(const char *, int *); 95 int parse_absolute_time(const char *, uint64_t *); 96 void format_absolute_time(uint64_t, char *, size_t); 97 int path_absolute(const char *); 98 int stdfd_devnull(int, int, int); 99 100 void sock_set_v6only(int); 101 102 struct passwd *pwcopy(struct passwd *); 103 const char *ssh_gai_strerror(int); 104 105 typedef void privdrop_fn(struct passwd *); 106 typedef 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 */ 112 pid_t subprocess(const char *, const char *, int, char **, FILE **, u_int, 113 struct passwd *, privdrop_fn *, privrestore_fn *); 114 115 typedef struct arglist arglist; 116 struct arglist { 117 char **list; 118 u_int num; 119 u_int nalloc; 120 }; 121 void addargs(arglist *, char *, ...) 122 __attribute__((format(printf, 2, 3))); 123 void replacearg(arglist *, u_int, char *, ...) 124 __attribute__((format(printf, 3, 4))); 125 void freeargs(arglist *); 126 127 int 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 */ 144 u_int64_t get_u64(const void *) 145 __attribute__((__bounded__( __minbytes__, 1, 8))); 146 u_int32_t get_u32(const void *) 147 __attribute__((__bounded__( __minbytes__, 1, 4))); 148 u_int16_t get_u16(const void *) 149 __attribute__((__bounded__( __minbytes__, 1, 2))); 150 void put_u64(void *, u_int64_t) 151 __attribute__((__bounded__( __minbytes__, 1, 8))); 152 void put_u32(void *, u_int32_t) 153 __attribute__((__bounded__( __minbytes__, 1, 4))); 154 void put_u16(void *, u_int16_t) 155 __attribute__((__bounded__( __minbytes__, 1, 2))); 156 157 /* Little-endian store/load, used by umac.c */ 158 u_int32_t get_u32_le(const void *) 159 __attribute__((__bounded__(__minbytes__, 1, 4))); 160 void put_u32_le(void *, u_int32_t) 161 __attribute__((__bounded__(__minbytes__, 1, 4))); 162 163 struct 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 171 void bandwidth_limit_init(struct bwlimit *, u_int64_t, size_t); 172 void bandwidth_limit(struct bwlimit *, size_t); 173 174 int parse_ipqos(const char *); 175 const char *iptos2str(int); 176 void mktemp_proto(char *, size_t); 177 178 void child_set_env(char ***envp, u_int *envsizep, const char *name, 179 const char *value); 180 const char *lookup_env_in_list(const char *env, 181 char * const *envs, size_t nenvs); 182 const char *lookup_setenv_in_list(const char *env, 183 char * const *envs, size_t nenvs); 184 185 int argv_split(const char *, int *, char ***, int); 186 char *argv_assemble(int, char **argv); 187 char *argv_next(int *, char ***); 188 void argv_consume(int *); 189 void argv_free(char **, int); 190 191 int exited_cleanly(pid_t, const char *, const char *, int); 192 193 struct stat; 194 int safe_path(const char *, struct stat *, const char *, uid_t, 195 char *, size_t); 196 int safe_path_fd(int, const char *, struct passwd *, 197 char *err, size_t errlen); 198 199 /* authorized_key-style options parsing helpers */ 200 int opt_flag(const char *opt, int allow_negate, const char **optsp); 201 char *opt_dequote(const char **sp, const char **errstrp); 202 int opt_match(const char **opts, const char *term); 203 204 /* readconf/servconf option lists */ 205 void opt_array_append(const char *file, const int line, 206 const char *directive, char ***array, u_int *lp, const char *s); 207 void opt_array_append2(const char *file, const int line, 208 const char *directive, char ***array, int **iarray, u_int *lp, 209 const char *s, int i); 210 211 /* readpass.c */ 212 213 #define RP_ECHO 0x0001 214 #define RP_ALLOW_STDIN 0x0002 215 #define RP_ALLOW_EOF 0x0004 216 #define RP_USE_ASKPASS 0x0008 217 218 struct notifier_ctx; 219 220 char *read_passphrase(const char *, int); 221 int ask_permission(const char *, ...) __attribute__((format(printf, 1, 2))); 222 struct notifier_ctx *notify_start(int, const char *, ...) 223 __attribute__((format(printf, 2, 3))); 224 void notify_complete(struct notifier_ctx *, const char *, ...) 225 __attribute__((format(printf, 2, 3))); 226 227 #define MINIMUM(a, b) (((a) < (b)) ? (a) : (b)) 228 #define MAXIMUM(a, b) (((a) > (b)) ? (a) : (b)) 229 #define ROUNDUP(x, y) ((((x)+((y)-1))/(y))*(y)) 230 231 typedef void (*sshsig_t)(int); 232 sshsig_t ssh_signal(int, sshsig_t); 233 234 #endif /* _MISC_H */ 235