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