src/pEp_internal.h
author Krista 'DarthMama' Bennett <krista@pep.foundation>
Tue, 25 Jun 2019 14:33:14 +0200
branchENGINE-581
changeset 3870 018251280dbf
parent 3797 657dc02b1cc3
child 3871 d1d515455192
child 3885 843f7c599a97
permissions -rw-r--r--
exclusive transaction instead of locking_mode - still not sure it does anything, but...
     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 10000
    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 *begin_transaction_excl;
   135         sqlite3_stmt *commit_transaction;
   136         sqlite3_stmt *rollback_transaction;
   137         sqlite3_stmt *tpk_find;
   138         sqlite3_stmt *tsk_find;
   139         sqlite3_stmt *tpk_find_by_keyid;
   140         sqlite3_stmt *tsk_find_by_keyid;
   141         sqlite3_stmt *tpk_find_by_email;
   142         sqlite3_stmt *tsk_find_by_email;
   143         sqlite3_stmt *tpk_all;
   144         sqlite3_stmt *tsk_all;
   145         sqlite3_stmt *tpk_save_insert_primary;
   146         sqlite3_stmt *tpk_save_insert_subkeys;
   147         sqlite3_stmt *tpk_save_insert_userids;
   148         sqlite3_stmt *delete_keypair;
   149     } sq_sql;
   150 #endif
   151 
   152     PEP_cryptotech_t *cryptotech;
   153     PEP_CIPHER_SUITE cipher_suite;
   154 
   155     PEP_transport_t *transports;
   156 
   157     sqlite3 *db;
   158     sqlite3 *system_db;
   159 
   160     sqlite3_stmt *log;
   161     sqlite3_stmt *trustword;
   162     sqlite3_stmt *get_identity;
   163     sqlite3_stmt *get_identity_without_trust_check;
   164     sqlite3_stmt *get_identities_by_address;
   165     sqlite3_stmt *get_identities_by_userid;
   166     sqlite3_stmt *get_identities_by_main_key_id;
   167     sqlite3_stmt *replace_identities_fpr;
   168     sqlite3_stmt *replace_main_user_fpr;
   169     sqlite3_stmt *get_main_user_fpr;
   170     sqlite3_stmt *refresh_userid_default_key;
   171     sqlite3_stmt *delete_key;
   172     sqlite3_stmt *remove_fpr_as_default;
   173     sqlite3_stmt *set_person;
   174     sqlite3_stmt *update_person;
   175     sqlite3_stmt *delete_person;
   176     sqlite3_stmt *exists_person;    
   177     sqlite3_stmt *set_as_pEp_user;
   178     sqlite3_stmt *is_pEp_user;
   179     sqlite3_stmt *add_into_social_graph;
   180     sqlite3_stmt *get_own_address_binding_from_contact;
   181     sqlite3_stmt *set_revoke_contact_as_notified;
   182     sqlite3_stmt *get_contacted_ids_from_revoke_fpr;
   183     sqlite3_stmt *was_id_for_revoke_contacted;
   184     sqlite3_stmt *get_last_contacted;
   185     // sqlite3_stmt *set_device_group;
   186     // sqlite3_stmt *get_device_group;
   187     sqlite3_stmt *set_pgp_keypair;
   188     sqlite3_stmt *set_identity_entry;
   189     sqlite3_stmt *update_identity_entry;
   190     sqlite3_stmt *exists_identity_entry;        
   191     sqlite3_stmt *set_identity_flags;
   192     sqlite3_stmt *unset_identity_flags;
   193     sqlite3_stmt *set_trust;
   194     sqlite3_stmt *update_trust;
   195     sqlite3_stmt *exists_trust_entry;
   196     sqlite3_stmt *update_trust_to_pEp;
   197     sqlite3_stmt *update_trust_for_fpr;
   198     sqlite3_stmt *get_trust;
   199     sqlite3_stmt *get_trust_by_userid;
   200     sqlite3_stmt *least_trust;
   201     sqlite3_stmt *mark_compromised;
   202     sqlite3_stmt *reset_trust;
   203     sqlite3_stmt *crashdump;
   204     sqlite3_stmt *languagelist;
   205     sqlite3_stmt *i18n_token;
   206     sqlite3_stmt *replace_userid;
   207 
   208     // blacklist
   209     sqlite3_stmt *blacklist_add;
   210     sqlite3_stmt *blacklist_delete;
   211     sqlite3_stmt *blacklist_is_listed;
   212     sqlite3_stmt *blacklist_retrieve;
   213     
   214     // Keys
   215     sqlite3_stmt *own_key_is_listed;
   216     sqlite3_stmt *is_own_address;
   217     sqlite3_stmt *own_identities_retrieve;
   218     sqlite3_stmt *own_keys_retrieve;
   219     sqlite3_stmt *get_user_default_key;
   220     sqlite3_stmt *get_all_keys_for_user;
   221         
   222     sqlite3_stmt *get_default_own_userid;
   223 
   224 
   225 //    sqlite3_stmt *set_own_key;
   226 
   227     // sequence value
   228     sqlite3_stmt *sequence_value1;
   229     sqlite3_stmt *sequence_value2;
   230 
   231     // revoked keys
   232     sqlite3_stmt *set_revoked;
   233     sqlite3_stmt *get_revoked;
   234     sqlite3_stmt *get_replacement_fpr;
   235 
   236     // mistrusted
   237     sqlite3_stmt* add_mistrusted_key;
   238     sqlite3_stmt* is_mistrusted_key;    
   239     sqlite3_stmt* delete_mistrusted_key;
   240     
   241     // aliases
   242     sqlite3_stmt *get_userid_alias_default;
   243     sqlite3_stmt *add_userid_alias;
   244 
   245     // callbacks
   246     examine_identity_t examine_identity;
   247     void *examine_management;
   248     notifyHandshake_t notifyHandshake;
   249     inject_sync_event_t inject_sync_event;
   250     retrieve_next_sync_event_t retrieve_next_sync_event;
   251 
   252     // pEp Sync
   253     void *sync_management;
   254     void *sync_obj;
   255     struct Sync_state_s sync_state;
   256 
   257 //     void* sync_state_payload;
   258 //     char sync_uuid[37];
   259 //     time_t LastCannotDecrypt;
   260 //     time_t LastUpdateRequest;
   261 
   262     // runtime config
   263 
   264     bool passive_mode;
   265     bool unencrypted_subject;
   266     bool service_log;
   267     
   268 #ifdef DEBUG_ERRORSTACK
   269     stringlist_t* errorstack;
   270 #endif
   271 };
   272 
   273 
   274 PEP_STATUS init_transport_system(PEP_SESSION session, bool in_first);
   275 void release_transport_system(PEP_SESSION session, bool out_last);
   276 
   277 /* NOT to be exposed to the outside!!! */
   278 PEP_STATUS encrypt_only(
   279         PEP_SESSION session, const stringlist_t *keylist, const char *ptext,
   280         size_t psize, char **ctext, size_t *csize
   281 );
   282 
   283 #if defined(NDEBUG) || defined(NOLOG)
   284 #define DEBUG_LOG(TITLE, ENTITY, DESC)
   285 #else
   286 #ifdef ANDROID
   287 #include <android/log.h>
   288 #define  LOG_MORE(...)  __android_log_print(ANDROID_LOG_DEBUG, "pEpEngine", " %s :: %s :: %s :: %s ", __VA_ARGS__);
   289 #else
   290 #include <stdio.h>
   291 #define  LOG_MORE(...)  fprintf(stderr, "pEpEngine DEBUG_LOG('%s','%s','%s','%s')\n", __VA_ARGS__);
   292 #endif
   293 #define DEBUG_LOG(TITLE, ENTITY, DESC) {\
   294     log_event(session, (TITLE), (ENTITY), (DESC), "debug " __FILE__ ":" S_LINE);\
   295     LOG_MORE((TITLE), (ENTITY), (DESC), __FILE__ ":" S_LINE)\
   296 }
   297 #endif
   298 
   299 typedef enum _normalize_hex_rest_t {
   300     accept_hex,
   301     ignore_hex,
   302     reject_hex
   303 } normalize_hex_res_t;
   304 
   305 static inline normalize_hex_res_t _normalize_hex(char *hex) 
   306 {
   307     if (*hex >= '0' && *hex <= '9')
   308         return accept_hex;
   309 
   310     if (*hex >= 'A' && *hex <= 'F') {
   311         *hex += 'a' - 'A';
   312         return accept_hex;
   313     }
   314 
   315     if (*hex >= 'a' && *hex <= 'f') 
   316         return accept_hex;
   317 
   318     if (*hex == ' ') 
   319         return ignore_hex;
   320 
   321     return reject_hex;
   322 }
   323 
   324 // Space tolerant and case insensitive fingerprint string compare
   325 static inline PEP_STATUS _compare_fprs(
   326         const char* fpra,
   327         size_t fpras,
   328         const char* fprb,
   329         size_t fprbs,
   330         int* comparison)
   331 {
   332 
   333     size_t ai = 0;
   334     size_t bi = 0;
   335     size_t significant = 0;
   336     int _comparison = 0;
   337     const int _FULL_FINGERPRINT_LENGTH = 40;
   338    
   339     // First compare every non-ignored chars until an end is reached
   340     while(ai < fpras && bi < fprbs)
   341     {
   342         char fprac = fpra[ai];
   343         char fprbc = fprb[bi];
   344         normalize_hex_res_t fprah = _normalize_hex(&fprac);
   345         normalize_hex_res_t fprbh = _normalize_hex(&fprbc);
   346 
   347         if(fprah == reject_hex || fprbh == reject_hex)
   348             return PEP_ILLEGAL_VALUE;
   349 
   350         if ( fprah == ignore_hex )
   351         {
   352             ai++;
   353         }
   354         else if ( fprbh == ignore_hex )
   355         {
   356             bi++;
   357         }
   358         else
   359         {
   360             if(fprac != fprbc && _comparison == 0 )
   361             {
   362                 _comparison = fprac > fprbc ? 1 : -1;
   363             }
   364 
   365             significant++;
   366             ai++;
   367             bi++;
   368 
   369         } 
   370     }
   371 
   372     // Bail out if we didn't got enough significnt chars
   373     if (significant != _FULL_FINGERPRINT_LENGTH )
   374         return PEP_TRUSTWORDS_FPR_WRONG_LENGTH;
   375 
   376     // Then purge remaining chars, all must be ignored chars
   377     while ( ai < fpras )
   378     {
   379         char fprac = fpra[ai];
   380         normalize_hex_res_t fprah = _normalize_hex(&fprac);
   381         if( fprah == reject_hex )
   382             return PEP_ILLEGAL_VALUE;
   383         if ( fprah != ignore_hex )
   384             return PEP_TRUSTWORDS_FPR_WRONG_LENGTH;
   385         ai++;
   386     }
   387     while ( bi < fprbs )
   388     {
   389         char fprbc = fprb[bi];
   390         normalize_hex_res_t fprbh = _normalize_hex(&fprbc);
   391         if( fprbh == reject_hex )
   392             return PEP_ILLEGAL_VALUE;
   393         if ( fprbh != ignore_hex )
   394             return PEP_TRUSTWORDS_FPR_WRONG_LENGTH;
   395         bi++;
   396     }
   397 
   398     *comparison = _comparison;
   399     return PEP_STATUS_OK;
   400 }
   401 
   402 static inline int _same_fpr(
   403         const char* fpra,
   404         size_t fpras,
   405         const char* fprb,
   406         size_t fprbs
   407     )
   408 {
   409     // illegal values are ignored, and considered not same.
   410     int comparison = 1;
   411 
   412     _compare_fprs(fpra, fpras, fprb, fprbs, &comparison);
   413 
   414     return comparison == 0;
   415 }
   416 
   417 // size is the length of the bytestr that's coming in. This is really only intended
   418 // for comparing two full strings. If charstr's length is different from bytestr_size,
   419 // we'll return a non-zero value.
   420 static inline int _unsigned_signed_strcmp(const unsigned char* bytestr, const char* charstr, int bytestr_size) {
   421     int charstr_len = strlen(charstr);
   422     if (charstr_len != bytestr_size)
   423         return -1; // we don't actually care except that it's non-zero
   424     return memcmp(bytestr, charstr, bytestr_size);
   425 }
   426 
   427 // This is just a horrible example of C type madness. UTF-8 made me do it.
   428 static inline char* _pEp_subj_copy() {
   429 #ifndef WIN32
   430     unsigned char pEpstr[] = PEP_SUBJ_STRING;
   431     void* retval = calloc(1, sizeof(unsigned char)*PEP_SUBJ_BYTELEN + 1);
   432     memcpy(retval, pEpstr, PEP_SUBJ_BYTELEN);
   433     return (char*)retval;
   434 #else
   435     return strdup("pEp");
   436 #endif
   437 }
   438 
   439 static inline bool is_me(PEP_SESSION session, pEp_identity* test_ident) {
   440     bool retval = false;
   441     if (test_ident && test_ident->user_id) {
   442         char* def_id = NULL;
   443         get_default_own_userid(session, &def_id);
   444         if (test_ident->me || 
   445             (def_id && strcmp(def_id, test_ident->user_id) == 0)) {
   446             retval = true;
   447         }
   448         free(def_id);
   449     }
   450     return retval;
   451 }
   452 
   453 #ifndef EMPTYSTR
   454 #define EMPTYSTR(STR) ((STR) == NULL || (STR)[0] == '\0')
   455 #endif
   456 
   457 #ifndef IS_PGP_CT
   458 #define IS_PGP_CT(CT) (((CT) | PEP_ct_confirmed) == PEP_ct_OpenPGP)
   459 #endif
   460 
   461 #ifndef _MIN
   462 #define _MIN(A, B) ((B) > (A) ? (A) : (B))
   463 #endif
   464 #ifndef _MAX
   465 #define _MAX(A, B) ((B) > (A) ? (B) : (A))
   466 #endif
   467 
   468 
   469 // These are globals used in generating message IDs and should only be
   470 // computed once, as they're either really constants or OS-dependent
   471 
   472 extern int _pEp_rand_max_bits;
   473 extern double _pEp_log2_36;
   474 
   475 static inline void _init_globals() {
   476     _pEp_rand_max_bits = (int) ceil(log2((double) RAND_MAX));
   477     _pEp_log2_36 = log2(36);
   478 }
   479 
   480 // spinlock implementation
   481 
   482 static inline int Sqlite3_step(sqlite3_stmt* stmt)
   483 {
   484     int rc;
   485     do {
   486         rc = sqlite3_step(stmt);
   487     } while (rc == SQLITE_BUSY || rc == SQLITE_LOCKED);
   488     return rc;
   489 }