common/iobuf.c: Improve iobuf_peek.
[gnupg.git] / common / util.h
index 10828d7..66749ea 100644 (file)
 /* util.h - Utility functions for GnuPG
- * Copyright (C) 2001, 2002, 2003, 2004 Free Software Foundation, Inc.
+ * Copyright (C) 2001, 2002, 2003, 2004, 2009 Free Software Foundation, Inc.
  *
  * This file is part of GnuPG.
  *
- * GnuPG is free software; you can redistribute it and/or modify
- * it under the terms of the GNU General Public License as published by
- * the Free Software Foundation; either version 2 of the License, or
- * (at your option) any later version.
+ * GnuPG is free software; you can redistribute it and/or modify it
+ * under the terms of either
  *
- * GnuPG is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
- * GNU General Public License for more details.
+ *   - the GNU Lesser General Public License as published by the Free
+ *     Software Foundation; either version 3 of the License, or (at
+ *     your option) any later version.
  *
- * You should have received a copy of the GNU General Public License
- * along with this program; if not, write to the Free Software
- * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301,
- * USA.
+ * or
+ *
+ *   - the GNU General Public License as published by the Free
+ *     Software Foundation; either version 2 of the License, or (at
+ *     your option) any later version.
+ *
+ * or both in parallel, as here.
+ *
+ * GnuPG is distributed in the hope that it will be useful, but
+ * WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ * General Public License for more details.
+ *
+ * You should have received a copies of the GNU General Public License
+ * and the GNU Lesser General Public License along with this program;
+ * if not, see <http://www.gnu.org/licenses/>.
  */
 
 #ifndef GNUPG_COMMON_UTIL_H
 #define GNUPG_COMMON_UTIL_H
 
 #include <gcrypt.h> /* We need this for the memory function protos. */
-#include <time.h>   /* We need time_t. */
 #include <errno.h>  /* We need errno.  */
