1 /* $OpenBSD: misc.h,v 1.91 2020/12/22 00:12:22 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 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 void skip_space(char **); 48 char *strdelim(char **); 49 char *strdelimw(char **); 50 int set_nonblock(int); 51 int unset_nonblock(int); 52 void set_nodelay(int); 53 int set_reuseaddr(int); 54 char *get_rdomain(int); 55 int set_rdomain(int, const char *); 56 int get_sock_af(int); 57 void set_sock_tos(int, int); 58 int waitrfd(int, int *); 59 int timeout_connect(int, const struct sockaddr *, socklen_t, int *); 60 int a2port(const char *); 61 int a2tun(const char *, int *); 62 char *put_host_port(const char *, u_short); 63 char *hpdelim2(char **, char *); 64 char *hpdelim(char **); 65 char *cleanhostname(char *); 66 char *colon(char *); 67 int parse_user_host_path(const char *, char **, char **, char **); 68 int parse_user_host_port(const char *, char **, char **, int *); 69 int parse_uri(const char *, const char *, char **, char **, int *, char **); 70 long convtime(const char *); 71 const char *fmt_timeframe(time_t t); 72 char *tilde_expand_filename(const char *, uid_t); 73 74 char *dollar_expand(int *, const char *string, ...); 75 char *percent_expand(const char *, ...) __attribute__((__sentinel__)); 76 char *percent_dollar_expand(const char *, ...) __attribute__((__sentinel__)); 77 char *tohex(const void *, size_t); 78 void xextendf(char **s, const char *sep, const char *fmt, ...) 79 __attribute__((__format__ (printf, 3, 4))) __attribute__((__nonnull__ (3))); 80 void sanitise_stdfd(void); 81 void ms_subtract_diff(struct timeval *, int *); 82 void ms_to_timeval(struct timeval *, int); 83 void monotime_ts(struct timespec *); 84 void monotime_tv(struct timeval *); 85 time_t monotime(void); 86 double monotime_double(void); 87 void lowercase(char *s); 88 int unix_listener(const char *, int, int); 89 int valid_domain(char *, int, const char **); 90 int valid_env_name(const char *); 91 const char *atoi_err(const char *, int *); 92 int parse_absolute_time(const char *, uint64_t *); 93 void format_absolute_time(uint64_t, char *, size_t); 94 int path_absolute(const char *); 95 int stdfd_devnull(int, int, int); 96 97 struct passwd *pwcopy(struct passwd *); 98 const char *ssh_gai_strerror(int); 99 100 typedef void privdrop_fn(struct passwd *); 101 typedef void privrestore_fn(void); 102 #define SSH_SUBPROCESS_STDOUT_DISCARD (1) /* Discard stdout */ 103 #define SSH_SUBPROCESS_STDOUT_CAPTURE (1<<1) /* Redirect stdout */ 104 #define SSH_SUBPROCESS_STDERR_DISCARD (1<<2) /* Discard stderr */ 105 #define SSH_SUBPROCESS_UNSAFE_PATH (1<<3) /* Don't check for safe cmd */ 106 #define SSH_SUBPROCESS_PRESERVE_ENV (1<<4) /* Keep parent environment */ 107 pid_t subprocess(const char *, const char *, int, char **, FILE **, u_int, 108 struct passwd *, privdrop_fn *, privrestore_fn *); 109 110 typedef struct arglist arglist; 111 struct arglist { 112 char **list; 113 u_int num; 114 u_int nalloc; 115 }; 116 void addargs(arglist *, char *, ...) 117 __attribute__((format(printf, 2, 3))); 118 void replacearg(arglist *, u_int, char *, ...) 119 __attribute__((format(printf, 3, 4))); 120 void freeargs(arglist *); 121 122 int tun_open(int, int, char **); 123 124 /* Common definitions for ssh tunnel device forwarding */ 125 #define SSH_TUNMODE_NO 0x00 126 #define SSH_TUNMODE_POINTOPOINT 0x01 127 #define SSH_TUNMODE_ETHERNET 0x02 128 #define SSH_TUNMODE_DEFAULT SSH_TUNMODE_POINTOPOINT 129 #define SSH_TUNMODE_YES (SSH_TUNMODE_POINTOPOINT|SSH_TUNMODE_ETHERNET) 130 131 #define SSH_TUNID_ANY 0x7fffffff 132 #define SSH_TUNID_ERR (SSH_TUNID_ANY - 1) 133 #define SSH_TUNID_MAX (SSH_TUNID_ANY - 2) 134 135 /* Fake port to indicate that host field is really a path. */ 136 #define PORT_STREAMLOCAL -2 137 138 /* Functions to extract or store big-endian words of various sizes */ 139 u_int64_t get_u64(const void *) 140 __attribute__((__bounded__( __minbytes__, 1, 8))); 141 u_int32_t get_u32(const void *) 142 __attribute__((__bounded__( __minbytes__, 1, 4))); 143 u_int16_t get_u16(const void *) 144 __attribute__((__bounded__( __minbytes__, 1, 2))); 145 void put_u64(void *, u_int64_t) 146 __attribute__((__bounded__( __minbytes__, 1, 8))); 147 void put_u32(void *, u_int32_t) 148 __attribute__((__bounded__( __minbytes__, 1, 4))); 149 void put_u16(void *, u_int16_t) 150 __attribute__((__bounded__( __minbytes__, 1, 2))); 151 152 /* Little-endian store/load, used by umac.c */ 153 u_int32_t get_u32_le(const void *) 154 __attribute__((__bounded__(__minbytes__, 1, 4))); 155 void put_u32_le(void *, u_int32_t) 156 __attribute__((__bounded__(__minbytes__, 1, 4))); 157 158 struct bwlimit { 159 size_t buflen; 160 u_int64_t rate; /* desired rate in kbit/s */ 161 u_int64_t thresh; /* threshold after which we'll check timers */ 162 u_int64_t lamt; /* amount written in last timer interval */ 163 struct timeval bwstart, bwend; 164 }; 165 166 void bandwidth_limit_init(struct bwlimit *, u_int64_t, size_t); 167 void bandwidth_limit(struct bwlimit *, size_t); 168 169 int parse_ipqos(const char *); 170 const char *iptos2str(int); 171 void mktemp_proto(char *, size_t); 172 173 void child_set_env(char ***envp, u_int *envsizep, const char *name, 174 const char *value); 175 176 int argv_split(const char *, int *, char ***); 177 char *argv_assemble(int, char **argv); 178 int exited_cleanly(pid_t, const char *, const char *, int); 179 180 struct stat; 181 int safe_path(const char *, struct stat *, const char *, uid_t, 182 char *, size_t); 183 int safe_path_fd(int, const char *, struct passwd *, 184 char *err, size_t errlen); 185 186 /* authorized_key-style options parsing helpers */ 187 int opt_flag(const char *opt, int allow_negate, const char **optsp); 188 char *opt_dequote(const char **sp, const char **errstrp); 189 int opt_match(const char **opts, const char *term); 190 191 /* readpass.c */ 192 193 #define RP_ECHO 0x0001 194 #define RP_ALLOW_STDIN 0x0002 195 #define RP_ALLOW_EOF 0x0004 196 #define RP_USE_ASKPASS 0x0008 197 198 struct notifier_ctx; 199 200 char *read_passphrase(const char *, int); 201 int ask_permission(const char *, ...) __attribute__((format(printf, 1, 2))); 202 struct notifier_ctx *notify_start(int, const char *, ...) 203 __attribute__((format(printf, 2, 3))); 204 void notify_complete(struct notifier_ctx *, const char *, ...) 205 __attribute__((format(printf, 2, 3))); 206 207 #define MINIMUM(a, b) (((a) < (b)) ? (a) : (b)) 208 #define MAXIMUM(a, b) (((a) > (b)) ? (a) : (b)) 209 #define ROUNDUP(x, y) ((((x)+((y)-1))/(y))*(y)) 210 211 typedef void (*sshsig_t)(int); 212 sshsig_t ssh_signal(int, sshsig_t); 213 #endif /* _MISC_H */ 214