Annotation of src/usr.bin/ssh/misc.h, Revision 1.82
1.82 ! djm 1: /* $OpenBSD: misc.h,v 1.81 2019/09/03 08:32: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.31 djm 21:
1.54 millert 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: };
1.56 djm 33:
34: int forward_equals(const struct Forward *, const struct Forward *);
1.61 dtucker 35: int daemonized(void);
1.54 millert 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:
1.14 djm 44: /* misc.c */
45:
1.9 itojun 46: char *chop(char *);
1.80 djm 47: void skip_space(char **);
1.9 itojun 48: char *strdelim(char **);
1.73 djm 49: char *strdelimw(char **);
1.15 djm 50: int set_nonblock(int);
51: int unset_nonblock(int);
1.11 stevesk 52: void set_nodelay(int);
1.66 djm 53: int set_reuseaddr(int);
1.67 djm 54: char *get_rdomain(int);
1.66 djm 55: int set_rdomain(int, const char *);
1.78 djm 56: int waitrfd(int, int *);
57: int timeout_connect(int, const struct sockaddr *, socklen_t, int *);
1.10 markus 58: int a2port(const char *);
1.27 reyk 59: int a2tun(const char *, int *);
1.33 dtucker 60: char *put_host_port(const char *, u_short);
1.79 dtucker 61: char *hpdelim2(char **, char *);
1.21 djm 62: char *hpdelim(char **);
1.10 markus 63: char *cleanhostname(char *);
64: char *colon(char *);
1.64 millert 65: int parse_user_host_path(const char *, char **, char **, char **);
1.57 djm 66: int parse_user_host_port(const char *, char **, char **, int *);
1.64 millert 67: int parse_uri(const char *, const char *, char **, char **, int *, char **);
1.10 markus 68: long convtime(const char *);
1.22 djm 69: char *tilde_expand_filename(const char *, uid_t);
1.25 dtucker 70: char *percent_expand(const char *, ...) __attribute__((__sentinel__));
1.31 djm 71: char *tohex(const void *, size_t);
1.26 djm 72: void sanitise_stdfd(void);
1.38 dtucker 73: void ms_subtract_diff(struct timeval *, int *);
74: void ms_to_timeval(struct timeval *, int);
1.68 dtucker 75: void monotime_ts(struct timespec *);
76: void monotime_tv(struct timeval *);
1.49 dtucker 77: time_t monotime(void);
1.55 dtucker 78: double monotime_double(void);
1.50 djm 79: void lowercase(char *s);
1.54 millert 80: int unix_listener(const char *, int, int);
1.64 millert 81: int valid_domain(char *, int, const char **);
1.75 djm 82: int valid_env_name(const char *);
1.69 dtucker 83: const char *atoi_err(const char *, int *);
1.71 djm 84: int parse_absolute_time(const char *, uint64_t *);
85: void format_absolute_time(uint64_t, char *, size_t);
1.76 djm 86: int path_absolute(const char *);
1.1 markus 87:
1.10 markus 88: struct passwd *pwcopy(struct passwd *);
1.37 dtucker 89: const char *ssh_gai_strerror(int);
1.5 mouring 90:
1.6 mouring 91: typedef struct arglist arglist;
92: struct arglist {
1.12 markus 93: char **list;
1.17 avsm 94: u_int num;
95: u_int nalloc;
1.6 mouring 96: };
1.29 djm 97: void addargs(arglist *, char *, ...)
98: __attribute__((format(printf, 2, 3)));
99: void replacearg(arglist *, u_int, char *, ...)
100: __attribute__((format(printf, 3, 4)));
101: void freeargs(arglist *);
1.14 djm 102:
1.65 djm 103: int tun_open(int, int, char **);
1.28 reyk 104:
105: /* Common definitions for ssh tunnel device forwarding */
106: #define SSH_TUNMODE_NO 0x00
107: #define SSH_TUNMODE_POINTOPOINT 0x01
108: #define SSH_TUNMODE_ETHERNET 0x02
109: #define SSH_TUNMODE_DEFAULT SSH_TUNMODE_POINTOPOINT
110: #define SSH_TUNMODE_YES (SSH_TUNMODE_POINTOPOINT|SSH_TUNMODE_ETHERNET)
111:
112: #define SSH_TUNID_ANY 0x7fffffff
113: #define SSH_TUNID_ERR (SSH_TUNID_ANY - 1)
114: #define SSH_TUNID_MAX (SSH_TUNID_ANY - 2)
1.54 millert 115:
116: /* Fake port to indicate that host field is really a path. */
117: #define PORT_STREAMLOCAL -2
1.31 djm 118:
119: /* Functions to extract or store big-endian words of various sizes */
120: u_int64_t get_u64(const void *)
1.53 djm 121: __attribute__((__bounded__( __minbytes__, 1, 8)));
1.31 djm 122: u_int32_t get_u32(const void *)
1.53 djm 123: __attribute__((__bounded__( __minbytes__, 1, 4)));
1.31 djm 124: u_int16_t get_u16(const void *)
1.53 djm 125: __attribute__((__bounded__( __minbytes__, 1, 2)));
1.31 djm 126: void put_u64(void *, u_int64_t)
1.53 djm 127: __attribute__((__bounded__( __minbytes__, 1, 8)));
1.31 djm 128: void put_u32(void *, u_int32_t)
1.53 djm 129: __attribute__((__bounded__( __minbytes__, 1, 4)));
1.31 djm 130: void put_u16(void *, u_int16_t)
1.53 djm 131: __attribute__((__bounded__( __minbytes__, 1, 2)));
1.52 djm 132:
133: /* Little-endian store/load, used by umac.c */
134: u_int32_t get_u32_le(const void *)
1.53 djm 135: __attribute__((__bounded__(__minbytes__, 1, 4)));
1.52 djm 136: void put_u32_le(void *, u_int32_t)
1.53 djm 137: __attribute__((__bounded__(__minbytes__, 1, 4)));
1.44 djm 138:
139: struct bwlimit {
140: size_t buflen;
1.77 dtucker 141: u_int64_t rate; /* desired rate in kbit/s */
142: u_int64_t thresh; /* threshold after which we'll check timers */
143: u_int64_t lamt; /* amount written in last timer interval */
1.44 djm 144: struct timeval bwstart, bwend;
145: };
146:
147: void bandwidth_limit_init(struct bwlimit *, u_int64_t, size_t);
148: void bandwidth_limit(struct bwlimit *, size_t);
1.31 djm 149:
1.46 djm 150: int parse_ipqos(const char *);
1.48 stevesk 151: const char *iptos2str(int);
1.47 djm 152: void mktemp_proto(char *, size_t);
1.62 djm 153:
154: void child_set_env(char ***envp, u_int *envsizep, const char *name,
155: const char *value);
156:
157: int argv_split(const char *, int *, char ***);
158: char *argv_assemble(int, char **argv);
1.63 djm 159: int exited_cleanly(pid_t, const char *, const char *, int);
1.62 djm 160:
161: struct stat;
162: int safe_path(const char *, struct stat *, const char *, uid_t,
163: char *, size_t);
164: int safe_path_fd(int, const char *, struct passwd *,
165: char *err, size_t errlen);
1.81 djm 166:
167: /* authorized_key-style options parsing helpers */
168: int opt_flag(const char *opt, int allow_negate, const char **optsp);
169: char *opt_dequote(const char **sp, const char **errstrp);
170: int opt_match(const char **opts, const char *term);
1.36 djm 171:
172: /* readpass.c */
173:
174: #define RP_ECHO 0x0001
175: #define RP_ALLOW_STDIN 0x0002
176: #define RP_ALLOW_EOF 0x0004
177: #define RP_USE_ASKPASS 0x0008
178:
1.82 ! djm 179: struct notifier_ctx;
! 180:
1.36 djm 181: char *read_passphrase(const char *, int);
182: int ask_permission(const char *, ...) __attribute__((format(printf, 1, 2)));
1.82 ! djm 183: struct notifier_ctx *notify_start(int, const char *, ...)
! 184: __attribute__((format(printf, 2, 3)));
! 185: void notify_complete(struct notifier_ctx *);
1.59 deraadt 186:
187: #define MINIMUM(a, b) (((a) < (b)) ? (a) : (b))
188: #define MAXIMUM(a, b) (((a) > (b)) ? (a) : (b))
189: #define ROUNDUP(x, y) ((((x)+((y)-1))/(y))*(y))
1.36 djm 190:
1.31 djm 191: #endif /* _MISC_H */