src/pEp_internal.h
author Krista Bennett <krista@pep-project.org>
Wed, 28 Feb 2018 14:54:30 +0100
branchENGINE-294
changeset 2549 5fc5d6be0b36
parent 2542 b7f6df848795
child 2571 817d69de911f
permissions -rw-r--r--
ENGINE-294: blacklisting is now only checked in identity_rating, outgoing_message_rating and encrypt_message, and then only for OpenPGP comm_types.
vb@1517
     1
// This file is under GNU General Public License 3.0
vb@1517
     2
// see LICENSE.txt
vb@1517
     3
krista@2150
     4
#define PEP_ENGINE_VERSION "0.9.0"
vb@908
     5
vb@908
     6
// maximum attachment size to import as key 1MB, maximum of 20 attachments
vb@908
     7
vb@908
     8
#define MAX_KEY_SIZE (1024 * 1024)
vb@908
     9
#define MAX_KEYS_TO_IMPORT  20
vb@24
    10
vb@233
    11
// this is 20 trustwords with 79 chars max
vb@251
    12
#define MAX_TRUSTWORDS_SPACE (20 * 80)
vb@24
    13
vb@24
    14
// XML parameters string
vb@24
    15
#define PARMS_MAX 32768
vb@24
    16
vb@24
    17
// maximum busy wait time in ms
vb@24
    18
#define BUSY_WAIT_TIME 5000
vb@24
    19
vb@24
    20
// maximum line length for reading gpg.conf
vb@24
    21
#define MAX_LINELENGTH 1024
vb@24
    22
vb@24
    23
// default keyserver
vb@450
    24
#ifndef DEFAULT_KEYSERVER
vb@24
    25
#define DEFAULT_KEYSERVER "hkp://keys.gnupg.net"
vb@450
    26
#endif
vb@450
    27
vb@450
    28
// crashdump constants
vb@450
    29
#ifndef CRASHDUMP_DEFAULT_LINES
vb@450
    30
#define CRASHDUMP_DEFAULT_LINES 100
vb@450
    31
#endif
vb@450
    32
#define CRASHDUMP_MAX_LINES 32767
vb@24
    33
krista@2045
    34
// p≡p full string, NUL-terminated
krista@2045
    35
#ifndef PEP_SUBJ_STRING
krista@2045
    36
#define PEP_SUBJ_STRING {0x70,0xE2,0x89,0xA1,0x70,0x00}
krista@2045
    37
#define PEP_SUBJ_BYTELEN 5
krista@2045
    38
#endif
krista@2045
    39
krista@2078
    40
#ifndef PEP_SUBJ_KEY
krista@2078
    41
#define PEP_SUBJ_KEY "Subject: "
krista@2078
    42
#define PEP_SUBJ_KEY_LC "subject: "
krista@2078
    43
#define PEP_SUBJ_KEY_LEN 9
krista@2078
    44
#endif
krista@2078
    45
krista@2120
    46
#ifndef PEP_MSG_WRAP_KEY
krista@2120
    47
#define PEP_MSG_WRAP_KEY "pEp-Wrapped-Message-Info: "
krista@2120
    48
#define PEP_MSG_WRAP_KEY_LC "pep-wrapped-message-info: "
krista@2120
    49
#define PEP_MSG_WRAP_KEY_LEN 26
krista@2078
    50
#endif
krista@2078
    51
krista@2078
    52
vb@130
    53
#include "platform.h"
vb@130
    54
vb@24
    55
#ifdef WIN32
vb@24
    56
#define LOCAL_DB windoze_local_db()
vb@24
    57
#define SYSTEM_DB windoze_system_db()
vb@24
    58
#define LIBGPGME "libgpgme-11.dll"
vb@24
    59
#else // UNIX
vb@24
    60
#define _POSIX_C_SOURCE 200809L
vb@24
    61
#include <dlfcn.h>
vb@24
    62
#define LOCAL_DB unix_local_db()
vb@24
    63
#ifndef SYSTEM_DB
vb@24
    64
#define SYSTEM_DB "/usr/share/pEp/system.db"
vb@24
    65
