1 /* $OpenBSD: misc.h,v 1.74 2018/07/27 05:13:02 dtucker Exp $ */
4 * Author: Tatu Ylonen <ylo@cs.hut.fi>
5 * Copyright (c) 1995 Tatu Ylonen <ylo@cs.hut.fi>, Espoo, Finland
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".
19 #include <sys/types.h>
21 /* Data structure for representing a forwarding request. */
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 */
33 int forward_equals(const struct Forward *, const struct Forward *);
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 */
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 *);
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 const char *atoi_err(const char *, int *);
78 int parse_absolute_time(const char *, uint64_t *);
79 void format_absolute_time(uint64_t, char *, size_t);
81 void sock_set_v6only(int);
83 struct passwd *pwcopy(struct passwd *);
84 const char *ssh_gai_strerror(int);
86 typedef struct arglist arglist;
92 void addargs(arglist *, char *, ...)
93 __attribute__((format(printf, 2, 3)));
94 void replacearg(arglist *, u_int, char *, ...)
95 __attribute__((format(printf, 3, 4)));
96 void freeargs(arglist *);
98 int tun_open(int, int, char **);
100 /* Common definitions for ssh tunnel device forwarding */
101 #define SSH_TUNMODE_NO 0x00
102 #define SSH_TUNMODE_POINTOPOINT 0x01
103 #define SSH_TUNMODE_ETHERNET 0x02
104 #define SSH_TUNMODE_DEFAULT SSH_TUNMODE_POINTOPOINT
105 #define SSH_TUNMODE_YES (SSH_TUNMODE_POINTOPOINT|SSH_TUNMODE_ETHERNET)
107 #define SSH_TUNID_ANY 0x7fffffff
108 #define SSH_TUNID_ERR (SSH_TUNID_ANY - 1)
109 #define SSH_TUNID_MAX (SSH_TUNID_ANY - 2)
111 /* Fake port to indicate that host field is really a path. */
112 #define PORT_STREAMLOCAL -2
114 /* Functions to extract or store big-endian words of various sizes */
115 u_int64_t get_u64(const void *)
116 __attribute__((__bounded__( __minbytes__, 1, 8)));
117 u_int32_t get_u32(const void *)
118 __attribute__((__bounded__( __minbytes__, 1, 4)));
119 u_int16_t get_u16(const void *)
120 __attribute__((__bounded__( __minbytes__, 1, 2)));
121 void put_u64(void *, u_int64_t)
122 __attribute__((__bounded__( __minbytes__, 1, 8)));
123 void put_u32(void *, u_int32_t)
124 __attribute__((__bounded__( __minbytes__, 1, 4)));
125 void put_u16(void *, u_int16_t)
126 __attribute__((__bounded__( __minbytes__, 1, 2)));
128 /* Little-endian store/load, used by umac.c */
129 u_int32_t get_u32_le(const void *)
130 __attribute__((__bounded__(__minbytes__, 1, 4)));
131 void put_u32_le(void *, u_int32_t)
132 __attribute__((__bounded__(__minbytes__, 1, 4)));
136 u_int64_t rate, thresh, lamt;
137 struct timeval bwstart, bwend;
140 void bandwidth_limit_init(struct bwlimit *, u_int64_t, size_t);
141 void bandwidth_limit(struct bwlimit *, size_t);
143 int parse_ipqos(const char *);
144 const char *iptos2str(int);
145 void mktemp_proto(char *, size_t);
147 void child_set_env(char ***envp, u_int *envsizep, const char *name,
150 int argv_split(const char *, int *, char ***);
151 char *argv_assemble(int, char **argv);
152 int exited_cleanly(pid_t, const char *, const char *, int);
155 int safe_path(const char *, struct stat *, const char *, uid_t,
157 int safe_path_fd(int, const char *, struct passwd *,
158 char *err, size_t errlen);
162 #define RP_ECHO 0x0001
163 #define RP_ALLOW_STDIN 0x0002
164 #define RP_ALLOW_EOF 0x0004
165 #define RP_USE_ASKPASS 0x0008
167 char *read_passphrase(const char *, int);
168 int ask_permission(const char *, ...) __attribute__((format(printf, 1, 2)));
170 #define MINIMUM(a, b) (((a) < (b)) ? (a) : (b))
171 #define MAXIMUM(a, b) (((a) > (b)) ? (a) : (b))
172 #define ROUNDUP(x, y) ((((x)+((y)-1))/(y))*(y))