1 /* $NetBSD: misc.h,v 1.21 2021/04/19 14:40:15 christos Exp $ */ 2 /* $OpenBSD: misc.h,v 1.95 2021/04/03 06:18:40 djm Exp $ */ 3 4 /* 5 * Author: Tatu Ylonen <ylo@cs.hut.fi> 6 * Copyright (c) 1995 Tatu Ylonen <ylo@cs.hut.fi>, Espoo, Finland 7 * All rights reserved 8 * 9 * As far as I am concerned, the code I have written for this software 10 * can be used freely for any purpose. Any derived versions of this 11 * software must be clearly marked as such, and if the derived work is 12 * incompatible with the protocol description in the RFC file, it must be 13 * called by a name other than "ssh" or "Secure Shell". 14 */ 15 16 #ifndef _MISC_H 17 #define _MISC_H 18 19 #include <sys/time.h> 20 #include <sys/types.h> 21 #include <sys/socket.h> 22 #include <stdio.h> 23 24 /* Data structure for representing a forwarding request. */ 25 struct Forward { 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 */ 34 }; 35 36 int forward_equals(const struct Forward *, const struct Forward *); 37 int daemonized(void); 38 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 */ 44 }; 45 46 /* misc.c */ 47 48 char *chop(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 char *tilde_expand_filename(const char *, uid_t); 75 76 char *dollar_expand(int *, const char *string, ...); 77 char *percent_expand(const char *, ...) __attribute__((__sentinel__)); 78 char *percent_dollar_expand(const char *, ...) __attribute__((__sentinel__)); 79 char *tohex(const void *, size_t); 80 void xextendf(char **s, const char *sep, const char *fmt, ...) 81 __attribute__((__format__ (printf, 3, 4))) __attribute__((__nonnull__ (3))); 82 void sanitise_stdfd(void); 83 struct timeval; 84 void ms_subtract_diff(struct timeval *, int *); 85 void ms_to_timeval(struct timeval *, 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 int bcrypt_pbkdf(const char *, size_t, const u_int8_t *, size_t, 101 u_int8_t *, size_t, unsigned int); 102 103 struct passwd *pwcopy(struct passwd *); 104 const char *ssh_gai_strerror(int); 105 106 typedef void privdrop_fn(struct passwd *); 107 typedef void privrestore_fn(void); 108 #define SSH_SUBPROCESS_STDOUT_DISCARD (1) /* Discard stdout */ 109 #define SSH_SUBPROCESS_STDOUT_CAPTURE (1<<1) /* Redirect stdout */ 110 #define SSH_SUBPROCESS_STDERR_DISCARD (1<<2) /* Discard stderr */ 111 #define SSH_SUBPROCESS_UNSAFE_PATH (1<<3) /* Don't check for safe cmd */ 112 #define SSH_SUBPROCESS_PRESERVE_ENV (1<<4) /* Keep parent environment */ 113 pid_t subprocess(const char *, const char *, int, char **, FILE **, u_int, 114 struct passwd *, privdrop_fn *, privrestore_fn *); 115 116 typedef struct arglist arglist; 117 struct arglist { 118 char **list; 119 u_int num; 120 u_int nalloc; 121 }; 122 void addargs(arglist *, const char *, ...) 123 __attribute__((format(printf, 2, 3))); 124 void replacearg(arglist *, u_int, const char *, ...) 125 __attribute__((format(printf, 3, 4))); 126 void freeargs(arglist *); 127 128 int tun_open(int, int, char **); 129 130 /* Common definitions for ssh tunnel device forwarding */ 131 #define SSH_TUNMODE_NO 0x00 132 #define SSH_TUNMODE_POINTOPOINT 0x01 133 #define SSH_TUNMODE_ETHERNET 0x02 134 #define SSH_TUNMODE_DEFAULT SSH_TUNMODE_POINTOPOINT 135 #define SSH_TUNMODE_YES (SSH_TUNMODE_POINTOPOINT|SSH_TUNMODE_ETHERNET) 136 137 #define SSH_TUNID_ANY 0x7fffffff 138 #define SSH_TUNID_ERR (SSH_TUNID_ANY - 1) 139 #define SSH_TUNID_MAX (SSH_TUNID_ANY - 2) 140 141 /* Fake port to indicate that host field is really a path. */ 142 #define PORT_STREAMLOCAL -2 143 144 /* Functions to extract or store big-endian words of various sizes */ 145 u_int64_t get_u64(const void *) 146 __attribute__((__bounded__( __minbytes__, 1, 8))); 147 u_int32_t get_u32(const void *) 148 __attribute__((__bounded__( __minbytes__, 1, 4))); 149 u_int16_t get_u16(const void *) 150 __attribute__((__bounded__( __minbytes__, 1, 2))); 151 void put_u64(void *, u_int64_t) 152 __attribute__((__bounded__( __minbytes__, 1, 8))); 153 void put_u32(void *, u_int32_t) 154 __attribute__((__bounded__( __minbytes__, 1, 4))); 155 void put_u16(void *, u_int16_t) 156 __attribute__((__bounded__( __minbytes__, 1, 2))); 157 158 /* Little-endian store/load, used by umac.c */ 159 u_int32_t get_u32_le(const void *) 160 __attribute__((__bounded__(__minbytes__, 1, 4))); 161 void put_u32_le(void *, u_int32_t) 162 __attribute__((__bounded__(__minbytes__, 1, 4))); 163 164 struct bwlimit { 165 size_t buflen; 166 u_int64_t rate; /* desired rate in kbit/s */ 167 u_int64_t thresh; /* threshold after which we'll check timers */ 168 u_int64_t lamt; /* amount written in last timer interval */ 169 struct timeval bwstart, bwend; 170 }; 171 172 void bandwidth_limit_init(struct bwlimit *, u_int64_t, size_t); 173 void bandwidth_limit(struct bwlimit *, size_t); 174 175 int parse_ipqos(const char *); 176 const char *iptos2str(int); 177 void mktemp_proto(char *, size_t); 178 179 void child_set_env(char ***envp, u_int *envsizep, const char *name, 180 const char *value); 181 182 int argv_split(const char *, int *, char ***); 183 char *argv_assemble(int, char **argv); 184 int exited_cleanly(pid_t, const char *, const char *, int); 185 186 struct stat; 187 int safe_path(const char *, struct stat *, const char *, uid_t, 188 char *, size_t); 189 int safe_path_fd(int, const char *, struct passwd *, 190 char *err, size_t errlen); 191 192 /* authorized_key-style options parsing helpers */ 193 int opt_flag(const char *opt, int allow_negate, const char **optsp); 194 char *opt_dequote(const char **sp, const char **errstrp); 195 int opt_match(const char **opts, const char *term); 196 197 /* readconf/servconf option lists */ 198 void opt_array_append(const char *file, const int line, 199 const char *directive, char ***array, u_int *lp, const char *s); 200 void opt_array_append2(const char *file, const int line, 201 const char *directive, char ***array, int **iarray, u_int *lp, 202 const char *s, int i); 203 204 /* readpass.c */ 205 206 #define RP_ECHO 0x0001 207 #define RP_ALLOW_STDIN 0x0002 208 #define RP_ALLOW_EOF 0x0004 209 #define RP_USE_ASKPASS 0x0008 210 211 struct notifier_ctx; 212 213 char *read_passphrase(const char *, int); 214 int ask_permission(const char *, ...) __attribute__((format(printf, 1, 2))); 215 struct notifier_ctx *notify_start(int, const char *, ...) 216 __attribute__((format(printf, 2, 3))); 217 void notify_complete(struct notifier_ctx *, const char *, ...) 218 __attribute__((format(printf, 2, 3))); 219 220 #define MINIMUM(a, b) (((a) < (b)) ? (a) : (b)) 221 #define MAXIMUM(a, b) (((a) > (b)) ? (a) : (b)) 222 #define ROUNDUP(x, y) ((((x)+((y)-1))/(y))*(y)) 223 224 typedef void (*sshsig_t)(int); 225 sshsig_t ssh_signal(int, sshsig_t); 226 227 #endif /* _MISC_H */ 228