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