src/pEp_internal.h
author Krista 'DarthMama' Bennett <krista@pep.foundation>
Tue, 10 Dec 2019 12:15:21 +0100
branchkey_reset_get_revocations
changeset 4245 40ef37a1e806
parent 4235 1daffdbc64aa
child 4284 11da23e0fe0c
child 4312 1d1672a6dfb9
permissions -rw-r--r--
first version compiles for key_reset_and_deliver_revocations
     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 *key_identities_retrieve;
   232     sqlite3_stmt *get_user_default_key;
   233     sqlite3_stmt *get_all_keys_for_user;
   234         
   235     sqlite3_stmt *get_default_own_userid;
   236 
   237 
   238 //    sqlite3_stmt *set_own_key;
   239 
   240     // sequence value
   241     sqlite3_stmt *sequence_value1;
   242     sqlite3_stmt *sequence_value2;
   243 
   244     // revoked keys
   245     sqlite3_stmt *set_revoked;
   246     sqlite3_stmt *get_revoked;
   247     sqlite3_stmt *get_replacement_fpr;
   248 
   249     // mistrusted
   250     sqlite3_stmt* add_mistrusted_key;
   251     sqlite3_stmt* is_mistrusted_key;    
   252     sqlite3_stmt* delete_mistrusted_key;
   253     
   254     // aliases
   255     sqlite3_stmt *get_userid_alias_default;
   256     sqlite3_stmt *add_userid_alias;
   257 
   258     // callbacks
   259     examine_identity_t examine_identity;
   260     void *examine_management;
   261     notifyHandshake_t notifyHandshake;
   262     inject_sync_event_t inject_sync_event;
   263     retrieve_next_sync_event_t retrieve_next_sync_event;
   264 
   265     // pEp Sync
   266     void *sync_management;
   267     void *sync_obj;
   268     struct Sync_state_s sync_state;
   269 
   270 //     void* sync_state_payload;
   271 //     char sync_uuid[37];
   272 //     time_t LastCannotDecrypt;
   273 //     time_t LastUpdateRequest;
   274 
   275     // runtime config
   276 
   277     bool passive_mode;
   278     bool unencrypted_subject;
   279     bool service_log;
   280     
   281 #ifndef NDEBUG
   282 #   ifdef DEBUG_ERRORSTACK
   283     stringlist_t* errorstack;
   284 #   endif
   285     int debug_color;
   286 #endif
   287 };
   288 
   289 
   290 PEP_STATUS init_transport_system(PEP_SESSION session, bool in_first);
   291 void release_transport_system(PEP_SESSION session, bool out_last);
   292 
   293 /* NOT to be exposed to the outside!!! */
   294 PEP_STATUS encrypt_only(
   295         PEP_SESSION session, const stringlist_t *keylist, const char *ptext,
   296         size_t psize, char **ctext, size_t *csize
   297 );
   298 
   299 void decorate_message(
   300     message *msg,
   301     PEP_rating rating,
   302     stringlist_t *keylist,
   303     bool add_version,
   304     bool clobber);
   305 
   306 #if defined(NDEBUG) || defined(NOLOG)
   307 #define DEBUG_LOG(TITLE, ENTITY, DESC)
   308 #else
   309 #ifdef ANDROID
   310 #include <android/log.h>
   311 #define  LOG_MORE(...)  __android_log_print(ANDROID_LOG_DEBUG, "pEpEngine", " %s :: %s :: %s :: %s ", __VA_ARGS__);
   312 #else
   313 #include <stdio.h>
   314 #define  LOG_MORE(...)  fprintf(stderr, "pEpEngine DEBUG_LOG('%s','%s','%s','%s')\n", __VA_ARGS__);
   315 #endif
   316 #define DEBUG_LOG(TITLE, ENTITY, DESC) {\
   317     log_event(session, (TITLE), (ENTITY), (DESC), "debug " __FILE__ ":" S_LINE);\
   318     LOG_MORE((TITLE), (ENTITY), (DESC), __FILE__ ":" S_LINE)\
   319 }
   320 #endif
   321 
   322 typedef enum _normalize_hex_rest_t {
   323     accept_hex,
   324     ignore_hex,
   325     reject_hex
   326 } normalize_hex_res_t;
   327 
   328 static inline normalize_hex_res_t _normalize_hex(char *hex) 
   329 {
   330     if (*hex >= '0' && *hex <= '9')
   331         return accept_hex;
   332 
   333     if (*hex >= 'A' && *hex <= 'F') {
   334         *hex += 'a' - 'A';
   335         return accept_hex;
   336     }
   337 
   338     if (*hex >= 'a' && *hex <= 'f') 
   339         return accept_hex;
   340 
   341     if (*hex == ' ') 
   342         return ignore_hex;
   343 
   344     return reject_hex;
   345 }
   346 
   347 // Space tolerant and case insensitive fingerprint string compare
   348 static inline PEP_STATUS _compare_fprs(
   349         const char* fpra,
   350         size_t fpras,
   351         const char* fprb,
   352         size_t fprbs,
   353         int* comparison)
   354 {
   355 
   356     size_t ai = 0;
   357     size_t bi = 0;
   358     size_t significant = 0;
   359     int _comparison = 0;
   360     const int _FULL_FINGERPRINT_LENGTH = 40;
   361    
   362     // First compare every non-ignored chars until an end is reached
   363     while(ai < fpras && bi < fprbs)
   364     {
   365         char fprac = fpra[ai];
   366         char fprbc = fprb[bi];
   367         normalize_hex_res_t fprah = _normalize_hex(&fprac);
   368         normalize_hex_res_t fprbh = _normalize_hex(&fprbc);
   369 
   370         if(fprah == reject_hex || fprbh == reject_hex)
   371             return PEP_ILLEGAL_VALUE;
   372 
   373         if ( fprah == ignore_hex )
   374         {
   375             ai++;
   376         }
   377         else if ( fprbh == ignore_hex )
   378         {
   379             bi++;
   380         }
   381         else
   382         {
   383             if(fprac != fprbc && _comparison == 0 )
   384             {
   385                 _comparison = fprac > fprbc ? 1 : -1;
   386             }
   387 
   388             significant++;
   389             ai++;
   390             bi++;
   391 
   392         } 
   393     }
   394 
   395     // Bail out if we didn't got enough significnt chars
   396     if (significant != _FULL_FINGERPRINT_LENGTH )
   397         return PEP_TRUSTWORDS_FPR_WRONG_LENGTH;
   398 
   399     // Then purge remaining chars, all must be ignored chars
   400     while ( ai < fpras )
   401     {
   402         char fprac = fpra[ai];
   403         normalize_hex_res_t fprah = _normalize_hex(&fprac);
   404         if( fprah == reject_hex )
   405             return PEP_ILLEGAL_VALUE;
   406         if ( fprah != ignore_hex )
   407             return PEP_TRUSTWORDS_FPR_WRONG_LENGTH;
   408         ai++;
   409     }
   410     while ( bi < fprbs )
   411     {
   412         char fprbc = fprb[bi];
   413         normalize_hex_res_t fprbh = _normalize_hex(&fprbc);
   414         if( fprbh == reject_hex )
   415             return PEP_ILLEGAL_VALUE;
   416         if ( fprbh != ignore_hex )
   417             return PEP_TRUSTWORDS_FPR_WRONG_LENGTH;
   418         bi++;
   419     }
   420 
   421     *comparison = _comparison;
   422     return PEP_STATUS_OK;
   423 }
   424 
   425 static inline int _same_fpr(
   426         const char* fpra,
   427         size_t fpras,
   428         const char* fprb,
   429         size_t fprbs
   430     )
   431 {
   432     // illegal values are ignored, and considered not same.
   433     int comparison = 1;
   434 
   435     _compare_fprs(fpra, fpras, fprb, fprbs, &comparison);
   436 
   437     return comparison == 0;
   438 }
   439 
   440 // size is the length of the bytestr that's coming in. This is really only intended
   441 // for comparing two full strings. If charstr's length is different from bytestr_size,
   442 // we'll return a non-zero value.
   443 static inline int _unsigned_signed_strcmp(const unsigned char* bytestr, const char* charstr, int bytestr_size) {
   444     int charstr_len = strlen(charstr);
   445     if (charstr_len != bytestr_size)
   446         return -1; // we don't actually care except that it's non-zero
   447     return memcmp(bytestr, charstr, bytestr_size);
   448 }
   449 
   450 // This is just a horrible example of C type madness. UTF-8 made me do it.
   451 static inline char* _pEp_subj_copy() {
   452 #ifndef WIN32
   453     unsigned char pEpstr[] = PEP_SUBJ_STRING;
   454     void* retval = calloc(1, sizeof(unsigned char)*PEP_SUBJ_BYTELEN + 1);
   455     memcpy(retval, pEpstr, PEP_SUBJ_BYTELEN);
   456     return (char*)retval;
   457 #else
   458     return strdup("pEp");
   459 #endif
   460 }
   461 
   462 static inline bool is_me(PEP_SESSION session, pEp_identity* test_ident) {
   463     bool retval = false;
   464     if (test_ident && test_ident->user_id) {
   465         char* def_id = NULL;
   466         get_default_own_userid(session, &def_id);
   467         if (test_ident->me || 
   468             (def_id && strcmp(def_id, test_ident->user_id) == 0)) {
   469             retval = true;
   470         }
   471         free(def_id);
   472     }
   473     return retval;
   474 }
   475 
   476 static inline float pEp_version_numeric(const char* version_str) {
   477     float retval = 0;    
   478         
   479     if (!version_str || sscanf(version_str, "%f", &retval) != 1)
   480         return 0;
   481         
   482     return retval;    
   483 }
   484 
   485 static inline void pEp_version_major_minor(const char* version_str, unsigned int* major, unsigned int* minor) {
   486     if (!major || !minor)
   487         return;
   488                 
   489     if (!version_str || sscanf(version_str, "%u.%u", major, minor) != 2) {
   490         *major = 0;
   491         *minor = 0;
   492     }
   493         
   494     return;    
   495 }
   496 
   497 static inline int compare_versions(unsigned int first_maj, unsigned int first_min,
   498                                    unsigned int second_maj, unsigned int second_min) {
   499     if (first_maj > second_maj)
   500         return 1;
   501     if (first_maj < second_maj)
   502         return -1;
   503     if (first_min > second_min)
   504         return 1;
   505     if (first_min < second_min)
   506         return -1;
   507     return 0;    
   508 }
   509 
   510 static inline void set_min_version(unsigned int first_maj, unsigned int first_minor,
   511                                    unsigned int second_maj, unsigned int second_minor,
   512                                    unsigned int* result_maj, unsigned int* result_minor) {
   513     int result = compare_versions(first_maj, first_minor, second_maj, second_minor);
   514     if (result < 0) {
   515         *result_maj = first_maj;
   516         *result_minor = first_minor;
   517     }
   518     else {
   519         *result_maj = second_maj;
   520         *result_minor = second_minor;
   521     }    
   522 }
   523 
   524 static inline void set_max_version(unsigned int first_maj, unsigned int first_minor,
   525                                    unsigned int second_maj, unsigned int second_minor,
   526                                    unsigned int* result_maj, unsigned int* result_minor) {
   527     int result = compare_versions(first_maj, first_minor, second_maj, second_minor);
   528     if (result > 0) {
   529         *result_maj = first_maj;
   530         *result_minor = first_minor;
   531     }
   532     else {
   533         *result_maj = second_maj;
   534         *result_minor = second_minor;
   535     }    
   536 }
   537 
   538 #ifndef EMPTYSTR
   539 #define EMPTYSTR(STR) ((STR) == NULL || (STR)[0] == '\0')
   540 #endif
   541 
   542 #ifndef IS_PGP_CT
   543 #define IS_PGP_CT(CT) (((CT) | PEP_ct_confirmed) == PEP_ct_OpenPGP)
   544 #endif
   545 
   546 #ifndef _MIN
   547 #define _MIN(A, B) ((B) > (A) ? (A) : (B))
   548 #endif
   549 #ifndef _MAX
   550 #define _MAX(A, B) ((B) > (A) ? (B) : (A))
   551 #endif
   552 
   553 // These are globals used in generating message IDs and should only be
   554 // computed once, as they're either really constants or OS-dependent
   555 
   556 extern int _pEp_rand_max_bits;
   557 extern double _pEp_log2_36;
   558 
   559 static inline void _init_globals() {
   560     _pEp_rand_max_bits = (int) ceil(log2((double) RAND_MAX));
   561     _pEp_log2_36 = log2(36);
   562 }
   563 
   564 // spinlock implementation
   565 
   566 static inline int Sqlite3_step(sqlite3_stmt* stmt)
   567 {
   568     int rc;
   569     do {
   570         rc = sqlite3_step(stmt);
   571     } while (rc == SQLITE_BUSY || rc == SQLITE_LOCKED);
   572     return rc;
   573 }