Merge branch 'STABLE-BRANCH-2-2' into master
[gnupg.git] / common / util.h
index af1a319..f372281 100644 (file)
@@ -3,8 +3,8 @@
  *
  * This file is part of GnuPG.
  *
- * GnuPG is free software; you can redistribute it and/or modify it
- * under the terms of either
+ * GnuPG is free software; you can redistribute and/or modify this
+ * part of GnuPG under the terms of either
  *
  *   - the GNU Lesser General Public License as published by the Free
  *     Software Foundation; either version 3 of the License, or (at
@@ -25,7 +25,7 @@
  *
  * 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/>.
+ * if not, see <https://www.gnu.org/licenses/>.
  */
 
 #ifndef GNUPG_COMMON_UTIL_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*/
-#if GPG_ERROR_VERSION_NUMBER < 0x011500  /* 1.21 */
-# define GPG_ERR_TRUE                       255
-# define GPG_ERR_FALSE                      256
+ * libgpg-error version.  Define them here.
+ * Example: (#if GPG_ERROR_VERSION_NUMBER < 0x011500 // 1.21)
+ */
+#if GPG_ERROR_VERSION_NUMBER < 0x011a00 /* 1.26 */
+# define GPG_ERR_UNKNOWN_FLAG     309
+# define GPG_ERR_INV_ORDER       310
+# define GPG_ERR_ALREADY_FETCHED  311
+# define GPG_ERR_TRY_LATER        312
+# define GPG_ERR_SYSTEM_BUG      666
+# define GPG_ERR_DNS_UNKNOWN     711
+# define GPG_ERR_DNS_SECTION     712
+# define GPG_ERR_DNS_ADDRESS     713
+# define GPG_ERR_DNS_NO_QUERY    714
+# define GPG_ERR_DNS_NO_ANSWER   715
+# define GPG_ERR_DNS_CLOSED      716
+# define GPG_ERR_DNS_VERIFY      717
+# define GPG_ERR_DNS_TIMEOUT     718
 #endif
 
+
 /* Hash function used with libksba. */
 #define HASH_FNC ((void (*)(void *, const void*,size_t))gcry_md_write)
 
+/* The length of the keygrip.  This is a SHA-1 hash of the key
+ * parameters as generated by gcry_pk_get_keygrip.  */
+#define KEYGRIP_LEN 20
+
+
 /* Get all the stuff from jnlib. */
 #include "../common/logging.h"
 #include "../common/argparse.h"
 #include "../common/dotlock.h"
 #include "../common/utf8conv.h"
 #include "../common/dynload.h"
+#include "../common/fwddecl.h"
+#include "../common/utilproto.h"
 
 #include "gettime.h"
 
 
 
 /* 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. */
@@ -218,7 +127,7 @@ 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.  */
+   be returned even if accidentally ERRNO is not set.  */
 static inline gpg_error_t
 out_of_core (void)
 {
@@ -226,11 +135,6 @@ out_of_core (void)
 }
 
 
-/*-- signal.c --*/
-void gnupg_init_signals (int mode, void (*fast_cleanup)(void));
-void gnupg_block_all_signals (void);
-void gnupg_unblock_all_signals (void);
-
 /*-- yesno.c --*/
 int answer_is_yes (const char *s);
 int answer_is_yes_no_default (const char *s, int def_answer);
@@ -271,11 +175,6 @@ 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,
@@ -301,9 +200,10 @@ gpg_error_t get_rsa_pk_from_canon_sexp (const unsigned char *keydata,
                                         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);
+
+int get_pk_algo_from_key (gcry_sexp_t key);
+int get_pk_algo_from_canon_sexp (const unsigned char *keydata,
+                                 size_t keydatalen);
 
 /*-- convert.c --*/
 int hex2bin (const char *string, void *buffer, size_t length);
@@ -326,16 +226,22 @@ size_t percent_unescape_inplace (char *string, int nulrepl);
 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);
+int openpgp_oid_is_cv25519 (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);
-
+const char *openpgp_is_curve_supported (const char *name,
+                                        int *r_algo, unsigned int *r_nbits);
 
 
 /*-- homedir.c --*/
 const char *standard_homedir (void);
 const char *default_homedir (void);
+void gnupg_set_homedir (const char *newdir);
+const char *gnupg_homedir (void);
+int gnupg_default_homedir_p (void);
+const char *gnupg_daemon_rootdir (void);
+const char *gnupg_socketdir (void);
 const char *gnupg_sysconfdir (void);
 const char *gnupg_bindir (void);
 const char *gnupg_libexecdir (void);
@@ -343,8 +249,9 @@ 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);
+const char *dirmngr_socket_name (void);
+
+char *_gnupg_socketdir_internal (int skip_checks, unsigned *r_info);
 
 /* All module names.  We also include gpg and gpgsm for the sake for
    gpgconf. */
@@ -359,8 +266,10 @@ const char *dirmngr_user_socket_name (void);
 #define GNUPG_MODULE_NAME_CONNECT_AGENT 9
 #define GNUPG_MODULE_NAME_GPGCONF       10
 #define GNUPG_MODULE_NAME_DIRMNGR_LDAP  11
+#define GNUPG_MODULE_NAME_GPGV          12
 const char *gnupg_module_name (int which);
 void gnupg_module_name_flush_some (void);
+void gnupg_set_builddir (const char *newdir);
 
 
 
@@ -379,6 +288,9 @@ const char *gnupg_messages_locale_name (void);
    logging subsystem. */
 void setup_libgcrypt_logging (void);
 
+/* Print an out of core message and die.  */
+void xoutofcore (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.  */
@@ -396,8 +308,10 @@ 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_utf8_string (estream_t stream, const char *p);
 void print_hexstring (FILE *fp, const void *buffer, size_t length,
                       int reserved);
+char *try_make_printable_string (const void *p, size_t n, int delim);
 char *make_printable_string (const void *p, size_t n, int delim);
 
 int is_file_compressed (const char *s, int *ret_rc);
@@ -449,6 +363,9 @@ int _gnupg_isatty (int fd);
 /*-- Macros to replace ctype ones to avoid locale problems. --*/
 #define spacep(p)   (*(p) == ' ' || *(p) == '\t')
 #define digitp(p)   (*(p) >= '0' && *(p) <= '9')
+#define alphap(p)   ((*(p) >= 'A' && *(p) <= 'Z')       \
+                     || (*(p) >= 'a' && *(p) <= 'z'))
+#define alnump(p)   (alphap (p) || digitp (p))
 #define hexdigitp(a) (digitp (a)                     \
                       || (*(a) >= 'A' && *(a) <= 'F')  \
                       || (*(a) >= 'a' && *(a) <= 'f'))
@@ -465,11 +382,4 @@ int _gnupg_isatty (int fd);
 #define xtoi_2(p)   ((xtoi_1(p) * 16) + xtoi_1((p)+1))
 #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*/