release/src/router/dropbear/dbutil.h

   1 /*
   2  * Dropbear - a SSH2 server
   3  *
   4  * Copyright (c) 2002,2003 Matt Johnston
   5  * All rights reserved.
   6  *
   7  * Permission is hereby granted, free of charge, to any person obtaining a copy
   8  * of this software and associated documentation files (the "Software"), to deal
   9  * in the Software without restriction, including without limitation the rights
  10  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
  11  * copies of the Software, and to permit persons to whom the Software is
  12  * furnished to do so, subject to the following conditions:
  13  *
  14  * The above copyright notice and this permission notice shall be included in
  15  * all copies or substantial portions of the Software.
  16  *
  17  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  18  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  19  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  20  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  21  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  22  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  23  * SOFTWARE. */
  24
  25 #ifndef _DBUTIL_H_
  26
  27 #define _DBUTIL_H_
  28
  29 #include "includes.h"
  30 #include "buffer.h"
  31
  32 #ifndef DISABLE_SYSLOG
  33 void startsyslog();
  34 #endif
  35
  36 #ifdef __GNUC__
  37 #define ATTRIB_PRINTF(fmt,args) __attribute__((format(printf, fmt, args)))
  38 #define ATTRIB_NORETURN __attribute__((noreturn))
  39 #define ATTRIB_SENTINEL __attribute__((sentinel))
  40 #else
  41 #define ATTRIB_PRINTF(fmt,args)
  42 #define ATTRIB_NORETURN
  43 #define ATTRIB_SENTINEL
  44 #endif
  45
  46 extern void (*_dropbear_exit)(int exitcode, const char* format, va_list param) ATTRIB_NORETURN;
  47 extern void (*_dropbear_log)(int priority, const char* format, va_list param);
  48
  49 void dropbear_exit(const char* format, ...) ATTRIB_PRINTF(1,2) ATTRIB_NORETURN;
  50
  51 void dropbear_close(const char* format, ...) ATTRIB_PRINTF(1,2) ;
  52 void dropbear_log(int priority, const char* format, ...) ATTRIB_PRINTF(2,3) ;
  53
  54 void fail_assert(const char* expr, const char* file, int line) ATTRIB_NORETURN;
  55
  56 #ifdef DEBUG_TRACE
  57 void dropbear_trace(const char* format, ...) ATTRIB_PRINTF(1,2);
  58 void dropbear_trace2(const char* format, ...) ATTRIB_PRINTF(1,2);
  59 void printhex(const char * label, const unsigned char * buf, int len);
  60 void printmpint(const char *label, mp_int *mp);
  61 extern int debug_trace;
  62 #endif
  63
  64 enum dropbear_prio {
  65         DROPBEAR_PRIO_DEFAULT = 10,
  66         DROPBEAR_PRIO_LOWDELAY = 11,
  67         DROPBEAR_PRIO_BULK = 12,
  68 };
  69
  70 char * stripcontrol(const char * text);
  71 void get_socket_address(int fd, char **local_host, char **local_port,
  72                 char **remote_host, char **remote_port, int host_lookup);
  73 void getaddrstring(struct sockaddr_storage* addr,
  74                 char **ret_host, char **ret_port, int host_lookup);
  75 void set_sock_nodelay(int sock);
  76 void set_sock_priority(int sock, enum dropbear_prio prio);
  77 int dropbear_listen(const char* address, const char* port,
  78                 int *socks, unsigned int sockcount, char **errstring, int *maxfd);
  79 int spawn_command(void(*exec_fn)(void *user_data), void *exec_data,
  80                 int *writefd, int *readfd, int *errfd, pid_t *pid);
  81 void run_shell_command(const char* cmd, unsigned int maxfd, char* usershell);
  82 #ifdef ENABLE_CONNECT_UNIX
  83 int connect_unix(const char* addr);
  84 #endif
  85 int connect_remote(const char* remotehost, const char* remoteport,
  86                 int nonblocking, char ** errstring);
  87 int buf_readfile(buffer* buf, const char* filename);
  88 int buf_getline(buffer * line, FILE * authfile);
  89
  90 void m_close(int fd);
  91 void * m_malloc(size_t size);
  92 void * m_strdup(const char * str);
  93 void * m_realloc(void* ptr, size_t size);
  94 #define m_free(X) do {free(X); (X) = NULL;} while (0);
  95 void m_burn(void* data, unsigned int len);
  96 void setnonblocking(int fd);
  97 void disallow_core();
  98 int m_str_to_uint(const char* str, unsigned int *val);
  99
 100 /* Used to force mp_ints to be initialised */
 101 #define DEF_MP_INT(X) mp_int X = {0, 0, 0, NULL}
 102
 103 /* Dropbear assertion */
 104 #define dropbear_assert(X) do { if (!(X)) { fail_assert(#X, __FILE__, __LINE__); } } while (0)
 105
 106 /* Returns 0 if a and b have the same contents */
 107 int constant_time_memcmp(const void* a, const void *b, size_t n);
 108
 109 /* Returns a time in seconds that doesn't go backwards - does not correspond to
 110 a real-world clock */
 111 time_t monotonic_now();
 112
 113 char * expand_tilde(const char *inpath);
 114
 115 #endif /* _DBUTIL_H_ */