-#include <gpg-error.h> /* We need gpg_error_t. */
-
-/* Common GNUlib includes (-I ../gl/). */
-#include "strpbrk.h"
-#include "strsep.h"
-#include "vasprintf.h"
-
+#include <gpg-error.h> /* We need gpg_error_t and estream. */
+
+/* These error codes are used but not defined in the required
+   libgpg-error version.  Define them here. */
+#if GPG_ERROR_VERSION_NUMBER < 0x011200  /* 1.18 */
+# define GPG_ERR_LEGACY_KEY     222
+# define GPG_ERR_OBJ_TERM_STATE 225
+# define GPG_ERR_FORBIDDEN      251
+#endif
+#if GPG_ERROR_VERSION_NUMBER < 0x011300  /* 1.19 */
+# define GPG_ERR_LDAP_GENERAL               721
+# define GPG_ERR_LDAP_ATTR_GENERAL          722
+# define GPG_ERR_LDAP_NAME_GENERAL          723
+# define GPG_ERR_LDAP_SECURITY_GENERAL      724
+# define GPG_ERR_LDAP_SERVICE_GENERAL       725
+# define GPG_ERR_LDAP_UPDATE_GENERAL        726
+# define GPG_ERR_LDAP_E_GENERAL             727
+# define GPG_ERR_LDAP_X_GENERAL             728
+# define GPG_ERR_LDAP_OTHER_GENERAL         729
+# define GPG_ERR_LDAP_X_CONNECTING          750
+# define GPG_ERR_LDAP_REFERRAL_LIMIT        751
+# define GPG_ERR_LDAP_CLIENT_LOOP           752
+# define GPG_ERR_LDAP_NO_RESULTS            754
+# define GPG_ERR_LDAP_CONTROL_NOT_FOUND     755
+# define GPG_ERR_LDAP_NOT_SUPPORTED         756
+# define GPG_ERR_LDAP_CONNECT               757
+# define GPG_ERR_LDAP_NO_MEMORY             758
+# define GPG_ERR_LDAP_PARAM                 759
+# define GPG_ERR_LDAP_USER_CANCELLED        760
+# define GPG_ERR_LDAP_FILTER                761
+# define GPG_ERR_LDAP_AUTH_UNKNOWN          762
+# define GPG_ERR_LDAP_TIMEOUT               763
+# define GPG_ERR_LDAP_DECODING              764
+# define GPG_ERR_LDAP_ENCODING              765
+# define GPG_ERR_LDAP_LOCAL                 766
+# define GPG_ERR_LDAP_SERVER_DOWN           767
+# define GPG_ERR_LDAP_SUCCESS               768
+# define GPG_ERR_LDAP_OPERATIONS            769
+# define GPG_ERR_LDAP_PROTOCOL              770
+# define GPG_ERR_LDAP_TIMELIMIT             771
+# define GPG_ERR_LDAP_SIZELIMIT             772
+# define GPG_ERR_LDAP_COMPARE_FALSE         773
+# define GPG_ERR_LDAP_COMPARE_TRUE          774
+# define GPG_ERR_LDAP_UNSUPPORTED_AUTH      775
+# define GPG_ERR_LDAP_STRONG_AUTH_RQRD      776
+# define GPG_ERR_LDAP_PARTIAL_RESULTS       777
+# define GPG_ERR_LDAP_REFERRAL              778
+# define GPG_ERR_LDAP_ADMINLIMIT            779
+# define GPG_ERR_LDAP_UNAVAIL_CRIT_EXTN     780
+# define GPG_ERR_LDAP_CONFIDENT_RQRD        781
+# define GPG_ERR_LDAP_SASL_BIND_INPROG      782
+# define GPG_ERR_LDAP_NO_SUCH_ATTRIBUTE     784
+# define GPG_ERR_LDAP_UNDEFINED_TYPE        785
+# define GPG_ERR_LDAP_BAD_MATCHING          786
+# define GPG_ERR_LDAP_CONST_VIOLATION       787
+# define GPG_ERR_LDAP_TYPE_VALUE_EXISTS     788
+# define GPG_ERR_LDAP_INV_SYNTAX            789
+# define GPG_ERR_LDAP_NO_SUCH_OBJ           800
+# define GPG_ERR_LDAP_ALIAS_PROBLEM         801
+# define GPG_ERR_LDAP_INV_DN_SYNTAX         802
+# define GPG_ERR_LDAP_IS_LEAF               803
+# define GPG_ERR_LDAP_ALIAS_DEREF           804
+# define GPG_ERR_LDAP_X_PROXY_AUTH_FAIL     815
+# define GPG_ERR_LDAP_BAD_AUTH              816
+# define GPG_ERR_LDAP_INV_CREDENTIALS       817
+# define GPG_ERR_LDAP_INSUFFICIENT_ACC      818
+# define GPG_ERR_LDAP_BUSY                  819
+# define GPG_ERR_LDAP_UNAVAILABLE           820
+# define GPG_ERR_LDAP_UNWILL_TO_PERFORM     821
+# define GPG_ERR_LDAP_LOOP_DETECT           822
+# define GPG_ERR_LDAP_NAMING_VIOLATION      832
+# define GPG_ERR_LDAP_OBJ_CLS_VIOLATION     833
+# define GPG_ERR_LDAP_NOT_ALLOW_NONLEAF     834
+# define GPG_ERR_LDAP_NOT_ALLOW_ON_RDN      835
+# define GPG_ERR_LDAP_ALREADY_EXISTS        836
+# define GPG_ERR_LDAP_NO_OBJ_CLASS_MODS     837
+# define GPG_ERR_LDAP_RESULTS_TOO_LARGE     838
+# define GPG_ERR_LDAP_AFFECTS_MULT_DSAS     839
+# define GPG_ERR_LDAP_VLV                   844
+# define GPG_ERR_LDAP_OTHER                 848
+# define GPG_ERR_LDAP_CUP_RESOURCE_LIMIT    881
+# define GPG_ERR_LDAP_CUP_SEC_VIOLATION     882
+# define GPG_ERR_LDAP_CUP_INV_DATA          883
+# define GPG_ERR_LDAP_CUP_UNSUP_SCHEME      884
+# define GPG_ERR_LDAP_CUP_RELOAD            885
+# define GPG_ERR_LDAP_CANCELLED             886
+# define GPG_ERR_LDAP_NO_SUCH_OPERATION     887
+# define GPG_ERR_LDAP_TOO_LATE              888
+# define GPG_ERR_LDAP_CANNOT_CANCEL         889
+# define GPG_ERR_LDAP_ASSERTION_FAILED      890
+# define GPG_ERR_LDAP_PROX_AUTH_DENIED      891
+#endif /*GPG_ERROR_VERSION_NUMBER < 0x011300*/
 
 /* Hash function used with libksba. */
 #define HASH_FNC ((void (*)(void *, const void*,size_t))gcry_md_write)
 
