misc.h revision 224638 
1/* $OpenBSD: misc.h,v 1.47 2010/11/21 01:01:13 djm 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);
39void	 sock_set_v6only(int);
40void	 sock_get_rcvbuf(int *, int);
41
42struct passwd *pwcopy(struct passwd *);
43const char *ssh_gai_strerror(int);
44
45typedef struct arglist arglist;
46struct arglist {
47	char    **list;
48	u_int   num;
49	u_int   nalloc;
50};
51void	 addargs(arglist *, char *, ...)
52	     __attribute__((format(printf, 2, 3)));
53void	 replacearg(arglist *, u_int, char *, ...)
54	     __attribute__((format(printf, 3, 4)));
55void	 freeargs(arglist *);
56
57int	 tun_open(int, int);
58
59/* Common definitions for ssh tunnel device forwarding */
60#define SSH_TUNMODE_NO		0x00
61#define SSH_TUNMODE_POINTOPOINT	0x01
62#define SSH_TUNMODE_ETHERNET	0x02
63#define SSH_TUNMODE_DEFAULT	SSH_TUNMODE_POINTOPOINT
64#define SSH_TUNMODE_YES		(SSH_TUNMODE_POINTOPOINT|SSH_TUNMODE_ETHERNET)
65
66#define SSH_TUNID_ANY		0x7fffffff
67#define SSH_TUNID_ERR		(SSH_TUNID_ANY - 1)
68#define SSH_TUNID_MAX		(SSH_TUNID_ANY - 2)
69
70/* Functions to extract or store big-endian words of various sizes */
71u_int64_t	get_u64(const void *)
72    __attribute__((__bounded__( __minbytes__, 1, 8)));
73u_int32_t	get_u32(const void *)
74    __attribute__((__bounded__( __minbytes__, 1, 4)));
75u_int16_t	get_u16(const void *)
76    __attribute__((__bounded__( __minbytes__, 1, 2)));
77void		put_u64(void *, u_int64_t)
78    __attribute__((__bounded__( __minbytes__, 1, 8)));
79void		put_u32(void *, u_int32_t)
80    __attribute__((__bounded__( __minbytes__, 1, 4)));
81void		put_u16(void *, u_int16_t)
82    __attribute__((__bounded__( __minbytes__, 1, 2)));
83
84struct bwlimit {
85	size_t buflen;
86	u_int64_t rate, thresh, lamt;
87	struct timeval bwstart, bwend;
88};
89
90void bandwidth_limit_init(struct bwlimit *, u_int64_t, size_t);
91void bandwidth_limit(struct bwlimit *, size_t);
92
93int parse_ipqos(const char *);
94void mktemp_proto(char *, size_t);
95
96/* readpass.c */
97
98#define RP_ECHO			0x0001
99#define RP_ALLOW_STDIN		0x0002
100#define RP_ALLOW_EOF		0x0004
101#define RP_USE_ASKPASS		0x0008
102
103char	*read_passphrase(const char *, int);
104int	 ask_permission(const char *, ...) __attribute__((format(printf, 1, 2)));
105int	 read_keyfile_line(FILE *, const char *, char *, size_t, u_long *);
106
107#endif /* _MISC_H */
108