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