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