misc.h revision 323129
1/* $OpenBSD: misc.h,v 1.57 2016/07/15 00:24:30 djm Exp $ */ 2 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 */ 14 15#ifndef _MISC_H 16#define _MISC_H 17 18/* Data structure for representing a forwarding request. */ 19struct 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}; 29 30int forward_equals(const struct Forward *, const struct Forward *); 31 32/* Common server and client forwarding options. */ 33struct 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 39/* misc.c */ 40 41char *chop(char *); 42char *strdelim(char **); 43int set_nonblock(int); 44int unset_nonblock(int); 45void set_nodelay(int); 46int a2port(const char *); 47int a2tun(const char *, int *); 48char *put_host_port(const char *, u_short); 49char *hpdelim(char **); 50char *cleanhostname(char *); 51char *colon(char *); 52int parse_user_host_port(const char *, char **, char **, int *); 53long convtime(const char *); 54char *tilde_expand_filename(const char *, uid_t); 55char *percent_expand(const char *, ...) __attribute__((__sentinel__)); 56char *tohex(const void *, size_t); 57void sanitise_stdfd(void); 58void ms_subtract_diff(struct timeval *, int *); 59void ms_to_timeval(struct timeval *, int); 60time_t monotime(void); 61double monotime_double(void); 62void lowercase(char *s); 63int unix_listener(const char *, int, int); 64 65void sock_set_v6only(int); 66 67struct passwd *pwcopy(struct passwd *); 68const char *ssh_gai_strerror(int); 69 70typedef struct arglist arglist; 71struct arglist { 72 char **list; 73 u_int num; 74 u_int nalloc; 75}; 76void addargs(arglist *, char *, ...) 77 __attribute__((format(printf, 2, 3))); 78void replacearg(arglist *, u_int, char *, ...) 79 __attribute__((format(printf, 3, 4))); 80void freeargs(arglist *); 81 82int 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) 94 95/* Fake port to indicate that host field is really a path. */ 96#define PORT_STREAMLOCAL -2 97 98/* Functions to extract or store big-endian words of various sizes */ 99u_int64_t get_u64(const void *) 100 __attribute__((__bounded__( __minbytes__, 1, 8))); 101u_int32_t get_u32(const void *) 102 __attribute__((__bounded__( __minbytes__, 1, 4))); 103u_int16_t get_u16(const void *) 104 __attribute__((__bounded__( __minbytes__, 1, 2))); 105void put_u64(void *, u_int64_t) 106 __attribute__((__bounded__( __minbytes__, 1, 8))); 107void put_u32(void *, u_int32_t) 108 __attribute__((__bounded__( __minbytes__, 1, 4))); 109void put_u16(void *, u_int16_t) 110 __attribute__((__bounded__( __minbytes__, 1, 2))); 111 112/* Little-endian store/load, used by umac.c */ 113u_int32_t get_u32_le(const void *) 114 __attribute__((__bounded__(__minbytes__, 1, 4))); 115void put_u32_le(void *, u_int32_t) 116 __attribute__((__bounded__(__minbytes__, 1, 4))); 117 118struct bwlimit { 119 size_t buflen; 120 u_int64_t rate, thresh, lamt; 121 struct timeval bwstart, bwend; 122}; 123 124void bandwidth_limit_init(struct bwlimit *, u_int64_t, size_t); 125void bandwidth_limit(struct bwlimit *, size_t); 126 127int parse_ipqos(const char *); 128const char *iptos2str(int); 129void mktemp_proto(char *, size_t); 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 138char *read_passphrase(const char *, int); 139int ask_permission(const char *, ...) __attribute__((format(printf, 1, 2))); 140int read_keyfile_line(FILE *, const char *, char *, size_t, u_long *); 141 142#endif /* _MISC_H */ 143