src/pEpEngine.h
author Krista Bennett <krista@pep-project.org>
Mon, 25 Jun 2018 09:26:49 +0200
branchENGINE-434
changeset 2760 5c3a4af5453f
parent 2677 a1ade141a1d1
permissions -rw-r--r--
ENGINE-427: Hoorah, I crossed the streams. Didn't they say never cross the streams? (I hate that movie.) Anyway, wrong branch, so committing so I can graft.
vb@1517
     1
// This file is under GNU General Public License 3.0
vb@1517
     2
// see LICENSE.txt
vb@1517
     3
vb@23
     4
#pragma once
vb@23
     5
vb@0
     6
#ifdef __cplusplus
vb@0
     7
extern "C" {
vb@0
     8
#endif
vb@0
     9
vb@25
    10
#include <stddef.h>
vb@0
    11
#include <stdint.h>
vb@0
    12
#include <stdbool.h>
vb@0
    13
vb@98
    14
#include "dynamic_api.h"
vb@98
    15
#include "stringlist.h"
krista@1005
    16
#include "stringpair.h"    
vb@201
    17
#include "timestamp.h"
vb@0
    18
krista@2152
    19
#define PEP_VERSION "2.0" // protocol version
vb@94
    20
Edouard@658
    21
#define PEP_OWN_USERID "pEp_own_userId"
Edouard@658
    22
    
vb@0
    23
// pEp Engine API
vb@0
    24
vb@0
    25
//  caveat:
vb@0
    26
//      Unicode data has to be normalized to NFC before calling
vb@0
    27
//      UTF-8 strings are UTF-8 encoded C strings (zero terminated)
vb@0
    28
vb@0
    29
vb@46
    30
struct _pEpSession;
vb@46
    31
typedef struct _pEpSession * PEP_SESSION;
vb@0
    32
vb@0
    33
typedef enum {
roker@529
    34
    PEP_STATUS_OK                                   = 0,
vb@0
    35
roker@529
    36
    PEP_INIT_CANNOT_LOAD_GPGME                      = 0x0110,
roker@529
    37
    PEP_INIT_GPGME_INIT_FAILED                      = 0x0111,
roker@529
    38
    PEP_INIT_NO_GPG_HOME                            = 0x0112,
roker@529
    39
    PEP_INIT_NETPGP_INIT_FAILED                     = 0x0113,
krista@2461
    40
    PEP_INIT_CANNOT_DETERMINE_GPG_VERSION           = 0x0114,
krista@2461
    41
    PEP_INIT_UNSUPPORTED_GPG_VERSION                = 0x0115,
krista@2461
    42
    PEP_INIT_CANNOT_CONFIG_GPG_AGENT                = 0x0116,
vb@0
    43
roker@529
    44
    PEP_INIT_SQLITE3_WITHOUT_MUTEX                  = 0x0120,
roker@529
    45
    PEP_INIT_CANNOT_OPEN_DB                         = 0x0121,
roker@529
    46
    PEP_INIT_CANNOT_OPEN_SYSTEM_DB                  = 0x0122,
roker@529
    47
    
roker@529
    48
    PEP_KEY_NOT_FOUND                               = 0x0201,
roker@529
    49
    PEP_KEY_HAS_AMBIG_NAME                          = 0x0202,
roker@529
    50
    PEP_GET_KEY_FAILED                              = 0x0203,
vb@1103
    51
    PEP_CANNOT_EXPORT_KEY                           = 0x0204,
edouard@1802
    52
    PEP_CANNOT_EDIT_KEY                             = 0x0205,
krista@2461
    53
    PEP_KEY_UNSUITABLE                              = 0x0206,
roker@529
    54
    
roker@529
    55
    PEP_CANNOT_FIND_IDENTITY                        = 0x0301,
roker@529
    56
    PEP_CANNOT_SET_PERSON                           = 0x0381,
roker@529
    57
    PEP_CANNOT_SET_PGP_KEYPAIR                      = 0x0382,
roker@529
    58
    PEP_CANNOT_SET_IDENTITY                         = 0x0383,
vb@370
    59
    PEP_CANNOT_SET_TRUST                            = 0x0384,
vb@515
    60
    PEP_KEY_BLACKLISTED                             = 0x0385,
krista@2461
    61
    PEP_CANNOT_FIND_PERSON                          = 0x0386,
krista@2461
    62
    
krista@2461
    63
    PEP_CANNOT_FIND_ALIAS                           = 0x0391,
krista@2461
    64
    PEP_CANNOT_SET_ALIAS                            = 0x0392,
roker@529
    65
    
roker@529
    66
    PEP_UNENCRYPTED                                 = 0x0400,
roker@529
    67
    PEP_VERIFIED                                    = 0x0401,
roker@529
    68
    PEP_DECRYPTED                                   = 0x0402,
roker@529
    69
    PEP_DECRYPTED_AND_VERIFIED                      = 0x0403,
roker@529
    70
    PEP_DECRYPT_WRONG_FORMAT                        = 0x0404,
roker@529
    71
    PEP_DECRYPT_NO_KEY                              = 0x0405,
roker@529
    72
    PEP_DECRYPT_SIGNATURE_DOES_NOT_MATCH            = 0x0406,
vb@0
    73
    PEP_VERIFY_NO_KEY                               = 0x0407,
vb@0
    74
    PEP_VERIFIED_AND_TRUSTED                        = 0x0408,
krista@2615
    75
    PEP_CANNOT_REENCRYPT                            = 0x0409,
krista@2677
    76
    PEP_DECRYPTED_BUT_UNSIGNED                      = 0x040A,
krista@2677
    77
    PEP_DECRYPT_MODIFICATION_DETECTED               = 0x040B,
krista@2677
    78
    PEP_DECRYPT_NO_KEY_FOR_SIGNER                   = 0x040C,
krista@2677
    79
    PEP_DECRYPT_BAD_SIGNATURE                       = 0x040D,
roker@529
    80
    PEP_CANNOT_DECRYPT_UNKNOWN                      = 0x04ff,
vb@0
    81
roker@529
    82
    PEP_TRUSTWORD_NOT_FOUND                         = 0x0501,
krista@1312
    83
    PEP_TRUSTWORDS_FPR_WRONG_LENGTH                 = 0x0502,
krista@1864
    84
    PEP_TRUSTWORDS_DUPLICATE_FPR                    = 0x0503,
vb@0
    85
vb@0
    86
    PEP_CANNOT_CREATE_KEY                           = 0x0601,
vb@0
    87
    PEP_CANNOT_SEND_KEY                             = 0x0602,
vb@0
    88
vb@458
    89
    PEP_PHRASE_NOT_FOUND                            = 0x0701,
vb@458
    90
vb@690
    91
    PEP_SEND_FUNCTION_NOT_REGISTERED                = 0x0801,
vb@691
    92
    PEP_CONTRAINTS_VIOLATED                         = 0x0802,
vb@691
    93
    PEP_CANNOT_ENCODE                               = 0x0803,
vb@690
    94
edouard@1467
    95
    PEP_SYNC_NO_NOTIFY_CALLBACK                     = 0x0901,
vb@951
    96
    PEP_SYNC_ILLEGAL_MESSAGE                        = 0x0902,
vb@1105
    97
    PEP_SYNC_NO_INJECT_CALLBACK                     = 0x0903,
vb@934
    98
vb@1085
    99
    PEP_SEQUENCE_VIOLATED                           = 0x0970,
vb@1085
   100
    PEP_CANNOT_INCREASE_SEQUENCE                    = 0x0971,
vb@1087
   101
    PEP_CANNOT_SET_SEQUENCE_VALUE                   = 0x0972,
vb@1087
   102
    PEP_OWN_SEQUENCE                                = 0x097f,
vb@1085
   103
vb@964
   104
    PEP_SYNC_STATEMACHINE_ERROR                     = 0x0980,
vb@1101
   105
    PEP_SYNC_NO_TRUST                               = 0x0981,
vb@964
   106
    PEP_STATEMACHINE_INVALID_STATE                  = 0x0982,
vb@964
   107
    PEP_STATEMACHINE_INVALID_EVENT                  = 0x0983,
vb@964
   108
    PEP_STATEMACHINE_INVALID_CONDITION              = 0x0984,
vb@964
   109
    PEP_STATEMACHINE_INVALID_ACTION                 = 0x0985,
edouard@1316
   110
    PEP_STATEMACHINE_INHIBITED_EVENT                = 0x0986,
vb@884
   111
roker@529
   112
    PEP_COMMIT_FAILED                               = 0xff01,
vb@1391
   113
    PEP_MESSAGE_CONSUME                             = 0xff02,
vb@1391
   114
    PEP_MESSAGE_IGNORE                              = 0xff03,
vb@0
   115
vb@1091
   116
    PEP_RECORD_NOT_FOUND                            = -6,
vb@44
   117
    PEP_CANNOT_CREATE_TEMP_FILE                     = -5,
vb@0
   118
    PEP_ILLEGAL_VALUE                               = -4,
vb@0
   119
    PEP_BUFFER_TOO_SMALL                            = -3,
roker@529
   120
    PEP_OUT_OF_MEMORY                               = -2,
krista@1914
   121
    PEP_UNKNOWN_ERROR                               = -1,
krista@1914
   122
    
krista@1914
   123
    PEP_VERSION_MISMATCH                            = -7,
vb@0
   124
} PEP_STATUS;
vb@0
   125
vb@0
   126
vb@0
   127
// INIT_STATUS init() - initialize pEpEngine for a thread
vb@0
   128
//
vb@0
   129
//  parameters:
roker@529
   130
//        session (out)   init() allocates session memory and returns a pointer
roker@529
   131
//                        as a handle
vb@0
   132
//
vb@0
   133
//  return value:
roker@529
   134
//        PEP_STATUS_OK = 0                 if init() succeeds
roker@529
   135
//        PEP_INIT_SQLITE3_WITHOUT_MUTEX    if SQLite3 was compiled with
roker@529
   136
//                                            SQLITE_THREADSAFE 0
roker@529
   137
//        PEP_INIT_CANNOT_LOAD_GPGME        if libgpgme.dll cannot be found
roker@529
   138
//        PEP_INIT_GPGME_INIT_FAILED        if GPGME init fails
roker@529
   139
//        PEP_INIT_CANNOT_OPEN_DB           if user's management db cannot be
roker@529
   140
//                                            opened
roker@529
   141
//        PEP_INIT_CANNOT_OPEN_SYSTEM_DB    if system's management db cannot be
roker@529
   142
//                                            opened
vb@0
   143
//
vb@0
   144
//  caveat:
krista@2126
   145
//      THE CALLER MUST GUARD THIS CALL EXTERNALLY WITH A MUTEX. release() should
krista@2126
   146
//      be similarly guarded.
krista@2126
   147
//
vb@0
   148
//      the pointer is valid only if the return value is PEP_STATUS_OK
vb@0
   149
//      in other case a NULL pointer will be returned; a valid handle must
vb@0
   150
//      be released using release() when it's no longer needed
vb@62
   151
//
vb@62
   152
//      the caller has to guarantee that the first call to this function
vb@62
   153
//      will succeed before further calls can be done
vb@0
   154
vb@0
   155
DYNAMIC_API PEP_STATUS init(PEP_SESSION *session);
vb@0
   156
vb@0
   157
vb@0
   158
// void release() - release thread session handle
vb@0
   159
//
vb@0
   160
//  parameters:
roker@529
   161
//        session (in)    session handle to release
vb@62
   162
//
roker@529
   163
//    caveat:
krista@2126
   164
//        THE CALLER MUST GUARD THIS CALL EXTERNALLY WITH A MUTEX. init() should
krista@2126
   165
//        be similarly guarded.
krista@2126
   166
//       
roker@529
   167
//        the last release() can be called only when all other release() calls
roker@529
   168
//        are done
vb@0
   169
vb@0
   170
DYNAMIC_API void release(PEP_SESSION session);
vb@0
   171
vb@0
   172
roker@1722
   173
// const stringlist_t* get_errorstack(PEP_SESSION) - get the error stack for that session, if any
roker@1722
   174
//
roker@1722
   175
//  parameters:
roker@1722
   176
//        session (in)    session handle
roker@1722
   177
//
roker@1722
   178
//    caveat:
roker@1722
   179
//        To get a useful error stack you have to compile with -DDEBUG_ERRORSTACK
roker@1722
   180
//        The error stack belongs to the session. Do no not change it!
roker@1722
   181
DYNAMIC_API const stringlist_t* get_errorstack(PEP_SESSION session);
roker@1722
   182
roker@1778
   183
roker@1777
   184
// void clear_errorstack(PEP_SESSION) - clear the error stack for that session, if any
roker@1777
   185
//
roker@1777
   186
//  parameters:
roker@1777
   187
//        session (in)    session handle
roker@1777
   188
//
roker@1777
   189
DYNAMIC_API void clear_errorstack(PEP_SESSION session);
roker@1777
   190
roker@1722
   191
vb@464
   192
// config_passive_mode() - enable passive mode
vb@464
   193
//
vb@464
   194
//  parameters:
vb@464
   195
//      session (in)    session handle
vb@467
   196
//      enable (in)     flag if enabled or disabled
vb@464
   197
vb@467
   198
DYNAMIC_API void config_passive_mode(PEP_SESSION session, bool enable);
vb@467
   199
vb@467
   200
vb@553
   201
// config_unencrypted_subject() - disable subject encryption
vb@467
   202
//
vb@467
   203
//  parameters:
vb@467
   204
//      session (in)    session handle
vb@467
   205
//      enable (in)     flag if enabled or disabled
vb@467
   206
vb@467
   207
DYNAMIC_API void config_unencrypted_subject(PEP_SESSION session, bool enable);
vb@464
   208
vb@464
   209
Edouard@721
   210
// config_use_only_own_private_keys() - enable passive mode
Edouard@721
   211
//
Edouard@721
   212
//  parameters:
Edouard@721
   213
//      session (in)    session handle
Edouard@721
   214
//      enable (in)     flag if enabled or disabled
Edouard@721
   215
Edouard@721
   216
DYNAMIC_API void config_use_only_own_private_keys(PEP_SESSION session, bool enable);
Edouard@721
   217
Edouard@721
   218
vb@1110
   219
// config_keep_sync_msg() - do not remove sync messages (for debugging purposes)
vb@1109
   220
//
vb@1109
   221
//      session (in)    session handle
vb@1109
   222
//      enable (in)     flag if enabled or disabled
vb@1109
   223
vb@1110
   224
DYNAMIC_API void config_keep_sync_msg(PEP_SESSION session, bool enable);
vb@1109
   225
vb@1109
   226
vb@1819
   227
// config_service_log() - log more for service purposes
vb@1819
   228
//
vb@1819
   229
//      session (in)    session handle
vb@1819
   230
//      enable (in)     flag if enabled or disabled
vb@1819
   231
vb@1819
   232
DYNAMIC_API void config_service_log(PEP_SESSION session, bool enable);
vb@1819
   233
vb@1819
   234
vb@0
   235
// decrypt_and_verify() - decrypt and/or verify a message
vb@0
   236
//
roker@529
   237
//    parameters:
roker@529
   238
//        session (in)    session handle
roker@529
   239
//        ctext (in)      cipher text to decrypt and/or verify
roker@529
   240
//        csize (in)      size of cipher text
krista@1397
   241
//        dsigtext (in)   if extant, *detached* signature text for this
krista@1397
   242
//                        message (or NULL if not)
krista@1397
   243
//        dsize (in)      size of *detached* signature text for this
krista@1397
   244
//                        message (0, if no detached sig exists)
roker@529
   245
//        ptext (out)     pointer to internal buffer with plain text
roker@529
   246
//        psize (out)     size of plain text
roker@529
   247
//        keylist (out)   list of key ids which where used to encrypt
vb@0
   248
//
roker@529
   249
//    return value:
roker@529
   250
//        PEP_UNENCRYPTED               message was unencrypted and not signed
roker@529
   251
//        PEP_VERIFIED                  message was unencrypted, signature matches
roker@529
   252
//        PEP_DECRYPTED                 message is decrypted now, no signature
roker@529
   253
//        PEP_DECRYPTED_AND_VERIFIED    message is decrypted now and verified
roker@529
   254
//        PEP_DECRYPT_WRONG_FORMAT      message has wrong format to handle
roker@529
   255
//        PEP_DECRYPT_NO_KEY            key not available to decrypt and/or verify
roker@529
   256
//        PEP_DECRYPT_SIGNATURE_DOES_NOT_MATCH    wrong signature
vb@0
   257
//
roker@529
   258
//    caveat:
roker@529
   259
//        the ownerships of ptext as well as keylist are going to the caller
roker@529
   260
//        the caller must use free() (or an Windoze pEp_free()) and
roker@529
   261
//        free_stringlist() to free them
vb@15
   262
//
vb@15
   263
//      if this function failes an error message may be the first element of
vb@15
   264
//      keylist and the other elements may be the keys used for encryption
vb@0
   265
vb@0
   266
DYNAMIC_API PEP_STATUS decrypt_and_verify(
vb@0
   267
        PEP_SESSION session, const char *ctext, size_t csize,
krista@1397
   268
        const char *dsigtext, size_t dsigsize,
vb@0
   269
        char **ptext, size_t *psize, stringlist_t **keylist
vb@0
   270
    );
vb@0
   271
vb@0
   272
vb@0
   273
// verify_text() - verfy plain text with a digital signature
vb@0
   274
//
vb@0
   275
//  parameters:
vb@0
   276
//      session (in)    session handle
vb@0
   277
//      text (in)       text to verify
vb@0
   278
//      size (in)       size of text
vb@0
   279
//      signature (in)  signature text
vb@0
   280
//      sig_size (in)   size of signature
roker@529
   281
//      keylist (out)   list of key ids which where used to encrypt or NULL on
roker@529
   282
//                        error
vb@0
   283
//
vb@0
   284
//  return value:
roker@529
   285
//        PEP_VERIFIED                message was unencrypted, signature matches
roker@529
   286
//        PEP_DECRYPT_NO_KEY          key not available to decrypt and/or verify
roker@529
   287
//        PEP_DECRYPT_SIGNATURE_DOES_NOT_MATCH    wrong signature
vb@0
   288
vb@0
   289
DYNAMIC_API PEP_STATUS verify_text(
vb@0
   290
        PEP_SESSION session, const char *text, size_t size,
vb@0
   291
        const char *signature, size_t sig_size, stringlist_t **keylist
vb@0
   292
    );
vb@0
   293
vb@0
   294
vb@0
   295
// encrypt_and_sign() - encrypt and sign a message
vb@0
   296
//
roker@529
   297
//    parameters:
roker@529
   298
//        session (in)    session handle
roker@529
   299
//        keylist (in)    list of key ids to encrypt with as C strings
roker@529
   300
//        ptext (in)      plain text to decrypt and/or verify
roker@529
   301
//        psize (in)      size of plain text
roker@529
   302
//        ctext (out)     pointer to internal buffer with cipher text
roker@529
   303
//        csize (out)     size of cipher text
vb@0
   304
//
roker@529
   305
//    return value:
roker@529
   306
//        PEP_STATUS_OK = 0            encryption and signing succeeded
roker@529
   307
//        PEP_KEY_NOT_FOUND            at least one of the receipient keys
roker@529
   308
//                                     could not be found
roker@529
   309
//        PEP_KEY_HAS_AMBIG_NAME       at least one of the receipient keys has
roker@529
   310
//                                     an ambiguous name
roker@529
   311
//        PEP_GET_KEY_FAILED           cannot retrieve key
vb@0
   312
//
roker@529
   313
//    caveat:
roker@529
   314
//      the ownership of ctext is going to the caller
vb@0
   315
//      the caller is responsible to free() it (on Windoze use pEp_free())
vb@20
   316
//      the first key in keylist is being used to sign the message
vb@20
   317
//      this implies there has to be a private key for that keypair
vb@0
   318
vb@0
   319
DYNAMIC_API PEP_STATUS encrypt_and_sign(
vb@0
   320
        PEP_SESSION session, const stringlist_t *keylist, const char *ptext,
vb@0
   321
        size_t psize, char **ctext, size_t *csize
vb@0
   322
    );
vb@0
   323
vb@0
   324
vb@0
   325
// log_event() - log a user defined event defined by UTF-8 encoded strings into
vb@0
   326
// management log
vb@0
   327
//
roker@529
   328
//    parameters:
roker@529
   329
//        session (in)        session handle
roker@529
   330
//        title (in)          C string with event name
roker@529
   331
//        entity (in)         C string with name of entity which is logging
roker@529
   332
//        description (in)    C string with long description for event or NULL if
roker@529
   333
//                            omitted
roker@529
   334
//        comment (in)        C string with user defined comment or NULL if
roker@529
   335
//                            omitted
vb@0
   336
//
roker@529
   337
//    return value:
roker@529
   338
//        PEP_STATUS_OK       log entry created
vb@0
   339
vb@0
   340
DYNAMIC_API PEP_STATUS log_event(
vb@450
   341
        PEP_SESSION session,
vb@451
   342
        const char *title,
vb@451
   343
        const char *entity,
vb@451
   344
        const char *description,
vb@451
   345
        const char *comment
vb@0
   346
    );
vb@0
   347
vb@0
   348
vb@1819
   349
DYNAMIC_API PEP_STATUS log_service(PEP_SESSION session, const char *title,
vb@1819
   350
        const char *entity, const char *description, const char *comment);
vb@1819
   351
vb@1819
   352
#define _STR_(x) #x
vb@1819
   353
#define _D_STR_(x) _STR_(x)
vb@1819
   354
#define S_LINE _D_STR_(__LINE__)
vb@1819
   355
vb@1819
   356
#define SERVICE_LOG(session, title, entity, desc) \
vb@1819
   357
    log_service((session), (title), (entity), (desc), "service " __FILE__ ":" S_LINE)
vb@1819
   358
vb@1819
   359
vb@233
   360
// trustword() - get the corresponding trustword for a 16 bit value
vb@0
   361
//
roker@529
   362
//    parameters:
roker@529
   363
//        session (in)            session handle
roker@529
   364
//        value (in)              value to find a trustword for
roker@529
   365
//        lang (in)               C string with ISO 639-1 language code
roker@529
   366
//        word (out)              pointer to C string with trustword UTF-8 encoded
roker@529
   367
//                                NULL if language is not supported or trustword
roker@529
   368
//                                wordlist is damaged or unavailable
roker@529
   369
//        wsize (out)             length of trustword
vb@0
   370
//
roker@529
   371
//    return value:
roker@529
   372
//        PEP_STATUS_OK            trustword retrieved
roker@529
   373
//        PEP_TRUSTWORD_NOT_FOUND  trustword not found
vb@0
   374
//
roker@529
   375
//    caveat:
roker@529
   376
//        the word pointer goes to the ownership of the caller
vb@0
   377
//      the caller is responsible to free() it (on Windoze use pEp_free())
vb@0
   378
vb@233
   379
DYNAMIC_API PEP_STATUS trustword(
vb@0
   380
            PEP_SESSION session, uint16_t value, const char *lang,
vb@0
   381
            char **word, size_t *wsize
vb@0
   382
        );
vb@0
   383
vb@0
   384
vb@233
   385
// trustwords() - get trustwords for a string of hex values of a fingerprint
vb@0
   386
//
roker@529
   387
//    parameters:
roker@529
   388
//        session (in)        session handle
roker@529
   389
//        fingerprint (in)    C string with hex values to find trustwords for
roker@529
   390
//        lang (in)           C string with ISO 639-1 language code
roker@529
   391
//        words (out)         pointer to C string with trustwords UTF-8 encoded,
roker@529
   392
//                            separated by a blank each
roker@529
   393
//                            NULL if language is not supported or trustword
roker@529
   394
//                            wordlist is damaged or unavailable
roker@529
   395
//        wsize (out)         length of trustwords string
roker@529
   396
//        max_words (in)      only generate a string with max_words;
roker@529
   397
//                            if max_words == 0 there is no such limit
vb@0
   398
//
roker@529
   399
//    return value:
roker@529
   400
//        PEP_STATUS_OK            trustwords retrieved
roker@529
   401
//        PEP_OUT_OF_MEMORY        out of memory
roker@529
   402
//        PEP_TRUSTWORD_NOT_FOUND  at least one trustword not found
vb@0
   403
//
roker@529
   404
//    caveat:
roker@529
   405
//        the word pointer goes to the ownership of the caller
vb@0
   406
//      the caller is responsible to free() it (on Windoze use pEp_free())
vb@0
   407
//
vb@0
   408
//  DON'T USE THIS FUNCTION FROM HIGH LEVEL LANGUAGES!
vb@0
   409
//
vb@233
   410
//  Better implement a simple one in the adapter yourself using trustword(), and
vb@233
   411
//  return a list of trustwords.
vb@0
   412
//  This function is provided for being used by C and C++ programs only.
vb@0
   413
vb@233
   414
DYNAMIC_API PEP_STATUS trustwords(
vb@0
   415
        PEP_SESSION session, const char *fingerprint, const char *lang,
vb@0
   416
        char **words, size_t *wsize, int max_words
vb@0
   417
    );
vb@0
   418
vb@0
   419
vb@951
   420
// TODO: increase versions in pEp.asn1 if rating changes
vb@951
   421
vb@0
   422
typedef enum _PEP_comm_type {
vb@9
   423
    PEP_ct_unknown = 0,
vb@0
   424
vb@9
   425
    // range 0x01 to 0x09: no encryption, 0x0a to 0x0e: nothing reasonable
vb@0
   426
vb@9
   427
    PEP_ct_no_encryption = 0x01,                // generic
vb@9
   428
    PEP_ct_no_encrypted_channel = 0x02,
vb@9
   429
    PEP_ct_key_not_found = 0x03,
vb@9
   430
    PEP_ct_key_expired = 0x04,
vb@9
   431
    PEP_ct_key_revoked = 0x05,
vb@9
   432
    PEP_ct_key_b0rken = 0x06,
vb@9
   433
    PEP_ct_my_key_not_included = 0x09,
vb@9
   434
vb@9
   435
    PEP_ct_security_by_obscurity = 0x0a,
vb@9
   436
    PEP_ct_b0rken_crypto = 0x0b,
Edouard@442
   437
    PEP_ct_key_too_short = 0x0c,
vb@9
   438
krista@2593
   439
    PEP_ct_compromised = 0x0e,                  // known compromised connection
krista@2593
   440
    PEP_ct_compromized = 0x0e,                  // deprecated misspelling
Edouard@442
   441
    PEP_ct_mistrusted = 0x0f,                   // known mistrusted key
vb@0
   442
vb@9
   443
    // range 0x10 to 0x3f: unconfirmed encryption
vb@0
   444
vb@0
   445
    PEP_ct_unconfirmed_encryption = 0x10,       // generic
roker@529
   446
    PEP_ct_OpenPGP_weak_unconfirmed = 0x11,     // RSA 1024 is weak
vb@190
   447
vb@190
   448
    PEP_ct_to_be_checked = 0x20,                // generic
vb@190
   449
    PEP_ct_SMIME_unconfirmed = 0x21,
vb@190
   450
    PEP_ct_CMS_unconfirmed = 0x22,
vb@190
   451
vb@190
   452
    PEP_ct_strong_but_unconfirmed = 0x30,       // generic
vb@122
   453
    PEP_ct_OpenPGP_unconfirmed = 0x38,          // key at least 2048 bit RSA or EC
vb@122
   454
    PEP_ct_OTR_unconfirmed = 0x3a,
vb@0
   455
vb@9
   456
    // range 0x40 to 0x7f: unconfirmed encryption and anonymization
vb@0
   457
vb@0
   458
    PEP_ct_unconfirmed_enc_anon = 0x40,         // generic
lix@710
   459
    PEP_ct_pEp_unconfirmed = 0x7f,
vb@0
   460
vb@9
   461
    PEP_ct_confirmed = 0x80,                    // this bit decides if trust is confirmed
vb@9
   462
vb@9
   463
    // range 0x81 to 0x8f: reserved
vb@9
   464
    // range 0x90 to 0xbf: confirmed encryption
vb@0
   465
vb@0
   466
    PEP_ct_confirmed_encryption = 0x90,         // generic
edouard@1635
   467
    PEP_ct_OpenPGP_weak = 0x91,                 // RSA 1024 is weak (unused)
vb@190
   468
vb@190
   469
    PEP_ct_to_be_checked_confirmed = 0xa0,      //generic
vb@190
   470
    PEP_ct_SMIME = 0xa1,
vb@190
   471
    PEP_ct_CMS = 0xa2,
vb@190
   472
vb@190
   473
    PEP_ct_strong_encryption = 0xb0,            // generic
roker@529
   474
    PEP_ct_OpenPGP = 0xb8,                      // key at least 2048 bit RSA or EC
roker@529
   475
    PEP_ct_OTR = 0xba,
vb@0
   476
vb@0
   477
    // range 0xc0 to 0xff: confirmed encryption and anonymization
vb@0
   478
vb@0
   479
    PEP_ct_confirmed_enc_anon = 0xc0,           // generic
roker@529
   480
    PEP_ct_pEp = 0xff
vb@0
   481
} PEP_comm_type;
vb@0
   482
vb@928
   483
typedef enum _identity_flags {
vb@951
   484
    // the first octet flags are app defined settings
edouard@1394
   485
    PEP_idf_not_for_sync = 0x0001,   // don't use this identity for sync
edouard@1394
   486
    PEP_idf_list = 0x0002,           // identity of list of persons
vb@951
   487
    // the second octet flags are calculated
edouard@1394
   488
    PEP_idf_devicegroup = 0x0100     // identity of a device group member
vb@928
   489
} identity_flags;
vb@928
   490
vb@944
   491
typedef unsigned int identity_flags_t;
vb@944
   492
edouard@1394
   493
// typedef enum _keypair_flags {
edouard@1394
   494
// } keypair_flags;
edouard@1364
   495
edouard@1364
   496
typedef unsigned int keypair_flags_t;
edouard@1364
   497
vb@0
   498
typedef struct _pEp_identity {
roker@529
   499
    char *address;              // C string with address UTF-8 encoded
roker@529
   500
    char *fpr;                  // C string with fingerprint UTF-8 encoded
roker@529
   501
    char *user_id;              // C string with user ID UTF-8 encoded
krista@2461
   502
                                // user_id MIGHT be set to "pEp_own_userId"
edouard@1946
   503
                                // (use PEP_OWN_USERID preprocessor define)
edouard@1946
   504
                                // if this is own user's identity.
krista@2461
   505
                                // But it is not REQUIRED to be.
roker@529
   506
    char *username;             // C string with user name UTF-8 encoded
roker@529
   507
    PEP_comm_type comm_type;    // type of communication with this ID
roker@529
   508
    char lang[3];               // language of conversation
vb@0
   509
                                // ISO 639-1 ALPHA-2, last byte is 0
krista@2461
   510
    bool me;                    // if this is the local user herself/himself
vb@944
   511
    identity_flags_t flags;     // identity_flag1 | identity_flag2 | ...
vb@0
   512
} pEp_identity;
vb@0
   513
Edouard@730
   514
typedef struct _identity_list {
Edouard@730
   515
    pEp_identity *ident;
Edouard@730
   516
    struct _identity_list *next;
Edouard@730
   517
} identity_list;
Edouard@730
   518
vb@0
   519
vb@0
   520
// new_identity() - allocate memory and set the string and size fields
vb@0
   521
//
vb@0
   522
//  parameters:
vb@0
   523
//      address (in)        UTF-8 string or NULL 
vb@0
   524
//      fpr (in)            UTF-8 string or NULL 
vb@0
   525
//      user_id (in)        UTF-8 string or NULL 
vb@0
   526
//      username (in)       UTF-8 string or NULL 
vb@0
   527
//
vb@0
   528
//  return value:
vb@932
   529
//      pEp_identity struct or NULL if out of memory
vb@0
   530
//
vb@0
   531
//  caveat:
vb@0
   532
//      the strings are copied; the original strings are still being owned by
vb@0
   533
//      the caller
vb@0
   534
vb@0
   535
DYNAMIC_API pEp_identity *new_identity(
vb@0
   536
        const char *address, const char *fpr, const char *user_id,
vb@0
   537
        const char *username
vb@0
   538
    );
vb@0
   539
vb@0
   540
vb@932
   541
// identity_dup() - allocate memory and duplicate
vb@37
   542
//
vb@37
   543
//  parameters:
vb@37
   544
//      src (in)            identity to duplicate
vb@37
   545
//
vb@37
   546
//  return value:
vb@932
   547
//      pEp_identity struct or NULL if out of memory
vb@37
   548
//
vb@37
   549
//  caveat:
vb@37
   550
//      the strings are copied; the original strings are still being owned by
vb@37
   551
//      the caller
vb@37
   552
vb@37
   553
DYNAMIC_API pEp_identity *identity_dup(const pEp_identity *src);
vb@37
   554
vb@37
   555
vb@0
   556
// free_identity() - free all memory being occupied by a pEp_identity struct
vb@0
   557
//
vb@0
   558
//  parameters:
vb@0
   559
//      identity (in)       struct to release
vb@0
   560
//
vb@0
   561
//  caveat:
vb@0
   562
//      not only the struct but also all string memory referenced by the
vb@0
   563
//      struct is being freed; all pointers inside are invalid afterwards
vb@0
   564
vb@0
   565
DYNAMIC_API void free_identity(pEp_identity *identity);
vb@0
   566
vb@0
   567
vb@0
   568
// get_identity() - get identity information
vb@0
   569
//
roker@529
   570
//    parameters:
roker@529
   571
//        session (in)        session handle
roker@529
   572
//        address (in)        C string with communication address, UTF-8 encoded
Edouard@562
   573
//        user_id (in)        unique C string to identify person that identity
Edouard@562
   574
//                            is refering to
roker@529
   575
//        identity (out)      pointer to pEp_identity structure with results or
roker@529
   576
//                            NULL if failure
vb@0
   577
//
roker@529
   578
//    caveat:
vb@951
   579
//        address and user_id are being copied; the original strings remains in
vb@951
   580
//        the ownership of the caller
roker@529
   581
//        the resulting pEp_identity structure goes to the ownership of the
roker@529
   582
//        caller and has to be freed with free_identity() when not in use any
roker@529
   583
//        more
vb@0
   584
vb@0
   585
DYNAMIC_API PEP_STATUS get_identity(
Edouard@559
   586
        PEP_SESSION session,
Edouard@559
   587
        const char *address,
Edouard@559
   588
        const char *user_id,
vb@0
   589
        pEp_identity **identity
vb@0
   590
    );
vb@0
   591
krista@1799
   592
PEP_STATUS replace_identities_fpr(PEP_SESSION session, 
krista@1799
   593
                                 const char* old_fpr, 
krista@1799
   594
                                 const char* new_fpr); 
krista@1797
   595
krista@1797
   596
vb@0
   597
// set_identity() - set identity information
vb@0
   598
//
roker@529
   599
//    parameters:
roker@529
   600
//        session (in)        session handle
roker@529
   601
//        identity (in)       pointer to pEp_identity structure
vb@0
   602
//
roker@529
   603
//    return value:
roker@529
   604
//        PEP_STATUS_OK = 0             encryption and signing succeeded
roker@529
   605
//        PEP_CANNOT_SET_PERSON         writing to table person failed
roker@529
   606
//        PEP_CANNOT_SET_PGP_KEYPAIR    writing to table pgp_keypair failed
roker@529
   607
//        PEP_CANNOT_SET_IDENTITY       writing to table identity failed
roker@529
   608
//        PEP_COMMIT_FAILED             SQL commit failed
vb@0
   609
//
roker@529
   610
//    caveat:
vb@932
   611
//        address, fpr, user_id and username must be given
vb@0
   612
vb@0
   613
DYNAMIC_API PEP_STATUS set_identity(
vb@0
   614
        PEP_SESSION session, const pEp_identity *identity
vb@0
   615
    );
vb@0
   616
krista@2461
   617
// get_default own_userid() - get the user_id of the own user
krista@2461
   618
//
krista@2461
   619
//    parameters:
krista@2461
   620
//        session (in)        session handle
krista@2461
   621
//        userid  (out)       own user id (if it exists)
krista@2461
   622
//
krista@2461
   623
//    return value:
krista@2461
   624
//        PEP_STATUS_OK = 0             userid was found
krista@2461
   625
//        PEP_CANNOT_FIND_IDENTITY      no own_user found in the DB
krista@2461
   626
//        PEP_UNKNOWN_ERROR             results were returned, but no ID
krista@2461
   627
//                                      found (no reason this should ever occur)
krista@2461
   628
//    caveat:
krista@2461
   629
//        userid will be NULL if not found; otherwise, returned string
krista@2461
   630
//        belongs to the caller.
krista@2461
   631
krista@2461
   632
DYNAMIC_API PEP_STATUS get_default_own_userid(
krista@2461
   633
        PEP_SESSION session, 
krista@2461
   634
        char** userid
krista@2461
   635
    );
krista@2461
   636
krista@2461
   637
// get_userid_alias_default() - get the default user_id which corresponds
krista@2461
   638
//                              to an alias
krista@2461
   639
//    parameters:
krista@2461
   640
//        session (in)        session handle
krista@2461
   641
//        alias_id (in)       the user_id which may be an alias for a default id
krista@2461
   642
//        default_id (out)    the default id for this alias, if the alias
krista@2461
   643
//                            is in the DB as an alias, else NULL
krista@2461
   644
//    return value:
krista@2461
   645
//        PEP_STATUS_OK = 0             userid was found
krista@2461
   646
//        PEP_CANNOT_FIND_ALIAS         this userid is not listed as an 
krista@2461
   647
//                                      alias in the DB
krista@2461
   648
//        PEP_UNKNOWN_ERROR             results were returned, but no ID
krista@2461
   649
//                                      found (no reason this should ever occur)
krista@2461
   650
//    caveat:
krista@2461
   651
//        default_id will be NULL if not found; otherwise, returned string
krista@2461
   652
//        belongs to the caller.
krista@2461
   653
//        also, current implementation does NOT check to see if this userid
krista@2461
   654
//        IS a default.
krista@2461
   655
krista@2461
   656
DYNAMIC_API PEP_STATUS get_userid_alias_default(
krista@2461
   657
        PEP_SESSION session, 
krista@2461
   658
        const char* alias_id,
krista@2461
   659
        char** default_id);
krista@2461
   660
krista@2461
   661
// set_userid_alias() - set an alias to correspond to a default id
krista@2461
   662
//    parameters:
krista@2461
   663
//        session (in)        session handle
krista@2461
   664
//        default_id (in)     the default id for this alias. This must
krista@2461
   665
//                            correspond to the default user_id for an
krista@2461
   666
//                            entry in the person (user) table.
krista@2461
   667
//        alias_id (in)       the alias to be set for this default id
krista@2461
   668
//    return value:
krista@2461
   669
//        PEP_STATUS_OK = 0             userid was found
krista@2461
   670
//        PEP_CANNOT_SET_ALIAS          there was an error setting this
krista@2461
   671
krista@2461
   672
DYNAMIC_API PEP_STATUS set_userid_alias (
krista@2461
   673
        PEP_SESSION session, 
krista@2461
   674
        const char* default_id,
krista@2461
   675
        const char* alias_id);
krista@2461
   676
krista@2461
   677
edouard@1234
   678
// set_device_group() - update own person's device group
edouard@1234
   679
//
edouard@1234
   680
//    parameters:
edouard@1234
   681
//        session (in)        session handle
edouard@1234
   682
//        group_name (in)     new group name
edouard@1234
   683
//
edouard@1234
   684
//    return value:
edouard@1235
   685
//        PEP_STATUS_OK = 0             device group was updated
edouard@1234
   686
//        PEP_CANNOT_SET_PERSON         update failed
edouard@1234
   687
edouard@1234
   688
DYNAMIC_API PEP_STATUS set_device_group(
edouard@1234
   689
        PEP_SESSION session,
edouard@1234
   690
        const char *group_name
edouard@1234
   691
    );
vb@0
   692
edouard@1235
   693
// get_device_group() - get own person's device group
edouard@1235
   694
//
edouard@1235
   695
//    parameters:
edouard@1235
   696
//        session (in)        session handle
edouard@1235
   697
//        group_name (in)     new group name
edouard@1235
   698
//
edouard@1235
   699
//    return value:
edouard@1235
   700
//        PEP_STATUS_OK = 0             couldn't get device group
edouard@1235
   701
//        PEP_RECORD_NOT_FOUND          update failed
edouard@1235
   702
//
edouard@1235
   703
//    caveat:
edouard@1235
   704
//        the ownerships of group_name is going to the caller
edouard@1235
   705
edouard@1235
   706
DYNAMIC_API PEP_STATUS get_device_group(
edouard@1235
   707
        PEP_SESSION session, 
edouard@1235
   708
        char **group_name
edouard@1235
   709
    );
edouard@1235
   710
vb@932
   711
// set_identity_flags() - update identity flags on existing identity
vb@932
   712
//
vb@932
   713
//    parameters:
vb@932
   714
//        session (in)        session handle
vb@934
   715
//        identity (in,out)   pointer to pEp_identity structure
vb@934
   716
//        flags (in)          new value for flags
vb@932
   717
//
vb@932
   718
//    return value:
vb@932
   719
//        PEP_STATUS_OK = 0             encryption and signing succeeded
vb@932
   720
//        PEP_CANNOT_SET_IDENTITY       update of identity failed
vb@932
   721
//
vb@932
   722
//    caveat:
vb@934
   723
//        address and user_id must be given in identity
vb@932
   724
vb@932
   725
DYNAMIC_API PEP_STATUS set_identity_flags(
vb@934
   726
        PEP_SESSION session,
vb@934
   727
        pEp_identity *identity,
vb@1425
   728
        identity_flags_t flags
vb@932
   729
    );
vb@932
   730
edouard@1406
   731
// unset_identity_flags() - update identity flags on existing identity
edouard@1406
   732
//
edouard@1406
   733
//    parameters:
edouard@1406
   734
//        session (in)        session handle
edouard@1406
   735
//        identity (in,out)   pointer to pEp_identity structure
edouard@1406
   736
//        flags (in)          new value for flags
edouard@1406
   737
//
edouard@1406
   738
//    return value:
edouard@1406
   739
//        PEP_STATUS_OK = 0             encryption and signing succeeded
edouard@1406
   740
//        PEP_CANNOT_SET_IDENTITY       update of identity failed
edouard@1406
   741
//
edouard@1406
   742
//    caveat:
edouard@1406
   743
//        address and user_id must be given in identity
edouard@1406
   744
edouard@1406
   745
DYNAMIC_API PEP_STATUS unset_identity_flags(
edouard@1406
   746
        PEP_SESSION session,
edouard@1406
   747
        pEp_identity *identity,
vb@1425
   748
        identity_flags_t flags
edouard@1406
   749
    );
vb@932
   750
krista@2593
   751
// mark_as_compromised() - mark key in trust db as compromised
vb@357
   752
//
roker@529
   753
//    parameters:
roker@529
   754
//        session (in)        session handle
roker@529
   755
//        fpr (in)            fingerprint of key to mark
vb@357
   756
krista@2593
   757
DYNAMIC_API PEP_STATUS mark_as_compromised(
krista@2593
   758
        PEP_SESSION session,
krista@2593
   759
        const char *fpr
krista@2593
   760
    );
krista@2593
   761
krista@2593
   762
krista@2593
   763
// mark_as_compromized() - deprecated to fix misspelling. Please move to
krista@2593
   764
//                         mark_as_compromised();
krista@2593
   765
vb@357
   766
DYNAMIC_API PEP_STATUS mark_as_compromized(
vb@357
   767
        PEP_SESSION session,
vb@357
   768
        const char *fpr
vb@357
   769
    );
vb@357
   770
vb@357
   771
vb@0
   772
// generate_keypair() - generate a new key pair and add it to the key ring
vb@0
   773
//
vb@0
   774
//  parameters:
vb@0
   775
//      session (in)            session handle
roker@529
   776
//        identity (inout)      pointer to pEp_identity structure
vb@0
   777
//
roker@529
   778
//    return value:
roker@529
   779
//        PEP_STATUS_OK = 0       encryption and signing succeeded
roker@529
   780
//        PEP_ILLEGAL_VALUE       illegal values for identity fields given
roker@529
   781
//        PEP_CANNOT_CREATE_KEY   key engine is on strike
vb@0
   782
//
vb@0
   783
//  caveat:
vb@0
   784
//      address and username fields must be set to UTF-8 strings
vb@0
   785
//      the fpr field must be set to NULL
vb@0
   786
//
vb@0
   787
//      this function allocates a string and sets set fpr field of identity
vb@0
   788
//      the caller is responsible to call free() for that string or use
vb@0
   789
//      free_identity() on the struct
vb@0
   790
vb@0
   791
DYNAMIC_API PEP_STATUS generate_keypair(
vb@0
   792
        PEP_SESSION session, pEp_identity *identity
vb@0
   793
    );
vb@0
   794
vb@0
   795
vb@0
   796
// delete_keypair() - delete a public key or a key pair from the key ring
vb@0
   797
//
vb@0
   798
//  parameters:
vb@0
   799
//      session (in)            session handle
vb@0
   800
//      fpr (in)                C string with key id or fingerprint of the
vb@0
   801
//                              public key
vb@0
   802
//
vb@0
   803
//  return value:
vb@0
   804
//      PEP_STATUS_OK = 0       key was successfully deleted
vb@0
   805
//      PEP_KEY_NOT_FOUND       key not found
vb@0
   806
//      PEP_ILLEGAL_VALUE       not a valid key id or fingerprint
vb@0
   807
//      PEP_KEY_HAS_AMBIG_NAME  fpr does not uniquely identify a key
vb@0
   808
//      PEP_OUT_OF_MEMORY       out of memory
vb@0
   809
vb@0
   810
DYNAMIC_API PEP_STATUS delete_keypair(PEP_SESSION session, const char *fpr);
vb@0
   811
vb@0
   812
vb@0
   813
// import_key() - import key from data
vb@0
   814
//
vb@0
   815
//  parameters:
vb@0
   816
//      session (in)            session handle
vb@0
   817
//      key_data (in)           key data, i.e. ASCII armored OpenPGP key
vb@0
   818
//      size (in)               amount of data to handle
Edouard@772
   819
//      private_keys (out)      list of private keys that have been imported
vb@0
   820
//
vb@0
   821
//  return value:
vb@0
   822
//      PEP_STATUS_OK = 0       key was successfully imported
vb@0
   823
//      PEP_OUT_OF_MEMORY       out of memory
vb@0
   824
//      PEP_ILLEGAL_VALUE       there is no key data to import
Edouard@772
   825
//
Edouard@772
   826
//  caveat:
Edouard@772
   827
//      private_keys goes to the ownership of the caller
Edouard@772
   828
//      private_keys can be left NULL, it is then ignored
vb@0
   829
Edouard@728
   830
DYNAMIC_API PEP_STATUS import_key(
Edouard@728
   831
        PEP_SESSION session,
Edouard@728
   832
        const char *key_data,
Edouard@728
   833
        size_t size,
Edouard@728
   834
        identity_list **private_keys
Edouard@728
   835
    );
vb@0
   836
vb@0
   837
vb@0
   838
// export_key() - export ascii armored key
vb@0
   839
//
vb@0
   840
//  parameters:
vb@0
   841
//      session (in)            session handle
vb@0
   842
//      fpr (in)                key id or fingerprint of key
vb@0
   843
//      key_data (out)          ASCII armored OpenPGP key
roker@529
   844
//      size (out)              amount of data to handle
vb@0
   845
//
vb@0
   846
//  return value:
vb@0
   847
//      PEP_STATUS_OK = 0       key was successfully exported
vb@0
   848
//      PEP_OUT_OF_MEMORY       out of memory
vb@0
   849
//      PEP_KEY_NOT_FOUND       key not found
vb@0
   850
//
vb@0
   851
//  caveat:
vb@0
   852
//      the key_data goes to the ownership of the caller
vb@0
   853
//      the caller is responsible to free() it (on Windoze use pEp_free())
vb@0
   854
vb@0
   855
DYNAMIC_API PEP_STATUS export_key(
vb@0
   856
        PEP_SESSION session, const char *fpr, char **key_data, size_t *size
vb@0
   857
    );
vb@0
   858
vb@0
   859
vb@1103
   860
// export_secret_key() - export secret key ascii armored
vb@1103
   861
//
vb@1103
   862
//  parameters:
vb@1103
   863
//      session (in)            session handle
vb@1103
   864
//      fpr (in)                fingerprint of key, at least 16 hex digits
vb@1103
   865
//      key_data (out)          ASCII armored OpenPGP secret key
vb@1103
   866
//      size (out)              amount of data to handle
vb@1103
   867
//
vb@1103
   868
//  return value:
vb@1103
   869
//      PEP_STATUS_OK = 0       key was successfully exported
vb@1103
   870
//      PEP_OUT_OF_MEMORY       out of memory
vb@1103
   871
//      PEP_KEY_NOT_FOUND       key not found
vb@1103
   872
//      PEP_CANNOT_EXPORT_KEY   cannot export secret key (i.e. it's on an HKS)
vb@1103
   873
//
vb@1103
   874
//  caveat:
vb@1103
   875
//      the key_data goes to the ownership of the caller
vb@1103
   876
//      the caller is responsible to free() it (on Windoze use pEp_free())
vb@1103
   877
//      beware of leaking secret key data - overwrite it in memory after use
vb@1103
   878
krista@2593
   879
DYNAMIC_API PEP_STATUS export_secret_key(
krista@2593
   880
        PEP_SESSION session, const char *fpr, char **key_data, size_t *size
krista@2593
   881
    );
krista@2593
   882
krista@2593
   883
krista@2593
   884
// export_secrect_key() - deprecated misspelled function. Please replace with
krista@2593
   885
//                        export_secret_key
krista@2593
   886
vb@1103
   887
DYNAMIC_API PEP_STATUS export_secrect_key(
vb@1103
   888
        PEP_SESSION session, const char *fpr, char **key_data, size_t *size
vb@1103
   889
    );
vb@1103
   890
vb@1103
   891
vb@0
   892
// recv_key() - update key(s) from keyserver
vb@0
   893
//
vb@0
   894
//  parameters:
vb@0
   895
//      session (in)            session handle
vb@0
   896
//      pattern (in)            key id, user id or address to search for as
vb@0
   897
//                              UTF-8 string
vb@0
   898
vb@0
   899
DYNAMIC_API PEP_STATUS recv_key(PEP_SESSION session, const char *pattern);
vb@0
   900
vb@0
   901
vb@0
   902
// find_keys() - find keys in keyring
vb@0
   903
//
vb@0
   904
//  parameters:
vb@0
   905
//      session (in)            session handle
vb@0
   906
//      pattern (in)            key id, user id or address to search for as
vb@0
   907
//                              UTF-8 string
vb@0
   908
//      keylist (out)           list of fingerprints found or NULL on error
vb@0
   909
//
vb@0
   910
//  caveat:
roker@529
   911
//        the ownerships of keylist isgoing to the caller
roker@529
   912
//        the caller must use free_stringlist() to free it
vb@0
   913
vb@0
   914
vb@0
   915
DYNAMIC_API PEP_STATUS find_keys(
vb@0
   916
        PEP_SESSION session, const char *pattern, stringlist_t **keylist
vb@0
   917
    );
vb@0
   918
vb@0
   919
// send_key() - send key(s) to keyserver
vb@0
   920
//
vb@0
   921
//  parameters:
vb@0
   922
//      session (in)            session handle
vb@0
   923
//      pattern (in)            key id, user id or address to search for as
vb@0
   924
//                              UTF-8 string
vb@0
   925
vb@0
   926
DYNAMIC_API PEP_STATUS send_key(PEP_SESSION session, const char *pattern);
vb@0
   927
vb@0
   928
vb@0
   929
// pEp_free() - free memory allocated by pEp engine
vb@0
   930
//
vb@0
   931
//  parameters:
vb@0
   932
//      p (in)                  pointer to free
vb@0
   933
//
vb@0
   934
//  The reason for this function is that heap management can be a pretty
vb@0
   935
//  complex task with Windoze. This free() version calls the free()
vb@0
   936
//  implementation of the C runtime library which was used to build pEp engine,
vb@0
   937
//  so you're using the correct heap. For more information, see:
vb@0
   938
//  <http://msdn.microsoft.com/en-us/library/windows/desktop/aa366711(v=vs.85).aspx>
vb@0
   939
vb@0
   940
DYNAMIC_API void pEp_free(void *p);
vb@0
   941
vb@8
   942
vb@8
   943
// get_trust() - get the trust level a key has for a person
vb@8
   944
//
vb@8
   945
//  parameters:
vb@8
   946
//      session (in)            session handle
vb@8
   947
//      identity (inout)        user_id and fpr to check as UTF-8 strings (in)
krista@2461
   948
//                              comm_type as result (out)
vb@8
   949
//
vb@14
   950
//  this function modifies the given identity struct; the struct remains in
vb@251
   951
//  the ownership of the caller
vb@14
   952
//  if the trust level cannot be determined identity->comm_type is set
vb@14
   953
//  to PEP_ct_unknown
vb@8
   954
vb@8
   955
DYNAMIC_API PEP_STATUS get_trust(PEP_SESSION session, pEp_identity *identity);
vb@8
   956
krista@2129
   957
krista@1797
   958
PEP_STATUS set_trust(PEP_SESSION session, 
krista@2480
   959
                     pEp_identity* identity);
krista@1805
   960
                            
krista@1805
   961
PEP_STATUS update_trust_for_fpr(PEP_SESSION session, 
krista@1805
   962
                                const char* fpr, 
krista@1805
   963
                                PEP_comm_type comm_type);
vb@8
   964
vb@251
   965
// least_trust() - get the least known trust level for a key in the database
vb@251
   966
//
vb@251
   967
//  parameters:
vb@251
   968
//      session (in)            session handle
vb@251
   969
//      fpr (in)                fingerprint of key to check
vb@251
   970
//      comm_type (out)         least comm_type as result (out)
vb@251
   971
//
vb@251
   972
//  if the trust level cannot be determined comm_type is set to PEP_ct_unknown
vb@251
   973
vb@251
   974
DYNAMIC_API PEP_STATUS least_trust(
vb@251
   975
        PEP_SESSION session,
vb@251
   976
        const char *fpr,
vb@251
   977
        PEP_comm_type *comm_type
vb@251
   978
    );
vb@251
   979
vb@251
   980
vb@9
   981
// get_key_rating() - get the rating a bare key has
vb@9
   982
//
vb@9
   983
//  parameters:
vb@9
   984
//      session (in)            session handle
vb@9
   985
//      fpr (in)                unique identifyer for key as UTF-8 string
vb@9
   986
//      comm_type (out)         key rating
vb@10
   987
//
vb@14
   988
//  if an error occurs, *comm_type is set to PEP_ct_unknown and an error
vb@10
   989
//  is returned
vb@9
   990
vb@9
   991
DYNAMIC_API PEP_STATUS get_key_rating(
vb@14
   992
        PEP_SESSION session,
vb@14
   993
        const char *fpr,
vb@14
   994
        PEP_comm_type *comm_type
vb@9
   995
    );
vb@9
   996
vb@9
   997
vb@198
   998
// renew_key() - renew an expired key
vb@196
   999
//
vb@196
  1000
//  parameters:
vb@196
  1001
//      session (in)            session handle
vb@214
  1002
//      fpr (in)                ID of key to renew as UTF-8 string
vb@201
  1003
//      ts (in)                 timestamp when key should expire or NULL for
vb@201
  1004
//                              default
vb@196
  1005
vb@201
  1006
DYNAMIC_API PEP_STATUS renew_key(
vb@201
  1007
        PEP_SESSION session,
vb@201
  1008
        const char *fpr,
vb@201
  1009
        const timestamp *ts
vb@201
  1010
    );
vb@196
  1011
vb@196
  1012
vb@224
  1013
// revoke_key() - revoke a key
vb@197
  1014
//
vb@197
  1015
//  parameters:
vb@197
  1016
//      session (in)            session handle
vb@214
  1017
//      fpr (in)                ID of key to revoke as UTF-8 string
vb@211
  1018
//      reason (in)             text with reason for revoke as UTF-8 string
vb@211
  1019
//                              or NULL if reason unknown
vb@211
  1020
//
vb@211
  1021
//  caveat:
vb@211
  1022
//      reason text must not include empty lines
vb@224
  1023
//      this function is meant for internal use only; better use
krista@1213
  1024
//      key_mistrusted() of keymanagement API
vb@197
  1025
vb@211
  1026
DYNAMIC_API PEP_STATUS revoke_key(
vb@211
  1027
        PEP_SESSION session,
vb@211
  1028
        const char *fpr,
vb@211
  1029
        const char *reason
vb@211
  1030
    );
vb@197
  1031
vb@197
  1032
vb@214
  1033
// key_expired() - flags if a key is already expired
vb@214
  1034
//
vb@214
  1035
//  parameters:
vb@214
  1036
//      session (in)            session handle
vb@214
  1037
//      fpr (in)                ID of key to check as UTF-8 string
Edouard@701
  1038
//      when (in)               UTC time of when should expiry be considered
vb@214
  1039
//      expired (out)           flag if key expired
vb@214
  1040
vb@214
  1041
DYNAMIC_API PEP_STATUS key_expired(
vb@214
  1042
        PEP_SESSION session,
vb@214
  1043
        const char *fpr,
Edouard@701
  1044
        const time_t when,
vb@214
  1045
        bool *expired
vb@214
  1046
    );
vb@214
  1047
Edouard@694
  1048
    
Edouard@694
  1049
// key_revoked() - flags if a key is already revoked
Edouard@694
  1050
//
Edouard@694
  1051
//  parameters:
Edouard@694
  1052
//      session (in)            session handle
Edouard@694
  1053
//      fpr (in)                ID of key to check as UTF-8 string
Edouard@694
  1054
//      revoked (out)           flag if key revoked
Edouard@694
  1055
Edouard@694
  1056
DYNAMIC_API PEP_STATUS key_revoked(
Edouard@694
  1057
        PEP_SESSION session,
Edouard@694
  1058
        const char *fpr,
Edouard@694
  1059
        bool *revoked
Edouard@694
  1060
    );
Edouard@694
  1061
krista@1797
  1062
PEP_STATUS get_key_userids(
krista@1797
  1063
        PEP_SESSION session,
krista@1797
  1064
        const char* fpr,
krista@1797
  1065
        stringlist_t** keylist
krista@1797
  1066
    );
krista@1797
  1067
vb@214
  1068
vb@450
  1069
// get_crashdump_log() - get the last log messages out
vb@450
  1070
//
vb@450
  1071
//  parameters:
vb@450
  1072
//      session (in)            session handle
vb@450
  1073
//      maxlines (in)           maximum number of lines (0 for default)
vb@458
  1074
//      logdata (out)           logdata as string in double quoted CSV format
vb@463
  1075
//                              column1 is title
vb@463
  1076
//                              column2 is entity
vb@463
  1077
//                              column3 is description
vb@463
  1078
//                              column4 is comment
vb@462
  1079
//
vb@462
  1080
//  caveat:
vb@462
  1081
//      the ownership of logdata goes to the caller
vb@450
  1082
vb@450
  1083
DYNAMIC_API PEP_STATUS get_crashdump_log(
vb@450
  1084
        PEP_SESSION session,
vb@450
  1085
        int maxlines,
vb@450
  1086
        char **logdata
vb@450
  1087
    );
vb@450
  1088
vb@450
  1089
dirk@501
  1090
// get_languagelist() - get the list of languages
vb@458
  1091
//
vb@458
  1092
//  parameters:
vb@458
  1093
//      session (in)            session handle
vb@458
  1094
//      languages (out)         languages as string in double quoted CSV format
vb@463
  1095
//                              column 1 is the ISO 639-1 language code
vb@463
  1096
//                              column 2 is the name of the language
vb@462
  1097
//
vb@462
  1098
//  caveat:
vb@462
  1099
//      the ownership of languages goes to the caller
vb@458
  1100
vb@458
  1101
DYNAMIC_API PEP_STATUS get_languagelist(
vb@458
  1102
        PEP_SESSION session,
vb@458
  1103
        char **languages
vb@458
  1104
    );
vb@458
  1105
vb@458
  1106
vb@458
  1107
// get_phrase() - get phrase in a dedicated language through i18n
vb@458
  1108
//
vb@458
  1109
//  parameters:
vb@458
  1110
//      session (in)            session handle
roker@529
  1111
//      lang (in)               C string with ISO 639-1 language code
vb@458
  1112
//      phrase_id (in)          id of phrase in i18n
vb@458
  1113
//      phrase (out)            phrase as UTF-8 string
vb@462
  1114
//
vb@462
  1115
//  caveat:
vb@462
  1116
//      the ownership of phrase goes to the caller
vb@458
  1117
vb@458
  1118
DYNAMIC_API PEP_STATUS get_phrase(
vb@458
  1119
        PEP_SESSION session,
vb@458
  1120
        const char *lang,
vb@458
  1121
        int phrase_id,
vb@458
  1122
        char **phrase
vb@458
  1123
    );
vb@458
  1124
vb@458
  1125
vb@632
  1126
// sequence_value() - raise the value of a named sequence and retrieve it
vb@632
  1127
//
vb@632
  1128
//  parameters:
vb@632
  1129
//      session (in)            session handle
vb@1085
  1130
//      name (inout)            name of sequence or char[37] set to {0, }
vb@1086
  1131
//                              for new own sequence named as UUID
vb@1085
  1132
//      value (inout)           value of sequence value to test or 0 for
vb@1085
  1133
//                              getting next value
vb@1085
  1134
//
vb@1085
  1135
//  returns:
vb@1086
  1136
//      PEP_STATUS_OK                   no error, not own sequence
vb@1086
  1137
//      PEP_SEQUENCE_VIOLATED           if sequence violated
vb@1086
  1138
//      PEP_CANNOT_INCREASE_SEQUENCE    if sequence cannot be increased
vb@1086
  1139
//      PEP_OWN_SEQUENCE                if own sequence
vb@632
  1140
vb@632
  1141
DYNAMIC_API PEP_STATUS sequence_value(
vb@632
  1142
        PEP_SESSION session,
vb@1085
  1143
        char *name,
vb@652
  1144
        int32_t *value
vb@632
  1145
    );
vb@632
  1146
vb@1044
  1147
Edouard@694
  1148
// set_revoked() - records relation between a revoked key and its replacement
Edouard@694
  1149
//
Edouard@694
  1150
//  parameters:
Edouard@694
  1151
//      session (in)            session handle
Edouard@694
  1152
//      revoked_fpr (in)        revoked fingerprint
Edouard@694
  1153
//      replacement_fpr (in)    replacement key fingerprint
Edouard@694
  1154
//      revocation_date (in)    revocation date
Edouard@694
  1155
Edouard@693
  1156
DYNAMIC_API PEP_STATUS set_revoked(
Edouard@693
  1157
       PEP_SESSION session,
Edouard@693
  1158
       const char *revoked_fpr,
Edouard@693
  1159
       const char *replacement_fpr,
Edouard@693
  1160
       const uint64_t revocation_date
Edouard@693
  1161
    );
Edouard@693
  1162
vb@958
  1163
Edouard@694
  1164
// get_revoked() - find revoked key that may have been replaced by given key, if any
Edouard@694
  1165
//
Edouard@694
  1166
//  parameters:
Edouard@694
  1167
//      session (in)            session handle
Edouard@694
  1168
//      fpr (in)                given fingerprint
Edouard@694
  1169
//      revoked_fpr (out)       revoked fingerprint
Edouard@694
  1170
//      revocation_date (out)   revocation date
Edouard@694
  1171
    
Edouard@693
  1172
DYNAMIC_API PEP_STATUS get_revoked(
Edouard@693
  1173
        PEP_SESSION session,
Edouard@693
  1174
        const char *fpr,
Edouard@693
  1175
        char **revoked_fpr,
Edouard@693
  1176
        uint64_t *revocation_date
Edouard@693
  1177
    );
Edouard@693
  1178
vb@632
  1179
vb@958
  1180
// key_created() - get creation date of a key
vb@958
  1181
//
vb@958
  1182
//  parameters:
vb@958
  1183
//      session (in)            session handle
vb@958
  1184
//      fpr (in)                fingerprint of key
vb@958
  1185
//      created (out)           date of creation
vb@958
  1186
vb@958
  1187
PEP_STATUS key_created(
vb@958
  1188
        PEP_SESSION session,
vb@958
  1189
        const char *fpr,
vb@958
  1190
        time_t *created
vb@958
  1191
    );
vb@958
  1192
vb@958
  1193
krista@1377
  1194
// find_private_keys() - find keys in keyring
krista@1357
  1195
//
krista@1357
  1196
//  parameters:
krista@1357
  1197
//      session (in)            session handle
krista@1357
  1198
//      pattern (in)            key id, user id or address to search for as
krista@1357
  1199
//                              UTF-8 string
krista@1357
  1200
//      keylist (out)           list of fingerprints found or NULL on error
krista@1357
  1201
//
krista@1357
  1202
//  caveat:
krista@1357
  1203
//        the ownerships of keylist isgoing to the caller
krista@1357
  1204
//        the caller must use free_stringlist() to free it
krista@1357
  1205
PEP_STATUS find_private_keys(PEP_SESSION session, const char* pattern,
krista@1357
  1206
                             stringlist_t **keylist);
krista@1357
  1207
krista@1011
  1208
// get_engine_version() - returns the current version of pEpEngine (this is different
krista@1011
  1209
//                        from the pEp protocol version!)
krista@1011
  1210
//
krista@1011
  1211
//  parameters: none
krista@1011
  1212
//
krista@1011
  1213
//  return_value: const char* to the engine version string constant
krista@1011
  1214
//
krista@1011
  1215
DYNAMIC_API const char* get_engine_version();
krista@1011
  1216
krista@2490
  1217
// is_pep_user() - returns true if the USER corresponding to this identity 
krista@2490
  1218
//                 has been listed in the *person* table as a pEp user. 
krista@2490
  1219
//
krista@2490
  1220
//  parameters:
krista@2490
  1221
//      identity (in) - identity containing the user_id to check (this is
krista@2490
  1222
//                      the only part of the struct we require to be set)
krista@2490
  1223
//      is_pep (out)  - boolean pointer - will return true or false by
krista@2490
  1224
//                      reference with respect to whether or not user is
krista@2490
  1225
//                      a known pep user
krista@2490
  1226
//
krista@2490
  1227
//  return_value: PEP_STATUS_OK if user found in person table
krista@2490
  1228
//                PEP_ILLEGAL_VALUE if no user_id in input
krista@2490
  1229
//                PEP_CANNOT_FIND_PERSON if user_id doesn't exist
krista@2490
  1230
//
krista@2490
  1231
//  caveat: This *does not check comm_type*
krista@2490
  1232
//                         
krista@2490
  1233
DYNAMIC_API PEP_STATUS is_pep_user(PEP_SESSION session, 
krista@2490
  1234
                                   pEp_identity *identity, 
krista@2490
  1235
                                   bool* is_pep);
krista@2490
  1236
krista@2490
  1237
krista@1307
  1238
vb@482
  1239
DYNAMIC_API PEP_STATUS reset_peptest_hack(PEP_SESSION session);
vb@482
  1240
krista@2461
  1241
// This is used internally when there is a temporary identity to be retrieved
krista@2461
  1242
// that may not yet have an FPR attached. See get_identity() for functionality,
krista@2461
  1243
// params and caveats.
krista@2461
  1244
PEP_STATUS get_identity_without_trust_check(
krista@2461
  1245
        PEP_SESSION session,
krista@2461
  1246
        const char *address,
krista@2461
  1247
        const char *user_id,
krista@2461
  1248
        pEp_identity **identity
krista@2461
  1249
    );
krista@2461
  1250
    
krista@2461
  1251
PEP_STATUS get_identities_by_address(
krista@2461
  1252
        PEP_SESSION session,
krista@2461
  1253
        const char *address,
krista@2461
  1254
        identity_list** id_list
krista@2461
  1255
    );
krista@2461
  1256
        
krista@2461
  1257
PEP_STATUS replace_userid(PEP_SESSION session, const char* old_uid,
krista@2461
  1258
                              const char* new_uid);
krista@2461
  1259
                              
krista@2461
  1260
PEP_STATUS remove_fpr_as_default(PEP_SESSION session, 
krista@2461
  1261
                                    const char* fpr);
krista@2461
  1262
                              
krista@2461
  1263
                                    
krista@2461
  1264
PEP_STATUS get_main_user_fpr(PEP_SESSION session, 
krista@2461
  1265
                             const char* user_id,
krista@2461
  1266
                             char** main_fpr);
krista@2461
  1267
krista@2461
  1268
PEP_STATUS replace_main_user_fpr(PEP_SESSION session, const char* user_id,
krista@2461
  1269
                              const char* new_fpr);
krista@2461
  1270
    
krista@2461
  1271
PEP_STATUS refresh_userid_default_key(PEP_SESSION session, const char* user_id);
krista@2461
  1272
krista@2468
  1273
// This ONLY sets the *user* flag, and creates a shell identity if necessary.
krista@2468
  1274
PEP_STATUS set_as_pep_user(PEP_SESSION session, pEp_identity* user);
krista@2468
  1275
krista@2480
  1276
// returns true (by reference) if a person with this user_id exists; 
krista@2480
  1277
// Also replaces aliased user_ids by defaults in identity.
krista@2480
  1278
PEP_STATUS exists_person(PEP_SESSION session, pEp_identity* identity, bool* exists);
krista@2468
  1279
krista@2477
  1280
PEP_STATUS set_pgp_keypair(PEP_SESSION session, const char* fpr);
krista@2468
  1281
krista@2760
  1282
PEP_STATUS compare_cached_engine_version_to_other(int* result, 
krista@2760
  1283
                                                  int major, 
krista@2760
  1284
                                                  int minor, 
krista@2760
  1285
                                                  int patch);
krista@2760
  1286
vb@0
  1287
#ifdef __cplusplus
vb@0
  1288
}
vb@0
  1289
#endif