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