-/* get all the stuff from jnlib */
-#include "../jnlib/logging.h"
-#include "../jnlib/argparse.h"
-#include "../jnlib/stringhelp.h"
-#include "../jnlib/mischelp.h"
-#include "../jnlib/strlist.h"
-#include "../jnlib/dotlock.h"
-#include "../jnlib/utf8conv.h"
+/* Get all the stuff from jnlib. */
+#include "../common/logging.h"
+#include "../common/argparse.h"
+#include "../common/stringhelp.h"
+#include "../common/mischelp.h"
+#include "../common/strlist.h"
+#include "../common/dotlock.h"
+#include "../common/utf8conv.h"
+#include "../common/dynload.h"
+
+#include "gettime.h"
+
+/* Redefine asprintf by our estream version which uses our own memory
+   allocator..  */
+#define asprintf gpgrt_asprintf
+#define vasprintf gpgrt_vasprintf
+
+/* Due to a bug in mingw32's snprintf related to the 'l' modifier and
+   for increased portability we use our snprintf on all systems. */
+#undef snprintf
+#define snprintf gpgrt_snprintf
+
+
+/* Replacements for macros not available with libgpg-error < 1.20.  */
+#ifndef GPGRT_GCC_VERSION
+
+# ifndef GPGRT_ATTR_FORMAT_ARG
+# if __GNUC__ >= 3 /* Actually 2.8 but testing the major is easier.  */
+#  define GPGRT_ATTR_FORMAT_ARG(a)  __attribute__ ((__format_arg__ (a)))
+# else
+#  define GPGRT_ATTR_FORMAT_ARG(a)
+# endif
+# endif
+
+# if __GNUC__ >= 4
+#  define GPGRT_ATTR_SENTINEL(a) __attribute__ ((sentinel(a)))
+# else
+#  define GPGRT_ATTR_SENTINEL(a)
+# endif
+
+# if __GNUC__ >= 4
+#  define GPGRT_ATTR_USED __attribute__ ((used))
+# else
+#  define GPGRT_ATTR_USED
+# endif
+
+#endif /*libgpg-error < 1.20 */
+
+
+/* We need this type even if we are not using libreadline and or we
+   did not include libreadline in the current file. */
+#ifndef GNUPG_LIBREADLINE_H_INCLUDED
+typedef char **rl_completion_func_t (const char *, int, int);
+#endif /*!GNUPG_LIBREADLINE_H_INCLUDED*/
+
 
 /* Handy malloc macros - please use only them. */
 #define xtrymalloc(a)    gcry_malloc ((a))
 #define xtryrealloc(a,b) gcry_realloc ((a),(b))
 #define xtrystrdup(a)    gcry_strdup ((a))
 #define xfree(a)         gcry_free ((a))
+#define xfree_fnc        gcry_free
 
 #define xmalloc(a)       gcry_xmalloc ((a))
 #define xmalloc_secure(a)  gcry_xmalloc_secure ((a))
 #define xmalloc_clear(a) gcry_xcalloc (1, (a))
 #define xmalloc_secure_clear(a) gcry_xcalloc_secure (1, (a))
 
