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