Annotation of src/usr.bin/ssh/misc.h, Revision 1.106
1.106 ! djm 1: /* $OpenBSD: misc.h,v 1.105 2023/08/28 03:31:16 djm Exp $ */
1.2 niklas 2:
1.1 markus 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: */
1.10 markus 14:
1.31 djm 15: #ifndef _MISC_H
16: #define _MISC_H
1.58 guenther 17:
18: #include <sys/time.h>
1.62 djm 19: #include <sys/types.h>
1.78 djm 20: #include <sys/socket.h>
1.94 djm 21: #include <stdio.h>
1.104 djm 22: #include <signal.h>
1.31 djm 23:
1.54 millert 24: /* Data structure for representing a forwarding request. */
25: struct 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: };
1.56 djm 35:
36: int forward_equals(const struct Forward *, const struct Forward *);
1.61 dtucker 37: int daemonized(void);
1.54 millert 38:
39: /* Common server and client forwarding options. */
40: struct 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:
1.14 djm 46: /* misc.c */
47:
1.9 itojun 48: char *chop(char *);
1.97 djm 49: void rtrim(char *);
1.80 djm 50: void skip_space(char **);
1.9 itojun 51: char *strdelim(char **);
1.73 djm 52: char *strdelimw(char **);
1.15 djm 53: int set_nonblock(int);
54: int unset_nonblock(int);
1.11 stevesk 55: void set_nodelay(int);
1.66 djm 56: int set_reuseaddr(int);
1.67 djm 57: char *get_rdomain(int);
1.66 djm 58: int set_rdomain(int, const char *);
1.90 djm 59: int get_sock_af(int);
60: void set_sock_tos(int, int);
1.104 djm 61: int waitrfd(int, int *, volatile sig_atomic_t *);
1.78 djm 62: int timeout_connect(int, const struct sockaddr *, socklen_t, int *);
1.10 markus 63: int a2port(const char *);
1.27 reyk 64: int a2tun(const char *, int *);
1.33 dtucker 65: char *put_host_port(const char *, u_short);
1.79 dtucker 66: char *hpdelim2(char **, char *);
1.21 djm 67: char *hpdelim(char **);
1.10 markus 68: char *cleanhostname(char *);
69: char *colon(char *);
1.64 millert 70: int parse_user_host_path(const char *, char **, char **, char **);
1.57 djm 71: int parse_user_host_port(const char *, char **, char **, int *);
1.64 millert 72: int parse_uri(const char *, const char *, char **, char **, int *, char **);
1.92 dtucker 73: int convtime(const char *);
1.85 djm 74: const char *fmt_timeframe(time_t t);
1.98 djm 75: int tilde_expand(const char *, uid_t, char **);
1.22 djm 76: char *tilde_expand_filename(const char *, uid_t);
1.86 dtucker 77:
1.87 dtucker 78: char *dollar_expand(int *, const char *string, ...);
1.25 dtucker 79: char *percent_expand(const char *, ...) __attribute__((__sentinel__));
1.86 dtucker 80: char *percent_dollar_expand(const char *, ...) __attribute__((__sentinel__));
1.31 djm 81: char *tohex(const void *, size_t);
1.84 djm 82: void xextendf(char **s, const char *sep, const char *fmt, ...)
83: __attribute__((__format__ (printf, 3, 4))) __attribute__((__nonnull__ (3)));
1.26 djm 84: void sanitise_stdfd(void);
1.38 dtucker 85: void ms_subtract_diff(struct timeval *, int *);
1.99 deraadt 86: void ms_to_timespec(struct timespec *, int);
1.68 dtucker 87: void monotime_ts(struct timespec *);
88: void monotime_tv(struct timeval *);
1.49 dtucker 89: time_t monotime(void);
1.55 dtucker 90: double monotime_double(void);
1.50 djm 91: void lowercase(char *s);
1.54 millert 92: int unix_listener(const char *, int, int);
1.64 millert 93: int valid_domain(char *, int, const char **);
1.75 djm 94: int valid_env_name(const char *);
1.69 dtucker 95: const char *atoi_err(const char *, int *);
1.71 djm 96: int parse_absolute_time(const char *, uint64_t *);
97: void format_absolute_time(uint64_t, char *, size_t);
1.106 ! djm 98: int parse_pattern_interval(const char *, char **, int *);
1.76 djm 99: int path_absolute(const char *);
1.88 djm 100: int stdfd_devnull(int, int, int);
1.103 djm 101: int lib_contains_symbol(const char *, const char *);
1.1 markus 102:
1.10 markus 103: struct passwd *pwcopy(struct passwd *);
1.37 dtucker 104: const char *ssh_gai_strerror(int);
1.91 djm 105:
106: typedef void privdrop_fn(struct passwd *);
107: typedef void privrestore_fn(void);
108: #define SSH_SUBPROCESS_STDOUT_DISCARD (1) /* Discard stdout */
109: #define SSH_SUBPROCESS_STDOUT_CAPTURE (1<<1) /* Redirect stdout */
110: #define SSH_SUBPROCESS_STDERR_DISCARD (1<<2) /* Discard stderr */
111: #define SSH_SUBPROCESS_UNSAFE_PATH (1<<3) /* Don't check for safe cmd */
112: #define SSH_SUBPROCESS_PRESERVE_ENV (1<<4) /* Keep parent environment */
113: pid_t subprocess(const char *, const char *, int, char **, FILE **, u_int,
114: struct passwd *, privdrop_fn *, privrestore_fn *);
1.5 mouring 115:
1.6 mouring 116: typedef struct arglist arglist;
117: struct arglist {
1.12 markus 118: char **list;
1.17 avsm 119: u_int num;
120: u_int nalloc;
1.6 mouring 121: };
1.29 djm 122: void addargs(arglist *, char *, ...)
1.95 djm 123: __attribute__((format(printf, 2, 3)));
1.29 djm 124: void replacearg(arglist *, u_int, char *, ...)
1.95 djm 125: __attribute__((format(printf, 3, 4)));
1.29 djm 126: void freeargs(arglist *);
1.14 djm 127:
1.65 djm 128: int tun_open(int, int, char **);
1.28 reyk 129:
130: /* Common definitions for ssh tunnel device forwarding */
131: #define SSH_TUNMODE_NO 0x00
132: #define SSH_TUNMODE_POINTOPOINT 0x01
133: #define SSH_TUNMODE_ETHERNET 0x02
134: #define SSH_TUNMODE_DEFAULT SSH_TUNMODE_POINTOPOINT
135: #define SSH_TUNMODE_YES (SSH_TUNMODE_POINTOPOINT|SSH_TUNMODE_ETHERNET)
136:
137: #define SSH_TUNID_ANY 0x7fffffff
138: #define SSH_TUNID_ERR (SSH_TUNID_ANY - 1)
139: #define SSH_TUNID_MAX (SSH_TUNID_ANY - 2)
1.54 millert 140:
141: /* Fake port to indicate that host field is really a path. */
142: #define PORT_STREAMLOCAL -2
1.31 djm 143:
144: /* Functions to extract or store big-endian words of various sizes */
145: u_int64_t get_u64(const void *)
1.53 djm 146: __attribute__((__bounded__( __minbytes__, 1, 8)));
1.31 djm 147: u_int32_t get_u32(const void *)
1.53 djm 148: __attribute__((__bounded__( __minbytes__, 1, 4)));
1.31 djm 149: u_int16_t get_u16(const void *)
1.53 djm 150: __attribute__((__bounded__( __minbytes__, 1, 2)));
1.31 djm 151: void put_u64(void *, u_int64_t)
1.53 djm 152: __attribute__((__bounded__( __minbytes__, 1, 8)));
1.31 djm 153: void put_u32(void *, u_int32_t)
1.53 djm 154: __attribute__((__bounded__( __minbytes__, 1, 4)));
1.31 djm 155: void put_u16(void *, u_int16_t)
1.53 djm 156: __attribute__((__bounded__( __minbytes__, 1, 2)));
1.52 djm 157:
158: /* Little-endian store/load, used by umac.c */
159: u_int32_t get_u32_le(const void *)
1.53 djm 160: __attribute__((__bounded__(__minbytes__, 1, 4)));
1.52 djm 161: void put_u32_le(void *, u_int32_t)
1.53 djm 162: __attribute__((__bounded__(__minbytes__, 1, 4)));
1.44 djm 163:
164: struct bwlimit {
165: size_t buflen;
1.77 dtucker 166: u_int64_t rate; /* desired rate in kbit/s */
167: u_int64_t thresh; /* threshold after which we'll check timers */
168: u_int64_t lamt; /* amount written in last timer interval */
1.44 djm 169: struct timeval bwstart, bwend;
170: };
171:
172: void bandwidth_limit_init(struct bwlimit *, u_int64_t, size_t);
173: void bandwidth_limit(struct bwlimit *, size_t);
1.31 djm 174:
1.46 djm 175: int parse_ipqos(const char *);
1.48 stevesk 176: const char *iptos2str(int);
1.47 djm 177: void mktemp_proto(char *, size_t);
1.62 djm 178:
179: void child_set_env(char ***envp, u_int *envsizep, const char *name,
1.95 djm 180: const char *value);
1.96 djm 181: const char *lookup_env_in_list(const char *env,
1.100 djm 182: char * const *envs, size_t nenvs);
183: const char *lookup_setenv_in_list(const char *env,
1.96 djm 184: char * const *envs, size_t nenvs);
1.62 djm 185:
1.97 djm 186: int argv_split(const char *, int *, char ***, int);
1.62 djm 187: char *argv_assemble(int, char **argv);
1.97 djm 188: char *argv_next(int *, char ***);
189: void argv_consume(int *);
190: void argv_free(char **, int);
191:
1.63 djm 192: int exited_cleanly(pid_t, const char *, const char *, int);
1.62 djm 193:
194: struct stat;
195: int safe_path(const char *, struct stat *, const char *, uid_t,
1.95 djm 196: char *, size_t);
1.62 djm 197: int safe_path_fd(int, const char *, struct passwd *,
1.95 djm 198: char *err, size_t errlen);
1.81 djm 199:
200: /* authorized_key-style options parsing helpers */
201: int opt_flag(const char *opt, int allow_negate, const char **optsp);
202: char *opt_dequote(const char **sp, const char **errstrp);
203: int opt_match(const char **opts, const char *term);
1.36 djm 204:
1.93 markus 205: /* readconf/servconf option lists */
206: void opt_array_append(const char *file, const int line,
207: const char *directive, char ***array, u_int *lp, const char *s);
208: void opt_array_append2(const char *file, const int line,
209: const char *directive, char ***array, int **iarray, u_int *lp,
210: const char *s, int i);
1.101 djm 211:
212: struct timespec;
213: void ptimeout_init(struct timespec *pt);
214: void ptimeout_deadline_sec(struct timespec *pt, long sec);
215: void ptimeout_deadline_ms(struct timespec *pt, long ms);
1.105 djm 216: void ptimeout_deadline_monotime_tsp(struct timespec *pt, struct timespec *when);
1.101 djm 217: void ptimeout_deadline_monotime(struct timespec *pt, time_t when);
218: int ptimeout_get_ms(struct timespec *pt);
219: struct timespec *ptimeout_get_tsp(struct timespec *pt);
220: int ptimeout_isset(struct timespec *pt);
1.93 markus 221:
1.36 djm 222: /* readpass.c */
223:
224: #define RP_ECHO 0x0001
225: #define RP_ALLOW_STDIN 0x0002
226: #define RP_ALLOW_EOF 0x0004
227: #define RP_USE_ASKPASS 0x0008
228:
1.82 djm 229: struct notifier_ctx;
230:
1.36 djm 231: char *read_passphrase(const char *, int);
232: int ask_permission(const char *, ...) __attribute__((format(printf, 1, 2)));
1.82 djm 233: struct notifier_ctx *notify_start(int, const char *, ...)
234: __attribute__((format(printf, 2, 3)));
1.89 djm 235: void notify_complete(struct notifier_ctx *, const char *, ...)
236: __attribute__((format(printf, 2, 3)));
1.59 deraadt 237:
238: #define MINIMUM(a, b) (((a) < (b)) ? (a) : (b))
239: #define MAXIMUM(a, b) (((a) > (b)) ? (a) : (b))
240: #define ROUNDUP(x, y) ((((x)+((y)-1))/(y))*(y))
1.36 djm 241:
1.83 dtucker 242: typedef void (*sshsig_t)(int);
243: sshsig_t ssh_signal(int, sshsig_t);
1.102 dtucker 244:
245: /* On OpenBSD time_t is int64_t which is long long. */
246: #define SSH_TIME_T_MAX LLONG_MAX
1.93 markus 247:
1.31 djm 248: #endif /* _MISC_H */