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