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