Annotation of src/usr.bin/ssh/misc.h, Revision 1.68
1.68 ! dtucker 1: /* $OpenBSD: misc.h,v 1.67 2017/10/25 00:17:08 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.31 djm 20:
1.54 millert 21: /* Data structure for representing a forwarding request. */
22: struct Forward {
23: char *listen_host; /* Host (address) to listen on. */
24: int listen_port; /* Port to forward. */
25: char *listen_path; /* Path to bind domain socket. */
26: char *connect_host; /* Host to connect. */
27: int connect_port; /* Port to connect on connect_host. */
28: char *connect_path; /* Path to connect domain socket. */
29: int allocated_port; /* Dynamically allocated listen port */
30: int handle; /* Handle for dynamic listen ports */
31: };
1.56 djm 32:
33: int forward_equals(const struct Forward *, const struct Forward *);
1.60 dtucker 34: int bind_permitted(int, uid_t);
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.15 djm 48: int set_nonblock(int);
49: int unset_nonblock(int);
1.11 stevesk 50: void set_nodelay(int);
1.66 djm 51: int set_reuseaddr(int);
1.67 djm 52: char *get_rdomain(int);
1.66 djm 53: int set_rdomain(int, const char *);
1.10 markus 54: int a2port(const char *);
1.27 reyk 55: int a2tun(const char *, int *);
1.33 dtucker 56: char *put_host_port(const char *, u_short);
1.21 djm 57: char *hpdelim(char **);
1.10 markus 58: char *cleanhostname(char *);
59: char *colon(char *);
1.64 millert 60: int parse_user_host_path(const char *, char **, char **, char **);
1.57 djm 61: int parse_user_host_port(const char *, char **, char **, int *);
1.64 millert 62: int parse_uri(const char *, const char *, char **, char **, int *, char **);
1.10 markus 63: long convtime(const char *);
1.22 djm 64: char *tilde_expand_filename(const char *, uid_t);
1.25 dtucker 65: char *percent_expand(const char *, ...) __attribute__((__sentinel__));
1.31 djm 66: char *tohex(const void *, size_t);
1.26 djm 67: void sanitise_stdfd(void);
1.38 dtucker 68: void ms_subtract_diff(struct timeval *, int *);
69: void ms_to_timeval(struct timeval *, int);
1.68 ! dtucker 70: void monotime_ts(struct timespec *);
! 71: void monotime_tv(struct timeval *);
1.49 dtucker 72: time_t monotime(void);
1.55 dtucker 73: double monotime_double(void);
1.50 djm 74: void lowercase(char *s);
1.54 millert 75: int unix_listener(const char *, int, int);
1.64 millert 76: int valid_domain(char *, int, const char **);
1.1 markus 77:
1.10 markus 78: struct passwd *pwcopy(struct passwd *);
1.37 dtucker 79: const char *ssh_gai_strerror(int);
1.5 mouring 80:
1.6 mouring 81: typedef struct arglist arglist;
82: struct arglist {
1.12 markus 83: char **list;
1.17 avsm 84: u_int num;
85: u_int nalloc;
1.6 mouring 86: };
1.29 djm 87: void addargs(arglist *, char *, ...)
88: __attribute__((format(printf, 2, 3)));
89: void replacearg(arglist *, u_int, char *, ...)
90: __attribute__((format(printf, 3, 4)));
91: void freeargs(arglist *);
1.14 djm 92:
1.65 djm 93: int tun_open(int, int, char **);
1.28 reyk 94:
95: /* Common definitions for ssh tunnel device forwarding */
96: #define SSH_TUNMODE_NO 0x00
97: #define SSH_TUNMODE_POINTOPOINT 0x01
98: #define SSH_TUNMODE_ETHERNET 0x02
99: #define SSH_TUNMODE_DEFAULT SSH_TUNMODE_POINTOPOINT
100: #define SSH_TUNMODE_YES (SSH_TUNMODE_POINTOPOINT|SSH_TUNMODE_ETHERNET)
101:
102: #define SSH_TUNID_ANY 0x7fffffff
103: #define SSH_TUNID_ERR (SSH_TUNID_ANY - 1)
104: #define SSH_TUNID_MAX (SSH_TUNID_ANY - 2)
1.54 millert 105:
106: /* Fake port to indicate that host field is really a path. */
107: #define PORT_STREAMLOCAL -2
1.31 djm 108:
109: /* Functions to extract or store big-endian words of various sizes */
110: u_int64_t get_u64(const void *)
1.53 djm 111: __attribute__((__bounded__( __minbytes__, 1, 8)));
1.31 djm 112: u_int32_t get_u32(const void *)
1.53 djm 113: __attribute__((__bounded__( __minbytes__, 1, 4)));
1.31 djm 114: u_int16_t get_u16(const void *)
1.53 djm 115: __attribute__((__bounded__( __minbytes__, 1, 2)));
1.31 djm 116: void put_u64(void *, u_int64_t)
1.53 djm 117: __attribute__((__bounded__( __minbytes__, 1, 8)));
1.31 djm 118: void put_u32(void *, u_int32_t)
1.53 djm 119: __attribute__((__bounded__( __minbytes__, 1, 4)));
1.31 djm 120: void put_u16(void *, u_int16_t)
1.53 djm 121: __attribute__((__bounded__( __minbytes__, 1, 2)));
1.52 djm 122:
123: /* Little-endian store/load, used by umac.c */
124: u_int32_t get_u32_le(const void *)
1.53 djm 125: __attribute__((__bounded__(__minbytes__, 1, 4)));
1.52 djm 126: void put_u32_le(void *, u_int32_t)
1.53 djm 127: __attribute__((__bounded__(__minbytes__, 1, 4)));
1.44 djm 128:
129: struct bwlimit {
130: size_t buflen;
131: u_int64_t rate, thresh, lamt;
132: struct timeval bwstart, bwend;
133: };
134:
135: void bandwidth_limit_init(struct bwlimit *, u_int64_t, size_t);
136: void bandwidth_limit(struct bwlimit *, size_t);
1.31 djm 137:
1.46 djm 138: int parse_ipqos(const char *);
1.48 stevesk 139: const char *iptos2str(int);
1.47 djm 140: void mktemp_proto(char *, size_t);
1.62 djm 141:
142: void child_set_env(char ***envp, u_int *envsizep, const char *name,
143: const char *value);
144:
145: int argv_split(const char *, int *, char ***);
146: char *argv_assemble(int, char **argv);
1.63 djm 147: int exited_cleanly(pid_t, const char *, const char *, int);
1.62 djm 148:
149: #define SSH_SUBPROCESS_STDOUT_DISCARD (1) /* Discard stdout */
150: #define SSH_SUBPROCESS_STDOUT_CAPTURE (1<<1) /* Redirect stdout */
151: #define SSH_SUBPROCESS_STDERR_DISCARD (1<<2) /* Discard stderr */
152: pid_t subprocess(const char *, struct passwd *,
153: const char *, int, char **, FILE **, u_int flags);
154:
155: struct stat;
156: int safe_path(const char *, struct stat *, const char *, uid_t,
157: char *, size_t);
158: int safe_path_fd(int, const char *, struct passwd *,
159: char *err, size_t errlen);
1.36 djm 160:
161: /* readpass.c */
162:
163: #define RP_ECHO 0x0001
164: #define RP_ALLOW_STDIN 0x0002
165: #define RP_ALLOW_EOF 0x0004
166: #define RP_USE_ASKPASS 0x0008
167:
168: char *read_passphrase(const char *, int);
169: int ask_permission(const char *, ...) __attribute__((format(printf, 1, 2)));
170: int read_keyfile_line(FILE *, const char *, char *, size_t, u_long *);
1.59 deraadt 171:
172: #define MINIMUM(a, b) (((a) < (b)) ? (a) : (b))
173: #define MAXIMUM(a, b) (((a) > (b)) ? (a) : (b))
174: #define ROUNDUP(x, y) ((((x)+((y)-1))/(y))*(y))
1.36 djm 175:
1.31 djm 176: #endif /* _MISC_H */