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