1 /* $OpenBSD: misc.h,v 1.75 2018/10/03 06:38:35 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 21 /* Data structure for representing a forwarding request. */ 22 struct Forward { 23 char *listen_host; /* Host (address) to listen on. */ 24 int listen_port; /* Port to forward. */ 25 char *listen_path; /* Path to bind domain socket. */ 26 char *connect_host; /* Host to connect. */ 27 int connect_port; /* Port to connect on connect_host. */ 28 char *connect_path; /* Path to connect domain socket. */ 29 int allocated_port; /* Dynamically allocated listen port */ 30 int handle; /* Handle for dynamic listen ports */ 31 }; 32 33 int forward_equals(const struct Forward *, const struct Forward *); 34 int daemonized(void); 35 36 /* Common server and client forwarding options. */ 37 struct ForwardOptions { 38 int gateway_ports; /* Allow remote connects to forwarded ports. */ 39 mode_t streamlocal_bind_mask; /* umask for streamlocal binds */ 40 int streamlocal_bind_unlink; /* unlink socket before bind */ 41 }; 42 43 /* misc.c */ 44 45 char *chop(char *); 46 char *strdelim(char **); 47 char *strdelimw(char **); 48 int set_nonblock(int); 49 int unset_nonblock(int); 50 void set_nodelay(int); 51 int set_reuseaddr(int); 52 char *get_rdomain(int); 53 int set_rdomain(int, const char *); 54 int a2port(const char *); 55 int a2tun(const char *, int *); 56 char *put_host_port(const char *, u_short); 57 char *hpdelim(char **); 58 char *cleanhostname(char *); 59 char *colon(char *); 60 int parse_user_host_path(const char *, char **, char **, char **); 61 int parse_user_host_port(const char *, char **, char **, int *); 62 int parse_uri(const char *, const char *, char **, char **, int *, char **); 63 long convtime(const char *); 64 char *tilde_expand_filename(const char *, uid_t); 65 char *percent_expand(const char *, ...) __attribute__((__sentinel__)); 66 char *tohex(const void *, size_t); 67 void sanitise_stdfd(void); 68 void ms_subtract_diff(struct timeval *, int *); 69 void ms_to_timeval(struct timeval *, int); 70 void monotime_ts(struct timespec *); 71 void monotime_tv(struct timeval *); 72 time_t monotime(void); 73 double monotime_double(void); 74 void lowercase(char *s); 75 int unix_listener(const char *, int, int); 76 int valid_domain(char *, int, const char **); 77 int valid_env_name(const char *); 78 const char *atoi_err(const char *, int *); 79 int parse_absolute_time(const char *, uint64_t *); 80 void format_absolute_time(uint64_t, char *, size_t); 81 82 struct passwd *pwcopy(struct passwd *); 83 const char *ssh_gai_strerror(int); 84 85 typedef struct arglist arglist; 86 struct arglist { 87 char **list; 88 u_int num; 89 u_int nalloc; 90 }; 91 void addargs(arglist *, char *, ...) 92 __attribute__((format(printf, 2, 3))); 93 void replacearg(arglist *, u_int, char *, ...) 94 __attribute__((format(printf, 3, 4))); 95 void freeargs(arglist *); 96 97 int tun_open(int, int, char **); 98 99 /* Common definitions for ssh tunnel device forwarding */ 100 #define SSH_TUNMODE_NO 0x00 101 #define SSH_TUNMODE_POINTOPOINT 0x01 102 #define SSH_TUNMODE_ETHERNET 0x02 103 #define SSH_TUNMODE_DEFAULT SSH_TUNMODE_POINTOPOINT 104 #define SSH_TUNMODE_YES (SSH_TUNMODE_POINTOPOINT|SSH_TUNMODE_ETHERNET) 105 106 #define SSH_TUNID_ANY 0x7fffffff 107 #define SSH_TUNID_ERR (SSH_TUNID_ANY - 1) 108 #define SSH_TUNID_MAX (SSH_TUNID_ANY - 2) 109 110 /* Fake port to indicate that host field is really a path. */ 111 #define PORT_STREAMLOCAL -2 112 113 /* Functions to extract or store big-endian words of various sizes */ 114 u_int64_t get_u64(const void *) 115 __attribute__((__bounded__( __minbytes__, 1, 8))); 116 u_int32_t get_u32(const void *) 117 __attribute__((__bounded__( __minbytes__, 1, 4))); 118 u_int16_t get_u16(const void *) 119 __attribute__((__bounded__( __minbytes__, 1, 2))); 120 void put_u64(void *, u_int64_t) 121 __attribute__((__bounded__( __minbytes__, 1, 8))); 122 void put_u32(void *, u_int32_t) 123 __attribute__((__bounded__( __minbytes__, 1, 4))); 124 void put_u16(void *, u_int16_t) 125 __attribute__((__bounded__( __minbytes__, 1, 2))); 126 127 /* Little-endian store/load, used by umac.c */ 128 u_int32_t get_u32_le(const void *) 129 __attribute__((__bounded__(__minbytes__, 1, 4))); 130 void put_u32_le(void *, u_int32_t) 131 __attribute__((__bounded__(__minbytes__, 1, 4))); 132 133 struct bwlimit { 134 size_t buflen; 135 u_int64_t rate, thresh, lamt; 136 struct timeval bwstart, bwend; 137 }; 138 139 void bandwidth_limit_init(struct bwlimit *, u_int64_t, size_t); 140 void bandwidth_limit(struct bwlimit *, size_t); 141 142 int parse_ipqos(const char *); 143 const char *iptos2str(int); 144 void mktemp_proto(char *, size_t); 145 146 void child_set_env(char ***envp, u_int *envsizep, const char *name, 147 const char *value); 148 149 int argv_split(const char *, int *, char ***); 150 char *argv_assemble(int, char **argv); 151 int exited_cleanly(pid_t, const char *, const char *, int); 152 153 struct stat; 154 int safe_path(const char *, struct stat *, const char *, uid_t, 155 char *, size_t); 156 int safe_path_fd(int, const char *, struct passwd *, 157 char *err, size_t errlen); 158 159 /* readpass.c */ 160 161 #define RP_ECHO 0x0001 162 #define RP_ALLOW_STDIN 0x0002 163 #define RP_ALLOW_EOF 0x0004 164 #define RP_USE_ASKPASS 0x0008 165 166 char *read_passphrase(const char *, int); 167 int ask_permission(const char *, ...) __attribute__((format(printf, 1, 2))); 168 169 #define MINIMUM(a, b) (((a) < (b)) ? (a) : (b)) 170 #define MAXIMUM(a, b) (((a) > (b)) ? (a) : (b)) 171 #define ROUNDUP(x, y) ((((x)+((y)-1))/(y))*(y)) 172 173 #endif /* _MISC_H */ 174