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