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