1/* $NetBSD: misc.h,v 1.16 2019/04/20 17:16:40 christos Exp $ */
2/* $OpenBSD: misc.h,v 1.79 2019/01/23 21:50:56 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#include <sys/types.h>
21#include <sys/socket.h>
22
23/* Data structure for representing a forwarding request. */
24struct Forward {
25 char *listen_host; /* Host (address) to listen on. */
26 int listen_port; /* Port to forward. */
27 char *listen_path; /* Path to bind domain socket. */
28 char *connect_host; /* Host to connect. */
29 int connect_port; /* Port to connect on connect_host. */
30 char *connect_path; /* Path to connect domain socket. */
31 int allocated_port; /* Dynamically allocated listen port */
32 int handle; /* Handle for dynamic listen ports */
33};
34
35int forward_equals(const struct Forward *, const struct Forward *);
36int daemonized(void);
37
38/* Common server and client forwarding options. */
39struct ForwardOptions {
40 int gateway_ports; /* Allow remote connects to forwarded ports. */
41 mode_t streamlocal_bind_mask; /* umask for streamlocal binds */
42 int streamlocal_bind_unlink; /* unlink socket before bind */
43};
44
45/* misc.c */
46
47char *chop(char *);
48char *strdelim(char **);
49char *strdelimw(char **);
50int set_nonblock(int);
51int unset_nonblock(int);
52void set_nodelay(int);
53int set_reuseaddr(int);
54char *get_rdomain(int);
55int set_rdomain(int, const char *);
56int waitrfd(int, int *);
57int timeout_connect(int, const struct sockaddr *, socklen_t, int *);
58int a2port(const char *);
59int a2tun(const char *, int *);
60char *put_host_port(const char *, u_short);
61char *hpdelim2(char **, char *);
62char *hpdelim(char **);
63char *cleanhostname(char *);
64char *colon(char *);
65int parse_user_host_path(const char *, char **, char **, const char **);
66int parse_user_host_port(const char *, char **, char **, int *);
67int parse_uri(const char *, const char *, char **, char **, int *, const char **);
68long convtime(const char *);
69char *tilde_expand_filename(const char *, uid_t);
70char *percent_expand(const char *, ...)
71#if __GNUC_PREREQ__(4, 0)
72 __attribute__((__sentinel__))
73#endif
74 ;
75char *tohex(const void *, size_t);
76void sanitise_stdfd(void);
77struct timeval;
78void ms_subtract_diff(struct timeval *, int *);
79void ms_to_timeval(struct timeval *, int);
80void monotime_ts(struct timespec *);
81void monotime_tv(struct timeval *);
82time_t monotime(void);
83double monotime_double(void);
84void lowercase(char *s);
85int unix_listener(const char *, int, int);
86int valid_domain(char *, int, const char **);
87int valid_env_name(const char *);
88const char *atoi_err(const char *, int *);
89int parse_absolute_time(const char *, uint64_t *);
90void format_absolute_time(uint64_t, char *, size_t);
91int path_absolute(const char *);
92
93int bcrypt_pbkdf(const char *, size_t, const u_int8_t *, size_t,
94 u_int8_t *, size_t, unsigned int);
95
96struct passwd *pwcopy(struct passwd *);
97const char *ssh_gai_strerror(int);
98
99typedef struct arglist arglist;
100struct arglist {
101 char **list;
102 u_int num;
103 u_int nalloc;
104};
105void addargs(arglist *, const char *, ...)
106 __attribute__((format(printf, 2, 3)));
107void replacearg(arglist *, u_int, const char *, ...)
108 __attribute__((format(printf, 3, 4)));
109void freeargs(arglist *);
110
111int tun_open(int, int, char **);
112
113/* Common definitions for ssh tunnel device forwarding */
114#define SSH_TUNMODE_NO 0x00
115#define SSH_TUNMODE_POINTOPOINT 0x01
116#define SSH_TUNMODE_ETHERNET 0x02
117#define SSH_TUNMODE_DEFAULT SSH_TUNMODE_POINTOPOINT
118#define SSH_TUNMODE_YES (SSH_TUNMODE_POINTOPOINT|SSH_TUNMODE_ETHERNET)
119
120#define SSH_TUNID_ANY 0x7fffffff
121#define SSH_TUNID_ERR (SSH_TUNID_ANY - 1)
122#define SSH_TUNID_MAX (SSH_TUNID_ANY - 2)
123
124/* Fake port to indicate that host field is really a path. */
125#define PORT_STREAMLOCAL -2
126
127/* Functions to extract or store big-endian words of various sizes */
128u_int64_t get_u64(const void *)
129 __attribute__((__bounded__( __minbytes__, 1, 8)));
130u_int32_t get_u32(const void *)
131 __attribute__((__bounded__( __minbytes__, 1, 4)));
132u_int16_t get_u16(const void *)
133 __attribute__((__bounded__( __minbytes__, 1, 2)));
134void put_u64(void *, u_int64_t)
135 __attribute__((__bounded__( __minbytes__, 1, 8)));
136void put_u32(void *, u_int32_t)
137 __attribute__((__bounded__( __minbytes__, 1, 4)));
138void put_u16(void *, u_int16_t)
139 __attribute__((__bounded__( __minbytes__, 1, 2)));
140
141/* Little-endian store/load, used by umac.c */
142u_int32_t get_u32_le(const void *)
143 __attribute__((__bounded__(__minbytes__, 1, 4)));
144void put_u32_le(void *, u_int32_t)
145 __attribute__((__bounded__(__minbytes__, 1, 4)));
146
147struct bwlimit {
148 size_t buflen;
149 u_int64_t rate; /* desired rate in kbit/s */
150 u_int64_t thresh; /* threshold after which we'll check timers */
151 u_int64_t lamt; /* amount written in last timer interval */
152 struct timeval bwstart, bwend;
153};
154
155void bandwidth_limit_init(struct bwlimit *, u_int64_t, size_t);
156void bandwidth_limit(struct bwlimit *, size_t);
157
158int parse_ipqos(const char *);
159const char *iptos2str(int);
160void mktemp_proto(char *, size_t);
161
162void child_set_env(char ***envp, u_int *envsizep, const char *name,
163 const char *value);
164
165int argv_split(const char *, int *, char ***);
166char *argv_assemble(int, char **argv);
167int exited_cleanly(pid_t, const char *, const char *, int);
168
169struct stat;
170int safe_path(const char *, struct stat *, const char *, uid_t,
171 char *, size_t);
172int safe_path_fd(int, const char *, struct passwd *,
173 char *err, size_t errlen);
174
175/* readpass.c */
176
177#define RP_ECHO 0x0001
178#define RP_ALLOW_STDIN 0x0002
179#define RP_ALLOW_EOF 0x0004
180#define RP_USE_ASKPASS 0x0008
181
182char *read_passphrase(const char *, int);
183int ask_permission(const char *, ...) __attribute__((format(printf, 1, 2)));
184
185#define MINIMUM(a, b) (((a) < (b)) ? (a) : (b))
186#define MAXIMUM(a, b) (((a) > (b)) ? (a) : (b))
187#define ROUNDUP(x, y) ((((x)+((y)-1))/(y))*(y))
188
189#endif /* _MISC_H */
190