#endif
vb@24
    66
#ifndef LIBGPGME
vb@24
    67
#define LIBGPGME "libgpgme-pthread.so"
vb@24
    68
#endif
vb@24
    69
#endif
vb@24
    70
vb@24
    71
#include <locale.h>
vb@24
    72
#include <stdlib.h>
vb@24
    73
#include <string.h>
vb@24
    74
#include <assert.h>
vb@24
    75
#include <stdio.h>
edouard@1521
    76
#include <ctype.h>
krista@2176
    77
#include <math.h>
vb@24
    78
damiano@1997
    79
#ifdef SQLITE3_FROM_OS
damiano@1997
    80
#include <sqlite3.h>
damiano@1997
    81
#else
vb@24
    82
#include "sqlite3.h"
damiano@1997
    83
#endif
vb@24
    84
vb@24
    85
#include "pEpEngine.h"
Edouard@168
    86
Edouard@168
    87
// If not specified, build for GPG
Edouard@168
    88
#ifndef USE_NETPGP
Edouard@168
    89
#ifndef USE_GPG
Edouard@168
    90
#define USE_GPG
Edouard@168
    91
#endif
Edouard@168
    92
#endif
Edouard@168
    93
Edouard@168
    94
#ifdef USE_GPG
vb@24
    95
#include "pgp_gpg_internal.h"
vb@229
    96
#elif defined(USE_NETPGP)
Edouard@168
    97
#include "pgp_netpgp_internal.h"
vb@24
    98
#endif
vb@24
    99
vb@292
   100
#include "keymanagement.h"
vb@28
   101
#include "cryptotech.h"
vb@28
   102
#include "transport.h"
krista@2271
   103
#include "sync.h"
vb@28
   104
vb@125
   105
#define NOT_IMPLEMENTED assert(0); return PEP_UNKNOWN_ERROR;
vb@24
   106
edouard@1603
   107
struct _pEpSession;
edouard@1603
   108
typedef struct _pEpSession pEpSession;
edouard@1603
   109
