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