1/* $OpenBSD: misc.h,v 1.49 2013/06/01 13:15:52 dtucker Exp $ */
2/* $FreeBSD$ */
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/* misc.c */
20
21char	*chop(char *);
22char	*strdelim(char **);
23int	 set_nonblock(int);
24int	 unset_nonblock(int);
25void	 set_nodelay(int);
26int	 a2port(const char *);
27int	 a2tun(const char *, int *);
28char	*put_host_port(const char *, u_short);
29char	*hpdelim(char **);
30char	*cleanhostname(char *);
31char	*colon(char *);
32long	 convtime(const char *);
33char	*tilde_expand_filename(const char *, uid_t);
34char	*percent_expand(const char *, ...) __attribute__((__sentinel__));
35char	*tohex(const void *, size_t);
36void	 sanitise_stdfd(void);
37void	 ms_subtract_diff(struct timeval *, int *);
38void	 ms_to_timeval(struct timeval *, int);
39time_t	 monotime(void);
40void	 sock_set_v6only(int);
41void	 sock_get_rcvbuf(int *, int);
42
43struct passwd *pwcopy(struct passwd *);
44const char *ssh_gai_strerror(int);
45
46typedef struct arglist arglist;
47struct arglist {
48	char    **list;
49	u_int   num;
50	u_int   nalloc;
51};
52void	 addargs(arglist *, char *, ...)
53	     __attribute__((format(printf, 2, 3)));
54void	 replacearg(arglist *, u_int, char *, ...)
55	     __attribute__((format(printf, 3, 4)));
56void	 freeargs(arglist *);
57
58int	 tun_open(int, int);
59
60/* Common definitions for ssh tunnel device forwarding */
61#define SSH_TUNMODE_NO		0x00
62#define SSH_TUNMODE_POINTOPOINT	0x01
63#define SSH_TUNMODE_ETHERNET	0x02
64#define SSH_TUNMODE_DEFAULT	SSH_TUNMODE_POINTOPOINT
65#define SSH_TUNMODE_YES		(SSH_TUNMODE_POINTOPOINT|SSH_TUNMODE_ETHERNET)
66
67#define SSH_TUNID_ANY		0x7fffffff
68#define SSH_TUNID_ERR		(SSH_TUNID_ANY - 1)
69#define SSH_TUNID_MAX		(SSH_TUNID_ANY - 2)
70
71/* Functions to extract or store big-endian words of various sizes */
72u_int64_t	get_u64(const void *)
73    __attribute__((__bounded__( __minbytes__, 1, 8)));
74u_int32_t	get_u32(const void *)
75    __attribute__((__bounded__( __minbytes__, 1, 4)));
76u_int16_t	get_u16(const void *)
77    __attribute__((__bounded__( __minbytes__, 1, 2)));
78void		put_u64(void *, u_int64_t)
79    __attribute__((__bounded__( __minbytes__, 1, 8)));
80void		put_u32(void *, u_int32_t)
81    __attribute__((__bounded__( __minbytes__, 1, 4)));
82void		put_u16(void *, u_int16_t)
83    __attribute__((__bounded__( __minbytes__, 1, 2)));
84
85struct bwlimit {
86	size_t buflen;
87	u_int64_t rate, thresh, lamt;
88	struct timeval bwstart, bwend;
89};
90
91void bandwidth_limit_init(struct bwlimit *, u_int64_t, size_t);
92void bandwidth_limit(struct bwlimit *, size_t);
93
94int parse_ipqos(const char *);
95const char *iptos2str(int);
96void mktemp_proto(char *, size_t);
97
98/* readpass.c */
99
100#define RP_ECHO			0x0001
101#define RP_ALLOW_STDIN		0x0002
102#define RP_ALLOW_EOF		0x0004
103#define RP_USE_ASKPASS		0x0008
104
105char	*read_passphrase(const char *, int);
106int	 ask_permission(const char *, ...) __attribute__((format(printf, 1, 2)));
107int	 read_keyfile_line(FILE *, const char *, char *, size_t, u_long *);
108
109#endif /* _MISC_H */
110