struct _pEpSession {
vb@24
   110
    const char *version;
Edouard@168
   111
#ifdef USE_GPG
vb@24
   112
    gpgme_ctx_t ctx;
vb@229
   113
#elif defined(USE_NETPGP)
Edouard@252
   114
    pEpNetPGPSession ctx;
vb@24
   115
#endif
vb@24
   116
vb@62
   117
    PEP_cryptotech_t *cryptotech;
vb@62
   118
    PEP_transport_t *transports;
vb@28
   119
vb@24
   120
    sqlite3 *db;
vb@24
   121
    sqlite3 *system_db;
vb@24
   122
vb@24
   123
    sqlite3_stmt *log;
vb@233
   124
    sqlite3_stmt *trustword;
vb@24
   125
    sqlite3_stmt *get_identity;
krista@2461
   126
    sqlite3_stmt *get_identity_without_trust_check;
krista@2461
   127
    sqlite3_stmt *get_identities_by_address;
krista@1799
   128
    sqlite3_stmt *replace_identities_fpr;
krista@2461
   129
    sqlite3_stmt *replace_main_user_fpr;
krista@2461
   130
    sqlite3_stmt *get_main_user_fpr;
krista@2461
   131
    sqlite3_stmt *refresh_userid_default_key;
krista@2461
   132
    sqlite3_stmt *remove_fpr_as_default;
vb@24
   133
    sqlite3_stmt *set_person;
krista@2480
   134
    sqlite3_stmt *update_person;
krista@2480
   135
    sqlite3_stmt *exists_person;    
krista@2468
   136
    sqlite3_stmt *set_as_pep_user;
krista@2468
   137
    sqlite3_stmt *is_pep_user;
edouard@1234
   138
    sqlite3_stmt *set_device_group;
edouard@1235
   139
    sqlite3_stmt *get_device_group;
vb@24
   140
    sqlite3_stmt *set_pgp_keypair;
krista@2478
   141
    sqlite3_stmt *set_identity_entry;
krista@2480
   142
    sqlite3_stmt *update_identity_entry;
krista@2480
   143
    sqlite3_stmt *exists_identity_entry;        
vb@932
   144
    sqlite3_stmt *set_identity_flags;
edouard@1394
   145
    sqlite3_stmt *unset_identity_flags;
vb@24
   146
    sqlite3_stmt *set_trust;
krista@2542
   147
    sqlite3_stmt *update_trust;
krista@2542
   148
    sqlite3_stmt *update_trust_to_pep;    
krista@2480
   149
    sqlite3_stmt *exists_trust_entry;
krista@1799
   150
    sqlite3_stmt *update_trust_for_fpr;
vb@24
   151
    sqlite3_stmt *get_trust;
vb@251
   152
    sqlite3_stmt *least_trust;
vb@357
   153
    sqlite3_stmt *mark_compromized;
Edouard@409
   154
    sqlite3_stmt *reset_trust;
vb@450
   155
    sqlite3_stmt *crashdump;
vb@458
   156
    sqlite3_stmt *languagelist;
vb@458
   157
    sqlite3_stmt *i18n_token;
krista@2461
   158
    sqlite3_stmt *replace_userid;
fdik@494
   159
fdik@494
   160
    // blacklist
fdik@494
   161
    sqlite3_stmt *blacklist_add;
fdik@494
   162
    sqlite3_stmt *blacklist_delete;
fdik@494
   163
    sqlite3_stmt *blacklist_is_listed;
fdik@494
   164
    sqlite3_stmt *blacklist_retrieve;
Edouard@584
   165
    
Edouard@584
   166
    // Own keys
Edouard@584
   167
    sqlite3_stmt *own_key_is_listed;
vb@955
   168
    sqlite3_stmt *own_identities_retrieve;
edouard@1394
   169
    sqlite3_stmt *own_keys_retrieve;
krista@2461
   170
    sqlite3_stmt *get_user_default_key;
krista@2461
   171
        
krista@2461
   172
    sqlite3_stmt *get_default_own_userid;
krista@2461
   173
krista@2461
   174
//    sqlite3_stmt *set_own_key;
vb@292
   175
vb@632
   176
    // sequence value
vb@633
   177
    sqlite3_stmt *sequence_value1;
vb@633
   178
    sqlite3_stmt *sequence_value2;
vb@1085
   179
    sqlite3_stmt *sequence_value3;
vb@632
   180
edouard@1236
   181
    // revoked keys
Edouard@693
   182
    sqlite3_stmt *set_revoked;
Edouard@693
   183
    sqlite3_stmt *get_revoked;
Edouard@693
   184
krista@2471
   185
    // mistrusted
krista@2471
   186
    sqlite3_stmt* add_mistrusted_key;
krista@2471
   187
    sqlite3_stmt* is_mistrusted_key;    
krista@2471
   188
    sqlite3_stmt* delete_mistrusted_key;
krista@2471
   189
    
krista@2461
   190
    // aliases
krista@2461
   191
    sqlite3_stmt *get_userid_alias_default;
krista@2461
   192
    sqlite3_stmt *add_userid_alias;
krista@2461
   193
Edouard@693
   194
    // callbacks
vb@292
   195
    examine_identity_t examine_identity;
vb@292
   196
    void *examine_management;
edouard@1462
   197
    void *sync_management;
vb@599
   198
    void *sync_obj;
krista@2271
   199
    messageToSend_t messageToSend;
krista@2271
   200
    notifyHandshake_t notifyHandshake;
krista@2271
   201
    inject_sync_msg_t inject_sync_msg;
krista@2271
   202
    retrieve_next_sync_msg_t retrieve_next_sync_msg;
vb@464
   203
edouard@1236
   204
    // key sync
edouard@1603
   205
    pEpSession* sync_session;
krista@2271
   206
    DeviceState_state sync_state;
edouard@1460
   207
    void* sync_state_payload;
edouard@1236
   208
    char sync_uuid[37];
edouard@1316
   209
    time_t LastCannotDecrypt;
edouard@1316
   210
    time_t LastUpdateRequest;
vb@690
   211
vb@464
   212
    // runtime config
vb@464
   213
vb@464
   214
    bool passive_mode;
vb@464
   215
    bool unencrypted_subject;
vb@1110
   216
    bool keep_sync_msg;
vb@1819
   217
    bool service_log;
krista@2129
   218
krista@2129
   219
    // mistrust undo cache
krista@2129
   220
    pEp_identity* cached_mistrusted;
Edouard@720
   221
    
roker@1722
   222
#ifdef DEBUG_ERRORSTACK
roker@1722
   223
    stringlist_t* errorstack;
roker@1722
   224
#endif
edouard@1603
   225
};
vb@48
   226
