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