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