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