roker@1722
   227
vb@62
   228
PEP_STATUS init_transport_system(PEP_SESSION session, bool in_first);
vb@62
   229
void release_transport_system(PEP_SESSION session, bool out_last);
vb@48
   230
krista@1639
   231
/* NOT to be exposed to the outside!!! */
krista@1639
   232
PEP_STATUS encrypt_only(
krista@1639
   233
        PEP_SESSION session, const stringlist_t *keylist, const char *ptext,
krista@1639
   234
        size_t psize, char **ctext, size_t *csize
krista@1639
   235
);
krista@1639
   236
krista@2047
   237
#if defined(NDEBUG) || defined(NOLOG)
vb@216
   238
#define DEBUG_LOG(TITLE, ENTITY, DESC)
vb@216
   239
#else
huss@1571
   240
#ifdef ANDROID
huss@1571
   241
#include <android/log.h>
vb@1819
   242
#define  LOG_MORE(...)  __android_log_print(ANDROID_LOG_DEBUG, "pEpEngine", " %s :: %s :: %s :: %s ", __VA_ARGS__);
edouard@1630
   243
#else
edouard@1630
   244
#include <stdio.h>
vb@1819
   245
#define  LOG_MORE(...)  fprintf(stderr, "pEpEngine DEBUG_LOG('%s','%s','%s','%s')\n", __VA_ARGS__);
huss@1571
   246
#endif
edouard@1630
   247
#define DEBUG_LOG(TITLE, ENTITY, DESC) {\
vb@1819
   248
    log_event(session, (TITLE), (ENTITY), (DESC), "debug " __FILE__ ":" S_LINE);\
vb@1819
   249
    LOG_MORE((TITLE), (ENTITY), (DESC), __FILE__ ":" S_LINE)\
edouard@1630
   250
}
vb@216
   251
#endif
vb@216
   252
edouard@1746
   253
typedef enum _normalize_hex_rest_t {
edouard@1746
   254
    accept_hex,
edouard@1746
   255
    ignore_hex,
edouard@1746
   256
    reject_hex
edouard@1746
   257
} normalize_hex_res_t;
edouard@1746
   258
edouard@1746
   259
static inline normalize_hex_res_t _normalize_hex(char *hex) 
edouard@1746
   260
{
edouard@1746
   261
    if (*hex >= '0' && *hex <= '9')
edouard@1746
   262
        return accept_hex;
edouard@1746
   263
edouard@1746
   264
    if (*hex >= 'A' && *hex <= 'F') {
edouard@1746
   265
        *hex += 'a' - 'A';
edouard@1746
   266
        return accept_hex;
edouard@1746
   267
    }
edouard@1746
   268
edouard@1746
   269
    if (*hex >= 'a' && *hex <= 'f') 
edouard@1746
   270
        return accept_hex;
edouard@1746
   271
edouard@1746
   272
    if (*hex == ' ') 
edouard@1746
   273
        return ignore_hex;
edouard@1746
   274
edouard@1746
   275
    return reject_hex;
edouard@1746
   276
}
edouard@1746
   277
edouard@1521
   278
// Space tolerant and case insensitive fingerprint string compare
edouard@1746
   279
static inline PEP_STATUS _compare_fprs(
edouard@1746
   280
        const char* fpra,
edouard@1746
   281
        size_t fpras,
edouard@1746
   282
        const char* fprb,
edouard@1746
   283
        size_t fprbs,
edouard@1746
   284
        int* comparison)
