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