crypto/openssh/misc.h

   1 /* $OpenBSD: misc.h,v 1.63 2017/08/18 05:48:04 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 #include <sys/time.h>
  19 #include <sys/types.h>
  20
  21 /* Data structure for representing a forwarding request. */
  22 struct Forward {
  23         char     *listen_host;          /* Host (address) to listen on. */
  24         int       listen_port;          /* Port to forward. */
  25         char     *listen_path;          /* Path to bind domain socket. */
  26         char     *connect_host;         /* Host to connect. */
  27         int       connect_port;         /* Port to connect on connect_host. */
  28         char     *connect_path;         /* Path to connect domain socket. */
  29         int       allocated_port;       /* Dynamically allocated listen port */
  30         int       handle;               /* Handle for dynamic listen ports */
  31 };
  32
  33 int forward_equals(const struct Forward *, const struct Forward *);
  34 int bind_permitted(int, uid_t);
  35 int daemonized(void);
  36
  37 /* Common server and client forwarding options. */
  38 struct ForwardOptions {
  39         int      gateway_ports; /* Allow remote connects to forwarded ports. */
  40         mode_t   streamlocal_bind_mask; /* umask for streamlocal binds */
  41         int      streamlocal_bind_unlink; /* unlink socket before bind */
  42 };
  43
  44 /* misc.c */
  45
  46 char    *chop(char *);
  47 char    *strdelim(char **);
  48 int      set_nonblock(int);
  49 int      unset_nonblock(int);
  50 void     set_nodelay(int);
  51 int      a2port(const char *);
  52 int      a2tun(const char *, int *);
  53 char    *put_host_port(const char *, u_short);
  54 char    *hpdelim(char **);
  55 char    *cleanhostname(char *);
  56 char    *colon(char *);
  57 int      parse_user_host_port(const char *, char **, char **, int *);
  58 long     convtime(const char *);
  59 char    *tilde_expand_filename(const char *, uid_t);
  60 char    *percent_expand(const char *, ...) __attribute__((__sentinel__));
  61 char    *tohex(const void *, size_t);
  62 void     sanitise_stdfd(void);
  63 void     ms_subtract_diff(struct timeval *, int *);
  64 void     ms_to_timeval(struct timeval *, int);
  65 time_t   monotime(void);
  66 double   monotime_double(void);
  67 void     lowercase(char *s);
  68 int      unix_listener(const char *, int, int);
  69
  70 void     sock_set_v6only(int);
  71
  72 struct passwd *pwcopy(struct passwd *);
  73 const char *ssh_gai_strerror(int);
  74
  75 typedef struct arglist arglist;
  76 struct arglist {
  77         char    **list;
  78         u_int   num;
  79         u_int   nalloc;
  80 };
  81 void     addargs(arglist *, char *, ...)
  82              __attribute__((format(printf, 2, 3)));
  83 void     replacearg(arglist *, u_int, char *, ...)
  84              __attribute__((format(printf, 3, 4)));
  85 void     freeargs(arglist *);
  86
  87 int      tun_open(int, int);
  88
  89 /* Common definitions for ssh tunnel device forwarding */
  90 #define SSH_TUNMODE_NO          0x00
  91 #define SSH_TUNMODE_POINTOPOINT 0x01
  92 #define SSH_TUNMODE_ETHERNET    0x02
  93 #define SSH_TUNMODE_DEFAULT     SSH_TUNMODE_POINTOPOINT
  94 #define SSH_TUNMODE_YES         (SSH_TUNMODE_POINTOPOINT|SSH_TUNMODE_ETHERNET)
  95
  96 #define SSH_TUNID_ANY           0x7fffffff
  97 #define SSH_TUNID_ERR           (SSH_TUNID_ANY - 1)
  98 #define SSH_TUNID_MAX           (SSH_TUNID_ANY - 2)
  99
 100 /* Fake port to indicate that host field is really a path. */
 101 #define PORT_STREAMLOCAL        -2
 102
 103 /* Functions to extract or store big-endian words of various sizes */
 104 u_int64_t       get_u64(const void *)
 105     __attribute__((__bounded__( __minbytes__, 1, 8)));
 106 u_int32_t       get_u32(const void *)
 107     __attribute__((__bounded__( __minbytes__, 1, 4)));
 108 u_int16_t       get_u16(const void *)
 109     __attribute__((__bounded__( __minbytes__, 1, 2)));
 110 void            put_u64(void *, u_int64_t)
 111     __attribute__((__bounded__( __minbytes__, 1, 8)));
 112 void            put_u32(void *, u_int32_t)
 113     __attribute__((__bounded__( __minbytes__, 1, 4)));
 114 void            put_u16(void *, u_int16_t)
 115     __attribute__((__bounded__( __minbytes__, 1, 2)));
 116
 117 /* Little-endian store/load, used by umac.c */
 118 u_int32_t       get_u32_le(const void *)
 119     __attribute__((__bounded__(__minbytes__, 1, 4)));
 120 void            put_u32_le(void *, u_int32_t)
 121     __attribute__((__bounded__(__minbytes__, 1, 4)));
 122
 123 struct bwlimit {
 124         size_t buflen;
 125         u_int64_t rate, thresh, lamt;
 126         struct timeval bwstart, bwend;
 127 };
 128
 129 void bandwidth_limit_init(struct bwlimit *, u_int64_t, size_t);
 130 void bandwidth_limit(struct bwlimit *, size_t);
 131
 132 int parse_ipqos(const char *);
 133 const char *iptos2str(int);
 134 void mktemp_proto(char *, size_t);
 135
 136 void     child_set_env(char ***envp, u_int *envsizep, const char *name,
 137              const char *value);
 138
 139 int      argv_split(const char *, int *, char ***);
 140 char    *argv_assemble(int, char **argv);
 141 int      exited_cleanly(pid_t, const char *, const char *, int);
 142
 143 #define SSH_SUBPROCESS_STDOUT_DISCARD   (1)     /* Discard stdout */
 144 #define SSH_SUBPROCESS_STDOUT_CAPTURE   (1<<1)  /* Redirect stdout */
 145 #define SSH_SUBPROCESS_STDERR_DISCARD   (1<<2)  /* Discard stderr */
 146 pid_t    subprocess(const char *, struct passwd *,
 147     const char *, int, char **, FILE **, u_int flags);
 148
 149 struct stat;
 150 int      safe_path(const char *, struct stat *, const char *, uid_t,
 151              char *, size_t);
 152 int      safe_path_fd(int, const char *, struct passwd *,
 153              char *err, size_t errlen);
 154
 155 /* readpass.c */
 156
 157 #define RP_ECHO                 0x0001
 158 #define RP_ALLOW_STDIN          0x0002
 159 #define RP_ALLOW_EOF            0x0004
 160 #define RP_USE_ASKPASS          0x0008
 161
 162 char    *read_passphrase(const char *, int);
 163 int      ask_permission(const char *, ...) __attribute__((format(printf, 1, 2)));
 164 int      read_keyfile_line(FILE *, const char *, char *, size_t, u_long *);
 165
 166 #define MINIMUM(a, b)   (((a) < (b)) ? (a) : (b))
 167 #define MAXIMUM(a, b)   (((a) > (b)) ? (a) : (b))
 168 #define ROUNDUP(x, y)   ((((x)+((y)-1))/(y))*(y))
 169
 170 #endif /* _MISC_H */