edouard@1746
   285
{
edouard@1746
   286
edouard@1746
   287
    size_t ai = 0;
edouard@1746
   288
    size_t bi = 0;
edouard@1746
   289
    size_t significant = 0;
edouard@1746
   290
    int _comparison = 0;
edouard@1746
   291
    const int _FULL_FINGERPRINT_LENGTH = 40;
edouard@1746
   292
   
edouard@1746
   293
    // First compare every non-ignored chars until an end is reached
edouard@1746
   294
    while(ai < fpras && bi < fprbs)
edouard@1746
   295
    {
edouard@1746
   296
        char fprac = fpra[ai];
edouard@1746
   297
        char fprbc = fprb[bi];
edouard@1746
   298
        normalize_hex_res_t fprah = _normalize_hex(&fprac);
edouard@1746
   299
        normalize_hex_res_t fprbh = _normalize_hex(&fprbc);
edouard@1746
   300
edouard@1746
   301
        if(fprah == reject_hex || fprbh == reject_hex)
edouard@1746
   302
            return PEP_ILLEGAL_VALUE;
edouard@1746
   303
edouard@1746
   304
        if ( fprah == ignore_hex )
edouard@1746
   305
        {
edouard@1746
   306
            ai++;
edouard@1746
   307
        }
edouard@1746
   308
        else if ( fprbh == ignore_hex )
edouard@1746
   309
        {
edouard@1746
   310
            bi++;
edouard@1746
   311
        }
edouard@1746
   312
        else
edouard@1746
   313
        {
edouard@1746
   314
            if(fprac != fprbc && _comparison == 0 )
edouard@1746
   315
            {
edouard@1746
   316
                _comparison = fprac > fprbc ? 1 : -1;
edouard@1746
   317
            }
edouard@1746
   318
edouard@1746
   319
            significant++;
edouard@1746
   320
            ai++;
edouard@1746
   321
            bi++;
edouard@1746
   322
edouard@1746
   323
        } 
edouard@1746
   324
    }
edouard@1746
   325
edouard@1746
   326
    // Bail out if we didn't got enough significnt chars
edouard@1746
   327
    if (significant != _FULL_FINGERPRINT_LENGTH )
edouard@1746
   328
        return PEP_TRUSTWORDS_FPR_WRONG_LENGTH;
edouard@1746
   329
edouard@1746
   330
    // Then purge remaining chars, all must be ignored chars
edouard@1746
   331
    while ( ai < fpras )
edouard@1746
   332
    {
edouard@1746
   333
        char fprac = fpra[ai];
edouard@1746
   334
        normalize_hex_res_t fprah = _normalize_hex(&fprac);
edouard@1746
   335
        if( fprah == reject_hex )
edouard@1746
   336
            return PEP_ILLEGAL_VALUE;
edouard@1746
   337
        if ( fprah != ignore_hex )
edouard@1746
   338
            return PEP_TRUSTWORDS_FPR_WRONG_LENGTH;
edouard@1746
   339
        ai++;
edouard@1746
   340
    }
edouard@1746
   341
    while ( bi < fprbs )
edouard@1746
   342
    {
edouard@1746
   343
        char fprbc = fprb[bi];
edouard@1746
   344
        normalize_hex_res_t fprbh = _normalize_hex(&fprbc);
edouard@1746
   345
        if( fprbh == reject_hex )
edouard@1746
   346
            return PEP_ILLEGAL_VALUE;
edouard@1746
   347
        if ( fprbh != ignore_hex )
edouard@1746
   348
            return PEP_TRUSTWORDS_FPR_WRONG_LENGTH;
edouard@1746
   349
        bi++;
edouard@1746
   350
    }
edouard@1746
   351
edouard@1746
   352
    *comparison = _comparison;
edouard@1746
   353
    return PEP_STATUS_OK;
edouard@1746
   354
}
edouard@1746
   355
edouard@1521
   356
static inline int _same_fpr(
edouard@1521
   357
        const char* fpra,
edouard@1521
   358
        size_t fpras,
edouard@1521
   359
        const char* fprb,
edouard@1521
   360
        size_t fprbs
edouard@1521
   361
    )
