crypto/openssh/misc.h

   1 /* $OpenBSD: misc.h,v 1.109 2024/06/06 17:15:25 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 #include <stdio.h>
  22 #include <signal.h>
  23
  24 /* special-case port number meaning allow any port */
  25 #define FWD_PERMIT_ANY_PORT     0
  26
  27 /* special-case wildcard meaning allow any host */
  28 #define FWD_PERMIT_ANY_HOST     "*"
  29
  30 /* Data structure for representing a forwarding request. */
  31 struct Forward {
  32         char     *listen_host;          /* Host (address) to listen on. */
  33         int       listen_port;          /* Port to forward. */
  34         char     *listen_path;          /* Path to bind domain socket. */
  35         char     *connect_host;         /* Host to connect. */
  36         int       connect_port;         /* Port to connect on connect_host. */
  37         char     *connect_path;         /* Path to connect domain socket. */
  38         int       allocated_port;       /* Dynamically allocated listen port */
  39         int       handle;               /* Handle for dynamic listen ports */
  40 };
  41
  42 int forward_equals(const struct Forward *, const struct Forward *);
  43 int permitopen_port(const char *p);
  44
  45 int daemonized(void);
  46
  47 /* Common server and client forwarding options. */
  48 struct ForwardOptions {
  49         int      gateway_ports; /* Allow remote connects to forwarded ports. */
  50         mode_t   streamlocal_bind_mask; /* umask for streamlocal binds */
  51         int      streamlocal_bind_unlink; /* unlink socket before bind */
  52 };
  53
  54 /* misc.c */
  55
  56 char    *chop(char *);
  57 void     rtrim(char *);
  58 void    skip_space(char **);
  59 char    *strdelim(char **);
  60 char    *strdelimw(char **);
  61 int      set_nonblock(int);
  62 int      unset_nonblock(int);
  63 void     set_nodelay(int);
  64 int      set_reuseaddr(int);
  65 char    *get_rdomain(int);
  66 int      set_rdomain(int, const char *);
  67 int      get_sock_af(int);
  68 void     set_sock_tos(int, int);
  69 int      waitrfd(int, int *, volatile sig_atomic_t *);
  70 int      timeout_connect(int, const struct sockaddr *, socklen_t, int *);
  71 int      a2port(const char *);
  72 int      a2tun(const char *, int *);
  73 char    *put_host_port(const char *, u_short);
  74 char    *hpdelim2(char **, char *);
  75 char    *hpdelim(char **);
  76 char    *cleanhostname(char *);
  77 char    *colon(char *);
  78 int      parse_user_host_path(const char *, char **, char **, char **);
  79 int      parse_user_host_port(const char *, char **, char **, int *);
  80 int      parse_uri(const char *, const char *, char **, char **, int *, char **);
  81 int      convtime(const char *);
  82 const char *fmt_timeframe(time_t t);
  83 int      tilde_expand(const char *, uid_t, char **);
  84 char    *tilde_expand_filename(const char *, uid_t);
  85
  86 char    *dollar_expand(int *, const char *string, ...);
  87 char    *percent_expand(const char *, ...) __attribute__((__sentinel__));
  88 char    *percent_dollar_expand(const char *, ...) __attribute__((__sentinel__));
  89 char    *tohex(const void *, size_t);
  90 void     xextendf(char **s, const char *sep, const char *fmt, ...)
  91     __attribute__((__format__ (printf, 3, 4))) __attribute__((__nonnull__ (3)));
  92 void     sanitise_stdfd(void);
  93 void     ms_subtract_diff(struct timeval *, int *);
  94 void     ms_to_timespec(struct timespec *, int);
  95 void     monotime_ts(struct timespec *);
  96 void     monotime_tv(struct timeval *);
  97 time_t   monotime(void);
  98 double   monotime_double(void);
  99 void     lowercase(char *s);
 100 int      unix_listener(const char *, int, int);
 101 int      valid_domain(char *, int, const char **);
 102 int      valid_env_name(const char *);
 103 const char *atoi_err(const char *, int *);
 104 int      parse_absolute_time(const char *, uint64_t *);
 105 void     format_absolute_time(uint64_t, char *, size_t);
 106 int      parse_pattern_interval(const char *, char **, int *);
 107 int      path_absolute(const char *);
 108 int      stdfd_devnull(int, int, int);
 109 int      lib_contains_symbol(const char *, const char *);
 110
 111 void     sock_set_v6only(int);
 112
 113 struct passwd *pwcopy(struct passwd *);
 114 const char *ssh_gai_strerror(int);
 115
 116 typedef void privdrop_fn(struct passwd *);
 117 typedef void privrestore_fn(void);
 118 #define SSH_SUBPROCESS_STDOUT_DISCARD   (1)     /* Discard stdout */
 119 #define SSH_SUBPROCESS_STDOUT_CAPTURE   (1<<1)  /* Redirect stdout */
 120 #define SSH_SUBPROCESS_STDERR_DISCARD   (1<<2)  /* Discard stderr */
 121 #define SSH_SUBPROCESS_UNSAFE_PATH      (1<<3)  /* Don't check for safe cmd */
 122 #define SSH_SUBPROCESS_PRESERVE_ENV     (1<<4)  /* Keep parent environment */
 123 pid_t subprocess(const char *, const char *, int, char **, FILE **, u_int,
 124     struct passwd *, privdrop_fn *, privrestore_fn *);
 125
 126 typedef struct arglist arglist;
 127 struct arglist {
 128         char    **list;
 129         u_int   num;
 130         u_int   nalloc;
 131 };
 132 void     addargs(arglist *, char *, ...)
 133             __attribute__((format(printf, 2, 3)));
 134 void     replacearg(arglist *, u_int, char *, ...)
 135             __attribute__((format(printf, 3, 4)));
 136 void     freeargs(arglist *);
 137
 138 int      tun_open(int, int, char **);
 139
 140 /* Common definitions for ssh tunnel device forwarding */
 141 #define SSH_TUNMODE_NO          0x00
 142 #define SSH_TUNMODE_POINTOPOINT 0x01
 143 #define SSH_TUNMODE_ETHERNET    0x02
 144 #define SSH_TUNMODE_DEFAULT     SSH_TUNMODE_POINTOPOINT
 145 #define SSH_TUNMODE_YES         (SSH_TUNMODE_POINTOPOINT|SSH_TUNMODE_ETHERNET)
 146
 147 #define SSH_TUNID_ANY           0x7fffffff
 148 #define SSH_TUNID_ERR           (SSH_TUNID_ANY - 1)
 149 #define SSH_TUNID_MAX           (SSH_TUNID_ANY - 2)
 150
 151 /* Fake port to indicate that host field is really a path. */
 152 #define PORT_STREAMLOCAL        -2
 153
 154 /* Functions to extract or store big-endian words of various sizes */
 155 u_int64_t       get_u64(const void *)
 156     __attribute__((__bounded__( __minbytes__, 1, 8)));
 157 u_int32_t       get_u32(const void *)
 158     __attribute__((__bounded__( __minbytes__, 1, 4)));
 159 u_int16_t       get_u16(const void *)
 160     __attribute__((__bounded__( __minbytes__, 1, 2)));
 161 void            put_u64(void *, u_int64_t)
 162     __attribute__((__bounded__( __minbytes__, 1, 8)));
 163 void            put_u32(void *, u_int32_t)
 164     __attribute__((__bounded__( __minbytes__, 1, 4)));
 165 void            put_u16(void *, u_int16_t)
 166     __attribute__((__bounded__( __minbytes__, 1, 2)));
 167
 168 /* Little-endian store/load, used by umac.c */
 169 u_int32_t       get_u32_le(const void *)
 170     __attribute__((__bounded__(__minbytes__, 1, 4)));
 171 void            put_u32_le(void *, u_int32_t)
 172     __attribute__((__bounded__(__minbytes__, 1, 4)));
 173
 174 struct bwlimit {
 175         size_t buflen;
 176         u_int64_t rate;         /* desired rate in kbit/s */
 177         u_int64_t thresh;       /* threshold after which we'll check timers */
 178         u_int64_t lamt;         /* amount written in last timer interval */
 179         struct timeval bwstart, bwend;
 180 };
 181
 182 void bandwidth_limit_init(struct bwlimit *, u_int64_t, size_t);
 183 void bandwidth_limit(struct bwlimit *, size_t);
 184
 185 int parse_ipqos(const char *);
 186 const char *iptos2str(int);
 187 void mktemp_proto(char *, size_t);
 188
 189 void     child_set_env(char ***envp, u_int *envsizep, const char *name,
 190             const char *value);
 191 const char *lookup_env_in_list(const char *env,
 192             char * const *envs, size_t nenvs);
 193 const char *lookup_setenv_in_list(const char *env,
 194             char * const *envs, size_t nenvs);
 195
 196 int      argv_split(const char *, int *, char ***, int);
 197 char    *argv_assemble(int, char **argv);
 198 char    *argv_next(int *, char ***);
 199 void     argv_consume(int *);
 200 void     argv_free(char **, int);
 201
 202 int      exited_cleanly(pid_t, const char *, const char *, int);
 203
 204 struct stat;
 205 int      safe_path(const char *, struct stat *, const char *, uid_t,
 206             char *, size_t);
 207 int      safe_path_fd(int, const char *, struct passwd *,
 208             char *err, size_t errlen);
 209
 210 /* authorized_key-style options parsing helpers */
 211 int     opt_flag(const char *opt, int allow_negate, const char **optsp);
 212 char    *opt_dequote(const char **sp, const char **errstrp);
 213 int     opt_match(const char **opts, const char *term);
 214
 215 /* readconf/servconf option lists */
 216 void    opt_array_append(const char *file, const int line,
 217             const char *directive, char ***array, u_int *lp, const char *s);
 218 void    opt_array_append2(const char *file, const int line,
 219             const char *directive, char ***array, int **iarray, u_int *lp,
 220             const char *s, int i);
 221 void    opt_array_free2(char **array, int **iarray, u_int l);
 222
 223 struct timespec;
 224 void ptimeout_init(struct timespec *pt);
 225 void ptimeout_deadline_sec(struct timespec *pt, long sec);
 226 void ptimeout_deadline_ms(struct timespec *pt, long ms);
 227 void ptimeout_deadline_monotime_tsp(struct timespec *pt, struct timespec *when);
 228 void ptimeout_deadline_monotime(struct timespec *pt, time_t when);
 229 int ptimeout_get_ms(struct timespec *pt);
 230 struct timespec *ptimeout_get_tsp(struct timespec *pt);
 231 int ptimeout_isset(struct timespec *pt);
 232
 233 /* readpass.c */
 234
 235 #define RP_ECHO                 0x0001
 236 #define RP_ALLOW_STDIN          0x0002
 237 #define RP_ALLOW_EOF            0x0004
 238 #define RP_USE_ASKPASS          0x0008
 239
 240 struct notifier_ctx;
 241
 242 char    *read_passphrase(const char *, int);
 243 int      ask_permission(const char *, ...) __attribute__((format(printf, 1, 2)));
 244 struct notifier_ctx *notify_start(int, const char *, ...)
 245         __attribute__((format(printf, 2, 3)));
 246 void    notify_complete(struct notifier_ctx *, const char *, ...)
 247         __attribute__((format(printf, 2, 3)));
 248
 249 #define MINIMUM(a, b)   (((a) < (b)) ? (a) : (b))
 250 #define MAXIMUM(a, b)   (((a) > (b)) ? (a) : (b))
 251 #define ROUNDUP(x, y)   ((((x)+((y)-1))/(y))*(y))
 252
 253 typedef void (*sshsig_t)(int);
 254 sshsig_t ssh_signal(int, sshsig_t);
 255 int signal_is_crash(int);
 256
 257 /* On OpenBSD time_t is int64_t which is long long. */
 258 /* #define SSH_TIME_T_MAX LLONG_MAX */
 259
 260 #endif /* _MISC_H */