src/util-misc.h

   1 /*
   2     Copyright (C) 2006, 2007, 2008, 2009, 2010, 2011, 2012, 2013, 2014, 2015,
   3     2016
   4     Ben Kibbey <bjk@luxsci.net>
   5
   6     This file is part of pwmd.
   7
   8     Pwmd is free software: you can redistribute it and/or modify
   9     it under the terms of the GNU General Public License as published by
  10     the Free Software Foundation, either version 2 of the License, or
  11     (at your option) any later version.
  12
  13     Pwmd is distributed in the hope that it will be useful,
  14     but WITHOUT ANY WARRANTY; without even the implied warranty of
  15     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16     GNU General Public License for more details.
  17
  18     You should have received a copy of the GNU General Public License
  19     along with Pwmd.  If not, see <http://www.gnu.org/licenses/>.
  20 */
  21 #ifndef UTIL_MISC_H
  22 #define UTIL_MISC_H
  23
  24 #include <pthread.h>
  25 #include <sys/types.h>
  26 #include <wchar.h>
  27 #include <pwd.h>
  28 #include "rcfile.h"
  29
  30 #ifdef HAVE_BACKTRACE
  31 #include <execinfo.h>
  32 #include <syslog.h>
  33 #define BACKTRACE_COUNT 20
  34 #define BACKTRACE(fn)   do {                                            \
  35         int n, nptrs;                                                   \
  36         char **strings;                                                 \
  37         void *buffer[BACKTRACE_COUNT];                                  \
  38         nptrs = backtrace(buffer, BACKTRACE_COUNT);                     \
  39         strings = backtrace_symbols(buffer, nptrs);                     \
  40         for (n = 0; n < nptrs; n++)                                     \
  41             log_write("BACKTRACE: (%s) %i: %s", fn, n, strings[n]);     \
  42     } while (0)
  43 #endif
  44
  45 #define log_write0 log_write
  46
  47 #define log_write1(...) do { \
  48         if (log_level >= 1)                                     \
  49             log_write(__VA_ARGS__);                             \
  50     } while (0)
  51
  52 #define log_write2(...) do {                                    \
  53         if (log_level >= 2)                                     \
  54             log_write(__VA_ARGS__);                             \
  55     } while (0)
  56
  57 typedef enum
  58 {
  59   OPTION_TYPE_NOARG,
  60   OPTION_TYPE_ARG,
  61   OPTION_TYPE_OPTARG,
  62 } option_type_t;
  63
  64 struct argv_s
  65 {
  66   const char *opt;
  67   option_type_t type;
  68   gpg_error_t (*func) (void *data, void *value);
  69 };
  70
  71 typedef struct
  72 {
  73   size_t len;
  74   void *buf;
  75 } membuf_t;
  76
  77 char *home_directory;
  78 int log_level;
  79
  80 gpg_error_t parse_options (char **line, struct argv_s *args[], void *data,
  81                            int more);
  82 int valid_filename (const char *filename);
  83 char *expand_homedir (char *str);
  84 char *bin2hex (const unsigned char *data, size_t len);
  85 char *plus_escape (const char *fmt, ...);
  86 char *gnupg_escape (const char *str);
  87 char *strip_texi_and_wrap (const char *str, int html);
  88 void free_key (void *data);
  89 gpg_error_t create_thread (void *(*cb) (void *), void *data,
  90                            pthread_t * tid, int detached);
  91 void release_mutex_cb (void *arg);
  92 void close_fd_cb (void *arg);
  93 int valid_keygrip (const unsigned char *data, size_t len);
  94 gpg_error_t get_checksum (const char *filename, unsigned char **r_crc,
  95                           size_t * r_crclen);
  96 char *get_username (uid_t);
  97 char *get_home_dir ();
  98 struct passwd *get_pwd_struct (const char *user, uid_t uid, struct passwd *,
  99                                char **buf, gpg_error_t *);
 100 wchar_t *str_to_wchar (const char *str);
 101
 102 #endif