Annotation of src/usr.bin/ssh/misc.h, Revision 1.59
1.59 ! deraadt 1: /* $OpenBSD: misc.h,v 1.58 2016/08/27 04:05:12 guenther 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.31 djm 19:
1.54 millert 20: /* Data structure for representing a forwarding request. */
21: struct Forward {
22: char *listen_host; /* Host (address) to listen on. */
23: int listen_port; /* Port to forward. */
24: char *listen_path; /* Path to bind domain socket. */
25: char *connect_host; /* Host to connect. */
26: int connect_port; /* Port to connect on connect_host. */
27: char *connect_path; /* Path to connect domain socket. */
28: int allocated_port; /* Dynamically allocated listen port */
29: int handle; /* Handle for dynamic listen ports */
30: };
1.56 djm 31:
32: int forward_equals(const struct Forward *, const struct Forward *);
1.54 millert 33:
34: /* Common server and client forwarding options. */
35: struct ForwardOptions {
36: int gateway_ports; /* Allow remote connects to forwarded ports. */
37: mode_t streamlocal_bind_mask; /* umask for streamlocal binds */
38: int streamlocal_bind_unlink; /* unlink socket before bind */
39: };
40:
1.14 djm 41: /* misc.c */
42:
1.9 itojun 43: char *chop(char *);
44: char *strdelim(char **);
1.15 djm 45: int set_nonblock(int);
46: int unset_nonblock(int);
1.11 stevesk 47: void set_nodelay(int);
1.10 markus 48: int a2port(const char *);
1.27 reyk 49: int a2tun(const char *, int *);
1.33 dtucker 50: char *put_host_port(const char *, u_short);
1.21 djm 51: char *hpdelim(char **);
1.10 markus 52: char *cleanhostname(char *);
53: char *colon(char *);
1.57 djm 54: int parse_user_host_port(const char *, char **, char **, int *);
1.10 markus 55: long convtime(const char *);
1.22 djm 56: char *tilde_expand_filename(const char *, uid_t);
1.25 dtucker 57: char *percent_expand(const char *, ...) __attribute__((__sentinel__));
1.31 djm 58: char *tohex(const void *, size_t);
1.26 djm 59: void sanitise_stdfd(void);
1.38 dtucker 60: void ms_subtract_diff(struct timeval *, int *);
61: void ms_to_timeval(struct timeval *, int);
1.49 dtucker 62: time_t monotime(void);
1.55 dtucker 63: double monotime_double(void);
1.50 djm 64: void lowercase(char *s);
1.54 millert 65: int unix_listener(const char *, int, int);
1.1 markus 66:
1.10 markus 67: struct passwd *pwcopy(struct passwd *);
1.37 dtucker 68: const char *ssh_gai_strerror(int);
1.5 mouring 69:
1.6 mouring 70: typedef struct arglist arglist;
71: struct arglist {
1.12 markus 72: char **list;
1.17 avsm 73: u_int num;
74: u_int nalloc;
1.6 mouring 75: };
1.29 djm 76: void addargs(arglist *, char *, ...)
77: __attribute__((format(printf, 2, 3)));
78: void replacearg(arglist *, u_int, char *, ...)
79: __attribute__((format(printf, 3, 4)));
80: void freeargs(arglist *);
1.14 djm 81:
1.28 reyk 82: int tun_open(int, int);
83:
84: /* Common definitions for ssh tunnel device forwarding */
85: #define SSH_TUNMODE_NO 0x00
86: #define SSH_TUNMODE_POINTOPOINT 0x01
87: #define SSH_TUNMODE_ETHERNET 0x02
88: #define SSH_TUNMODE_DEFAULT SSH_TUNMODE_POINTOPOINT
89: #define SSH_TUNMODE_YES (SSH_TUNMODE_POINTOPOINT|SSH_TUNMODE_ETHERNET)
90:
91: #define SSH_TUNID_ANY 0x7fffffff
92: #define SSH_TUNID_ERR (SSH_TUNID_ANY - 1)
93: #define SSH_TUNID_MAX (SSH_TUNID_ANY - 2)
1.54 millert 94:
95: /* Fake port to indicate that host field is really a path. */
96: #define PORT_STREAMLOCAL -2
1.31 djm 97:
98: /* Functions to extract or store big-endian words of various sizes */
99: u_int64_t get_u64(const void *)
1.53 djm 100: __attribute__((__bounded__( __minbytes__, 1, 8)));
1.31 djm 101: u_int32_t get_u32(const void *)
1.53 djm 102: __attribute__((__bounded__( __minbytes__, 1, 4)));
1.31 djm 103: u_int16_t get_u16(const void *)
1.53 djm 104: __attribute__((__bounded__( __minbytes__, 1, 2)));
1.31 djm 105: void put_u64(void *, u_int64_t)
1.53 djm 106: __attribute__((__bounded__( __minbytes__, 1, 8)));
1.31 djm 107: void put_u32(void *, u_int32_t)
1.53 djm 108: __attribute__((__bounded__( __minbytes__, 1, 4)));
1.31 djm 109: void put_u16(void *, u_int16_t)
1.53 djm 110: __attribute__((__bounded__( __minbytes__, 1, 2)));
1.52 djm 111:
112: /* Little-endian store/load, used by umac.c */
113: u_int32_t get_u32_le(const void *)
1.53 djm 114: __attribute__((__bounded__(__minbytes__, 1, 4)));
1.52 djm 115: void put_u32_le(void *, u_int32_t)
1.53 djm 116: __attribute__((__bounded__(__minbytes__, 1, 4)));
1.44 djm 117:
118: struct bwlimit {
119: size_t buflen;
120: u_int64_t rate, thresh, lamt;
121: struct timeval bwstart, bwend;
122: };
123:
124: void bandwidth_limit_init(struct bwlimit *, u_int64_t, size_t);
125: void bandwidth_limit(struct bwlimit *, size_t);
1.31 djm 126:
1.46 djm 127: int parse_ipqos(const char *);
1.48 stevesk 128: const char *iptos2str(int);
1.47 djm 129: void mktemp_proto(char *, size_t);
1.36 djm 130:
131: /* readpass.c */
132:
133: #define RP_ECHO 0x0001
134: #define RP_ALLOW_STDIN 0x0002
135: #define RP_ALLOW_EOF 0x0004
136: #define RP_USE_ASKPASS 0x0008
137:
138: char *read_passphrase(const char *, int);
139: int ask_permission(const char *, ...) __attribute__((format(printf, 1, 2)));
140: int read_keyfile_line(FILE *, const char *, char *, size_t, u_long *);
1.59 ! deraadt 141:
! 142: #define MINIMUM(a, b) (((a) < (b)) ? (a) : (b))
! 143: #define MAXIMUM(a, b) (((a) > (b)) ? (a) : (b))
! 144: #define ROUNDUP(x, y) ((((x)+((y)-1))/(y))*(y))
1.36 djm 145:
1.31 djm 146: #endif /* _MISC_H */