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