1/* $OpenBSD: misc.h,v 1.75 2018/10/03 06:38:35 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#include <sys/time.h> 19#include <sys/types.h> 20 21/* Data structure for representing a forwarding request. */ 22struct 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}; 32 33int forward_equals(const struct Forward *, const struct Forward *); 34int daemonized(void); 35 36/* Common server and client forwarding options. */ 37struct ForwardOptions { 38 int gateway_ports; /* Allow remote connects to forwarded ports. */ 39 mode_t streamlocal_bind_mask; /* umask for streamlocal binds */ 40 int streamlocal_bind_unlink; /* unlink socket before bind */ 41}; 42 43/* misc.c */ 44 45char *chop(char *); 46char *strdelim(char **); 47char *strdelimw(char **); 48int set_nonblock(int); 49int unset_nonblock(int); 50void set_nodelay(int); 51int set_reuseaddr(int); 52char *get_rdomain(int); 53int set_rdomain(int, const char *); 54int a2port(const char *); 55int a2tun(const char *, int *); 56char *put_host_port(const char *, u_short); 57char *hpdelim(char **); 58char *cleanhostname(char *); 59char *colon(char *); 60int parse_user_host_path(const char *, char **, char **, char **); 61int parse_user_host_port(const char *, char **, char **, int *); 62int parse_uri(const char *, const char *, char **, char **, int *, char **); 63long convtime(const char *); 64char *tilde_expand_filename(const char *, uid_t); 65char *percent_expand(const char *, ...) __attribute__((__sentinel__)); 66char *tohex(const void *, size_t); 67void sanitise_stdfd(void); 68void ms_subtract_diff(struct timeval *, int *); 69void ms_to_timeval(struct timeval *, int); 70void monotime_ts(struct timespec *); 71void monotime_tv(struct timeval *); 72time_t monotime(void); 73double monotime_double(void); 74void lowercase(char *s); 75int unix_listener(const char *, int, int); 76int valid_domain(char *, int, const char **); 77int valid_env_name(const char *); 78const char *atoi_err(const char *, int *); 79int parse_absolute_time(const char *, uint64_t *); 80void format_absolute_time(uint64_t, char *, size_t); 81 82void sock_set_v6only(int); 83 84struct passwd *pwcopy(struct passwd *); 85const char *ssh_gai_strerror(int); 86 87typedef struct arglist arglist; 88struct arglist { 89 char **list; 90 u_int num; 91 u_int nalloc; 92}; 93void addargs(arglist *, char *, ...) 94 __attribute__((format(printf, 2, 3))); 95void replacearg(arglist *, u_int, char *, ...) 96 __attribute__((format(printf, 3, 4))); 97void freeargs(arglist *); 98 99int tun_open(int, int, char **); 100 101/* Common definitions for ssh tunnel device forwarding */ 102#define SSH_TUNMODE_NO 0x00 103#define SSH_TUNMODE_POINTOPOINT 0x01 104#define SSH_TUNMODE_ETHERNET 0x02 105#define SSH_TUNMODE_DEFAULT SSH_TUNMODE_POINTOPOINT 106#define SSH_TUNMODE_YES (SSH_TUNMODE_POINTOPOINT|SSH_TUNMODE_ETHERNET) 107 108#define SSH_TUNID_ANY 0x7fffffff 109#define SSH_TUNID_ERR (SSH_TUNID_ANY - 1) 110#define SSH_TUNID_MAX (SSH_TUNID_ANY - 2) 111 112/* Fake port to indicate that host field is really a path. */ 113#define PORT_STREAMLOCAL -2 114 115/* Functions to extract or store big-endian words of various sizes */ 116u_int64_t get_u64(const void *) 117 __attribute__((__bounded__( __minbytes__, 1, 8))); 118u_int32_t get_u32(const void *) 119 __attribute__((__bounded__( __minbytes__, 1, 4))); 120u_int16_t get_u16(const void *) 121 __attribute__((__bounded__( __minbytes__, 1, 2))); 122void put_u64(void *, u_int64_t) 123 __attribute__((__bounded__( __minbytes__, 1, 8))); 124void put_u32(void *, u_int32_t) 125 __attribute__((__bounded__( __minbytes__, 1, 4))); 126void put_u16(void *, u_int16_t) 127 __attribute__((__bounded__( __minbytes__, 1, 2))); 128 129/* Little-endian store/load, used by umac.c */ 130u_int32_t get_u32_le(const void *) 131 __attribute__((__bounded__(__minbytes__, 1, 4))); 132void put_u32_le(void *, u_int32_t) 133 __attribute__((__bounded__(__minbytes__, 1, 4))); 134 135struct bwlimit { 136 size_t buflen; 137 u_int64_t rate, thresh, lamt; 138 struct timeval bwstart, bwend; 139}; 140 141void bandwidth_limit_init(struct bwlimit *, u_int64_t, size_t); 142void bandwidth_limit(struct bwlimit *, size_t); 143 144int parse_ipqos(const char *); 145const char *iptos2str(int); 146void mktemp_proto(char *, size_t); 147 148void child_set_env(char ***envp, u_int *envsizep, const char *name, 149 const char *value); 150 151int argv_split(const char *, int *, char ***); 152char *argv_assemble(int, char **argv); 153int exited_cleanly(pid_t, const char *, const char *, int); 154 155struct stat; 156int safe_path(const char *, struct stat *, const char *, uid_t, 157 char *, size_t); 158int safe_path_fd(int, const char *, struct passwd *, 159 char *err, size_t errlen); 160 161/* readpass.c */ 162 163#define RP_ECHO 0x0001 164#define RP_ALLOW_STDIN 0x0002 165#define RP_ALLOW_EOF 0x0004 166#define RP_USE_ASKPASS 0x0008 167 168char *read_passphrase(const char *, int); 169int ask_permission(const char *, ...) __attribute__((format(printf, 1, 2))); 170 171#define MINIMUM(a, b) (((a) < (b)) ? (a) : (b)) 172#define MAXIMUM(a, b) (((a) > (b)) ? (a) : (b)) 173#define ROUNDUP(x, y) ((((x)+((y)-1))/(y))*(y)) 174 175#endif /* _MISC_H */ 176