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