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