src/pEp_internal.h
author Neal H. Walfield <neal@pep.foundation>
Wed, 08 May 2019 12:20:37 +0200
branchemail_comparison
changeset 3649 1dd837adc30b
parent 3540 8b1730bcb3e0
child 3638 4ba9bd8b80c1
child 3689 6ea4a0524c38
permissions -rw-r--r--
Fix public key.
     1 // This file is under GNU General Public License 3.0
     2 // see LICENSE.txt
     3 
     4 #define PEP_ENGINE_VERSION "1.1.1"
     5 
     6 // maximum attachment size to import as key 1MB, maximum of 20 attachments
     7 
     8 #define MAX_KEY_SIZE (1024 * 1024)
     9 #define MAX_KEYS_TO_IMPORT  20
    10 
    11 #define KEY_EXPIRE_DELTA (60 * 60 * 24 * 365)
    12 
    13 // this is 20 trustwords with 79 chars max
    14 #define MAX_TRUSTWORDS_SPACE (20 * 80)
    15 
    16 // XML parameters string
    17 #define PARMS_MAX 32768
    18 
    19 // maximum busy wait time in ms
    20 #define BUSY_WAIT_TIME 5000
    21 
    22 // maximum line length for reading gpg.conf
    23 #define MAX_LINELENGTH 1024
    24 
    25 // default keyserver
    26 #ifndef DEFAULT_KEYSERVER
    27 #define DEFAULT_KEYSERVER "hkp://keys.gnupg.net"
    28 #endif
    29 
    30 // crashdump constants
    31 #ifndef CRASHDUMP_DEFAULT_LINES
    32 #define CRASHDUMP_DEFAULT_LINES 100
    33 #endif
    34 #define CRASHDUMP_MAX_LINES 32767
    35 
    36 // p≡p full string, NUL-terminated
    37 #ifndef PEP_SUBJ_STRING
    38 #define PEP_SUBJ_STRING {0x70,0xE2,0x89,0xA1,0x70,0x00}
    39 #define PEP_SUBJ_BYTELEN 5
    40 #endif
    41 
    42 #ifndef PEP_SUBJ_KEY
    43 #define PEP_SUBJ_KEY "Subject: "
    44 #define PEP_SUBJ_KEY_LC "subject: "
    45 #define PEP_SUBJ_KEY_LEN 9
    46 #endif
    47 
    48 #ifndef PEP_MSG_WRAP_KEY
    49 #define PEP_MSG_WRAP_KEY "pEp-Wrapped-Message-Info: "
    50 #define PEP_MSG_WRAP_KEY_LC "pep-wrapped-message-info: "
    51 #define PEP_MSG_WRAP_KEY_LEN 26
    52 #endif
    53 
    54 
    55 #include "platform.h"
    56 
    57 #ifdef WIN32
    58 #define LOCAL_DB windoze_local_db()
    59 #define SYSTEM_DB windoze_system_db()
    60 #define LIBGPGME "libgpgme-11.dll"
    61 #else // UNIX
    62 #define _POSIX_C_SOURCE 200809L
    63 #include <dlfcn.h>
    64 #ifdef NDEBUG
    65 #define LOCAL_DB unix_local_db()
    66 #else
    67 #define LOCAL_DB unix_local_db(false)
    68 #endif
    69 #ifndef SYSTEM_DB
    70 #define SYSTEM_DB "/usr/share/pEp/system.db"
    71 #endif
    72 #ifndef LIBGPGME
    73 #define LIBGPGME "libgpgme-pthread.so"
    74 #endif
    75 #endif
    76 
    77 #include <locale.h>
    78 #include <stdlib.h>
    79 #include <string.h>
    80 #include <assert.h>
    81 #include <stdio.h>
    82 #include <ctype.h>
    83 #include <math.h>
    84 
    85 #ifdef SQLITE3_FROM_OS
    86 #include <sqlite3.h>
    87 #else
    88 #include "sqlite3.h"
    89 #endif
    90 
    91 #include "pEpEngine.h"
    92 
    93 // If not specified, build for GPG
    94 #ifndef USE_SEQUOIA
    95 #ifndef USE_NETPGP
    96 #ifndef USE_GPG
    97 #define USE_GPG
    98 #endif
    99 #endif
   100 #endif
   101 
   102 #if defined(USE_SEQUOIA)
   103 #include "pgp_sequoia_internal.h"
   104 #elif defined(USE_NETPGP)
   105 #include "pgp_netpgp_internal.h"
   106 #elif defined(USE_GPG)
   107 #include "pgp_gpg_internal.h"
   108 #endif
   109 
   110 #include "keymanagement.h"
   111 #include "cryptotech.h"
   112 #include "transport.h"
   113 #include "sync_api.h"
   114 #include "Sync_func.h"
   115 
   116 #include "key_reset.h"
   117 
   118 #define NOT_IMPLEMENTED assert(0); return PEP_UNKNOWN_ERROR;
   119 
   120 struct _pEpSession;
   121 typedef struct _pEpSession pEpSession;
   122 struct _pEpSession {
   123     const char *version;
   124     messageToSend_t messageToSend;
   125 
   126 #ifdef USE_GPG
   127     gpgme_ctx_t ctx;
   128 #elif defined(USE_NETPGP)
   129     pEpNetPGPSession ctx;
   130 #elif defined(USE_SEQUOIA)
   131     sqlite3 *key_db;
   132     struct {
   133         sqlite3_stmt *begin_transaction;
   134         sqlite3_stmt *commit_transaction;
   135         sqlite3_stmt *rollback_transaction;
   136         sqlite3_stmt *tpk_find;
   137         sqlite3_stmt *tsk_find;
   138         sqlite3_stmt *tpk_find_by_keyid;
   139         sqlite3_stmt *tsk_find_by_keyid;
   140         sqlite3_stmt *tpk_find_by_email;
   141         sqlite3_stmt *tsk_find_by_email;
   142         sqlite3_stmt *tpk_all;
   143         sqlite3_stmt *tsk_all;
   144         sqlite3_stmt *tpk_save_insert_primary;
   145         sqlite3_stmt *tpk_save_insert_subkeys;
   146         sqlite3_stmt *tpk_save_insert_userids;
   147     } sq_sql;
   148 #endif
   149 
   150     PEP_cryptotech_t *cryptotech;
   151     PEP_transport_t *transports;
   152 
   153     sqlite3 *db;
   154     sqlite3 *system_db;
   155 
   156     sqlite3_stmt *log;
   157     sqlite3_stmt *trustword;
   158     sqlite3_stmt *get_identity;
   159     sqlite3_stmt *get_identity_without_trust_check;
   160     sqlite3_stmt *get_identities_by_address;
   161     sqlite3_stmt *get_identities_by_userid;
   162     sqlite3_stmt *get_identities_by_main_key_id;
   163     sqlite3_stmt *replace_identities_fpr;
   164     sqlite3_stmt *replace_main_user_fpr;
   165     sqlite3_stmt *get_main_user_fpr;
   166     sqlite3_stmt *refresh_userid_default_key;
   167     sqlite3_stmt *delete_key;
   168     sqlite3_stmt *remove_fpr_as_default;
   169     sqlite3_stmt *set_person;
   170     sqlite3_stmt *update_person;
   171     sqlite3_stmt *delete_person;
   172     sqlite3_stmt *exists_person;    
   173     sqlite3_stmt *set_as_pEp_user;
   174     sqlite3_stmt *is_pEp_user;
   175     sqlite3_stmt *add_into_social_graph;
   176     sqlite3_stmt *get_own_address_binding_from_contact;
   177     sqlite3_stmt *set_revoke_contact_as_notified;
   178     sqlite3_stmt *get_contacted_ids_from_revoke_fpr;
   179     sqlite3_stmt *was_id_for_revoke_contacted;
   180     sqlite3_stmt *get_last_contacted;
   181     // sqlite3_stmt *set_device_group;
   182     // sqlite3_stmt *get_device_group;
   183     sqlite3_stmt *set_pgp_keypair;
   184     sqlite3_stmt *set_identity_entry;
   185     sqlite3_stmt *update_identity_entry;
   186     sqlite3_stmt *exists_identity_entry;        
   187     sqlite3_stmt *set_identity_flags;
   188     sqlite3_stmt *unset_identity_flags;
   189     sqlite3_stmt *set_trust;
   190     sqlite3_stmt *update_trust;
   191     sqlite3_stmt *exists_trust_entry;
   192     sqlite3_stmt *update_trust_to_pEp;
   193     sqlite3_stmt *update_trust_for_fpr;
   194     sqlite3_stmt *get_trust;
   195     sqlite3_stmt *get_trust_by_userid;
   196     sqlite3_stmt *least_trust;
   197     sqlite3_stmt *mark_compromised;
   198     sqlite3_stmt *reset_trust;
   199     sqlite3_stmt *crashdump;
   200     sqlite3_stmt *languagelist;
   201     sqlite3_stmt *i18n_token;
   202     sqlite3_stmt *replace_userid;
   203 
   204     // blacklist
   205     sqlite3_stmt *blacklist_add;
   206     sqlite3_stmt *blacklist_delete;
   207     sqlite3_stmt *blacklist_is_listed;
   208     sqlite3_stmt *blacklist_retrieve;
   209     
   210     // Keys
   211     sqlite3_stmt *own_key_is_listed;
   212     sqlite3_stmt *is_own_address;
   213     sqlite3_stmt *own_identities_retrieve;
   214     sqlite3_stmt *own_keys_retrieve;
   215     sqlite3_stmt *get_user_default_key;
   216     sqlite3_stmt *get_all_keys_for_user;
   217         
   218     sqlite3_stmt *get_default_own_userid;
   219 
   220 
   221 //    sqlite3_stmt *set_own_key;
   222 
   223     // sequence value
   224     sqlite3_stmt *sequence_value1;
   225     sqlite3_stmt *sequence_value2;
   226 
   227     // revoked keys
   228     sqlite3_stmt *set_revoked;
   229     sqlite3_stmt *get_revoked;
   230     sqlite3_stmt *get_replacement_fpr;
   231 
   232     // mistrusted
   233     sqlite3_stmt* add_mistrusted_key;
   234     sqlite3_stmt* is_mistrusted_key;    
   235     sqlite3_stmt* delete_mistrusted_key;
   236     
   237     // aliases
   238     sqlite3_stmt *get_userid_alias_default;
   239     sqlite3_stmt *add_userid_alias;
   240 
   241     // callbacks
   242     examine_identity_t examine_identity;
   243     void *examine_management;
   244     notifyHandshake_t notifyHandshake;
   245     inject_sync_event_t inject_sync_event;
   246     retrieve_next_sync_event_t retrieve_next_sync_event;
   247 
   248     // pEp Sync
   249     void *sync_management;
   250     void *sync_obj;
   251     struct Sync_state_s sync_state;
   252     struct own_Sync_state_s own_sync_state;
   253 
   254 //     void* sync_state_payload;
   255 //     char sync_uuid[37];
   256 //     time_t LastCannotDecrypt;
   257 //     time_t LastUpdateRequest;
   258 
   259     // runtime config
   260 
   261     bool passive_mode;
   262     bool unencrypted_subject;
   263     bool service_log;
   264     
   265 #ifdef DEBUG_ERRORSTACK
   266     stringlist_t* errorstack;
   267 #endif
   268 };
   269 
   270 
   271 PEP_STATUS init_transport_system(PEP_SESSION session, bool in_first);
   272 void release_transport_system(PEP_SESSION session, bool out_last);
   273 
   274 /* NOT to be exposed to the outside!!! */
   275 PEP_STATUS encrypt_only(
   276         PEP_SESSION session, const stringlist_t *keylist, const char *ptext,
   277         size_t psize, char **ctext, size_t *csize
   278 );
   279 
   280 #if defined(NDEBUG) || defined(NOLOG)
   281 #define DEBUG_LOG(TITLE, ENTITY, DESC)
   282 #else
   283 #ifdef ANDROID
   284 #include <android/log.h>
   285 #define  LOG_MORE(...)  __android_log_print(ANDROID_LOG_DEBUG, "pEpEngine", " %s :: %s :: %s :: %s ", __VA_ARGS__);
   286 #else
   287 #include <stdio.h>
   288 #define  LOG_MORE(...)  fprintf(stderr, "pEpEngine DEBUG_LOG('%s','%s','%s','%s')\n", __VA_ARGS__);
   289 #endif
   290 #define DEBUG_LOG(TITLE, ENTITY, DESC) {\
   291     log_event(session, (TITLE), (ENTITY), (DESC), "debug " __FILE__ ":" S_LINE);\
   292     LOG_MORE((TITLE), (ENTITY), (DESC), __FILE__ ":" S_LINE)\
   293 }
   294 #endif
   295 
   296 typedef enum _normalize_hex_rest_t {
   297     accept_hex,
   298     ignore_hex,
   299     reject_hex
   300 } normalize_hex_res_t;
   301 
   302 static inline normalize_hex_res_t _normalize_hex(char *hex) 
   303 {
   304     if (*hex >= '0' && *hex <= '9')
   305         return accept_hex;
   306 
   307     if (*hex >= 'A' && *hex <= 'F') {
   308         *hex += 'a' - 'A';
   309         return accept_hex;
   310     }
   311 
   312     if (*hex >= 'a' && *hex <= 'f') 
   313         return accept_hex;
   314 
   315     if (*hex == ' ') 
   316         return ignore_hex;
   317 
   318     return reject_hex;
   319 }
   320 
   321 // Space tolerant and case insensitive fingerprint string compare
   322 static inline PEP_STATUS _compare_fprs(
   323         const char* fpra,
   324         size_t fpras,
   325         const char* fprb,
   326         size_t fprbs,
   327         int* comparison)
   328 {
   329 
   330     size_t ai = 0;
   331     size_t bi = 0;
   332     size_t significant = 0;
   333     int _comparison = 0;
   334     const int _FULL_FINGERPRINT_LENGTH = 40;
   335    
   336     // First compare every non-ignored chars until an end is reached
   337     while(ai < fpras && bi < fprbs)
   338     {
   339         char fprac = fpra[ai];
   340         char fprbc = fprb[bi];
   341         normalize_hex_res_t fprah = _normalize_hex(&fprac);
   342         normalize_hex_res_t fprbh = _normalize_hex(&fprbc);
   343 
   344         if(fprah == reject_hex || fprbh == reject_hex)
   345             return PEP_ILLEGAL_VALUE;
   346 
   347         if ( fprah == ignore_hex )
   348         {
   349             ai++;
   350         }
   351         else if ( fprbh == ignore_hex )
   352         {
   353             bi++;
   354         }
   355         else
   356         {
   357             if(fprac != fprbc && _comparison == 0 )
   358             {
   359                 _comparison = fprac > fprbc ? 1 : -1;
   360             }
   361 
   362             significant++;
   363             ai++;
   364             bi++;
   365 
   366         } 
   367     }
   368 
   369     // Bail out if we didn't got enough significnt chars
   370     if (significant != _FULL_FINGERPRINT_LENGTH )
   371         return PEP_TRUSTWORDS_FPR_WRONG_LENGTH;
   372 
   373     // Then purge remaining chars, all must be ignored chars
   374     while ( ai < fpras )
   375     {
   376         char fprac = fpra[ai];
   377         normalize_hex_res_t fprah = _normalize_hex(&fprac);
   378         if( fprah == reject_hex )
   379             return PEP_ILLEGAL_VALUE;
   380         if ( fprah != ignore_hex )
   381             return PEP_TRUSTWORDS_FPR_WRONG_LENGTH;
   382         ai++;
   383     }
   384     while ( bi < fprbs )
   385     {
   386         char fprbc = fprb[bi];
   387         normalize_hex_res_t fprbh = _normalize_hex(&fprbc);
   388         if( fprbh == reject_hex )
   389             return PEP_ILLEGAL_VALUE;
   390         if ( fprbh != ignore_hex )
   391             return PEP_TRUSTWORDS_FPR_WRONG_LENGTH;
   392         bi++;
   393     }
   394 
   395     *comparison = _comparison;
   396     return PEP_STATUS_OK;
   397 }
   398 
   399 static inline int _same_fpr(
   400         const char* fpra,
   401         size_t fpras,
   402         const char* fprb,
   403         size_t fprbs
   404     )
   405 {
   406     // illegal values are ignored, and considered not same.
   407     int comparison = 1;
   408 
   409     _compare_fprs(fpra, fpras, fprb, fprbs, &comparison);
   410 
   411     return comparison == 0;
   412 }
   413 
   414 // size is the length of the bytestr that's coming in. This is really only intended
   415 // for comparing two full strings. If charstr's length is different from bytestr_size,
   416 // we'll return a non-zero value.
   417 static inline int _unsigned_signed_strcmp(const unsigned char* bytestr, const char* charstr, int bytestr_size) {
   418     int charstr_len = strlen(charstr);
   419     if (charstr_len != bytestr_size)
   420         return -1; // we don't actually care except that it's non-zero
   421     return memcmp(bytestr, charstr, bytestr_size);
   422 }
   423 
   424 // This is just a horrible example of C type madness. UTF-8 made me do it.
   425 static inline char* _pEp_subj_copy() {
   426 #ifndef WIN32
   427     unsigned char pEpstr[] = PEP_SUBJ_STRING;
   428     void* retval = calloc(1, sizeof(unsigned char)*PEP_SUBJ_BYTELEN + 1);
   429     memcpy(retval, pEpstr, PEP_SUBJ_BYTELEN);
   430     return (char*)retval;
   431 #else
   432     return strdup("pEp");
   433 #endif
   434 }
   435 
   436 static inline bool is_me(PEP_SESSION session, pEp_identity* test_ident) {
   437     bool retval = false;
   438     if (test_ident && test_ident->user_id) {
   439         char* def_id = NULL;
   440         get_default_own_userid(session, &def_id);
   441         if (test_ident->me || 
   442             (def_id && strcmp(def_id, test_ident->user_id) == 0)) {
   443             retval = true;
   444         }
   445         free(def_id);
   446     }
   447     return retval;
   448 }
   449 
   450 #ifndef EMPTYSTR
   451 #define EMPTYSTR(STR) ((STR) == NULL || (STR)[0] == '\0')
   452 #endif
   453 
   454 #ifndef IS_PGP_CT
   455 #define IS_PGP_CT(CT) (((CT) | PEP_ct_confirmed) == PEP_ct_OpenPGP)
   456 #endif
   457 
   458 #ifndef _MIN
   459 #define _MIN(A, B) ((B) > (A) ? (A) : (B))
   460 #endif
   461 #ifndef _MAX
   462 #define _MAX(A, B) ((B) > (A) ? (B) : (A))
   463 #endif
   464 
   465 
   466 // These are globals used in generating message IDs and should only be
   467 // computed once, as they're either really constants or OS-dependent
   468 
   469 extern int _pEp_rand_max_bits;
   470 extern double _pEp_log2_36;
   471 
   472 static inline void _init_globals() {
   473     _pEp_rand_max_bits = (int) ceil(log2((double) RAND_MAX));
   474     _pEp_log2_36 = log2(36);
   475 }