dropbear: dbutil.h annotate

annotate dbutil.h @ 1026:59a1146e8b9d fastopen

generalise write iovec handling

author	Matt Johnston <matt@ucc.asn.au>
date	Wed, 18 Feb 2015 23:02:49 +0800
parents	02baa0b334e8
children	daf21fd50abf

rev	line source
4 fe6bca95afa7 Makefile.in contains updated files required Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1 /*
fe6bca95afa7 Makefile.in contains updated files required Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2 * Dropbear - a SSH2 server
fe6bca95afa7 Makefile.in contains updated files required Matt Johnston <matt@ucc.asn.au> parents: diff changeset	3 *
fe6bca95afa7 Makefile.in contains updated files required Matt Johnston <matt@ucc.asn.au> parents: diff changeset	4 * Copyright (c) 2002,2003 Matt Johnston
fe6bca95afa7 Makefile.in contains updated files required Matt Johnston <matt@ucc.asn.au> parents: diff changeset	5 * All rights reserved.
fe6bca95afa7 Makefile.in contains updated files required Matt Johnston <matt@ucc.asn.au> parents: diff changeset	6 *
fe6bca95afa7 Makefile.in contains updated files required Matt Johnston <matt@ucc.asn.au> parents: diff changeset	7 * Permission is hereby granted, free of charge, to any person obtaining a copy
fe6bca95afa7 Makefile.in contains updated files required Matt Johnston <matt@ucc.asn.au> parents: diff changeset	8 * of this software and associated documentation files (the "Software"), to deal
fe6bca95afa7 Makefile.in contains updated files required Matt Johnston <matt@ucc.asn.au> parents: diff changeset	9 * in the Software without restriction, including without limitation the rights
fe6bca95afa7 Makefile.in contains updated files required Matt Johnston <matt@ucc.asn.au> parents: diff changeset	10 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
fe6bca95afa7 Makefile.in contains updated files required Matt Johnston <matt@ucc.asn.au> parents: diff changeset	11 * copies of the Software, and to permit persons to whom the Software is
fe6bca95afa7 Makefile.in contains updated files required Matt Johnston <matt@ucc.asn.au> parents: diff changeset	12 * furnished to do so, subject to the following conditions:
fe6bca95afa7 Makefile.in contains updated files required Matt Johnston <matt@ucc.asn.au> parents: diff changeset	13 *
fe6bca95afa7 Makefile.in contains updated files required Matt Johnston <matt@ucc.asn.au> parents: diff changeset	14 * The above copyright notice and this permission notice shall be included in
fe6bca95afa7 Makefile.in contains updated files required Matt Johnston <matt@ucc.asn.au> parents: diff changeset	15 * all copies or substantial portions of the Software.
fe6bca95afa7 Makefile.in contains updated files required Matt Johnston <matt@ucc.asn.au> parents: diff changeset	16 *
fe6bca95afa7 Makefile.in contains updated files required Matt Johnston <matt@ucc.asn.au> parents: diff changeset	17 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
fe6bca95afa7 Makefile.in contains updated files required Matt Johnston <matt@ucc.asn.au> parents: diff changeset	18 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
fe6bca95afa7 Makefile.in contains updated files required Matt Johnston <matt@ucc.asn.au> parents: diff changeset	19 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
fe6bca95afa7 Makefile.in contains updated files required Matt Johnston <matt@ucc.asn.au> parents: diff changeset	20 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
fe6bca95afa7 Makefile.in contains updated files required Matt Johnston <matt@ucc.asn.au> parents: diff changeset	21 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
fe6bca95afa7 Makefile.in contains updated files required Matt Johnston <matt@ucc.asn.au> parents: diff changeset	22 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
fe6bca95afa7 Makefile.in contains updated files required Matt Johnston <matt@ucc.asn.au> parents: diff changeset	23 * SOFTWARE. */
fe6bca95afa7 Makefile.in contains updated files required Matt Johnston <matt@ucc.asn.au> parents: diff changeset	24
fe6bca95afa7 Makefile.in contains updated files required Matt Johnston <matt@ucc.asn.au> parents: diff changeset	25 #ifndef _DBUTIL_H_
fe6bca95afa7 Makefile.in contains updated files required Matt Johnston <matt@ucc.asn.au> parents: diff changeset	26
fe6bca95afa7 Makefile.in contains updated files required Matt Johnston <matt@ucc.asn.au> parents: diff changeset	27 #define _DBUTIL_H_
fe6bca95afa7 Makefile.in contains updated files required Matt Johnston <matt@ucc.asn.au> parents: diff changeset	28
fe6bca95afa7 Makefile.in contains updated files required Matt Johnston <matt@ucc.asn.au> parents: diff changeset	29 #include "includes.h"
fe6bca95afa7 Makefile.in contains updated files required Matt Johnston <matt@ucc.asn.au> parents: diff changeset	30 #include "buffer.h"
fe6bca95afa7 Makefile.in contains updated files required Matt Johnston <matt@ucc.asn.au> parents: diff changeset	31
fe6bca95afa7 Makefile.in contains updated files required Matt Johnston <matt@ucc.asn.au> parents: diff changeset	32 #ifndef DISABLE_SYSLOG
fe6bca95afa7 Makefile.in contains updated files required Matt Johnston <matt@ucc.asn.au> parents: diff changeset	33 void startsyslog();
fe6bca95afa7 Makefile.in contains updated files required Matt Johnston <matt@ucc.asn.au> parents: diff changeset	34 #endif
fe6bca95afa7 Makefile.in contains updated files required Matt Johnston <matt@ucc.asn.au> parents: diff changeset	35
614 00eca37e47e8 Add noreturn and format attribute hints for some functions. Matt Johnston <matt@ucc.asn.au> parents: 568 diff changeset	36 #ifdef __GNUC__
00eca37e47e8 Add noreturn and format attribute hints for some functions. Matt Johnston <matt@ucc.asn.au> parents: 568 diff changeset	37 #define ATTRIB_PRINTF(fmt,args) __attribute__((format(printf, fmt, args)))
744 504f33c684b5 Add sentinel attribute Matt Johnston <matt@ucc.asn.au> parents: 731 diff changeset	38 #define ATTRIB_NORETURN __attribute__((noreturn))
504f33c684b5 Add sentinel attribute Matt Johnston <matt@ucc.asn.au> parents: 731 diff changeset	39 #define ATTRIB_SENTINEL __attribute__((sentinel))
614 00eca37e47e8 Add noreturn and format attribute hints for some functions. Matt Johnston <matt@ucc.asn.au> parents: 568 diff changeset	40 #else
00eca37e47e8 Add noreturn and format attribute hints for some functions. Matt Johnston <matt@ucc.asn.au> parents: 568 diff changeset	41 #define ATTRIB_PRINTF(fmt,args)
00eca37e47e8 Add noreturn and format attribute hints for some functions. Matt Johnston <matt@ucc.asn.au> parents: 568 diff changeset	42 #define ATTRIB_NORETURN
744 504f33c684b5 Add sentinel attribute Matt Johnston <matt@ucc.asn.au> parents: 731 diff changeset	43 #define ATTRIB_SENTINEL
614 00eca37e47e8 Add noreturn and format attribute hints for some functions. Matt Johnston <matt@ucc.asn.au> parents: 568 diff changeset	44 #endif
00eca37e47e8 Add noreturn and format attribute hints for some functions. Matt Johnston <matt@ucc.asn.au> parents: 568 diff changeset	45
00eca37e47e8 Add noreturn and format attribute hints for some functions. Matt Johnston <matt@ucc.asn.au> parents: 568 diff changeset	46 extern void (_dropbear_exit)(int exitcode, const char format, va_list param) ATTRIB_NORETURN;
4 fe6bca95afa7 Makefile.in contains updated files required Matt Johnston <matt@ucc.asn.au> parents: diff changeset	47 extern void (_dropbear_log)(int priority, const char format, va_list param);
fe6bca95afa7 Makefile.in contains updated files required Matt Johnston <matt@ucc.asn.au> parents: diff changeset	48
614 00eca37e47e8 Add noreturn and format attribute hints for some functions. Matt Johnston <matt@ucc.asn.au> parents: 568 diff changeset	49 void dropbear_exit(const char* format, ...) ATTRIB_PRINTF(1,2) ATTRIB_NORETURN;
00eca37e47e8 Add noreturn and format attribute hints for some functions. Matt Johnston <matt@ucc.asn.au> parents: 568 diff changeset	50
00eca37e47e8 Add noreturn and format attribute hints for some functions. Matt Johnston <matt@ucc.asn.au> parents: 568 diff changeset	51 void dropbear_close(const char* format, ...) ATTRIB_PRINTF(1,2) ;
00eca37e47e8 Add noreturn and format attribute hints for some functions. Matt Johnston <matt@ucc.asn.au> parents: 568 diff changeset	52 void dropbear_log(int priority, const char* format, ...) ATTRIB_PRINTF(2,3) ;
00eca37e47e8 Add noreturn and format attribute hints for some functions. Matt Johnston <matt@ucc.asn.au> parents: 568 diff changeset	53
00eca37e47e8 Add noreturn and format attribute hints for some functions. Matt Johnston <matt@ucc.asn.au> parents: 568 diff changeset	54 void fail_assert(const char* expr, const char* file, int line) ATTRIB_NORETURN;
00eca37e47e8 Add noreturn and format attribute hints for some functions. Matt Johnston <matt@ucc.asn.au> parents: 568 diff changeset	55
4 fe6bca95afa7 Makefile.in contains updated files required Matt Johnston <matt@ucc.asn.au> parents: diff changeset	56 #ifdef DEBUG_TRACE
614 00eca37e47e8 Add noreturn and format attribute hints for some functions. Matt Johnston <matt@ucc.asn.au> parents: 568 diff changeset	57 void dropbear_trace(const char* format, ...) ATTRIB_PRINTF(1,2);
731 9a5438271556 Move the more verbose TRACE() statements into TRACE2() Matt Johnston <matt@ucc.asn.au> parents: 650 diff changeset	58 void dropbear_trace2(const char* format, ...) ATTRIB_PRINTF(1,2);
198 65585699d980 * add a "label" argument to printhex() Matt Johnston <matt@ucc.asn.au> parents: 109 diff changeset	59 void printhex(const char * label, const unsigned char * buf, int len);
764 2202e854d187 add printmpint() for debugging Matt Johnston <matt@ucc.asn.au> parents: 650 diff changeset	60 void printmpint(const char label, mp_int mp);
1021 24135c8e1d46 Add envirnonment variable for debug timestamps to roughly match Matt Johnston <matt@ucc.asn.au> parents: 1003 diff changeset	61 void debug_start_net();
94 c85c88500ea6 DEBUG_TRACE now only triggers with -v on the cmdline Matt Johnston <matt@ucc.asn.au> parents: 62 diff changeset	62 extern int debug_trace;
4 fe6bca95afa7 Makefile.in contains updated files required Matt Johnston <matt@ucc.asn.au> parents: diff changeset	63 #endif
614 00eca37e47e8 Add noreturn and format attribute hints for some functions. Matt Johnston <matt@ucc.asn.au> parents: 568 diff changeset	64
871 aa689d140928 - Sockets are set to lowdelay priority initially to improve conneciton setup Matt Johnston <matt@ucc.asn.au> parents: 870 diff changeset	65 enum dropbear_prio {
948 f92eb625c48d - Don't use multichar constants since recent gcc complains Matt Johnston <matt@ucc.asn.au> parents: 941 diff changeset	66 DROPBEAR_PRIO_DEFAULT = 10,
f92eb625c48d - Don't use multichar constants since recent gcc complains Matt Johnston <matt@ucc.asn.au> parents: 941 diff changeset	67 DROPBEAR_PRIO_LOWDELAY = 11,
f92eb625c48d - Don't use multichar constants since recent gcc complains Matt Johnston <matt@ucc.asn.au> parents: 941 diff changeset	68 DROPBEAR_PRIO_BULK = 12,
871 aa689d140928 - Sockets are set to lowdelay priority initially to improve conneciton setup Matt Johnston <matt@ucc.asn.au> parents: 870 diff changeset	69 };
aa689d140928 - Sockets are set to lowdelay priority initially to improve conneciton setup Matt Johnston <matt@ucc.asn.au> parents: 870 diff changeset	70
4 fe6bca95afa7 Makefile.in contains updated files required Matt Johnston <matt@ucc.asn.au> parents: diff changeset	71 char * stripcontrol(const char * text);
568 005530560594 Rearrange getaddrstring() etc Matt Johnston <matt@ucc.asn.au> parents: 500 diff changeset	72 void get_socket_address(int fd, char local_host, char local_port,
005530560594 Rearrange getaddrstring() etc Matt Johnston <matt@ucc.asn.au> parents: 500 diff changeset	73 char remote_host, char remote_port, int host_lookup);
005530560594 Rearrange getaddrstring() etc Matt Johnston <matt@ucc.asn.au> parents: 500 diff changeset	74 void getaddrstring(struct sockaddr_storage* addr,
005530560594 Rearrange getaddrstring() etc Matt Johnston <matt@ucc.asn.au> parents: 500 diff changeset	75 char ret_host, char ret_port, int host_lookup);
870 80af450dae76 Set IPTOS_LOWDELAY on PTY sessions only Catalin Patulea <cat@vv.carleton.ca> parents: 835 diff changeset	76 void set_sock_nodelay(int sock);
871 aa689d140928 - Sockets are set to lowdelay priority initially to improve conneciton setup Matt Johnston <matt@ucc.asn.au> parents: 870 diff changeset	77 void set_sock_priority(int sock, enum dropbear_prio prio);
1023 a00303a7d247 tcp fastopen for the server Matt Johnston <matt@ucc.asn.au> parents: 1022 diff changeset	78
1024 aac0095dc3b4 work in progress for async connect Matt Johnston <matt@ucc.asn.au> parents: 1023 diff changeset	79 #if defined(__linux__) && HAVE_SENDMSG
1023 a00303a7d247 tcp fastopen for the server Matt Johnston <matt@ucc.asn.au> parents: 1022 diff changeset	80 #define DROPBEAR_TCP_FAST_OPEN
a00303a7d247 tcp fastopen for the server Matt Johnston <matt@ucc.asn.au> parents: 1022 diff changeset	81 void set_listen_fast_open(int sock);
a00303a7d247 tcp fastopen for the server Matt Johnston <matt@ucc.asn.au> parents: 1022 diff changeset	82 #endif
a00303a7d247 tcp fastopen for the server Matt Johnston <matt@ucc.asn.au> parents: 1022 diff changeset	83
62 20563735e8b5 just checkpointing Matt Johnston <matt@ucc.asn.au> parents: 52 diff changeset	84 int dropbear_listen(const char* address, const char* port,
20563735e8b5 just checkpointing Matt Johnston <matt@ucc.asn.au> parents: 52 diff changeset	85 int socks, unsigned int sockcount, char errstring, int maxfd);
481 357a2e2e9bcc - Generalise spawn_command function Matt Johnston <matt@ucc.asn.au> parents: 425 diff changeset	86 int spawn_command(void(exec_fn)(void user_data), void *exec_data,
357a2e2e9bcc - Generalise spawn_command function Matt Johnston <matt@ucc.asn.au> parents: 425 diff changeset	87 int writefd, int readfd, int errfd, pid_t pid);
482 7ad49f34a122 - Add run_shell_command() function to run a "sh -c" command, handling Matt Johnston <matt@ucc.asn.au> parents: 481 diff changeset	88 void run_shell_command(const char* cmd, unsigned int maxfd, char* usershell);
225 ca7e76d981d9 - progress towards client agent forwarding Matt Johnston <matt@ucc.asn.au> parents: 198 diff changeset	89 #ifdef ENABLE_CONNECT_UNIX
ca7e76d981d9 - progress towards client agent forwarding Matt Johnston <matt@ucc.asn.au> parents: 198 diff changeset	90 int connect_unix(const char* addr);
ca7e76d981d9 - progress towards client agent forwarding Matt Johnston <matt@ucc.asn.au> parents: 198 diff changeset	91 #endif
4 fe6bca95afa7 Makefile.in contains updated files required Matt Johnston <matt@ucc.asn.au> parents: diff changeset	92 int buf_readfile(buffer* buf, const char* filename);
52 c8fcd4841956 Forgot dbutil.h with the last commit (added buf_get_line) Matt Johnston <matt@ucc.asn.au> parents: 26 diff changeset	93 int buf_getline(buffer * line, FILE * authfile);
4 fe6bca95afa7 Makefile.in contains updated files required Matt Johnston <matt@ucc.asn.au> parents: diff changeset	94
277 044bc108b9b3 * Per-IP connection unauthed connection limits Matt Johnston <matt@ucc.asn.au> parents: 241 diff changeset	95 void m_close(int fd);
4 fe6bca95afa7 Makefile.in contains updated files required Matt Johnston <matt@ucc.asn.au> parents: diff changeset	96 void * m_malloc(size_t size);
11 f76c9389e9e0 Mostly done with the listener changeover Matt Johnston <matt@ucc.asn.au> parents: 4 diff changeset	97 void * m_strdup(const char * str);
4 fe6bca95afa7 Makefile.in contains updated files required Matt Johnston <matt@ucc.asn.au> parents: diff changeset	98 void * m_realloc(void* ptr, size_t size);
1003 7668ca9ae132 Fix bad multi-statement define for m_free(), detected by Coverity Matt Johnston <matt@ucc.asn.au> parents: 995 diff changeset	99 #define m_free(X) do {free(X); (X) = NULL;} while (0);
4 fe6bca95afa7 Makefile.in contains updated files required Matt Johnston <matt@ucc.asn.au> parents: diff changeset	100 void m_burn(void* data, unsigned int len);
109 2e9d1f29c50f merge of 50be59810e462f9f44f55e421227d6aa0b31982b Matt Johnston <matt@ucc.asn.au> parents: 94 diff changeset	101 void setnonblocking(int fd);
425 1afa503e33f5 Disable core dumps Matt Johnston <matt@ucc.asn.au> parents: 277 diff changeset	102 void disallow_core();
492 b956d6151600 Replace calls to strtoul() with a helper m_str_to_uint() Matt Johnston <matt@ucc.asn.au> parents: 482 diff changeset	103 int m_str_to_uint(const char* str, unsigned int *val);
4 fe6bca95afa7 Makefile.in contains updated files required Matt Johnston <matt@ucc.asn.au> parents: diff changeset	104
26 0969767bca0d snapshot of stuff Matt Johnston <matt@ucc.asn.au> parents: 24 diff changeset	105 /* Used to force mp_ints to be initialised */
0969767bca0d snapshot of stuff Matt Johnston <matt@ucc.asn.au> parents: 24 diff changeset	106 #define DEF_MP_INT(X) mp_int X = {0, 0, 0, NULL}
0969767bca0d snapshot of stuff Matt Johnston <matt@ucc.asn.au> parents: 24 diff changeset	107
241 c5d3ef11155f * use own assertions which should get logged properly Matt Johnston <matt@ucc.asn.au> parents: 198 diff changeset	108 /* Dropbear assertion */
c5d3ef11155f * use own assertions which should get logged properly Matt Johnston <matt@ucc.asn.au> parents: 198 diff changeset	109 #define dropbear_assert(X) do { if (!(X)) { fail_assert(#X, __FILE__, __LINE__); } } while (0)
c5d3ef11155f * use own assertions which should get logged properly Matt Johnston <matt@ucc.asn.au> parents: 198 diff changeset	110
817 a625f9e135a4 Constant time memcmp for the hmac and password crypt Matt Johnston <matt@ucc.asn.au> parents: 744 diff changeset	111 /* Returns 0 if a and b have the same contents */
a625f9e135a4 Constant time memcmp for the hmac and password crypt Matt Johnston <matt@ucc.asn.au> parents: 744 diff changeset	112 int constant_time_memcmp(const void* a, const void *b, size_t n);
a625f9e135a4 Constant time memcmp for the hmac and password crypt Matt Johnston <matt@ucc.asn.au> parents: 744 diff changeset	113
928 7cd89d4e0335 Add new monotonic_now() wrapper so that timeouts are unaffected by Matt Johnston <matt@ucc.asn.au> parents: 871 diff changeset	114 /* Returns a time in seconds that doesn't go backwards - does not correspond to
7cd89d4e0335 Add new monotonic_now() wrapper so that timeouts are unaffected by Matt Johnston <matt@ucc.asn.au> parents: 871 diff changeset	115 a real-world clock */
7cd89d4e0335 Add new monotonic_now() wrapper so that timeouts are unaffected by Matt Johnston <matt@ucc.asn.au> parents: 871 diff changeset	116 time_t monotonic_now();
7cd89d4e0335 Add new monotonic_now() wrapper so that timeouts are unaffected by Matt Johnston <matt@ucc.asn.au> parents: 871 diff changeset	117
995 6fb4c010c448 Default client key path ~/.ssh/id_dropbear Matt Johnston <matt@ucc.asn.au> parents: 948 diff changeset	118 char * expand_tilde(const char *inpath);
928 7cd89d4e0335 Add new monotonic_now() wrapper so that timeouts are unaffected by Matt Johnston <matt@ucc.asn.au> parents: 871 diff changeset	119
1024 aac0095dc3b4 work in progress for async connect Matt Johnston <matt@ucc.asn.au> parents: 1023 diff changeset	120 struct dropbear_progress_connection;
aac0095dc3b4 work in progress for async connect Matt Johnston <matt@ucc.asn.au> parents: 1023 diff changeset	121
aac0095dc3b4 work in progress for async connect Matt Johnston <matt@ucc.asn.au> parents: 1023 diff changeset	122 /* result is DROPBEAR_SUCCESS or DROPBEAR_FAILURE.
aac0095dc3b4 work in progress for async connect Matt Johnston <matt@ucc.asn.au> parents: 1023 diff changeset	123 errstring is only set on DROPBEAR_FAILURE, returns failure message for the last attempted socket */
aac0095dc3b4 work in progress for async connect Matt Johnston <matt@ucc.asn.au> parents: 1023 diff changeset	124 typedef void(connect_callback)(int result, int sock, void data, const char* errstring);
aac0095dc3b4 work in progress for async connect Matt Johnston <matt@ucc.asn.au> parents: 1023 diff changeset	125
aac0095dc3b4 work in progress for async connect Matt Johnston <matt@ucc.asn.au> parents: 1023 diff changeset	126 struct dropbear_progress_connection * connect_remote (const char* remotehost, const char* remoteport,
aac0095dc3b4 work in progress for async connect Matt Johnston <matt@ucc.asn.au> parents: 1023 diff changeset	127 connect_callback cb, void *cb_data);
aac0095dc3b4 work in progress for async connect Matt Johnston <matt@ucc.asn.au> parents: 1023 diff changeset	128
aac0095dc3b4 work in progress for async connect Matt Johnston <matt@ucc.asn.au> parents: 1023 diff changeset	129 void set_connect_fds(fd_set *writefd);
aac0095dc3b4 work in progress for async connect Matt Johnston <matt@ucc.asn.au> parents: 1023 diff changeset	130 void handle_connect_fds(fd_set *writefd);
aac0095dc3b4 work in progress for async connect Matt Johnston <matt@ucc.asn.au> parents: 1023 diff changeset	131
1025 02baa0b334e8 async connections working Matt Johnston <matt@ucc.asn.au> parents: 1024 diff changeset	132 /* Doesn't actually stop the connect, but adds a dummy callback instead */
02baa0b334e8 async connections working Matt Johnston <matt@ucc.asn.au> parents: 1024 diff changeset	133 void cancel_connect(struct dropbear_progress_connection *c);
02baa0b334e8 async connections working Matt Johnston <matt@ucc.asn.au> parents: 1024 diff changeset	134
4 fe6bca95afa7 Makefile.in contains updated files required Matt Johnston <matt@ucc.asn.au> parents: diff changeset	135 #endif /* _DBUTIL_H_ */

Mercurial > dropbear

annotate dbutil.h @ 1026:59a1146e8b9d fastopen