+/* The default error source of the application.  This is different
+   from GPG_ERR_SOURCE_DEFAULT in that it does not depend on the
+   source file and thus is usable in code shared by applications.
+   Defined by init.c.  */
+extern gpg_err_source_t default_errsource;
+
 /* Convenience function to return a gpg-error code for memory
    allocation failures.  This function makes sure that an error will
    be returned even if accidently ERRNO is not set.  */
 static inline gpg_error_t
 out_of_core (void)
 {
-  return gpg_error (errno
-                    ? gpg_err_code_from_errno(errno)
-                    : GPG_ERR_MISSING_ERRNO);
-}
-
-/* A type to hold the ISO time.  Note that this this is the same as
-   the the KSBA type ksba_isotime_t. */
-typedef char gnupg_isotime_t[16];
-
-
-/*-- gettime.c --*/
-time_t gnupg_get_time (void);
-void   gnupg_get_isotime (gnupg_isotime_t timebuf);
-void   gnupg_set_time (time_t newtime, int freeze);
-int    gnupg_faked_time_p (void);
-u32    make_timestamp (void);
-u32    scan_isodatestr (const char *string);
-u32    add_days_to_timestamp (u32 stamp, u16 days);
-const char *strtimevalue (u32 stamp);
-const char *strtimestamp (u32 stamp); /* GMT */
-const char *isotimestamp (u32 stamp); /* GMT */
-const char *asctimestamp (u32 stamp); /* localized */
-
-
-/* Copy one iso ddate to another, this is inline so that we can do a
-   sanity check. */
-static inline void
-gnupg_copy_time (gnupg_isotime_t d, const gnupg_isotime_t s)
-{
-  if (*s && (strlen (s) != 15 || s[8] != 'T'))
-    BUG();
-  strcpy (d, s);
+  return gpg_error_from_syserror ();
 }
 
 
 /*-- signal.c --*/
 void gnupg_init_signals (int mode, void (*fast_cleanup)(void));
-void gnupg_pause_on_sigusr (int which);
 void gnupg_block_all_signals (void);
 void gnupg_unblock_all_signals (void);
 
@@ -119,77 +234,213 @@ int answer_is_yes_no_quit (const char *s);
 int answer_is_okay_cancel (const char *s, int def_answer);
 
 /*-- xreadline.c --*/
