1 /* $NetBSD: misc.h,v 1.11 2016/12/25 00:07:47 christos Exp $ */ 2 /* $OpenBSD: misc.h,v 1.61 2016/11/30 00:28:31 dtucker 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 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 bind_permitted(int, uid_t); 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 char *strdelim(char **); 48 int set_nonblock(int); 49 int unset_nonblock(int); 50 void set_nodelay(int); 51 int a2port(const char *); 52 int a2tun(const char *, int *); 53 char *put_host_port(const char *, u_short); 54 char *hpdelim(char **); 55 char *cleanhostname(char *); 56 char *colon(char *); 57 int parse_user_host_port(const char *, char **, char **, int *); 58 long convtime(const char *); 59 char *tilde_expand_filename(const char *, uid_t); 60 char *percent_expand(const char *, ...) 61 #if __GNUC_PREREQ__(4, 0) 62 __attribute__((__sentinel__)) 63 #endif 64 ; 65 char *tohex(const void *, size_t); 66 void sanitise_stdfd(void); 67 struct timeval; 68 void ms_subtract_diff(struct timeval *, int *); 69 void ms_to_timeval(struct timeval *, int); 70 time_t monotime(void); 71 double monotime_double(void); 72 void lowercase(char *s); 73 int unix_listener(const char *, int, int); 74 75 int bcrypt_pbkdf(const char *, size_t, const u_int8_t *, size_t, 76 u_int8_t *, size_t, unsigned int); 77 78 struct passwd *pwcopy(struct passwd *); 79 const char *ssh_gai_strerror(int); 80 81 typedef struct arglist arglist; 82 struct arglist { 83 char **list; 84 u_int num; 85 u_int nalloc; 86 }; 87 void addargs(arglist *, const char *, ...) 88 __attribute__((format(printf, 2, 3))); 89 void replacearg(arglist *, u_int, const char *, ...) 90 __attribute__((format(printf, 3, 4))); 91 void freeargs(arglist *); 92 93 int tun_open(int, int); 94 95 /* Common definitions for ssh tunnel device forwarding */ 96 #define SSH_TUNMODE_NO 0x00 97 #define SSH_TUNMODE_POINTOPOINT 0x01 98 #define SSH_TUNMODE_ETHERNET 0x02 99 #define SSH_TUNMODE_DEFAULT SSH_TUNMODE_POINTOPOINT 100 #define SSH_TUNMODE_YES (SSH_TUNMODE_POINTOPOINT|SSH_TUNMODE_ETHERNET) 101 102 #define SSH_TUNID_ANY 0x7fffffff 103 #define SSH_TUNID_ERR (SSH_TUNID_ANY - 1) 104 #define SSH_TUNID_MAX (SSH_TUNID_ANY - 2) 105 106 /* Fake port to indicate that host field is really a path. */ 107 #define PORT_STREAMLOCAL -2 108 109 /* Functions to extract or store big-endian words of various sizes */ 110 u_int64_t get_u64(const void *) 111 __attribute__((__bounded__( __minbytes__, 1, 8))); 112 u_int32_t get_u32(const void *) 113 __attribute__((__bounded__( __minbytes__, 1, 4))); 114 u_int16_t get_u16(const void *) 115 __attribute__((__bounded__( __minbytes__, 1, 2))); 116 void put_u64(void *, u_int64_t) 117 __attribute__((__bounded__( __minbytes__, 1, 8))); 118 void put_u32(void *, u_int32_t) 119 __attribute__((__bounded__( __minbytes__, 1, 4))); 120 void put_u16(void *, u_int16_t) 121 __attribute__((__bounded__( __minbytes__, 1, 2))); 122 123 /* Little-endian store/load, used by umac.c */ 124 u_int32_t get_u32_le(const void *) 125 __attribute__((__bounded__(__minbytes__, 1, 4))); 126 void put_u32_le(void *, u_int32_t) 127 __attribute__((__bounded__(__minbytes__, 1, 4))); 128 129 struct bwlimit { 130 size_t buflen; 131 u_int64_t rate, thresh, lamt; 132 struct timeval bwstart, bwend; 133 }; 134 135 void bandwidth_limit_init(struct bwlimit *, u_int64_t, size_t); 136 void bandwidth_limit(struct bwlimit *, size_t); 137 138 int parse_ipqos(const char *); 139 const char *iptos2str(int); 140 void mktemp_proto(char *, size_t); 141 142 /* readpass.c */ 143 144 #define RP_ECHO 0x0001 145 #define RP_ALLOW_STDIN 0x0002 146 #define RP_ALLOW_EOF 0x0004 147 #define RP_USE_ASKPASS 0x0008 148 149 char *read_passphrase(const char *, int); 150 int ask_permission(const char *, ...) __attribute__((format(printf, 1, 2))); 151 int read_keyfile_line(FILE *, const char *, char *, size_t, u_long *); 152 153 #define MINIMUM(a, b) (((a) < (b)) ? (a) : (b)) 154 #define MAXIMUM(a, b) (((a) > (b)) ? (a) : (b)) 155 #define ROUNDUP(x, y) ((((x)+((y)-1))/(y))*(y)) 156 157 #endif /* _MISC_H */ 158