src/pEpEngine.h
author Volker Birk <vb@pep.foundation>
Sat, 20 Aug 2016 15:29:43 +0200
branchkeysync
changeset 1044 10a56596be7d
parent 1024 fc8ac1e60c3c
child 1047 2a4a2ec1340b
permissions -rw-r--r--
adding get_own_addresses()
vb@23
     1
#pragma once
vb@23
     2
vb@0
     3
#ifdef __cplusplus
vb@0
     4
extern "C" {
vb@0
     5
#endif
vb@0
     6
vb@25
     7
#include <stddef.h>
vb@0
     8
#include <stdint.h>
vb@0
     9
#include <stdbool.h>
vb@0
    10
vb@98
    11
#include "dynamic_api.h"
vb@98
    12
#include "stringlist.h"
vb@201
    13
#include "timestamp.h"
vb@0
    14
krista@942
    15
#define PEP_VERSION "1.0" // protocol version
vb@94
    16
Edouard@658
    17
#define PEP_OWN_USERID "pEp_own_userId"
Edouard@658
    18
    
vb@0
    19
// pEp Engine API
vb@0
    20
vb@0
    21
//  caveat:
vb@0
    22
//      Unicode data has to be normalized to NFC before calling
vb@0
    23
//      UTF-8 strings are UTF-8 encoded C strings (zero terminated)
vb@0
    24
vb@0
    25
vb@46
    26
struct _pEpSession;
vb@46
    27
typedef struct _pEpSession * PEP_SESSION;
vb@0
    28
vb@0
    29
typedef enum {
roker@529
    30
    PEP_STATUS_OK                                   = 0,
vb@0
    31
roker@529
    32
    PEP_INIT_CANNOT_LOAD_GPGME                      = 0x0110,
roker@529
    33
    PEP_INIT_GPGME_INIT_FAILED                      = 0x0111,
roker@529
    34
    PEP_INIT_NO_GPG_HOME                            = 0x0112,
roker@529
    35
    PEP_INIT_NETPGP_INIT_FAILED                     = 0x0113,
vb@0
    36
roker@529
    37
    PEP_INIT_SQLITE3_WITHOUT_MUTEX                  = 0x0120,
roker@529
    38
    PEP_INIT_CANNOT_OPEN_DB                         = 0x0121,
roker@529
    39
    PEP_INIT_CANNOT_OPEN_SYSTEM_DB                  = 0x0122,
roker@529
    40
    
roker@529
    41
    PEP_KEY_NOT_FOUND                               = 0x0201,
roker@529
    42
    PEP_KEY_HAS_AMBIG_NAME                          = 0x0202,
roker@529
    43
    PEP_GET_KEY_FAILED                              = 0x0203,
roker@529
    44
    
roker@529
    45
    PEP_CANNOT_FIND_IDENTITY                        = 0x0301,
roker@529
    46
    PEP_CANNOT_SET_PERSON                           = 0x0381,
roker@529
    47
    PEP_CANNOT_SET_PGP_KEYPAIR                      = 0x0382,
roker@529
    48
    PEP_CANNOT_SET_IDENTITY                         = 0x0383,
vb@370
    49
    PEP_CANNOT_SET_TRUST                            = 0x0384,
vb@515
    50
    PEP_KEY_BLACKLISTED                             = 0x0385,
roker@529
    51
    
roker@529
    52
    PEP_UNENCRYPTED                                 = 0x0400,
roker@529
    53
    PEP_VERIFIED                                    = 0x0401,
roker@529
    54
    PEP_DECRYPTED                                   = 0x0402,
roker@529
    55
    PEP_DECRYPTED_AND_VERIFIED                      = 0x0403,
roker@529
    56
    PEP_DECRYPT_WRONG_FORMAT                        = 0x0404,
roker@529
    57
    PEP_DECRYPT_NO_KEY                              = 0x0405,
roker@529
    58
    PEP_DECRYPT_SIGNATURE_DOES_NOT_MATCH            = 0x0406,
vb@0
    59
    PEP_VERIFY_NO_KEY                               = 0x0407,
vb@0
    60
    PEP_VERIFIED_AND_TRUSTED                        = 0x0408,
roker@529
    61
    PEP_CANNOT_DECRYPT_UNKNOWN                      = 0x04ff,
vb@0
    62
roker@529
    63
    PEP_TRUSTWORD_NOT_FOUND                         = 0x0501,
vb@0
    64
vb@0
    65
    PEP_CANNOT_CREATE_KEY                           = 0x0601,
vb@0
    66
    PEP_CANNOT_SEND_KEY                             = 0x0602,
vb@0
    67
vb@458
    68
    PEP_PHRASE_NOT_FOUND                            = 0x0701,
vb@458
    69
vb@690
    70
    PEP_SEND_FUNCTION_NOT_REGISTERED                = 0x0801,
vb@691
    71
    PEP_CONTRAINTS_VIOLATED                         = 0x0802,
vb@691
    72
    PEP_CANNOT_ENCODE                               = 0x0803,
vb@690
    73
vb@884
    74
    PEP_SYNC_NO_TRUSTWORDS_CALLBACK                 = 0x0901,
vb@951
    75
    PEP_SYNC_ILLEGAL_MESSAGE                        = 0x0902,
vb@934
    76
vb@964
    77
    PEP_SYNC_STATEMACHINE_ERROR                     = 0x0980,
vb@964
    78
    PEP_STATEMACHINE_INVALID_STATE                  = 0x0982,
vb@964
    79
    PEP_STATEMACHINE_INVALID_EVENT                  = 0x0983,
vb@964
    80
    PEP_STATEMACHINE_INVALID_CONDITION              = 0x0984,
vb@964
    81
    PEP_STATEMACHINE_INVALID_ACTION                 = 0x0985,
vb@884
    82
roker@529
    83
    PEP_COMMIT_FAILED                               = 0xff01,
vb@952
    84
    PEP_MESSAGE_CONSUMED                            = 0xff02,
vb@0
    85
vb@44
    86
    PEP_CANNOT_CREATE_TEMP_FILE                     = -5,
vb@0
    87
    PEP_ILLEGAL_VALUE                               = -4,
vb@0
    88
    PEP_BUFFER_TOO_SMALL                            = -3,
roker@529
    89
    PEP_OUT_OF_MEMORY                               = -2,
roker@529
    90
    PEP_UNKNOWN_ERROR                               = -1
vb@0
    91
} PEP_STATUS;
vb@0
    92
vb@0
    93
vb@0
    94
// INIT_STATUS init() - initialize pEpEngine for a thread
vb@0
    95
//
vb@0
    96
//  parameters:
roker@529
    97
//        session (out)   init() allocates session memory and returns a pointer
roker@529
    98
//                        as a handle
vb@0
    99
//
vb@0
   100
//  return value:
roker@529
   101
//        PEP_STATUS_OK = 0                 if init() succeeds
roker@529
   102
//        PEP_INIT_SQLITE3_WITHOUT_MUTEX    if SQLite3 was compiled with
roker@529
   103
//                                            SQLITE_THREADSAFE 0
roker@529
   104
//        PEP_INIT_CANNOT_LOAD_GPGME        if libgpgme.dll cannot be found
roker@529
   105
//        PEP_INIT_GPGME_INIT_FAILED        if GPGME init fails
roker@529
   106
//        PEP_INIT_CANNOT_OPEN_DB           if user's management db cannot be
roker@529
   107
//                                            opened
roker@529
   108
//        PEP_INIT_CANNOT_OPEN_SYSTEM_DB    if system's management db cannot be
roker@529
   109
//                                            opened
vb@0
   110
//
vb@0
   111
//  caveat:
vb@0
   112
//      the pointer is valid only if the return value is PEP_STATUS_OK
vb@0
   113
//      in other case a NULL pointer will be returned; a valid handle must
vb@0
   114
//      be released using release() when it's no longer needed
vb@62
   115
//
vb@62
   116
//      the caller has to guarantee that the first call to this function
vb@62
   117
//      will succeed before further calls can be done
vb@0
   118
vb@0
   119
DYNAMIC_API PEP_STATUS init(PEP_SESSION *session);
vb@0
   120
vb@0
   121
vb@0
   122
// void release() - release thread session handle
vb@0
   123
//
vb@0
   124
//  parameters:
roker@529
   125
//        session (in)    session handle to release
vb@62
   126
//
roker@529
   127
//    caveat:
roker@529
   128
//        the last release() can be called only when all other release() calls
roker@529
   129
//        are done
vb@0
   130
vb@0
   131
DYNAMIC_API void release(PEP_SESSION session);
vb@0
   132
vb@0
   133
vb@464
   134
// config_passive_mode() - enable passive mode
vb@464
   135
//
vb@464
   136
//  parameters:
vb@464
   137
//      session (in)    session handle
vb@467
   138
//      enable (in)     flag if enabled or disabled
vb@464
   139
vb@467
   140
DYNAMIC_API void config_passive_mode(PEP_SESSION session, bool enable);
vb@467
   141
vb@467
   142
vb@553
   143
// config_unencrypted_subject() - disable subject encryption
vb@467
   144
//
vb@467
   145
//  parameters:
vb@467
   146
//      session (in)    session handle
vb@467
   147
//      enable (in)     flag if enabled or disabled
vb@467
   148
vb@467
   149
DYNAMIC_API void config_unencrypted_subject(PEP_SESSION session, bool enable);
vb@464
   150
vb@464
   151
Edouard@721
   152
// config_use_only_own_private_keys() - enable passive mode
Edouard@721
   153
//
Edouard@721
   154
//  parameters:
Edouard@721
   155
//      session (in)    session handle
Edouard@721
   156
//      enable (in)     flag if enabled or disabled
Edouard@721
   157
Edouard@721
   158
DYNAMIC_API void config_use_only_own_private_keys(PEP_SESSION session, bool enable);
Edouard@721
   159
Edouard@721
   160
vb@0
   161
// decrypt_and_verify() - decrypt and/or verify a message
vb@0
   162
//
roker@529
   163
//    parameters:
roker@529
   164
//        session (in)    session handle
roker@529
   165
//        ctext (in)      cipher text to decrypt and/or verify
roker@529
   166
//        csize (in)      size of cipher text
roker@529
   167
//        ptext (out)     pointer to internal buffer with plain text
roker@529
   168
//        psize (out)     size of plain text
roker@529
   169
//        keylist (out)   list of key ids which where used to encrypt
vb@0
   170
//
roker@529
   171
//    return value:
roker@529
   172
//        PEP_UNENCRYPTED               message was unencrypted and not signed
roker@529
   173
//        PEP_VERIFIED                  message was unencrypted, signature matches
roker@529
   174
//        PEP_DECRYPTED                 message is decrypted now, no signature
roker@529
   175
//        PEP_DECRYPTED_AND_VERIFIED    message is decrypted now and verified
roker@529
   176
//        PEP_DECRYPT_WRONG_FORMAT      message has wrong format to handle
roker@529
   177
//        PEP_DECRYPT_NO_KEY            key not available to decrypt and/or verify
roker@529
   178
//        PEP_DECRYPT_SIGNATURE_DOES_NOT_MATCH    wrong signature
vb@0
   179
//
roker@529
   180
//    caveat:
roker@529
   181
//        the ownerships of ptext as well as keylist are going to the caller
roker@529
   182
//        the caller must use free() (or an Windoze pEp_free()) and
roker@529
   183
//        free_stringlist() to free them
vb@15
   184
//
vb@15
   185
//      if this function failes an error message may be the first element of
vb@15
   186
//      keylist and the other elements may be the keys used for encryption
vb@0
   187
vb@0
   188
DYNAMIC_API PEP_STATUS decrypt_and_verify(
vb@0
   189
        PEP_SESSION session, const char *ctext, size_t csize,
vb@0
   190
        char **ptext, size_t *psize, stringlist_t **keylist
vb@0
   191
    );
vb@0
   192
vb@0
   193
vb@0
   194
// verify_text() - verfy plain text with a digital signature
vb@0
   195
//
vb@0
   196
//  parameters:
vb@0
   197
//      session (in)    session handle
vb@0
   198
//      text (in)       text to verify
vb@0
   199
//      size (in)       size of text
vb@0
   200
//      signature (in)  signature text
vb@0
   201
//      sig_size (in)   size of signature
roker@529
   202
//      keylist (out)   list of key ids which where used to encrypt or NULL on
roker@529
   203
//                        error
vb@0
   204
//
vb@0
   205
//  return value:
roker@529
   206
//        PEP_VERIFIED                message was unencrypted, signature matches
roker@529
   207
//        PEP_DECRYPT_NO_KEY          key not available to decrypt and/or verify
roker@529
   208
//        PEP_DECRYPT_SIGNATURE_DOES_NOT_MATCH    wrong signature
vb@0
   209
vb@0
   210
DYNAMIC_API PEP_STATUS verify_text(
vb@0
   211
        PEP_SESSION session, const char *text, size_t size,
vb@0
   212
        const char *signature, size_t sig_size, stringlist_t **keylist
vb@0
   213
    );
vb@0
   214
vb@0
   215
vb@0
   216
// encrypt_and_sign() - encrypt and sign a message
vb@0
   217
//
roker@529
   218
//    parameters:
roker@529
   219
//        session (in)    session handle
roker@529
   220
//        keylist (in)    list of key ids to encrypt with as C strings
roker@529
   221
//        ptext (in)      plain text to decrypt and/or verify
roker@529
   222
//        psize (in)      size of plain text
roker@529
   223
//        ctext (out)     pointer to internal buffer with cipher text
roker@529
   224
//        csize (out)     size of cipher text
vb@0
   225
//
roker@529
   226
//    return value:
roker@529
   227
//        PEP_STATUS_OK = 0            encryption and signing succeeded
roker@529
   228
//        PEP_KEY_NOT_FOUND            at least one of the receipient keys
roker@529
   229
//                                     could not be found
roker@529
   230
//        PEP_KEY_HAS_AMBIG_NAME       at least one of the receipient keys has
roker@529
   231
//                                     an ambiguous name
roker@529
   232
//        PEP_GET_KEY_FAILED           cannot retrieve key
vb@0
   233
//
roker@529
   234
//    caveat:
roker@529
   235
//      the ownership of ctext is going to the caller
vb@0
   236
//      the caller is responsible to free() it (on Windoze use pEp_free())
vb@20
   237
//      the first key in keylist is being used to sign the message
vb@20
   238
//      this implies there has to be a private key for that keypair
vb@0
   239
vb@0
   240
DYNAMIC_API PEP_STATUS encrypt_and_sign(
vb@0
   241
        PEP_SESSION session, const stringlist_t *keylist, const char *ptext,
vb@0
   242
        size_t psize, char **ctext, size_t *csize
vb@0
   243
    );
vb@0
   244
vb@0
   245
vb@0
   246
// log_event() - log a user defined event defined by UTF-8 encoded strings into
vb@0
   247
// management log
vb@0
   248
//
roker@529
   249
//    parameters:
roker@529
   250
//        session (in)        session handle
roker@529
   251
//        title (in)          C string with event name
roker@529
   252
//        entity (in)         C string with name of entity which is logging
roker@529
   253
//        description (in)    C string with long description for event or NULL if
roker@529
   254
//                            omitted
roker@529
   255
//        comment (in)        C string with user defined comment or NULL if
roker@529
   256
//                            omitted
vb@0
   257
//
roker@529
   258
//    return value:
roker@529
   259
//        PEP_STATUS_OK       log entry created
vb@0
   260
vb@0
   261
DYNAMIC_API PEP_STATUS log_event(
vb@450
   262
        PEP_SESSION session,
vb@451
   263
        const char *title,
vb@451
   264
        const char *entity,
vb@451
   265
        const char *description,
vb@451
   266
        const char *comment
vb@0
   267
    );
vb@0
   268
vb@0
   269
vb@233
   270
// trustword() - get the corresponding trustword for a 16 bit value
vb@0
   271
//
roker@529
   272
//    parameters:
roker@529
   273
//        session (in)            session handle
roker@529
   274
//        value (in)              value to find a trustword for
roker@529
   275
//        lang (in)               C string with ISO 639-1 language code
roker@529
   276
//        word (out)              pointer to C string with trustword UTF-8 encoded
roker@529
   277
//                                NULL if language is not supported or trustword
roker@529
   278
//                                wordlist is damaged or unavailable
roker@529
   279
//        wsize (out)             length of trustword
vb@0
   280
//
roker@529
   281
//    return value:
roker@529
   282
//        PEP_STATUS_OK            trustword retrieved
roker@529
   283
//        PEP_TRUSTWORD_NOT_FOUND  trustword not found
vb@0
   284
//
roker@529
   285
//    caveat:
roker@529
   286
//        the word pointer goes to the ownership of the caller
vb@0
   287
//      the caller is responsible to free() it (on Windoze use pEp_free())
vb@0
   288
vb@233
   289
DYNAMIC_API PEP_STATUS trustword(
vb@0
   290
            PEP_SESSION session, uint16_t value, const char *lang,
vb@0
   291
            char **word, size_t *wsize
vb@0
   292
        );
vb@0
   293
vb@0
   294
vb@233
   295
// trustwords() - get trustwords for a string of hex values of a fingerprint
vb@0
   296
//
roker@529
   297
//    parameters:
roker@529
   298
//        session (in)        session handle
roker@529
   299
//        fingerprint (in)    C string with hex values to find trustwords for
roker@529
   300
//        lang (in)           C string with ISO 639-1 language code
roker@529
   301
//        words (out)         pointer to C string with trustwords UTF-8 encoded,
roker@529
   302
//                            separated by a blank each
roker@529
   303
//                            NULL if language is not supported or trustword
roker@529
   304
//                            wordlist is damaged or unavailable
roker@529
   305
//        wsize (out)         length of trustwords string
roker@529
   306
//        max_words (in)      only generate a string with max_words;
roker@529
   307
//                            if max_words == 0 there is no such limit
vb@0
   308
//
roker@529
   309
//    return value:
roker@529
   310
//        PEP_STATUS_OK            trustwords retrieved
roker@529
   311
//        PEP_OUT_OF_MEMORY        out of memory
roker@529
   312
//        PEP_TRUSTWORD_NOT_FOUND  at least one trustword not found
vb@0
   313
//
roker@529
   314
//    caveat:
roker@529
   315
//        the word pointer goes to the ownership of the caller
vb@0
   316
//      the caller is responsible to free() it (on Windoze use pEp_free())
vb@0
   317
//
vb@0
   318
//  DON'T USE THIS FUNCTION FROM HIGH LEVEL LANGUAGES!
vb@0
   319
//
vb@233
   320
//  Better implement a simple one in the adapter yourself using trustword(), and
vb@233
   321
//  return a list of trustwords.
vb@0
   322
//  This function is provided for being used by C and C++ programs only.
vb@0
   323
vb@233
   324
DYNAMIC_API PEP_STATUS trustwords(
vb@0
   325
        PEP_SESSION session, const char *fingerprint, const char *lang,
vb@0
   326
        char **words, size_t *wsize, int max_words
vb@0
   327
    );
vb@0
   328
vb@0
   329
vb@951
   330
// TODO: increase versions in pEp.asn1 if rating changes
vb@951
   331
vb@0
   332
typedef enum _PEP_comm_type {
vb@9
   333
    PEP_ct_unknown = 0,
vb@0
   334
vb@9
   335
    // range 0x01 to 0x09: no encryption, 0x0a to 0x0e: nothing reasonable
vb@0
   336
vb@9
   337
    PEP_ct_no_encryption = 0x01,                // generic
vb@9
   338
    PEP_ct_no_encrypted_channel = 0x02,
vb@9
   339
    PEP_ct_key_not_found = 0x03,
vb@9
   340
    PEP_ct_key_expired = 0x04,
vb@9
   341
    PEP_ct_key_revoked = 0x05,
vb@9
   342
    PEP_ct_key_b0rken = 0x06,
vb@9
   343
    PEP_ct_my_key_not_included = 0x09,
vb@9
   344
vb@9
   345
    PEP_ct_security_by_obscurity = 0x0a,
vb@9
   346
    PEP_ct_b0rken_crypto = 0x0b,
Edouard@442
   347
    PEP_ct_key_too_short = 0x0c,
vb@9
   348
Edouard@442
   349
    PEP_ct_compromized = 0x0e,                  // known compromized connection
Edouard@442
   350
    PEP_ct_mistrusted = 0x0f,                   // known mistrusted key
vb@0
   351
vb@9
   352
    // range 0x10 to 0x3f: unconfirmed encryption
vb@0
   353
vb@0
   354
    PEP_ct_unconfirmed_encryption = 0x10,       // generic
roker@529
   355
    PEP_ct_OpenPGP_weak_unconfirmed = 0x11,     // RSA 1024 is weak
vb@190
   356
vb@190
   357
    PEP_ct_to_be_checked = 0x20,                // generic
vb@190
   358
    PEP_ct_SMIME_unconfirmed = 0x21,
vb@190
   359
    PEP_ct_CMS_unconfirmed = 0x22,
vb@190
   360
vb@190
   361
    PEP_ct_strong_but_unconfirmed = 0x30,       // generic
vb@122
   362
    PEP_ct_OpenPGP_unconfirmed = 0x38,          // key at least 2048 bit RSA or EC
vb@122
   363
    PEP_ct_OTR_unconfirmed = 0x3a,
vb@0
   364
vb@9
   365
    // range 0x40 to 0x7f: unconfirmed encryption and anonymization
vb@0
   366
vb@0
   367
    PEP_ct_unconfirmed_enc_anon = 0x40,         // generic
lix@710
   368
    PEP_ct_pEp_unconfirmed = 0x7f,
vb@0
   369
vb@9
   370
    PEP_ct_confirmed = 0x80,                    // this bit decides if trust is confirmed
vb@9
   371
vb@9
   372
    // range 0x81 to 0x8f: reserved
vb@9
   373
    // range 0x90 to 0xbf: confirmed encryption
vb@0
   374
vb@0
   375
    PEP_ct_confirmed_encryption = 0x90,         // generic
roker@529
   376
    PEP_ct_OpenPGP_weak = 0x91,                 // RSA 1024 is weak
vb@190
   377
vb@190
   378
    PEP_ct_to_be_checked_confirmed = 0xa0,      //generic
vb@190
   379
    PEP_ct_SMIME = 0xa1,
vb@190
   380
    PEP_ct_CMS = 0xa2,
vb@190
   381
vb@190
   382
    PEP_ct_strong_encryption = 0xb0,            // generic
roker@529
   383
    PEP_ct_OpenPGP = 0xb8,                      // key at least 2048 bit RSA or EC
roker@529
   384
    PEP_ct_OTR = 0xba,
vb@0
   385
vb@0
   386
    // range 0xc0 to 0xff: confirmed encryption and anonymization
vb@0
   387
vb@0
   388
    PEP_ct_confirmed_enc_anon = 0xc0,           // generic
roker@529
   389
    PEP_ct_pEp = 0xff
vb@0
   390
} PEP_comm_type;
vb@0
   391
vb@928
   392
typedef enum _identity_flags {
vb@951
   393
    // the first octet flags are app defined settings
vb@934
   394
    PEP_idf_not_for_sync = 1,   // don't use this identity for sync
vb@951
   395
    PEP_idf_list = 2,           // identity of list of persons
vb@945
   396
vb@951
   397
    // the second octet flags are calculated
vb@951
   398
    PEP_idf_devicegroup = 256   // identity of a device group member
vb@928
   399
} identity_flags;
vb@928
   400
vb@944
   401
typedef unsigned int identity_flags_t;
vb@944
   402
vb@0
   403
typedef struct _pEp_identity {
roker@529
   404
    char *address;              // C string with address UTF-8 encoded
roker@529
   405
    char *fpr;                  // C string with fingerprint UTF-8 encoded
roker@529
   406
    char *user_id;              // C string with user ID UTF-8 encoded
roker@529
   407
    char *username;             // C string with user name UTF-8 encoded
roker@529
   408
    PEP_comm_type comm_type;    // type of communication with this ID
roker@529
   409
    char lang[3];               // language of conversation
vb@0
   410
                                // ISO 639-1 ALPHA-2, last byte is 0
vb@0
   411
    bool me;                    // if this is the local user herself/himself
vb@944
   412
    identity_flags_t flags;     // identity_flag1 | identity_flag2 | ...
vb@0
   413
} pEp_identity;
vb@0
   414
Edouard@730
   415
typedef struct _identity_list {
Edouard@730
   416
    pEp_identity *ident;
Edouard@730
   417
    struct _identity_list *next;
Edouard@730
   418
} identity_list;
Edouard@730
   419
vb@0
   420
vb@0
   421
// new_identity() - allocate memory and set the string and size fields
vb@0
   422
//
vb@0
   423
//  parameters:
vb@0
   424
//      address (in)        UTF-8 string or NULL 
vb@0
   425
//      fpr (in)            UTF-8 string or NULL 
vb@0
   426
//      user_id (in)        UTF-8 string or NULL 
vb@0
   427
//      username (in)       UTF-8 string or NULL 
vb@0
   428
//
vb@0
   429
//  return value:
vb@932
   430
//      pEp_identity struct or NULL if out of memory
vb@0
   431
//
vb@0
   432
//  caveat:
vb@0
   433
//      the strings are copied; the original strings are still being owned by
vb@0
   434
//      the caller
vb@0
   435
vb@0
   436
DYNAMIC_API pEp_identity *new_identity(
vb@0
   437
        const char *address, const char *fpr, const char *user_id,
vb@0
   438
        const char *username
vb@0
   439
    );
vb@0
   440
vb@0
   441
vb@932
   442
// identity_dup() - allocate memory and duplicate
vb@37
   443
//
vb@37
   444
//  parameters:
vb@37
   445
//      src (in)            identity to duplicate
vb@37
   446
//
vb@37
   447
//  return value:
vb@932
   448
//      pEp_identity struct or NULL if out of memory
vb@37
   449
//
vb@37
   450
//  caveat:
vb@37
   451
//      the strings are copied; the original strings are still being owned by
vb@37
   452
//      the caller
vb@37
   453
vb@37
   454
DYNAMIC_API pEp_identity *identity_dup(const pEp_identity *src);
vb@37
   455
vb@37
   456
vb@0
   457
// free_identity() - free all memory being occupied by a pEp_identity struct
vb@0
   458
//
vb@0
   459
//  parameters:
vb@0
   460
//      identity (in)       struct to release
vb@0
   461
//
vb@0
   462
//  caveat:
vb@0
   463
//      not only the struct but also all string memory referenced by the
vb@0
   464
//      struct is being freed; all pointers inside are invalid afterwards
vb@0
   465
vb@0
   466
DYNAMIC_API void free_identity(pEp_identity *identity);
vb@0
   467
vb@0
   468
vb@0
   469
// get_identity() - get identity information
vb@0
   470
//
roker@529
   471
//    parameters:
roker@529
   472
//        session (in)        session handle
roker@529
   473
//        address (in)        C string with communication address, UTF-8 encoded
Edouard@562
   474
//        user_id (in)        unique C string to identify person that identity
Edouard@562
   475
//                            is refering to
roker@529
   476
//        identity (out)      pointer to pEp_identity structure with results or
roker@529
   477
//                            NULL if failure
vb@0
   478
//
roker@529
   479
//    caveat:
vb@951
   480
//        address and user_id are being copied; the original strings remains in
vb@951
   481
//        the ownership of the caller
roker@529
   482
//        the resulting pEp_identity structure goes to the ownership of the
roker@529
   483
//        caller and has to be freed with free_identity() when not in use any
roker@529
   484
//        more
vb@0
   485
vb@0
   486
DYNAMIC_API PEP_STATUS get_identity(
Edouard@559
   487
        PEP_SESSION session,
Edouard@559
   488
        const char *address,
Edouard@559
   489
        const char *user_id,
vb@0
   490
        pEp_identity **identity
vb@0
   491
    );
vb@0
   492
vb@0
   493
// set_identity() - set identity information
vb@0
   494
//
roker@529
   495
//    parameters:
roker@529
   496
//        session (in)        session handle
roker@529
   497
//        identity (in)       pointer to pEp_identity structure
vb@0
   498
//
roker@529
   499
//    return value:
roker@529
   500
//        PEP_STATUS_OK = 0             encryption and signing succeeded
roker@529
   501
//        PEP_CANNOT_SET_PERSON         writing to table person failed
roker@529
   502
//        PEP_CANNOT_SET_PGP_KEYPAIR    writing to table pgp_keypair failed
roker@529
   503
//        PEP_CANNOT_SET_IDENTITY       writing to table identity failed
roker@529
   504
//        PEP_COMMIT_FAILED             SQL commit failed
vb@932
   505
//        PEP_KEY_BLACKLISTED           Key blacklisted, cannot set identity
vb@0
   506
//
roker@529
   507
//    caveat:
vb@932
   508
//        address, fpr, user_id and username must be given
vb@0
   509
vb@0
   510
DYNAMIC_API PEP_STATUS set_identity(
vb@0
   511
        PEP_SESSION session, const pEp_identity *identity
vb@0
   512
    );
vb@0
   513
vb@0
   514
vb@932
   515
// set_identity_flags() - update identity flags on existing identity
vb@932
   516
//
vb@932
   517
//    parameters:
vb@932
   518
//        session (in)        session handle
vb@934
   519
//        identity (in,out)   pointer to pEp_identity structure
vb@934
   520
//        flags (in)          new value for flags
vb@932
   521
//
vb@932
   522
//    return value:
vb@932
   523
//        PEP_STATUS_OK = 0             encryption and signing succeeded
vb@932
   524
//        PEP_CANNOT_SET_IDENTITY       update of identity failed
vb@932
   525
//
vb@932
   526
//    caveat:
vb@934
   527
//        address and user_id must be given in identity
vb@932
   528
vb@932
   529
DYNAMIC_API PEP_STATUS set_identity_flags(
vb@934
   530
        PEP_SESSION session,
vb@934
   531
        pEp_identity *identity,
vb@934
   532
        unsigned int flags
vb@932
   533
    );
vb@932
   534
vb@932
   535
vb@357
   536
// mark_as_compromized() - mark key in trust db as compromized
vb@357
   537
//
roker@529
   538
//    parameters:
roker@529
   539
//        session (in)        session handle
roker@529
   540
//        fpr (in)            fingerprint of key to mark
vb@357
   541
vb@357
   542
DYNAMIC_API PEP_STATUS mark_as_compromized(
vb@357
   543
        PEP_SESSION session,
vb@357
   544
        const char *fpr
vb@357
   545
    );
vb@357
   546
vb@357
   547
vb@0
   548
// generate_keypair() - generate a new key pair and add it to the key ring
vb@0
   549
//
vb@0
   550
//  parameters:
vb@0
   551
//      session (in)            session handle
roker@529
   552
//        identity (inout)      pointer to pEp_identity structure
vb@0
   553
//
roker@529
   554
//    return value:
roker@529
   555
//        PEP_STATUS_OK = 0       encryption and signing succeeded
roker@529
   556
//        PEP_ILLEGAL_VALUE       illegal values for identity fields given
roker@529
   557
//        PEP_CANNOT_CREATE_KEY   key engine is on strike
vb@0
   558
//
vb@0
   559
//  caveat:
vb@0
   560
//      address and username fields must be set to UTF-8 strings
vb@0
   561
//      the fpr field must be set to NULL
vb@0
   562
//
vb@0
   563
//      this function allocates a string and sets set fpr field of identity
vb@0
   564
//      the caller is responsible to call free() for that string or use
vb@0
   565
//      free_identity() on the struct
vb@0
   566
vb@0
   567
DYNAMIC_API PEP_STATUS generate_keypair(
vb@0
   568
        PEP_SESSION session, pEp_identity *identity
vb@0
   569
    );
vb@0
   570
vb@0
   571
vb@0
   572
// delete_keypair() - delete a public key or a key pair from the key ring
vb@0
   573
//
vb@0
   574
//  parameters:
vb@0
   575
//      session (in)            session handle
vb@0
   576
//      fpr (in)                C string with key id or fingerprint of the
vb@0
   577
//                              public key
vb@0
   578
//
vb@0
   579
//  return value:
vb@0
   580
//      PEP_STATUS_OK = 0       key was successfully deleted
vb@0
   581
//      PEP_KEY_NOT_FOUND       key not found
vb@0
   582
//      PEP_ILLEGAL_VALUE       not a valid key id or fingerprint
vb@0
   583
//      PEP_KEY_HAS_AMBIG_NAME  fpr does not uniquely identify a key
vb@0
   584
//      PEP_OUT_OF_MEMORY       out of memory
vb@0
   585
vb@0
   586
DYNAMIC_API PEP_STATUS delete_keypair(PEP_SESSION session, const char *fpr);
vb@0
   587
vb@0
   588
vb@0
   589
// import_key() - import key from data
vb@0
   590
//
vb@0
   591
//  parameters:
vb@0
   592
//      session (in)            session handle
vb@0
   593
//      key_data (in)           key data, i.e. ASCII armored OpenPGP key
vb@0
   594
//      size (in)               amount of data to handle
Edouard@772
   595
//      private_keys (out)      list of private keys that have been imported
vb@0
   596
//
vb@0
   597
//  return value:
vb@0
   598
//      PEP_STATUS_OK = 0       key was successfully imported
vb@0
   599
//      PEP_OUT_OF_MEMORY       out of memory
vb@0
   600
//      PEP_ILLEGAL_VALUE       there is no key data to import
Edouard@772
   601
//
Edouard@772
   602
//  caveat:
Edouard@772
   603
//      private_keys goes to the ownership of the caller
Edouard@772
   604
//      private_keys can be left NULL, it is then ignored
vb@0
   605
Edouard@728
   606
DYNAMIC_API PEP_STATUS import_key(
Edouard@728
   607
        PEP_SESSION session,
Edouard@728
   608
        const char *key_data,
Edouard@728
   609
        size_t size,
Edouard@728
   610
        identity_list **private_keys
Edouard@728
   611
    );
vb@0
   612
vb@0
   613
vb@0
   614
// export_key() - export ascii armored key
vb@0
   615
//
vb@0
   616
//  parameters:
vb@0
   617
//      session (in)            session handle
vb@0
   618
//      fpr (in)                key id or fingerprint of key
vb@0
   619
//      key_data (out)          ASCII armored OpenPGP key
roker@529
   620
//      size (out)              amount of data to handle
vb@0
   621
//
vb@0
   622
//  return value:
vb@0
   623
//      PEP_STATUS_OK = 0       key was successfully exported
vb@0
   624
//      PEP_OUT_OF_MEMORY       out of memory
vb@0
   625
//      PEP_KEY_NOT_FOUND       key not found
vb@0
   626
//
vb@0
   627
//  caveat:
vb@0
   628
//      the key_data goes to the ownership of the caller
vb@0
   629
//      the caller is responsible to free() it (on Windoze use pEp_free())
vb@0
   630
vb@0
   631
DYNAMIC_API PEP_STATUS export_key(
vb@0
   632
        PEP_SESSION session, const char *fpr, char **key_data, size_t *size
vb@0
   633
    );
vb@0
   634
vb@0
   635
vb@0
   636
// recv_key() - update key(s) from keyserver
vb@0
   637
//
vb@0
   638
//  parameters:
vb@0
   639
//      session (in)            session handle
vb@0
   640
//      pattern (in)            key id, user id or address to search for as
vb@0
   641
//                              UTF-8 string
vb@0
   642
vb@0
   643
DYNAMIC_API PEP_STATUS recv_key(PEP_SESSION session, const char *pattern);
vb@0
   644
vb@0
   645
vb@0
   646
// find_keys() - find keys in keyring
vb@0
   647
//
vb@0
   648
//  parameters:
vb@0
   649
//      session (in)            session handle
vb@0
   650
//      pattern (in)            key id, user id or address to search for as
vb@0
   651
//                              UTF-8 string
vb@0
   652
//      keylist (out)           list of fingerprints found or NULL on error
vb@0
   653
//
vb@0
   654
//  caveat:
roker@529
   655
//        the ownerships of keylist isgoing to the caller
roker@529
   656
//        the caller must use free_stringlist() to free it
vb@0
   657
vb@0
   658
vb@0
   659
DYNAMIC_API PEP_STATUS find_keys(
vb@0
   660
        PEP_SESSION session, const char *pattern, stringlist_t **keylist
vb@0
   661
    );
vb@0
   662
vb@0
   663
vb@0
   664
// send_key() - send key(s) to keyserver
vb@0
   665
//
vb@0
   666
//  parameters:
vb@0
   667
//      session (in)            session handle
vb@0
   668
//      pattern (in)            key id, user id or address to search for as
vb@0
   669
//                              UTF-8 string
vb@0
   670
vb@0
   671
DYNAMIC_API PEP_STATUS send_key(PEP_SESSION session, const char *pattern);
vb@0
   672
vb@0
   673
vb@0
   674
// pEp_free() - free memory allocated by pEp engine
vb@0
   675
//
vb@0
   676
//  parameters:
vb@0
   677
//      p (in)                  pointer to free
vb@0
   678
//
vb@0
   679
//  The reason for this function is that heap management can be a pretty
vb@0
   680
//  complex task with Windoze. This free() version calls the free()
vb@0
   681
//  implementation of the C runtime library which was used to build pEp engine,
vb@0
   682
//  so you're using the correct heap. For more information, see:
vb@0
   683
//  <http://msdn.microsoft.com/en-us/library/windows/desktop/aa366711(v=vs.85).aspx>
vb@0
   684
vb@0
   685
DYNAMIC_API void pEp_free(void *p);
vb@0
   686
vb@8
   687
vb@8
   688
// get_trust() - get the trust level a key has for a person
vb@8
   689
//
vb@8
   690
//  parameters:
vb@8
   691
//      session (in)            session handle
vb@8
   692
//      identity (inout)        user_id and fpr to check as UTF-8 strings (in)
vb@8
   693
//                              user_id and comm_type as result (out)
vb@8
   694
//
vb@14
   695
//  this function modifies the given identity struct; the struct remains in
vb@251
   696
//  the ownership of the caller
vb@14
   697
//  if the trust level cannot be determined identity->comm_type is set
vb@14
   698
//  to PEP_ct_unknown
vb@8
   699
vb@8
   700
DYNAMIC_API PEP_STATUS get_trust(PEP_SESSION session, pEp_identity *identity);
vb@8
   701
vb@8
   702
vb@251
   703
// least_trust() - get the least known trust level for a key in the database
vb@251
   704
//
vb@251
   705
//  parameters:
vb@251
   706
//      session (in)            session handle
vb@251
   707
//      fpr (in)                fingerprint of key to check
vb@251
   708
//      comm_type (out)         least comm_type as result (out)
vb@251
   709
//
vb@251
   710
//  if the trust level cannot be determined comm_type is set to PEP_ct_unknown
vb@251
   711
vb@251
   712
DYNAMIC_API PEP_STATUS least_trust(
vb@251
   713
        PEP_SESSION session,
vb@251
   714
        const char *fpr,
vb@251
   715
        PEP_comm_type *comm_type
vb@251
   716
    );
vb@251
   717
vb@251
   718
vb@9
   719
// get_key_rating() - get the rating a bare key has
vb@9
   720
//
vb@9
   721
//  parameters:
vb@9
   722
//      session (in)            session handle
vb@9
   723
//      fpr (in)                unique identifyer for key as UTF-8 string
vb@9
   724
//      comm_type (out)         key rating
vb@10
   725
//
vb@14
   726
//  if an error occurs, *comm_type is set to PEP_ct_unknown and an error
vb@10
   727
//  is returned
vb@9
   728
vb@9
   729
DYNAMIC_API PEP_STATUS get_key_rating(
vb@14
   730
        PEP_SESSION session,
vb@14
   731
        const char *fpr,
vb@14
   732
        PEP_comm_type *comm_type
vb@9
   733
    );
vb@9
   734
vb@9
   735
vb@198
   736
// renew_key() - renew an expired key
vb@196
   737
//
vb@196
   738
//  parameters:
vb@196
   739
//      session (in)            session handle
vb@214
   740
//      fpr (in)                ID of key to renew as UTF-8 string
vb@201
   741
//      ts (in)                 timestamp when key should expire or NULL for
vb@201
   742
//                              default
vb@196
   743
vb@201
   744
DYNAMIC_API PEP_STATUS renew_key(
vb@201
   745
        PEP_SESSION session,
vb@201
   746
        const char *fpr,
vb@201
   747
        const timestamp *ts
vb@201
   748
    );
vb@196
   749
vb@196
   750
vb@224
   751
// revoke_key() - revoke a key
vb@197
   752
//
vb@197
   753
//  parameters:
vb@197
   754
//      session (in)            session handle
vb@214
   755
//      fpr (in)                ID of key to revoke as UTF-8 string
vb@211
   756
//      reason (in)             text with reason for revoke as UTF-8 string
vb@211
   757
//                              or NULL if reason unknown
vb@211
   758
//
vb@211
   759
//  caveat:
vb@211
   760
//      reason text must not include empty lines
vb@224
   761
//      this function is meant for internal use only; better use
vb@224
   762
//      key_compromized() of keymanagement API
vb@197
   763
vb@211
   764
DYNAMIC_API PEP_STATUS revoke_key(
vb@211
   765
        PEP_SESSION session,
vb@211
   766
        const char *fpr,
vb@211
   767
        const char *reason
vb@211
   768
    );
vb@197
   769
vb@197
   770
vb@214
   771
// key_expired() - flags if a key is already expired
vb@214
   772
//
vb@214
   773
//  parameters:
vb@214
   774
//      session (in)            session handle
vb@214
   775
//      fpr (in)                ID of key to check as UTF-8 string
Edouard@701
   776
//      when (in)               UTC time of when should expiry be considered
vb@214
   777
//      expired (out)           flag if key expired
vb@214
   778
vb@214
   779
DYNAMIC_API PEP_STATUS key_expired(
vb@214
   780
        PEP_SESSION session,
vb@214
   781
        const char *fpr,
Edouard@701
   782
        const time_t when,
vb@214
   783
        bool *expired
vb@214
   784
    );
vb@214
   785
Edouard@694
   786
    
Edouard@694
   787
// key_revoked() - flags if a key is already revoked
Edouard@694
   788
//
Edouard@694
   789
//  parameters:
Edouard@694
   790
//      session (in)            session handle
Edouard@694
   791
//      fpr (in)                ID of key to check as UTF-8 string
Edouard@694
   792
//      revoked (out)           flag if key revoked
Edouard@694
   793
Edouard@694
   794
DYNAMIC_API PEP_STATUS key_revoked(
Edouard@694
   795
        PEP_SESSION session,
Edouard@694
   796
        const char *fpr,
Edouard@694
   797
        bool *revoked
Edouard@694
   798
    );
Edouard@694
   799
vb@214
   800
vb@450
   801
// get_crashdump_log() - get the last log messages out
vb@450
   802
//
vb@450
   803
//  parameters:
vb@450
   804
//      session (in)            session handle
vb@450
   805
//      maxlines (in)           maximum number of lines (0 for default)
vb@458
   806
//      logdata (out)           logdata as string in double quoted CSV format
vb@463
   807
//                              column1 is title
vb@463
   808
//                              column2 is entity
vb@463
   809
//                              column3 is description
vb@463
   810
//                              column4 is comment
vb@462
   811
//
vb@462
   812
//  caveat:
vb@462
   813
//      the ownership of logdata goes to the caller
vb@450
   814
vb@450
   815
DYNAMIC_API PEP_STATUS get_crashdump_log(
vb@450
   816
        PEP_SESSION session,
vb@450
   817
        int maxlines,
vb@450
   818
        char **logdata
vb@450
   819
    );
vb@450
   820
vb@450
   821
dirk@501
   822
// get_languagelist() - get the list of languages
vb@458
   823
//
vb@458
   824
//  parameters:
vb@458
   825
//      session (in)            session handle
vb@458
   826
//      languages (out)         languages as string in double quoted CSV format
vb@463
   827
//                              column 1 is the ISO 639-1 language code
vb@463
   828
//                              column 2 is the name of the language
vb@462
   829
//
vb@462
   830
//  caveat:
vb@462
   831
//      the ownership of languages goes to the caller
vb@458
   832
vb@458
   833
DYNAMIC_API PEP_STATUS get_languagelist(
vb@458
   834
        PEP_SESSION session,
vb@458
   835
        char **languages
vb@458
   836
    );
vb@458
   837
vb@458
   838
vb@458
   839
// get_phrase() - get phrase in a dedicated language through i18n
vb@458
   840
//
vb@458
   841
//  parameters:
vb@458
   842
//      session (in)            session handle
roker@529
   843
//      lang (in)               C string with ISO 639-1 language code
vb@458
   844
//      phrase_id (in)          id of phrase in i18n
vb@458
   845
//      phrase (out)            phrase as UTF-8 string
vb@462
   846
//
vb@462
   847
//  caveat:
vb@462
   848
//      the ownership of phrase goes to the caller
vb@458
   849
vb@458
   850
DYNAMIC_API PEP_STATUS get_phrase(
vb@458
   851
        PEP_SESSION session,
vb@458
   852
        const char *lang,
vb@458
   853
        int phrase_id,
vb@458
   854
        char **phrase
vb@458
   855
    );
vb@458
   856
vb@458
   857
vb@632
   858
// sequence_value() - raise the value of a named sequence and retrieve it
vb@632
   859
//
vb@632
   860
//  parameters:
vb@632
   861
//      session (in)            session handle
vb@632
   862
//      name (in)               name of sequence
vb@632
   863
//      value (out)             value of sequence
vb@632
   864
vb@632
   865
DYNAMIC_API PEP_STATUS sequence_value(
vb@632
   866
        PEP_SESSION session,
vb@632
   867
        const char *name,
vb@652
   868
        int32_t *value
vb@632
   869
    );
vb@632
   870
vb@1044
   871
vb@1044
   872
// get_own_addresses() - get a list of own addresses
vb@1044
   873
//
vb@1044
   874
//  parameters:
vb@1044
   875
//      session (in)            session handle
vb@1044
   876
//      addresses (out)         stringlist with addresses
vb@1044
   877
vb@1044
   878
DYNAMIC_API PEP_STATUS get_own_addresses(
vb@1044
   879
        PEP_SESSION session,
vb@1044
   880
        stringlist_t **addresses
vb@1044
   881
    );
vb@1044
   882
Edouard@694
   883
// set_revoked() - records relation between a revoked key and its replacement
Edouard@694
   884
//
Edouard@694
   885
//  parameters:
Edouard@694
   886
//      session (in)            session handle
Edouard@694
   887
//      revoked_fpr (in)        revoked fingerprint
Edouard@694
   888
//      replacement_fpr (in)    replacement key fingerprint
Edouard@694
   889
//      revocation_date (in)    revocation date
Edouard@694
   890
Edouard@693
   891
DYNAMIC_API PEP_STATUS set_revoked(
Edouard@693
   892
       PEP_SESSION session,
Edouard@693
   893
       const char *revoked_fpr,
Edouard@693
   894
       const char *replacement_fpr,
Edouard@693
   895
       const uint64_t revocation_date
Edouard@693
   896
    );
Edouard@693
   897
vb@958
   898
Edouard@694
   899
// get_revoked() - find revoked key that may have been replaced by given key, if any
Edouard@694
   900
//
Edouard@694
   901
//  parameters:
Edouard@694
   902
//      session (in)            session handle
Edouard@694
   903
//      fpr (in)                given fingerprint
Edouard@694
   904
//      revoked_fpr (out)       revoked fingerprint
Edouard@694
   905
//      revocation_date (out)   revocation date
Edouard@694
   906
    
Edouard@693
   907
DYNAMIC_API PEP_STATUS get_revoked(
Edouard@693
   908
        PEP_SESSION session,
Edouard@693
   909
        const char *fpr,
Edouard@693
   910
        char **revoked_fpr,
Edouard@693
   911
        uint64_t *revocation_date
Edouard@693
   912
    );
Edouard@693
   913
vb@632
   914
vb@958
   915
// key_created() - get creation date of a key
vb@958
   916
//
vb@958
   917
//  parameters:
vb@958
   918
//      session (in)            session handle
vb@958
   919
//      fpr (in)                fingerprint of key
vb@958
   920
//      created (out)           date of creation
vb@958
   921
vb@958
   922
PEP_STATUS key_created(
vb@958
   923
        PEP_SESSION session,
vb@958
   924
        const char *fpr,
vb@958
   925
        time_t *created
vb@958
   926
    );
vb@958
   927
vb@958
   928
krista@1011
   929
// get_engine_version() - returns the current version of pEpEngine (this is different
krista@1011
   930
//                        from the pEp protocol version!)
krista@1011
   931
//
krista@1011
   932
//  parameters: none
krista@1011
   933
//
krista@1011
   934
//  return_value: const char* to the engine version string constant
krista@1011
   935
//
krista@1011
   936
DYNAMIC_API const char* get_engine_version();
krista@1011
   937
vb@482
   938
DYNAMIC_API PEP_STATUS reset_peptest_hack(PEP_SESSION session);
vb@482
   939
vb@0
   940
#ifdef __cplusplus
vb@0
   941
}
vb@0
   942
#endif