blob: c242f9011f592f694522effa849749e46f0f1af1 [file] [log] [blame]
dtucker@openbsd.org7fc47662016-11-30 00:28:31 +00001/* $OpenBSD: misc.h,v 1.61 2016/11/30 00:28:31 dtucker 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>
19
Damien Miller7acefbb2014-07-18 14:11:24 +100020/* Data structure for representing a forwarding request. */
21struct Forward {
22 char *listen_host; /* Host (address) to listen on. */
23 int listen_port; /* Port to forward. */
24 char *listen_path; /* Path to bind domain socket. */
25 char *connect_host; /* Host to connect. */
26 int connect_port; /* Port to connect on connect_host. */
27 char *connect_path; /* Path to connect domain socket. */
28 int allocated_port; /* Dynamically allocated listen port */
29 int handle; /* Handle for dynamic listen ports */
30};
31
djm@openbsd.org0ccbd5e2016-04-06 06:42:17 +000032int forward_equals(const struct Forward *, const struct Forward *);
dtucker@openbsd.org1c4ef0b2016-10-23 22:04:05 +000033int bind_permitted(int, uid_t);
dtucker@openbsd.org7fc47662016-11-30 00:28:31 +000034int daemonized(void);
djm@openbsd.org0ccbd5e2016-04-06 06:42:17 +000035
Damien Miller7acefbb2014-07-18 14:11:24 +100036/* Common server and client forwarding options. */
37struct 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
Darren Tuckere608ca22004-05-13 16:15:47 +100043/* misc.c */
44
Kevin Stevesd009ae32001-07-04 17:25:54 +000045char *chop(char *);
46char *strdelim(char **);
Damien Miller232711f2004-06-15 10:35:30 +100047int set_nonblock(int);
48int unset_nonblock(int);
Damien Miller398e1cf2002-02-05 11:52:13 +110049void set_nodelay(int);
Kevin Stevesd009ae32001-07-04 17:25:54 +000050int a2port(const char *);
Damien Millerd27b9472005-12-13 19:29:02 +110051int a2tun(const char *, int *);
Darren Tuckerda345532006-07-10 23:04:19 +100052char *put_host_port(const char *, u_short);
Damien Millerf91ee4c2005-03-01 21:24:33 +110053char *hpdelim(char **);
Kevin Stevesd009ae32001-07-04 17:25:54 +000054char *cleanhostname(char *);
55char *colon(char *);
djm@openbsd.orged877ef2016-07-15 00:24:30 +000056int parse_user_host_port(const char *, char **, char **, int *);
Kevin Stevesd009ae32001-07-04 17:25:54 +000057long convtime(const char *);
Damien Miller5fd38c02005-05-26 12:02:14 +100058char *tilde_expand_filename(const char *, uid_t);
Darren Tucker8e2eb302005-07-14 17:07:21 +100059char *percent_expand(const char *, ...) __attribute__((__sentinel__));
Damien Miller3f941882006-03-31 23:13:02 +110060char *tohex(const void *, size_t);
Darren Tuckerce321d82005-10-03 18:11:24 +100061void sanitise_stdfd(void);
Darren Tucker3fc464e2008-06-13 06:42:45 +100062void ms_subtract_diff(struct timeval *, int *);
63void ms_to_timeval(struct timeval *, int);
Darren Tuckerb759c9c2013-06-02 07:46:16 +100064time_t monotime(void);
dtucker@openbsd.orgb8d4eaf2016-03-02 22:42:40 +000065double monotime_double(void);
Damien Millere9fc72e2013-10-15 12:14:12 +110066void lowercase(char *s);
Damien Miller7acefbb2014-07-18 14:11:24 +100067int unix_listener(const char *, int, int);
Damien Millere9fc72e2013-10-15 12:14:12 +110068
Damien Miller04ee0f82009-11-18 17:48:30 +110069void sock_set_v6only(int);
Kevin Stevesd009ae32001-07-04 17:25:54 +000070
71struct passwd *pwcopy(struct passwd *);
Darren Tucker4abde772007-12-29 02:43:51 +110072const char *ssh_gai_strerror(int);
Ben Lindstrom226cfa02001-01-22 05:34:40 +000073
Ben Lindstrom387c4722001-05-08 20:27:25 +000074typedef struct arglist arglist;
75struct arglist {
Ben Lindstrom6328ab32002-03-22 02:54:23 +000076 char **list;
Darren Tuckerc7a6fc42004-08-13 21:18:00 +100077 u_int num;
78 u_int nalloc;
Ben Lindstrom387c4722001-05-08 20:27:25 +000079};
Damien Miller3eec6b72006-01-31 21:49:27 +110080void addargs(arglist *, char *, ...)
81 __attribute__((format(printf, 2, 3)));
82void replacearg(arglist *, u_int, char *, ...)
83 __attribute__((format(printf, 3, 4)));
84void freeargs(arglist *);
Darren Tucker06f2bd82004-05-13 16:06:46 +100085
Damien Miller7b58e802005-12-13 19:33:19 +110086int tun_open(int, int);
87
88/* Common definitions for ssh tunnel device forwarding */
89#define SSH_TUNMODE_NO 0x00
90#define SSH_TUNMODE_POINTOPOINT 0x01
91#define SSH_TUNMODE_ETHERNET 0x02
92#define SSH_TUNMODE_DEFAULT SSH_TUNMODE_POINTOPOINT
93#define SSH_TUNMODE_YES (SSH_TUNMODE_POINTOPOINT|SSH_TUNMODE_ETHERNET)
94
95#define SSH_TUNID_ANY 0x7fffffff
96#define SSH_TUNID_ERR (SSH_TUNID_ANY - 1)
97#define SSH_TUNID_MAX (SSH_TUNID_ANY - 2)
Damien Miller3f941882006-03-31 23:13:02 +110098
Damien Miller7acefbb2014-07-18 14:11:24 +100099/* Fake port to indicate that host field is really a path. */
100#define PORT_STREAMLOCAL -2
101
Damien Miller3f941882006-03-31 23:13:02 +1100102/* Functions to extract or store big-endian words of various sizes */
103u_int64_t get_u64(const void *)
Damien Miller686c7d92014-05-15 14:37:03 +1000104 __attribute__((__bounded__( __minbytes__, 1, 8)));
Damien Miller3f941882006-03-31 23:13:02 +1100105u_int32_t get_u32(const void *)
Damien Miller686c7d92014-05-15 14:37:03 +1000106 __attribute__((__bounded__( __minbytes__, 1, 4)));
Damien Miller3f941882006-03-31 23:13:02 +1100107u_int16_t get_u16(const void *)
Damien Miller686c7d92014-05-15 14:37:03 +1000108 __attribute__((__bounded__( __minbytes__, 1, 2)));
Damien Miller3f941882006-03-31 23:13:02 +1100109void put_u64(void *, u_int64_t)
Damien Miller686c7d92014-05-15 14:37:03 +1000110 __attribute__((__bounded__( __minbytes__, 1, 8)));
Damien Miller3f941882006-03-31 23:13:02 +1100111void put_u32(void *, u_int32_t)
Damien Miller686c7d92014-05-15 14:37:03 +1000112 __attribute__((__bounded__( __minbytes__, 1, 4)));
Damien Miller3f941882006-03-31 23:13:02 +1100113void put_u16(void *, u_int16_t)
Damien Miller686c7d92014-05-15 14:37:03 +1000114 __attribute__((__bounded__( __minbytes__, 1, 2)));
Damien Miller3f941882006-03-31 23:13:02 +1100115
Damien Miller88856692014-04-20 13:33:19 +1000116/* Little-endian store/load, used by umac.c */
117u_int32_t get_u32_le(const void *)
Damien Miller686c7d92014-05-15 14:37:03 +1000118 __attribute__((__bounded__(__minbytes__, 1, 4)));
Damien Miller88856692014-04-20 13:33:19 +1000119void put_u32_le(void *, u_int32_t)
Damien Miller686c7d92014-05-15 14:37:03 +1000120 __attribute__((__bounded__(__minbytes__, 1, 4)));
Damien Miller88856692014-04-20 13:33:19 +1000121
Damien Miller65e42f82010-09-24 22:15:11 +1000122struct bwlimit {
123 size_t buflen;
124 u_int64_t rate, thresh, lamt;
125 struct timeval bwstart, bwend;
126};
127
128void bandwidth_limit_init(struct bwlimit *, u_int64_t, size_t);
129void bandwidth_limit(struct bwlimit *, size_t);
130
Damien Miller0dac6fb2010-11-20 15:19:38 +1100131int parse_ipqos(const char *);
Damien Miller91475862011-05-05 14:14:34 +1000132const char *iptos2str(int);
Damien Miller2cd62932010-12-01 11:50:35 +1100133void mktemp_proto(char *, size_t);
Damien Miller3f941882006-03-31 23:13:02 +1100134
Damien Millerbdf00ca2006-08-19 00:33:05 +1000135/* readpass.c */
136
137#define RP_ECHO 0x0001
138#define RP_ALLOW_STDIN 0x0002
139#define RP_ALLOW_EOF 0x0004
140#define RP_USE_ASKPASS 0x0008
141
142char *read_passphrase(const char *, int);
143int ask_permission(const char *, ...) __attribute__((format(printf, 1, 2)));
144int read_keyfile_line(FILE *, const char *, char *, size_t, u_long *);
145
deraadt@openbsd.org9136ec12016-09-12 01:22:38 +0000146#define MINIMUM(a, b) (((a) < (b)) ? (a) : (b))
147#define MAXIMUM(a, b) (((a) > (b)) ? (a) : (b))
148#define ROUNDUP(x, y) ((((x)+((y)-1))/(y))*(y))
149
Damien Millerbdf00ca2006-08-19 00:33:05 +1000150#endif /* _MISC_H */