crypto/openssh/misc.h

   1 /* $OpenBSD: misc.h,v 1.84 2020/01/24 23:54:40 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 #include <sys/socket.h>
  21
  22 /* Data structure for representing a forwarding request. */
  23 struct Forward {
  24         char     *listen_host;          /* Host (address) to listen on. */
  25         int       listen_port;          /* Port to forward. */
  26         char     *listen_path;          /* Path to bind domain socket. */
  27         char     *connect_host;         /* Host to connect. */
  28         int       connect_port;         /* Port to connect on connect_host. */
  29         char     *connect_path;         /* Path to connect domain socket. */
  30         int       allocated_port;       /* Dynamically allocated listen port */
  31         int       handle;               /* Handle for dynamic listen ports */
  32 };
  33
  34 int forward_equals(const struct Forward *, const struct Forward *);
  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 void    skip_space(char **);
  48 char    *strdelim(char **);
  49 char    *strdelimw(char **);
  50 int      set_nonblock(int);
  51 int      unset_nonblock(int);
  52 void     set_nodelay(int);
  53 int      set_reuseaddr(int);
  54 char    *get_rdomain(int);
  55 int      set_rdomain(int, const char *);
  56 int      waitrfd(int, int *);
  57 int      timeout_connect(int, const struct sockaddr *, socklen_t, int *);
  58 int      a2port(const char *);
  59 int      a2tun(const char *, int *);
  60 char    *put_host_port(const char *, u_short);
  61 char    *hpdelim2(char **, char *);
  62 char    *hpdelim(char **);
  63 char    *cleanhostname(char *);
  64 char    *colon(char *);
  65 int      parse_user_host_path(const char *, char **, char **, char **);
  66 int      parse_user_host_port(const char *, char **, char **, int *);
  67 int      parse_uri(const char *, const char *, char **, char **, int *, char **);
  68 long     convtime(const char *);
  69 char    *tilde_expand_filename(const char *, uid_t);
  70 char    *percent_expand(const char *, ...) __attribute__((__sentinel__));
  71 char    *tohex(const void *, size_t);
  72 void     xextendf(char **s, const char *sep, const char *fmt, ...)
  73     __attribute__((__format__ (printf, 3, 4))) __attribute__((__nonnull__ (3)));
  74 void     sanitise_stdfd(void);
  75 void     ms_subtract_diff(struct timeval *, int *);
  76 void     ms_to_timeval(struct timeval *, int);
  77 void     monotime_ts(struct timespec *);
  78 void     monotime_tv(struct timeval *);
  79 time_t   monotime(void);
  80 double   monotime_double(void);
  81 void     lowercase(char *s);
  82 int      unix_listener(const char *, int, int);
  83 int      valid_domain(char *, int, const char **);
  84 int      valid_env_name(const char *);
  85 const char *atoi_err(const char *, int *);
  86 int      parse_absolute_time(const char *, uint64_t *);
  87 void     format_absolute_time(uint64_t, char *, size_t);
  88 int      path_absolute(const char *);
  89
  90 void     sock_set_v6only(int);
  91
  92 struct passwd *pwcopy(struct passwd *);
  93 const char *ssh_gai_strerror(int);
  94
  95 typedef struct arglist arglist;
  96 struct arglist {
  97         char    **list;
  98         u_int   num;
  99         u_int   nalloc;
 100 };
 101 void     addargs(arglist *, char *, ...)
 102              __attribute__((format(printf, 2, 3)));
 103 void     replacearg(arglist *, u_int, char *, ...)
 104              __attribute__((format(printf, 3, 4)));
 105 void     freeargs(arglist *);
 106
 107 int      tun_open(int, int, char **);
 108
 109 /* Common definitions for ssh tunnel device forwarding */
 110 #define SSH_TUNMODE_NO          0x00
 111 #define SSH_TUNMODE_POINTOPOINT 0x01
 112 #define SSH_TUNMODE_ETHERNET    0x02
 113 #define SSH_TUNMODE_DEFAULT     SSH_TUNMODE_POINTOPOINT
 114 #define SSH_TUNMODE_YES         (SSH_TUNMODE_POINTOPOINT|SSH_TUNMODE_ETHERNET)
 115
 116 #define SSH_TUNID_ANY           0x7fffffff
 117 #define SSH_TUNID_ERR           (SSH_TUNID_ANY - 1)
 118 #define SSH_TUNID_MAX           (SSH_TUNID_ANY - 2)
 119
 120 /* Fake port to indicate that host field is really a path. */
 121 #define PORT_STREAMLOCAL        -2
 122
 123 /* Functions to extract or store big-endian words of various sizes */
 124 u_int64_t       get_u64(const void *)
 125     __attribute__((__bounded__( __minbytes__, 1, 8)));
 126 u_int32_t       get_u32(const void *)
 127     __attribute__((__bounded__( __minbytes__, 1, 4)));
 128 u_int16_t       get_u16(const void *)
 129     __attribute__((__bounded__( __minbytes__, 1, 2)));
 130 void            put_u64(void *, u_int64_t)
 131     __attribute__((__bounded__( __minbytes__, 1, 8)));
 132 void            put_u32(void *, u_int32_t)
 133     __attribute__((__bounded__( __minbytes__, 1, 4)));
 134 void            put_u16(void *, u_int16_t)
 135     __attribute__((__bounded__( __minbytes__, 1, 2)));
 136
 137 /* Little-endian store/load, used by umac.c */
 138 u_int32_t       get_u32_le(const void *)
 139     __attribute__((__bounded__(__minbytes__, 1, 4)));
 140 void            put_u32_le(void *, u_int32_t)
 141     __attribute__((__bounded__(__minbytes__, 1, 4)));
 142
 143 struct bwlimit {
 144         size_t buflen;
 145         u_int64_t rate;         /* desired rate in kbit/s */
 146         u_int64_t thresh;       /* threshold after which we'll check timers */
 147         u_int64_t lamt;         /* amount written in last timer interval */
 148         struct timeval bwstart, bwend;
 149 };
 150
 151 void bandwidth_limit_init(struct bwlimit *, u_int64_t, size_t);
 152 void bandwidth_limit(struct bwlimit *, size_t);
 153
 154 int parse_ipqos(const char *);
 155 const char *iptos2str(int);
 156 void mktemp_proto(char *, size_t);
 157
 158 void     child_set_env(char ***envp, u_int *envsizep, const char *name,
 159              const char *value);
 160
 161 int      argv_split(const char *, int *, char ***);
 162 char    *argv_assemble(int, char **argv);
 163 int      exited_cleanly(pid_t, const char *, const char *, int);
 164
 165 struct stat;
 166 int      safe_path(const char *, struct stat *, const char *, uid_t,
 167              char *, size_t);
 168 int      safe_path_fd(int, const char *, struct passwd *,
 169              char *err, size_t errlen);
 170
 171 /* authorized_key-style options parsing helpers */
 172 int     opt_flag(const char *opt, int allow_negate, const char **optsp);
 173 char    *opt_dequote(const char **sp, const char **errstrp);
 174 int     opt_match(const char **opts, const char *term);
 175
 176 /* readpass.c */
 177
 178 #define RP_ECHO                 0x0001
 179 #define RP_ALLOW_STDIN          0x0002
 180 #define RP_ALLOW_EOF            0x0004
 181 #define RP_USE_ASKPASS          0x0008
 182
 183 struct notifier_ctx;
 184
 185 char    *read_passphrase(const char *, int);
 186 int      ask_permission(const char *, ...) __attribute__((format(printf, 1, 2)));
 187 struct notifier_ctx *notify_start(int, const char *, ...)
 188         __attribute__((format(printf, 2, 3)));
 189 void    notify_complete(struct notifier_ctx *);
 190
 191 #define MINIMUM(a, b)   (((a) < (b)) ? (a) : (b))
 192 #define MAXIMUM(a, b)   (((a) > (b)) ? (a) : (b))
 193 #define ROUNDUP(x, y)   ((((x)+((y)-1))/(y))*(y))
 194
 195 typedef void (*sshsig_t)(int);
 196 sshsig_t ssh_signal(int, sshsig_t);
 197 #endif /* _MISC_H */