misc.h revision 295367 
1/* $OpenBSD: misc.h,v 1.54 2014/07/15 15:54:14 millert 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/* Data structure for representing a forwarding request. */
19struct Forward {
20	char	 *listen_host;		/* Host (address) to listen on. */
21	int	  listen_port;		/* Port to forward. */
22	char	 *listen_path;		/* Path to bind domain socket. */
23	char	 *connect_host;		/* Host to connect. */
24	int	  connect_port;		/* Port to connect on connect_host. */
25	char	 *connect_path;		/* Path to connect domain socket. */
26	int	  allocated_port;	/* Dynamically allocated listen port */
27	int	  handle;		/* Handle for dynamic listen ports */
28};
29
30/* Common server and client forwarding options. */
31struct ForwardOptions {
32	int	 gateway_ports; /* Allow remote connects to forwarded ports. */
33	mode_t	 streamlocal_bind_mask; /* umask for streamlocal binds */
34	int	 streamlocal_bind_unlink; /* unlink socket before bind */
35};
36
37/* misc.c */
38
39char	*chop(char *);
40char	*strdelim(char **);
41int	 set_nonblock(int);
42int	 unset_nonblock(int);
43void	 set_nodelay(int);
44int	 a2port(const char *);
45int	 a2tun(const char *, int *);
46char	*put_host_port(const char *, u_short);
47char	*hpdelim(char **);
48char	*cleanhostname(char *);
49char	*colon(char *);
50long	 convtime(const char *);
51char	*tilde_expand_filename(const char *, uid_t);
52char	*percent_expand(const char *, ...) __attribute__((__sentinel__));
53char	*tohex(const void *, size_t);
54void	 sanitise_stdfd(void);
55void	 ms_subtract_diff(struct timeval *, int *);
56void	 ms_to_timeval(struct timeval *, int);
57time_t	 monotime(void);
58void	 lowercase(char *s);
59int	 unix_listener(const char *, int, int);
60
61void	 sock_set_v6only(int);
62
63struct passwd *pwcopy(struct passwd *);
64const char *ssh_gai_strerror(int);
65
66typedef struct arglist arglist;
67struct arglist {
68	char    **list;
69	u_int   num;
70	u_int   nalloc;
71};
72void	 addargs(arglist *, char *, ...)
73	     __attribute__((format(printf, 2, 3)));
74void	 replacearg(arglist *, u_int, char *, ...)
75	     __attribute__((format(printf, 3, 4)));
76void	 freeargs(arglist *);
77
78int	 tun_open(int, int);
79
80/* Common definitions for ssh tunnel device forwarding */
81#define SSH_TUNMODE_NO		0x00
82#define SSH_TUNMODE_POINTOPOINT	0x01
83#define SSH_TUNMODE_ETHERNET	0x02
84#define SSH_TUNMODE_DEFAULT	SSH_TUNMODE_POINTOPOINT
85#define SSH_TUNMODE_YES		(SSH_TUNMODE_POINTOPOINT|SSH_TUNMODE_ETHERNET)
86
87#define SSH_TUNID_ANY		0x7fffffff
88#define SSH_TUNID_ERR		(SSH_TUNID_ANY - 1)
89#define SSH_TUNID_MAX		(SSH_TUNID_ANY - 2)
90
91/* Fake port to indicate that host field is really a path. */
92#define PORT_STREAMLOCAL	-2
93
94/* Functions to extract or store big-endian words of various sizes */
95u_int64_t	get_u64(const void *)
96    __attribute__((__bounded__( __minbytes__, 1, 8)));
97u_int32_t	get_u32(const void *)
98    __attribute__((__bounded__( __minbytes__, 1, 4)));
99u_int16_t	get_u16(const void *)
100    __attribute__((__bounded__( __minbytes__, 1, 2)));
101void		put_u64(void *, u_int64_t)
102    __attribute__((__bounded__( __minbytes__, 1, 8)));
103void		put_u32(void *, u_int32_t)
104    __attribute__((__bounded__( __minbytes__, 1, 4)));
105void		put_u16(void *, u_int16_t)
106    __attribute__((__bounded__( __minbytes__, 1, 2)));
107
108/* Little-endian store/load, used by umac.c */
109u_int32_t	get_u32_le(const void *)
110    __attribute__((__bounded__(__minbytes__, 1, 4)));
111void		put_u32_le(void *, u_int32_t)
112    __attribute__((__bounded__(__minbytes__, 1, 4)));
113
114struct bwlimit {
115	size_t buflen;
116	u_int64_t rate, thresh, lamt;
117	struct timeval bwstart, bwend;
118};
119
120void bandwidth_limit_init(struct bwlimit *, u_int64_t, size_t);
121void bandwidth_limit(struct bwlimit *, size_t);
122
123int parse_ipqos(const char *);
124const char *iptos2str(int);
125void mktemp_proto(char *, size_t);
126
127/* readpass.c */
128
129#define RP_ECHO			0x0001
130#define RP_ALLOW_STDIN		0x0002
131#define RP_ALLOW_EOF		0x0004
132#define RP_USE_ASKPASS		0x0008
133
134char	*read_passphrase(const char *, int);
135int	 ask_permission(const char *, ...) __attribute__((format(printf, 1, 2)));
136int	 read_keyfile_line(FILE *, const char *, char *, size_t, u_long *);
137
138#endif /* _MISC_H */
139