blob: 47177d838c53974a81c4944ab25b2d72f2b7dc2a [file] [log] [blame]
djm@openbsd.org0a843d92018-12-27 03:25:24 +00001/* $OpenBSD: misc.h,v 1.78 2018/12/27 03:25:25 djm Exp $ */
Ben Lindstrom36579d32001-01-29 07:39:26 +00002
Ben Lindstrom226cfa02001-01-22 05:34:40 +00003/*
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 Lindstrom226cfa02001-01-22 05:34:40 +000014
Damien Miller3f941882006-03-31 23:13:02 +110015#ifndef _MISC_H
16#define _MISC_H
17
guenther@openbsd.org5bcc1e22016-08-27 04:05:12 +000018#include <sys/time.h>
djm@openbsd.orgde4ae072017-08-18 05:36:45 +000019#include <sys/types.h>
djm@openbsd.org0a843d92018-12-27 03:25:24 +000020#include <sys/socket.h>
guenther@openbsd.org5bcc1e22016-08-27 04:05:12 +000021
Damien Miller7acefbb2014-07-18 14:11:24 +100022/* Data structure for representing a forwarding request. */
23struct 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.org0ccbd5e2016-04-06 06:42:17 +000034int forward_equals(const struct Forward *, const struct Forward *);
dtucker@openbsd.org7fc47662016-11-30 00:28:31 +000035int daemonized(void);
djm@openbsd.org0ccbd5e2016-04-06 06:42:17 +000036
Damien Miller7acefbb2014-07-18 14:11:24 +100037/* Common server and client forwarding options. */
38struct 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 Tuckere608ca22004-05-13 16:15:47 +100044/* misc.c */
45
Kevin Stevesd009ae32001-07-04 17:25:54 +000046char *chop(char *);
47char *strdelim(char **);
djm@openbsd.org7082bb52018-06-09 03:01:12 +000048char *strdelimw(char **);
Damien Miller232711f2004-06-15 10:35:30 +100049int set_nonblock(int);
50int unset_nonblock(int);
Damien Miller398e1cf2002-02-05 11:52:13 +110051void set_nodelay(int);
djm@openbsd.orgacf559e2017-10-25 00:15:35 +000052int set_reuseaddr(int);
djm@openbsd.org35eb33f2017-10-25 00:17:08 +000053char *get_rdomain(int);
djm@openbsd.orgacf559e2017-10-25 00:15:35 +000054int set_rdomain(int, const char *);
djm@openbsd.org0a843d92018-12-27 03:25:24 +000055int waitrfd(int, int *);
56int timeout_connect(int, const struct sockaddr *, socklen_t, int *);
Kevin Stevesd009ae32001-07-04 17:25:54 +000057int a2port(const char *);
Damien Millerd27b9472005-12-13 19:29:02 +110058int a2tun(const char *, int *);
Darren Tuckerda345532006-07-10 23:04:19 +100059char *put_host_port(const char *, u_short);
Damien Millerf91ee4c2005-03-01 21:24:33 +110060char *hpdelim(char **);
Kevin Stevesd009ae32001-07-04 17:25:54 +000061char *cleanhostname(char *);
62char *colon(char *);
millert@openbsd.org887669e2017-10-21 23:06:24 +000063int parse_user_host_path(const char *, char **, char **, char **);
djm@openbsd.orged877ef2016-07-15 00:24:30 +000064int parse_user_host_port(const char *, char **, char **, int *);
millert@openbsd.org887669e2017-10-21 23:06:24 +000065int parse_uri(const char *, const char *, char **, char **, int *, char **);
Kevin Stevesd009ae32001-07-04 17:25:54 +000066long convtime(const char *);
Damien Miller5fd38c02005-05-26 12:02:14 +100067char *tilde_expand_filename(const char *, uid_t);
Darren Tucker8e2eb302005-07-14 17:07:21 +100068char *percent_expand(const char *, ...) __attribute__((__sentinel__));
Damien Miller3f941882006-03-31 23:13:02 +110069char *tohex(const void *, size_t);
Darren Tuckerce321d82005-10-03 18:11:24 +100070void sanitise_stdfd(void);
Darren Tucker3fc464e2008-06-13 06:42:45 +100071void ms_subtract_diff(struct timeval *, int *);
72void ms_to_timeval(struct timeval *, int);
dtucker@openbsd.org@openbsd.org5db6fbf2017-11-25 06:46:22 +000073void monotime_ts(struct timespec *);
74void monotime_tv(struct timeval *);
Darren Tuckerb759c9c2013-06-02 07:46:16 +100075time_t monotime(void);
dtucker@openbsd.orgb8d4eaf2016-03-02 22:42:40 +000076double monotime_double(void);
Damien Millere9fc72e2013-10-15 12:14:12 +110077void lowercase(char *s);
Damien Miller7acefbb2014-07-18 14:11:24 +100078int unix_listener(const char *, int, int);
millert@openbsd.org887669e2017-10-21 23:06:24 +000079int valid_domain(char *, int, const char **);
djm@openbsd.org5eff5b82018-10-03 06:38:35 +000080int valid_env_name(const char *);
dtucker@openbsd.org609d96b2017-12-05 23:59:47 +000081const char *atoi_err(const char *, int *);
djm@openbsd.orgbf0fbf22018-03-12 00:52:01 +000082int parse_absolute_time(const char *, uint64_t *);
83void format_absolute_time(uint64_t, char *, size_t);
djm@openbsd.org2a358622018-11-16 03:26:01 +000084int path_absolute(const char *);
Damien Millere9fc72e2013-10-15 12:14:12 +110085
Damien Miller04ee0f82009-11-18 17:48:30 +110086void sock_set_v6only(int);
Kevin Stevesd009ae32001-07-04 17:25:54 +000087
88struct passwd *pwcopy(struct passwd *);
Darren Tucker4abde772007-12-29 02:43:51 +110089const char *ssh_gai_strerror(int);
Ben Lindstrom226cfa02001-01-22 05:34:40 +000090
Ben Lindstrom387c4722001-05-08 20:27:25 +000091typedef struct arglist arglist;
92struct arglist {
Ben Lindstrom6328ab32002-03-22 02:54:23 +000093 char **list;
Darren Tuckerc7a6fc42004-08-13 21:18:00 +100094 u_int num;
95 u_int nalloc;
Ben Lindstrom387c4722001-05-08 20:27:25 +000096};
Damien Miller3eec6b72006-01-31 21:49:27 +110097void addargs(arglist *, char *, ...)
98 __attribute__((format(printf, 2, 3)));
99void replacearg(arglist *, u_int, char *, ...)
100 __attribute__((format(printf, 3, 4)));
101void freeargs(arglist *);
Darren Tucker06f2bd82004-05-13 16:06:46 +1000102
djm@openbsd.orgb7548b12017-10-23 05:08:00 +0000103int tun_open(int, int, char **);
Damien Miller7b58e802005-12-13 19:33:19 +1100104
105/* Common definitions for ssh tunnel device forwarding */
106#define SSH_TUNMODE_NO 0x00
107#define SSH_TUNMODE_POINTOPOINT 0x01
108#define SSH_TUNMODE_ETHERNET 0x02
109#define SSH_TUNMODE_DEFAULT SSH_TUNMODE_POINTOPOINT
110#define SSH_TUNMODE_YES (SSH_TUNMODE_POINTOPOINT|SSH_TUNMODE_ETHERNET)
111
112#define SSH_TUNID_ANY 0x7fffffff
113#define SSH_TUNID_ERR (SSH_TUNID_ANY - 1)
114#define SSH_TUNID_MAX (SSH_TUNID_ANY - 2)
Damien Miller3f941882006-03-31 23:13:02 +1100115
Damien Miller7acefbb2014-07-18 14:11:24 +1000116/* Fake port to indicate that host field is really a path. */
117#define PORT_STREAMLOCAL -2
118
Damien Miller3f941882006-03-31 23:13:02 +1100119/* Functions to extract or store big-endian words of various sizes */
120u_int64_t get_u64(const void *)
Damien Miller686c7d92014-05-15 14:37:03 +1000121 __attribute__((__bounded__( __minbytes__, 1, 8)));
Damien Miller3f941882006-03-31 23:13:02 +1100122u_int32_t get_u32(const void *)
Damien Miller686c7d92014-05-15 14:37:03 +1000123 __attribute__((__bounded__( __minbytes__, 1, 4)));
Damien Miller3f941882006-03-31 23:13:02 +1100124u_int16_t get_u16(const void *)
Damien Miller686c7d92014-05-15 14:37:03 +1000125 __attribute__((__bounded__( __minbytes__, 1, 2)));
Damien Miller3f941882006-03-31 23:13:02 +1100126void put_u64(void *, u_int64_t)
Damien Miller686c7d92014-05-15 14:37:03 +1000127 __attribute__((__bounded__( __minbytes__, 1, 8)));
Damien Miller3f941882006-03-31 23:13:02 +1100128void put_u32(void *, u_int32_t)
Damien Miller686c7d92014-05-15 14:37:03 +1000129 __attribute__((__bounded__( __minbytes__, 1, 4)));
Damien Miller3f941882006-03-31 23:13:02 +1100130void put_u16(void *, u_int16_t)
Damien Miller686c7d92014-05-15 14:37:03 +1000131 __attribute__((__bounded__( __minbytes__, 1, 2)));
Damien Miller3f941882006-03-31 23:13:02 +1100132
Damien Miller88856692014-04-20 13:33:19 +1000133/* Little-endian store/load, used by umac.c */
134u_int32_t get_u32_le(const void *)
Damien Miller686c7d92014-05-15 14:37:03 +1000135 __attribute__((__bounded__(__minbytes__, 1, 4)));
Damien Miller88856692014-04-20 13:33:19 +1000136void put_u32_le(void *, u_int32_t)
Damien Miller686c7d92014-05-15 14:37:03 +1000137 __attribute__((__bounded__(__minbytes__, 1, 4)));
Damien Miller88856692014-04-20 13:33:19 +1000138
Damien Miller65e42f82010-09-24 22:15:11 +1000139struct bwlimit {
140 size_t buflen;
dtucker@openbsd.org434b5872018-12-07 04:36:09 +0000141 u_int64_t rate; /* desired rate in kbit/s */
142 u_int64_t thresh; /* threshold after which we'll check timers */
143 u_int64_t lamt; /* amount written in last timer interval */
Damien Miller65e42f82010-09-24 22:15:11 +1000144 struct timeval bwstart, bwend;
145};
146
147void bandwidth_limit_init(struct bwlimit *, u_int64_t, size_t);
148void bandwidth_limit(struct bwlimit *, size_t);
149
Damien Miller0dac6fb2010-11-20 15:19:38 +1100150int parse_ipqos(const char *);
Damien Miller91475862011-05-05 14:14:34 +1000151const char *iptos2str(int);
Damien Miller2cd62932010-12-01 11:50:35 +1100152void mktemp_proto(char *, size_t);
Damien Miller3f941882006-03-31 23:13:02 +1100153
djm@openbsd.orgde4ae072017-08-18 05:36:45 +0000154void child_set_env(char ***envp, u_int *envsizep, const char *name,
155 const char *value);
156
157int argv_split(const char *, int *, char ***);
158char *argv_assemble(int, char **argv);
djm@openbsd.orgb074c3c2017-08-18 05:48:04 +0000159int exited_cleanly(pid_t, const char *, const char *, int);
djm@openbsd.orgde4ae072017-08-18 05:36:45 +0000160
djm@openbsd.orgde4ae072017-08-18 05:36:45 +0000161struct stat;
162int safe_path(const char *, struct stat *, const char *, uid_t,
163 char *, size_t);
164int safe_path_fd(int, const char *, struct passwd *,
165 char *err, size_t errlen);
166
Damien Millerbdf00ca2006-08-19 00:33:05 +1000167/* readpass.c */
168
169#define RP_ECHO 0x0001
170#define RP_ALLOW_STDIN 0x0002
171#define RP_ALLOW_EOF 0x0004
172#define RP_USE_ASKPASS 0x0008
173
174char *read_passphrase(const char *, int);
175int ask_permission(const char *, ...) __attribute__((format(printf, 1, 2)));
Damien Millerbdf00ca2006-08-19 00:33:05 +1000176
deraadt@openbsd.org9136ec12016-09-12 01:22:38 +0000177#define MINIMUM(a, b) (((a) < (b)) ? (a) : (b))
178#define MAXIMUM(a, b) (((a) > (b)) ? (a) : (b))
179#define ROUNDUP(x, y) ((((x)+((y)-1))/(y))*(y))
180
Damien Millerbdf00ca2006-08-19 00:33:05 +1000181#endif /* _MISC_H */