dtucker@openbsd.org | d05ea25 | 2019-01-23 21:50:56 +0000 | [diff] [blame] | 1 | /* $OpenBSD: misc.h,v 1.79 2019/01/23 21:50:56 dtucker Exp $ */ |
Ben Lindstrom | 36579d3 | 2001-01-29 07:39:26 +0000 | [diff] [blame] | 2 | |
Ben Lindstrom | 226cfa0 | 2001-01-22 05:34:40 +0000 | [diff] [blame] | 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 | */ |
Ben Lindstrom | 226cfa0 | 2001-01-22 05:34:40 +0000 | [diff] [blame] | 14 | |
Damien Miller | 3f94188 | 2006-03-31 23:13:02 +1100 | [diff] [blame] | 15 | #ifndef _MISC_H |
| 16 | #define _MISC_H |
| 17 | |
guenther@openbsd.org | 5bcc1e2 | 2016-08-27 04:05:12 +0000 | [diff] [blame] | 18 | #include <sys/time.h> |
djm@openbsd.org | de4ae07 | 2017-08-18 05:36:45 +0000 | [diff] [blame] | 19 | #include <sys/types.h> |
djm@openbsd.org | 0a843d9 | 2018-12-27 03:25:24 +0000 | [diff] [blame] | 20 | #include <sys/socket.h> |
guenther@openbsd.org | 5bcc1e2 | 2016-08-27 04:05:12 +0000 | [diff] [blame] | 21 | |
Damien Miller | 7acefbb | 2014-07-18 14:11:24 +1000 | [diff] [blame] | 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 | |
djm@openbsd.org | 0ccbd5e | 2016-04-06 06:42:17 +0000 | [diff] [blame] | 34 | int forward_equals(const struct Forward *, const struct Forward *); |
dtucker@openbsd.org | 7fc4766 | 2016-11-30 00:28:31 +0000 | [diff] [blame] | 35 | int daemonized(void); |
djm@openbsd.org | 0ccbd5e | 2016-04-06 06:42:17 +0000 | [diff] [blame] | 36 | |
Damien Miller | 7acefbb | 2014-07-18 14:11:24 +1000 | [diff] [blame] | 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 | |
Darren Tucker | e608ca2 | 2004-05-13 16:15:47 +1000 | [diff] [blame] | 44 | /* misc.c */ |
| 45 | |
Kevin Steves | d009ae3 | 2001-07-04 17:25:54 +0000 | [diff] [blame] | 46 | char *chop(char *); |
| 47 | char *strdelim(char **); |
djm@openbsd.org | 7082bb5 | 2018-06-09 03:01:12 +0000 | [diff] [blame] | 48 | char *strdelimw(char **); |
Damien Miller | 232711f | 2004-06-15 10:35:30 +1000 | [diff] [blame] | 49 | int set_nonblock(int); |
| 50 | int unset_nonblock(int); |
Damien Miller | 398e1cf | 2002-02-05 11:52:13 +1100 | [diff] [blame] | 51 | void set_nodelay(int); |
djm@openbsd.org | acf559e | 2017-10-25 00:15:35 +0000 | [diff] [blame] | 52 | int set_reuseaddr(int); |
djm@openbsd.org | 35eb33f | 2017-10-25 00:17:08 +0000 | [diff] [blame] | 53 | char *get_rdomain(int); |
djm@openbsd.org | acf559e | 2017-10-25 00:15:35 +0000 | [diff] [blame] | 54 | int set_rdomain(int, const char *); |
djm@openbsd.org | 0a843d9 | 2018-12-27 03:25:24 +0000 | [diff] [blame] | 55 | int waitrfd(int, int *); |
| 56 | int timeout_connect(int, const struct sockaddr *, socklen_t, int *); |
Kevin Steves | d009ae3 | 2001-07-04 17:25:54 +0000 | [diff] [blame] | 57 | int a2port(const char *); |
Damien Miller | d27b947 | 2005-12-13 19:29:02 +1100 | [diff] [blame] | 58 | int a2tun(const char *, int *); |
Darren Tucker | da34553 | 2006-07-10 23:04:19 +1000 | [diff] [blame] | 59 | char *put_host_port(const char *, u_short); |
dtucker@openbsd.org | d05ea25 | 2019-01-23 21:50:56 +0000 | [diff] [blame] | 60 | char *hpdelim2(char **, char *); |
Damien Miller | f91ee4c | 2005-03-01 21:24:33 +1100 | [diff] [blame] | 61 | char *hpdelim(char **); |
Kevin Steves | d009ae3 | 2001-07-04 17:25:54 +0000 | [diff] [blame] | 62 | char *cleanhostname(char *); |
| 63 | char *colon(char *); |
millert@openbsd.org | 887669e | 2017-10-21 23:06:24 +0000 | [diff] [blame] | 64 | int parse_user_host_path(const char *, char **, char **, char **); |
djm@openbsd.org | ed877ef | 2016-07-15 00:24:30 +0000 | [diff] [blame] | 65 | int parse_user_host_port(const char *, char **, char **, int *); |
millert@openbsd.org | 887669e | 2017-10-21 23:06:24 +0000 | [diff] [blame] | 66 | int parse_uri(const char *, const char *, char **, char **, int *, char **); |
Kevin Steves | d009ae3 | 2001-07-04 17:25:54 +0000 | [diff] [blame] | 67 | long convtime(const char *); |
Damien Miller | 5fd38c0 | 2005-05-26 12:02:14 +1000 | [diff] [blame] | 68 | char *tilde_expand_filename(const char *, uid_t); |
Darren Tucker | 8e2eb30 | 2005-07-14 17:07:21 +1000 | [diff] [blame] | 69 | char *percent_expand(const char *, ...) __attribute__((__sentinel__)); |
Damien Miller | 3f94188 | 2006-03-31 23:13:02 +1100 | [diff] [blame] | 70 | char *tohex(const void *, size_t); |
Darren Tucker | ce321d8 | 2005-10-03 18:11:24 +1000 | [diff] [blame] | 71 | void sanitise_stdfd(void); |
Darren Tucker | 3fc464e | 2008-06-13 06:42:45 +1000 | [diff] [blame] | 72 | void ms_subtract_diff(struct timeval *, int *); |
| 73 | void ms_to_timeval(struct timeval *, int); |
dtucker@openbsd.org@openbsd.org | 5db6fbf | 2017-11-25 06:46:22 +0000 | [diff] [blame] | 74 | void monotime_ts(struct timespec *); |
| 75 | void monotime_tv(struct timeval *); |
Darren Tucker | b759c9c | 2013-06-02 07:46:16 +1000 | [diff] [blame] | 76 | time_t monotime(void); |
dtucker@openbsd.org | b8d4eaf | 2016-03-02 22:42:40 +0000 | [diff] [blame] | 77 | double monotime_double(void); |
Damien Miller | e9fc72e | 2013-10-15 12:14:12 +1100 | [diff] [blame] | 78 | void lowercase(char *s); |
Damien Miller | 7acefbb | 2014-07-18 14:11:24 +1000 | [diff] [blame] | 79 | int unix_listener(const char *, int, int); |
millert@openbsd.org | 887669e | 2017-10-21 23:06:24 +0000 | [diff] [blame] | 80 | int valid_domain(char *, int, const char **); |
djm@openbsd.org | 5eff5b8 | 2018-10-03 06:38:35 +0000 | [diff] [blame] | 81 | int valid_env_name(const char *); |
dtucker@openbsd.org | 609d96b | 2017-12-05 23:59:47 +0000 | [diff] [blame] | 82 | const char *atoi_err(const char *, int *); |
djm@openbsd.org | bf0fbf2 | 2018-03-12 00:52:01 +0000 | [diff] [blame] | 83 | int parse_absolute_time(const char *, uint64_t *); |
| 84 | void format_absolute_time(uint64_t, char *, size_t); |
djm@openbsd.org | 2a35862 | 2018-11-16 03:26:01 +0000 | [diff] [blame] | 85 | int path_absolute(const char *); |
Damien Miller | e9fc72e | 2013-10-15 12:14:12 +1100 | [diff] [blame] | 86 | |
Damien Miller | 04ee0f8 | 2009-11-18 17:48:30 +1100 | [diff] [blame] | 87 | void sock_set_v6only(int); |
Kevin Steves | d009ae3 | 2001-07-04 17:25:54 +0000 | [diff] [blame] | 88 | |
| 89 | struct passwd *pwcopy(struct passwd *); |
Darren Tucker | 4abde77 | 2007-12-29 02:43:51 +1100 | [diff] [blame] | 90 | const char *ssh_gai_strerror(int); |
Ben Lindstrom | 226cfa0 | 2001-01-22 05:34:40 +0000 | [diff] [blame] | 91 | |
Ben Lindstrom | 387c472 | 2001-05-08 20:27:25 +0000 | [diff] [blame] | 92 | typedef struct arglist arglist; |
| 93 | struct arglist { |
Ben Lindstrom | 6328ab3 | 2002-03-22 02:54:23 +0000 | [diff] [blame] | 94 | char **list; |
Darren Tucker | c7a6fc4 | 2004-08-13 21:18:00 +1000 | [diff] [blame] | 95 | u_int num; |
| 96 | u_int nalloc; |
Ben Lindstrom | 387c472 | 2001-05-08 20:27:25 +0000 | [diff] [blame] | 97 | }; |
Damien Miller | 3eec6b7 | 2006-01-31 21:49:27 +1100 | [diff] [blame] | 98 | void addargs(arglist *, char *, ...) |
| 99 | __attribute__((format(printf, 2, 3))); |
| 100 | void replacearg(arglist *, u_int, char *, ...) |
| 101 | __attribute__((format(printf, 3, 4))); |
| 102 | void freeargs(arglist *); |
Darren Tucker | 06f2bd8 | 2004-05-13 16:06:46 +1000 | [diff] [blame] | 103 | |
djm@openbsd.org | b7548b1 | 2017-10-23 05:08:00 +0000 | [diff] [blame] | 104 | int tun_open(int, int, char **); |
Damien Miller | 7b58e80 | 2005-12-13 19:33:19 +1100 | [diff] [blame] | 105 | |
| 106 | /* Common definitions for ssh tunnel device forwarding */ |
| 107 | #define SSH_TUNMODE_NO 0x00 |
| 108 | #define SSH_TUNMODE_POINTOPOINT 0x01 |
| 109 | #define SSH_TUNMODE_ETHERNET 0x02 |
| 110 | #define SSH_TUNMODE_DEFAULT SSH_TUNMODE_POINTOPOINT |
| 111 | #define SSH_TUNMODE_YES (SSH_TUNMODE_POINTOPOINT|SSH_TUNMODE_ETHERNET) |
| 112 | |
| 113 | #define SSH_TUNID_ANY 0x7fffffff |
| 114 | #define SSH_TUNID_ERR (SSH_TUNID_ANY - 1) |
| 115 | #define SSH_TUNID_MAX (SSH_TUNID_ANY - 2) |
Damien Miller | 3f94188 | 2006-03-31 23:13:02 +1100 | [diff] [blame] | 116 | |
Damien Miller | 7acefbb | 2014-07-18 14:11:24 +1000 | [diff] [blame] | 117 | /* Fake port to indicate that host field is really a path. */ |
| 118 | #define PORT_STREAMLOCAL -2 |
| 119 | |
Damien Miller | 3f94188 | 2006-03-31 23:13:02 +1100 | [diff] [blame] | 120 | /* Functions to extract or store big-endian words of various sizes */ |
| 121 | u_int64_t get_u64(const void *) |
Damien Miller | 686c7d9 | 2014-05-15 14:37:03 +1000 | [diff] [blame] | 122 | __attribute__((__bounded__( __minbytes__, 1, 8))); |
Damien Miller | 3f94188 | 2006-03-31 23:13:02 +1100 | [diff] [blame] | 123 | u_int32_t get_u32(const void *) |
Damien Miller | 686c7d9 | 2014-05-15 14:37:03 +1000 | [diff] [blame] | 124 | __attribute__((__bounded__( __minbytes__, 1, 4))); |
Damien Miller | 3f94188 | 2006-03-31 23:13:02 +1100 | [diff] [blame] | 125 | u_int16_t get_u16(const void *) |
Damien Miller | 686c7d9 | 2014-05-15 14:37:03 +1000 | [diff] [blame] | 126 | __attribute__((__bounded__( __minbytes__, 1, 2))); |
Damien Miller | 3f94188 | 2006-03-31 23:13:02 +1100 | [diff] [blame] | 127 | void put_u64(void *, u_int64_t) |
Damien Miller | 686c7d9 | 2014-05-15 14:37:03 +1000 | [diff] [blame] | 128 | __attribute__((__bounded__( __minbytes__, 1, 8))); |
Damien Miller | 3f94188 | 2006-03-31 23:13:02 +1100 | [diff] [blame] | 129 | void put_u32(void *, u_int32_t) |
Damien Miller | 686c7d9 | 2014-05-15 14:37:03 +1000 | [diff] [blame] | 130 | __attribute__((__bounded__( __minbytes__, 1, 4))); |
Damien Miller | 3f94188 | 2006-03-31 23:13:02 +1100 | [diff] [blame] | 131 | void put_u16(void *, u_int16_t) |
Damien Miller | 686c7d9 | 2014-05-15 14:37:03 +1000 | [diff] [blame] | 132 | __attribute__((__bounded__( __minbytes__, 1, 2))); |
Damien Miller | 3f94188 | 2006-03-31 23:13:02 +1100 | [diff] [blame] | 133 | |
Damien Miller | 8885669 | 2014-04-20 13:33:19 +1000 | [diff] [blame] | 134 | /* Little-endian store/load, used by umac.c */ |
| 135 | u_int32_t get_u32_le(const void *) |
Damien Miller | 686c7d9 | 2014-05-15 14:37:03 +1000 | [diff] [blame] | 136 | __attribute__((__bounded__(__minbytes__, 1, 4))); |
Damien Miller | 8885669 | 2014-04-20 13:33:19 +1000 | [diff] [blame] | 137 | void put_u32_le(void *, u_int32_t) |
Damien Miller | 686c7d9 | 2014-05-15 14:37:03 +1000 | [diff] [blame] | 138 | __attribute__((__bounded__(__minbytes__, 1, 4))); |
Damien Miller | 8885669 | 2014-04-20 13:33:19 +1000 | [diff] [blame] | 139 | |
Damien Miller | 65e42f8 | 2010-09-24 22:15:11 +1000 | [diff] [blame] | 140 | struct bwlimit { |
| 141 | size_t buflen; |
dtucker@openbsd.org | 434b587 | 2018-12-07 04:36:09 +0000 | [diff] [blame] | 142 | u_int64_t rate; /* desired rate in kbit/s */ |
| 143 | u_int64_t thresh; /* threshold after which we'll check timers */ |
| 144 | u_int64_t lamt; /* amount written in last timer interval */ |
Damien Miller | 65e42f8 | 2010-09-24 22:15:11 +1000 | [diff] [blame] | 145 | struct timeval bwstart, bwend; |
| 146 | }; |
| 147 | |
| 148 | void bandwidth_limit_init(struct bwlimit *, u_int64_t, size_t); |
| 149 | void bandwidth_limit(struct bwlimit *, size_t); |
| 150 | |
Damien Miller | 0dac6fb | 2010-11-20 15:19:38 +1100 | [diff] [blame] | 151 | int parse_ipqos(const char *); |
Damien Miller | 9147586 | 2011-05-05 14:14:34 +1000 | [diff] [blame] | 152 | const char *iptos2str(int); |
Damien Miller | 2cd6293 | 2010-12-01 11:50:35 +1100 | [diff] [blame] | 153 | void mktemp_proto(char *, size_t); |
Damien Miller | 3f94188 | 2006-03-31 23:13:02 +1100 | [diff] [blame] | 154 | |
djm@openbsd.org | de4ae07 | 2017-08-18 05:36:45 +0000 | [diff] [blame] | 155 | void child_set_env(char ***envp, u_int *envsizep, const char *name, |
| 156 | const char *value); |
| 157 | |
| 158 | int argv_split(const char *, int *, char ***); |
| 159 | char *argv_assemble(int, char **argv); |
djm@openbsd.org | b074c3c | 2017-08-18 05:48:04 +0000 | [diff] [blame] | 160 | int exited_cleanly(pid_t, const char *, const char *, int); |
djm@openbsd.org | de4ae07 | 2017-08-18 05:36:45 +0000 | [diff] [blame] | 161 | |
djm@openbsd.org | de4ae07 | 2017-08-18 05:36:45 +0000 | [diff] [blame] | 162 | struct stat; |
| 163 | int safe_path(const char *, struct stat *, const char *, uid_t, |
| 164 | char *, size_t); |
| 165 | int safe_path_fd(int, const char *, struct passwd *, |
| 166 | char *err, size_t errlen); |
| 167 | |
Damien Miller | bdf00ca | 2006-08-19 00:33:05 +1000 | [diff] [blame] | 168 | /* readpass.c */ |
| 169 | |
| 170 | #define RP_ECHO 0x0001 |
| 171 | #define RP_ALLOW_STDIN 0x0002 |
| 172 | #define RP_ALLOW_EOF 0x0004 |
| 173 | #define RP_USE_ASKPASS 0x0008 |
| 174 | |
| 175 | char *read_passphrase(const char *, int); |
| 176 | int ask_permission(const char *, ...) __attribute__((format(printf, 1, 2))); |
Damien Miller | bdf00ca | 2006-08-19 00:33:05 +1000 | [diff] [blame] | 177 | |
deraadt@openbsd.org | 9136ec1 | 2016-09-12 01:22:38 +0000 | [diff] [blame] | 178 | #define MINIMUM(a, b) (((a) < (b)) ? (a) : (b)) |
| 179 | #define MAXIMUM(a, b) (((a) > (b)) ? (a) : (b)) |
| 180 | #define ROUNDUP(x, y) ((((x)+((y)-1))/(y))*(y)) |
| 181 | |
Damien Miller | bdf00ca | 2006-08-19 00:33:05 +1000 | [diff] [blame] | 182 | #endif /* _MISC_H */ |