-ssize_t read_line (FILE *fp, 
+ssize_t read_line (FILE *fp,
                    char **addr_of_buffer, size_t *length_of_buffer,
                    size_t *max_length);
 
 
-/*-- b64enc.c --*/
-struct b64state 
-{ 
+/*-- b64enc.c and b64dec.c --*/
+struct b64state
+{
   unsigned int flags;
   int idx;
   int quad_count;
   FILE *fp;
+  estream_t stream;
   char *title;
   unsigned char radbuf[4];
+  u32 crc;
+  int stop_seen:1;
+  int invalid_encoding:1;
+  gpg_error_t lasterr;
 };
+
 gpg_error_t b64enc_start (struct b64state *state, FILE *fp, const char *title);
+gpg_error_t b64enc_start_es (struct b64state *state, estream_t fp,
+                             const char *title);
 gpg_error_t b64enc_write (struct b64state *state,
                           const void *buffer, size_t nbytes);
 gpg_error_t b64enc_finish (struct b64state *state);
 
+gpg_error_t b64dec_start (struct b64state *state, const char *title);
+gpg_error_t b64dec_proc (struct b64state *state, void *buffer, size_t length,
+                         size_t *r_nbytes);
+gpg_error_t b64dec_finish (struct b64state *state);
+
+
+/*-- zb32.c --*/
+char *zb32_encode (const void *data, unsigned int databits);
+
+
 /*-- sexputil.c */
+char *canon_sexp_to_string (const unsigned char *canon, size_t canonlen);
+void log_printcanon (const char *text,
+                     const unsigned char *sexp, size_t sexplen);
+void log_printsexp (const char *text, gcry_sexp_t sexp);
+
+gpg_error_t make_canon_sexp (gcry_sexp_t sexp,
+                             unsigned char **r_buffer, size_t *r_buflen);
+gpg_error_t make_canon_sexp_pad (gcry_sexp_t sexp, int secure,
+                                 unsigned char **r_buffer, size_t *r_buflen);
 gpg_error_t keygrip_from_canon_sexp (const unsigned char *key, size_t keylen,
                                      unsigned char *grip);
 int cmp_simple_canon_sexp (const unsigned char *a, const unsigned char *b);
 unsigned char *make_simple_sexp_from_hexstr (const char *line,
                                              size_t *nscanned);
+int hash_algo_from_sigval (const unsigned char *sigval);
+unsigned char *make_canon_sexp_from_rsa_pk (const void *m, size_t mlen,
+                                            const void *e, size_t elen,
+                                            size_t *r_len);
+gpg_error_t get_rsa_pk_from_canon_sexp (const unsigned char *keydata,
+                                        size_t keydatalen,
+                                        unsigned char const **r_n,
+                                        size_t *r_nlen,
+                                        unsigned char const **r_e,
+                                        size_t *r_elen);
+gpg_error_t get_pk_algo_from_canon_sexp (const unsigned char *keydata,
+                                         size_t keydatalen,
+                                         const char **r_algo);
+
+/*-- convert.c --*/
+int hex2bin (const char *string, void *buffer, size_t length);
+int hexcolon2bin (const char *string, void *buffer, size_t length);
+char *bin2hex (const void *buffer, size_t length, char *stringbuf);
+char *bin2hexcolon (const void *buffer, size_t length, char *stringbuf);
+const char *hex2str (const char *hexstring,
+                     char *buffer, size_t bufsize, size_t *buflen);
+char *hex2str_alloc (const char *hexstring, size_t *r_count);
+
+/*-- percent.c --*/
+char *percent_plus_escape (const char *string);
+char *percent_plus_unescape (const char *string, int nulrepl);
+char *percent_unescape (const char *string, int nulrepl);
+
+size_t percent_plus_unescape_inplace (char *string, int nulrepl);
+size_t percent_unescape_inplace (char *string, int nulrepl);
+
+/*-- openpgp-oid.c --*/
+gpg_error_t openpgp_oid_from_str (const char *string, gcry_mpi_t *r_mpi);
+char *openpgp_oid_to_str (gcry_mpi_t a);
+int openpgp_oid_is_ed25519 (gcry_mpi_t a);
+int openpgp_oid_is_crv25519 (gcry_mpi_t a);
+const char *openpgp_curve_to_oid (const char *name, unsigned int *r_nbits);
+const char *openpgp_oid_to_curve (const char *oid, int canon);
+const char *openpgp_enum_curves (int *idxp);
+
+
 
 /*-- homedir.c --*/
+const char *standard_homedir (void);
 const char *default_homedir (void);
-
+const char *gnupg_sysconfdir (void);
+const char *gnupg_bindir (void);
+const char *gnupg_libexecdir (void);
+const char *gnupg_libdir (void);
+const char *gnupg_datadir (void);
+const char *gnupg_localedir (void);
+const char *gnupg_cachedir (void);
+const char *dirmngr_sys_socket_name (void);
+const char *dirmngr_user_socket_name (void);
+
+/* All module names.  We also include gpg and gpgsm for the sake for
+   gpgconf. */
+#define GNUPG_MODULE_NAME_AGENT        1
+#define GNUPG_MODULE_NAME_PINENTRY     2
+#define GNUPG_MODULE_NAME_SCDAEMON     3
+#define GNUPG_MODULE_NAME_DIRMNGR      4
+#define GNUPG_MODULE_NAME_PROTECT_TOOL 5
+#define GNUPG_MODULE_NAME_CHECK_PATTERN 6
+#define GNUPG_MODULE_NAME_GPGSM         7
+#define GNUPG_MODULE_NAME_GPG           8
+#define GNUPG_MODULE_NAME_CONNECT_AGENT 9
+#define GNUPG_MODULE_NAME_GPGCONF       10
+#define GNUPG_MODULE_NAME_DIRMNGR_LDAP  11
+const char *gnupg_module_name (int which);
+void gnupg_module_name_flush_some (void);
+
+
+
+/*-- gpgrlhelp.c --*/
+void gnupg_rl_initialize (void);
+
+/*-- helpfile.c --*/
+char *gnupg_get_help_string (const char *key, int only_current_locale);
+
+/*-- localename.c --*/
+const char *gnupg_messages_locale_name (void);
 
 /*-- miscellaneous.c --*/
 
-/* Same as asprintf but return an allocated buffer suitable to be
-   freed using xfree.  This function simply dies on memory failure,
-   thus no extra check is required. */
-char *xasprintf (const char *fmt, ...) JNLIB_GCC_A_PRINTF(1,2);
-/* Same as asprintf but return an allocated buffer suitable to be
-   freed using xfree.  This function returns NULL on memory failure and
-   sets errno. */
-char *xtryasprintf (const char *fmt, ...) JNLIB_GCC_A_PRINTF(1,2);
+/* This function is called at startup to tell libgcrypt to use our own
+   logging subsystem. */
+void setup_libgcrypt_logging (void);
+
+/* Same as estream_asprintf but die on memory failure.  */
+char *xasprintf (const char *fmt, ...) GPGRT_ATTR_PRINTF(1,2);
+/* This is now an alias to estream_asprintf.  */
+char *xtryasprintf (const char *fmt, ...) GPGRT_ATTR_PRINTF(1,2);
+
+/* Replacement for gcry_cipher_algo_name.  */
+const char *gnupg_cipher_algo_name (int algo);
+
+void obsolete_option (const char *configname, unsigned int configlineno,
+                      const char *name);
 
 const char *print_fname_stdout (const char *s);
 const char *print_fname_stdin (const char *s);
-void print_string (FILE *fp, const byte *p, size_t n, int delim);
-void print_utf8_string2 ( FILE *fp, const byte *p, size_t n, int delim);
-void print_utf8_string (FILE *fp, const byte *p, size_t n);
+void print_utf8_buffer3 (estream_t fp, const void *p, size_t n,
+                         const char *delim);
+void print_utf8_buffer2 (estream_t fp, const void *p, size_t n, int delim);
+void print_utf8_buffer (estream_t fp, const void *p, size_t n);
+void print_hexstring (FILE *fp, const void *buffer, size_t length,
+                      int reserved);
 char *make_printable_string (const void *p, size_t n, int delim);
 
 int is_file_compressed (const char *s, int *ret_rc);
 
 int match_multistr (const char *multistr,const char *match);
 
+int gnupg_compare_version (const char *a, const char *b);
 
-/*-- Simple replacement functions. */
-#ifndef HAVE_TTYNAME
-/* Systems without ttyname (W32) will merely return NULL. */
-static inline char *
-ttyname (int fd) 
+struct debug_flags_s
 {
-  return NULL
+  unsigned int flag;
+  const char *name;
 };
-#endif /* !HAVE_TTYNAME */
+int parse_debug_flag (const char *string, unsigned int *debugvar,
+                      const struct debug_flags_s *flags);
+
 
-#ifndef HAVE_ISASCII
-static inline int 
-isascii (int c)
+/*-- Simple replacement functions. */
+
+/* We use the gnupg_ttyname macro to be safe not to run into conflicts
+   which an extisting but broken ttyname.  */
+#if !defined(HAVE_TTYNAME) || defined(HAVE_BROKEN_TTYNAME)
+# define gnupg_ttyname(n) _gnupg_ttyname ((n))
+/* Systems without ttyname (W32) will merely return NULL. */
+static inline char *
+_gnupg_ttyname (int fd)
 {
-  return (((c) & ~0x7f) == 0);
+  (void)fd;
+  return NULL;
 }
-#endif /* !HAVE_ISASCII */
+#else /*HAVE_TTYNAME*/
+# define gnupg_ttyname(n) ttyname ((n))
+#endif /*HAVE_TTYNAME */
+
+#ifdef HAVE_W32CE_SYSTEM
+#define getpid() GetCurrentProcessId ()
+char *_gnupg_getenv (const char *name); /* See sysutils.c */
+#define getenv(a)  _gnupg_getenv ((a))
+char *_gnupg_setenv (const char *name); /* See sysutils.c */
+#define setenv(a,b,c)  _gnupg_setenv ((a),(b),(c))
+int _gnupg_isatty (int fd);
+#define gnupg_isatty(a)  _gnupg_isatty ((a))
+#else
+#define gnupg_isatty(a)  isatty ((a))
+#endif
+
+
 
 /*-- Macros to replace ctype ones to avoid locale problems. --*/
 #define spacep(p)   (*(p) == ' ' || *(p) == '\t')
@@ -211,5 +462,10 @@ isascii (int c)
 #define xtoi_4(p)   ((xtoi_2(p) * 256) + xtoi_2((p)+2))
 
 
+/*-- Forward declaration of the commonly used server control structure.  */
+/*   (We need it here as it is used by some callback prototypes.) */
+struct server_control_s;
+typedef struct server_control_s *ctrl_t;
+
 
 #endif /*GNUPG_COMMON_UTIL_H*/