edouard@1521
   362
{
edouard@1746
   363
    // illegal values are ignored, and considered not same.
edouard@1746
   364
    int comparison = 1;
edouard@1746
   365
edouard@1746
   366
    _compare_fprs(fpra, fpras, fprb, fprbs, &comparison);
edouard@1746
   367
edouard@1746
   368
    return comparison == 0;
edouard@1521
   369
}
roker@1722
   370
krista@2045
   371
// size is the length of the bytestr that's coming in. This is really only intended
krista@2045
   372
// for comparing two full strings. If charstr's length is different from bytestr_size,
krista@2045
   373
// we'll return a non-zero value.
krista@2045
   374
static inline int _unsigned_signed_strcmp(const unsigned char* bytestr, const char* charstr, int bytestr_size) {
krista@2045
   375
    int charstr_len = strlen(charstr);
krista@2045
   376
    if (charstr_len != bytestr_size)
krista@2045
   377
        return -1; // we don't actually care except that it's non-zero
krista@2045
   378
    return memcmp(bytestr, charstr, bytestr_size);
krista@2045
   379
}
krista@2045
   380
krista@2045
   381
// This is just a horrible example of C type madness. UTF-8 made me do it.
krista@2045
   382
static inline char* _pep_subj_copy() {
krista@2285
   383
#ifndef WIN32
krista@2045
   384
    unsigned char pepstr[] = PEP_SUBJ_STRING;
krista@2045
   385
    void* retval = calloc(1, sizeof(unsigned char)*PEP_SUBJ_BYTELEN + 1);
krista@2045
   386
    memcpy(retval, pepstr, PEP_SUBJ_BYTELEN);
krista@2045
   387
    return (char*)retval;
krista@2285
   388
#else
krista@2285
   389
    return strdup("pEp");
krista@2285
   390
#endif
krista@2045
   391
}
krista@2045
   392
krista@2461
   393
static inline bool is_me(PEP_SESSION session, pEp_identity* test_ident) {
krista@2461
   394
    bool retval = false;
krista@2461
   395
    if (test_ident && test_ident->user_id) {
krista@2461
   396
        char* def_id = NULL;
krista@2461
   397
        get_default_own_userid(session, &def_id);
krista@2461
   398
        if (test_ident->me || 
krista@2461
   399
            (def_id && strcmp(def_id, test_ident->user_id) == 0)) {
krista@2461
   400
            retval = true;
krista@2461
   401
        }
krista@2461
   402
        free(def_id);
krista@2461
   403
    }
krista@2461
   404
    return retval;
krista@2461
   405
}
krista@2461
   406
krista@2461
   407
#ifndef EMPTYSTR
krista@2461
   408
#define EMPTYSTR(STR) ((STR) == NULL || (STR)[0] == '\0')
krista@2461
   409
#endif
krista@2461
   410
krista@2549
   411
#ifndef IS_PGP_CT
krista@2549
   412
#define IS_PGP_CT(CT) (((CT) | PEP_ct_confirmed) == PEP_ct_OpenPGP)
krista@2549
   413
#endif
krista@2549
   414
krista@2461
   415
#ifndef _MIN
krista@2461
   416
#define _MIN(A, B) ((B) > (A) ? (A) : (B))
krista@2461
   417
#endif
krista@2461
   418
#ifndef _MAX
krista@2461
   419
#define _MAX(A, B) ((B) > (A) ? (B) : (A))
krista@2461
   420
#endif
krista@2461
   421
krista@2461
   422
krista@2176
   423
// These are globals used in generating message IDs and should only be
krista@2176
   424
// computed once, as they're either really constants or OS-dependent
krista@2176
   425
krista@2467
   426
extern int _pEp_rand_max_bits;
krista@2467
   427
extern double _pEp_log2_36;
krista@2176
   428
krista@2176
   429
static inline void _init_globals() {
krista@2176
   430
    _pEp_rand_max_bits = ceil(log2(RAND_MAX));
krista@2176
   431
    _pEp_log2_36 = log2(36);
krista@2176
   432
}