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