• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1 /* $OpenBSD: misc.h,v 1.61 2016/11/30 00:28:31 dtucker Exp $ */
2 
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  */
14 
15 #ifndef _MISC_H
16 #define _MISC_H
17 
18 #include <sys/time.h>
19 
20 /* Data structure for representing a forwarding request. */
21 struct 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 
32 int forward_equals(const struct Forward *, const struct Forward *);
33 int bind_permitted(int, uid_t);
34 int daemonized(void);
35 
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 */
41 };
42 
43 /* misc.c */
44 
45 char	*chop(char *);
46 char	*strdelim(char **);
47 int	 set_nonblock(int);
48 int	 unset_nonblock(int);
49 void	 set_nodelay(int);
50 int	 a2port(const char *);
51 int	 a2tun(const char *, int *);
52 char	*put_host_port(const char *, u_short);
53 char	*hpdelim(char **);
54 char	*cleanhostname(char *);
55 char	*colon(char *);
56 int	 parse_user_host_port(const char *, char **, char **, int *);
57 long	 convtime(const char *);
58 char	*tilde_expand_filename(const char *, uid_t);
59 char	*percent_expand(const char *, ...) __attribute__((__sentinel__));
60 char	*tohex(const void *, size_t);
61 void	 sanitise_stdfd(void);
62 void	 ms_subtract_diff(struct timeval *, int *);
63 void	 ms_to_timeval(struct timeval *, int);
64 time_t	 monotime(void);
65 double	 monotime_double(void);
66 void	 lowercase(char *s);
67 int	 unix_listener(const char *, int, int);
68 
69 void	 sock_set_v6only(int);
70 
71 struct passwd *pwcopy(struct passwd *);
72 const char *ssh_gai_strerror(int);
73 
74 typedef struct arglist arglist;
75 struct arglist {
76 	char    **list;
77 	u_int   num;
78 	u_int   nalloc;
79 };
80 void	 addargs(arglist *, char *, ...)
81 	     __attribute__((format(printf, 2, 3)));
82 void	 replacearg(arglist *, u_int, char *, ...)
83 	     __attribute__((format(printf, 3, 4)));
84 void	 freeargs(arglist *);
85 
86 int	 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)
98 
99 /* Fake port to indicate that host field is really a path. */
100 #define PORT_STREAMLOCAL	-2
101 
102 /* Functions to extract or store big-endian words of various sizes */
103 u_int64_t	get_u64(const void *)
104     __attribute__((__bounded__( __minbytes__, 1, 8)));
105 u_int32_t	get_u32(const void *)
106     __attribute__((__bounded__( __minbytes__, 1, 4)));
107 u_int16_t	get_u16(const void *)
108     __attribute__((__bounded__( __minbytes__, 1, 2)));
109 void		put_u64(void *, u_int64_t)
110     __attribute__((__bounded__( __minbytes__, 1, 8)));
111 void		put_u32(void *, u_int32_t)
112     __attribute__((__bounded__( __minbytes__, 1, 4)));
113 void		put_u16(void *, u_int16_t)
114     __attribute__((__bounded__( __minbytes__, 1, 2)));
115 
116 /* Little-endian store/load, used by umac.c */
117 u_int32_t	get_u32_le(const void *)
118     __attribute__((__bounded__(__minbytes__, 1, 4)));
119 void		put_u32_le(void *, u_int32_t)
120     __attribute__((__bounded__(__minbytes__, 1, 4)));
121 
122 struct bwlimit {
123 	size_t buflen;
124 	u_int64_t rate, thresh, lamt;
125 	struct timeval bwstart, bwend;
126 };
127 
128 void bandwidth_limit_init(struct bwlimit *, u_int64_t, size_t);
129 void bandwidth_limit(struct bwlimit *, size_t);
130 
131 int parse_ipqos(const char *);
132 const char *iptos2str(int);
133 void mktemp_proto(char *, size_t);
134 
135 /* 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 
142 char	*read_passphrase(const char *, int);
143 int	 ask_permission(const char *, ...) __attribute__((format(printf, 1, 2)));
144 int	 read_keyfile_line(FILE *, const char *, char *, size_t, u_long *);
145 
146 #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 
150 #endif /* _MISC_H */
151