Home | History | Annotate | Line # | Download | only in dist
misc.h revision 1.4 
      1 /*	$NetBSD: misc.h,v 1.4 2011/07/25 03:03:10 christos Exp $	*/
      2 /* $OpenBSD: misc.h,v 1.47 2010/11/21 01:01:13 djm Exp $ */
      3 
      4 /*
      5  * Author: Tatu Ylonen <ylo (at) cs.hut.fi>
      6  * Copyright (c) 1995 Tatu Ylonen <ylo (at) 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 *, ...)
     35 #if __GNUC_PREREQ__(4, 0)
     36     __attribute__((__sentinel__))
     37 #endif
     38     ;
     39 char	*tohex(const void *, size_t);
     40 void	 sanitise_stdfd(void);
     41 void	 ms_subtract_diff(struct timeval *, int *);
     42 void	 ms_to_timeval(struct timeval *, int);
     43 
     44 int	 timingsafe_bcmp(const void *, const void *, size_t);
     45 long long strtonum(const char *, long long, long long, const char **);
     46 
     47 struct passwd *pwcopy(struct passwd *);
     48 const char *ssh_gai_strerror(int);
     49 
     50 typedef struct arglist arglist;
     51 struct arglist {
     52 	char    **list;
     53 	u_int   num;
     54 	u_int   nalloc;
     55 };
     56 void	 addargs(arglist *, const char *, ...)
     57 	     __attribute__((format(printf, 2, 3)));
     58 void	 replacearg(arglist *, u_int, const char *, ...)
     59 	     __attribute__((format(printf, 3, 4)));
     60 void	 freeargs(arglist *);
     61 
     62 int	 tun_open(int, int);
     63 
     64 /* Common definitions for ssh tunnel device forwarding */
     65 #define SSH_TUNMODE_NO		0x00
     66 #define SSH_TUNMODE_POINTOPOINT	0x01
     67 #define SSH_TUNMODE_ETHERNET	0x02
     68 #define SSH_TUNMODE_DEFAULT	SSH_TUNMODE_POINTOPOINT
     69 #define SSH_TUNMODE_YES		(SSH_TUNMODE_POINTOPOINT|SSH_TUNMODE_ETHERNET)
     70 
     71 #define SSH_TUNID_ANY		0x7fffffff
     72 #define SSH_TUNID_ERR		(SSH_TUNID_ANY - 1)
     73 #define SSH_TUNID_MAX		(SSH_TUNID_ANY - 2)
     74 
     75 /* Functions to extract or store big-endian words of various sizes */
     76 u_int64_t	get_u64(const void *)
     77 #ifdef __OpenBSD__
     78     __attribute__((__bounded__( __minbytes__, 1, 8)))
     79 #endif
     80     ;
     81 u_int32_t	get_u32(const void *)
     82 #ifdef __OpenBSD__
     83     __attribute__((__bounded__( __minbytes__, 1, 4)))
     84 #endif
     85     ;
     86 u_int16_t	get_u16(const void *)
     87 #ifdef __OpenBSD__
     88     __attribute__((__bounded__( __minbytes__, 1, 2)))
     89 #endif
     90     ;
     91 void		put_u64(void *, u_int64_t)
     92 #ifdef __OpenBSD__
     93     __attribute__((__bounded__( __minbytes__, 1, 8)))
     94 #endif
     95     ;
     96 void		put_u32(void *, u_int32_t)
     97 #ifdef __OpenBSD__
     98     __attribute__((__bounded__( __minbytes__, 1, 4)))
     99 #endif
    100     ;
    101 void		put_u16(void *, u_int16_t)
    102 #ifdef __OpenBSD__
    103     __attribute__((__bounded__( __minbytes__, 1, 2)))
    104 #endif
    105     ;
    106 
    107 struct bwlimit {
    108 	size_t buflen;
    109 	u_int64_t rate, thresh, lamt;
    110 	struct timeval bwstart, bwend;
    111 };
    112 
    113 void bandwidth_limit_init(struct bwlimit *, u_int64_t, size_t);
    114 void bandwidth_limit(struct bwlimit *, size_t);
    115 
    116 int parse_ipqos(const char *);
    117 void mktemp_proto(char *, size_t);
    118 
    119 /* readpass.c */
    120 
    121 #define RP_ECHO			0x0001
    122 #define RP_ALLOW_STDIN		0x0002
    123 #define RP_ALLOW_EOF		0x0004
    124 #define RP_USE_ASKPASS		0x0008
    125 
    126 char	*read_passphrase(const char *, int);
    127 int	 ask_permission(const char *, ...) __attribute__((format(printf, 1, 2)));
    128 int	 read_keyfile_line(FILE *, const char *, char *, size_t, u_long *);
    129 
    130 #endif /* _MISC_H */
    131