misc.h revision 181097 
1/* $OpenBSD: misc.h,v 1.36 2006/08/18 10:27:16 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
20char	*chop(char *);
21char	*strdelim(char **);
22int	 set_nonblock(int);
23int	 unset_nonblock(int);
24void	 set_nodelay(int);
25int	 a2port(const char *);
26int	 a2tun(const char *, int *);
27char	*put_host_port(const char *, u_short);
28char	*hpdelim(char **);
29char	*cleanhostname(char *);
30char	*colon(char *);
31long	 convtime(const char *);
32char	*tilde_expand_filename(const char *, uid_t);
33char	*percent_expand(const char *, ...) __attribute__((__sentinel__));
34char	*tohex(const void *, size_t);
35void	 sanitise_stdfd(void);
36
37struct passwd *pwcopy(struct passwd *);
38
39typedef struct arglist arglist;
40struct arglist {
41	char    **list;
42	u_int   num;
43	u_int   nalloc;
44};
45void	 addargs(arglist *, char *, ...)
46	     __attribute__((format(printf, 2, 3)));
47void	 replacearg(arglist *, u_int, char *, ...)
48	     __attribute__((format(printf, 3, 4)));
49void	 freeargs(arglist *);
50
51int	 tun_open(int, int);
52
53/* Common definitions for ssh tunnel device forwarding */
54#define SSH_TUNMODE_NO		0x00
55#define SSH_TUNMODE_POINTOPOINT	0x01
56#define SSH_TUNMODE_ETHERNET	0x02
57#define SSH_TUNMODE_DEFAULT	SSH_TUNMODE_POINTOPOINT
58#define SSH_TUNMODE_YES		(SSH_TUNMODE_POINTOPOINT|SSH_TUNMODE_ETHERNET)
59
60#define SSH_TUNID_ANY		0x7fffffff
61#define SSH_TUNID_ERR		(SSH_TUNID_ANY - 1)
62#define SSH_TUNID_MAX		(SSH_TUNID_ANY - 2)
63
64/* Functions to extract or store big-endian words of various sizes */
65u_int64_t	get_u64(const void *)
66    __attribute__((__bounded__( __minbytes__, 1, 8)));
67u_int32_t	get_u32(const void *)
68    __attribute__((__bounded__( __minbytes__, 1, 4)));
69u_int16_t	get_u16(const void *)
70    __attribute__((__bounded__( __minbytes__, 1, 2)));
71void		put_u64(void *, u_int64_t)
72    __attribute__((__bounded__( __minbytes__, 1, 8)));
73void		put_u32(void *, u_int32_t)
74    __attribute__((__bounded__( __minbytes__, 1, 4)));
75void		put_u16(void *, u_int16_t)
76    __attribute__((__bounded__( __minbytes__, 1, 2)));
77
78
79/* readpass.c */
80
81#define RP_ECHO			0x0001
82#define RP_ALLOW_STDIN		0x0002
83#define RP_ALLOW_EOF		0x0004
84#define RP_USE_ASKPASS		0x0008
85
86char	*read_passphrase(const char *, int);
87int	 ask_permission(const char *, ...) __attribute__((format(printf, 1, 2)));
88int	 read_keyfile_line(FILE *, const char *, char *, size_t, u_long *);
89
90#endif /* _MISC_H */
91