src/message_api.h
author Krista Bennett <krista@pep-project.org>
Mon, 23 Apr 2018 13:57:14 +0200
branchENGINE-423
changeset 2624 06472aa7727d
parent 2623 009950d133c1
child 2625 d7dd538d402b
permissions -rw-r--r--
ENGINE-423: documentation
vb@1513
     1
// This file is under GNU General Public License 3.0
vb@1513
     2
// see LICENSE.txt
vb@1513
     3
vb@39
     4
#pragma once
vb@39
     5
vb@102
     6
#include "pEpEngine.h"
vb@102
     7
#include "keymanagement.h"
vb@101
     8
#include "message.h"
vb@259
     9
#include "cryptotech.h"
vb@101
    10
vb@37
    11
#ifdef __cplusplus
vb@37
    12
extern "C" {
vb@37
    13
#endif
vb@37
    14
vb@39
    15
Edouard@734
    16
bool import_attached_keys(
Edouard@728
    17
        PEP_SESSION session, 
Edouard@728
    18
        const message *msg,
Edouard@728
    19
        identity_list **private_idents
Edouard@728
    20
    );
roker@1869
    21
vb@236
    22
void attach_own_key(PEP_SESSION session, message *msg);
roker@1869
    23
vb@258
    24
PEP_cryptotech determine_encryption_format(message *msg);
roker@1869
    25
vb@952
    26
void add_opt_field(message *msg, const char *name, const char *value);
Edouard@736
    27
vb@939
    28
typedef enum _PEP_encrypt_flags {
krista@1639
    29
    // "default" means whatever the default behaviour for the function is.
krista@1639
    30
    PEP_encrypt_flag_default = 0x0,
markus@1633
    31
    PEP_encrypt_flag_force_encryption = 0x1,
markus@1633
    32
markus@1633
    33
    // This flag is for special use cases and should not be used
markus@1633
    34
    // by normal pEp clients!
krista@1640
    35
    PEP_encrypt_flag_force_unsigned = 0x2,
krista@2121
    36
    PEP_encrypt_flag_force_no_attached_key = 0x4,
krista@2121
    37
    
krista@2121
    38
    // This is used for outer messages (used to wrap the real message)
krista@2121
    39
    // This is only used internally and (eventually) by transport functions
krista@2147
    40
    PEP_encrypt_flag_inner_message = 0x8
krista@2612
    41
    
vb@939
    42
} PEP_encrypt_flags; 
vb@939
    43
vb@939
    44
typedef unsigned int PEP_encrypt_flags_t;
vb@235
    45
roker@1869
    46
vb@39
    47
// encrypt_message() - encrypt message in memory
vb@39
    48
//
vb@39
    49
//  parameters:
vb@48
    50
//      session (in)        session handle
vb@48
    51
//      src (in)            message to encrypt
vb@48
    52
//      extra (in)          extra keys for encryption
vb@2338
    53
//      dst (out)           pointer to new encrypted message or NULL if no
vb@2338
    54
//                          encryption could take place
vb@84
    55
//      enc_format (in)     encrypted format
vb@939
    56
//      flags (in)          flags to set special encryption features
vb@39
    57
//
vb@39
    58
//  return value:
vb@48
    59
//      PEP_STATUS_OK                   on success
edouard@1854
    60
//      PEP_KEY_HAS_AMBIG_NAME          at least one of the receipient keys has
edouard@1854
    61
//                                      an ambiguous name
vb@2338
    62
//      PEP_UNENCRYPTED                 on demand or no recipients with usable
vb@2338
    63
//                                      key, is left unencrypted, and key is
vb@2338
    64
//                                      attached to it
vb@83
    65
//
roker@1869
    66
//  caveat:
roker@1869
    67
//      the ownershop of src remains with the caller
roker@1869
    68
//      the ownership of dst goes to the caller
vb@44
    69
DYNAMIC_API PEP_STATUS encrypt_message(
vb@37
    70
        PEP_SESSION session,
vb@113
    71
        message *src,
vb@37
    72
        stringlist_t *extra,
vb@38
    73
        message **dst,
vb@939
    74
        PEP_enc_format enc_format,
vb@939
    75
        PEP_encrypt_flags_t flags
vb@37
    76
    );
vb@37
    77
roker@1869
    78
krista@2592
    79
DYNAMIC_API PEP_STATUS encrypt_message_and_add_priv_key(
krista@2592
    80
        PEP_SESSION session,
krista@2592
    81
        message *src,
krista@2592
    82
        message **dst,
krista@2592
    83
        const char* to_fpr,
krista@2594
    84
        PEP_enc_format enc_format,
krista@2594
    85
        PEP_encrypt_flags_t flags
krista@2592
    86
    );
krista@2592
    87
krista@2592
    88
krista@1034
    89
// encrypt_message_for_self() - encrypt message in memory for user's identity only,
krista@1034
    90
//                              ignoring recipients and other identities from
krista@1034
    91
//                              the message
krista@994
    92
//  parameters:
krista@994
    93
//      session (in)        session handle
krista@995
    94
//      target_id (in)      self identity this message should be encrypted for
krista@994
    95
//      src (in)            message to encrypt
krista@2588
    96
//      extra (in)          extra keys for encryption
krista@994
    97
//      dst (out)           pointer to new encrypted message or NULL on failure
krista@994
    98
//      enc_format (in)     encrypted format
markus@1634
    99
//      flags (in)          flags to set special encryption features
krista@994
   100
//
krista@994
   101
//  return value:       (FIXME: This may not be correct or complete)
roker@1869
   102
//      PEP_STATUS_OK            on success
roker@1869
   103
//      PEP_KEY_NOT_FOUND        at least one of the receipient keys
roker@1869
   104
//                               could not be found
roker@1869
   105
//      PEP_KEY_HAS_AMBIG_NAME   at least one of the receipient keys has
roker@1869
   106
//                               an ambiguous name
roker@1869
   107
//      PEP_GET_KEY_FAILED       cannot retrieve key
krista@994
   108
//
roker@1869
   109
//  caveat:
roker@1869
   110
//      the ownership of src remains with the caller
krista@994
   111
//      the ownership of target_id remains w/ caller            
roker@1869
   112
//      the ownership of dst goes to the caller
krista@995
   113
//      message is NOT encrypted for identities other than the target_id (and then,
roker@1869
   114
//      only if the target_id refers to self!)
krista@995
   115
DYNAMIC_API PEP_STATUS encrypt_message_for_self(
krista@994
   116
        PEP_SESSION session,
krista@994
   117
        pEp_identity* target_id,
krista@994
   118
        message *src,
krista@2588
   119
        stringlist_t* extra,
krista@994
   120
        message **dst,
markus@1633
   121
        PEP_enc_format enc_format,
markus@1633
   122
        PEP_encrypt_flags_t flags
krista@994
   123
    );
vb@39
   124
roker@1869
   125
krista@1325
   126
// MIME_encrypt_message() - encrypt a MIME message, with MIME output
krista@1325
   127
//
krista@1325
   128
//  parameters:
krista@1325
   129
//      session (in)            session handle
krista@1325
   130
//      mimetext (in)           MIME encoded text to encrypt
krista@1331
   131
//      size (in)               size of input mime text
krista@1325
   132
//      extra (in)              extra keys for encryption
krista@1325
   133
//      mime_ciphertext (out)   encrypted, encoded message
krista@1325
   134
//      enc_format (in)         encrypted format
krista@1325
   135
//      flags (in)              flags to set special encryption features
krista@1325
   136
//
krista@1325
   137
//  return value:
krista@1325
   138
//      PEP_STATUS_OK           if everything worked
krista@1325
   139
//      PEP_BUFFER_TOO_SMALL    if encoded message size is too big to handle
krista@1325
   140
//      PEP_CANNOT_CREATE_TEMP_FILE
krista@1325
   141
//                              if there are issues with temp files; in
krista@1325
   142
//                              this case errno will contain the underlying
krista@1325
   143
//                              error
krista@1325
   144
//      PEP_OUT_OF_MEMORY       if not enough memory could be allocated
krista@1325
   145
//
krista@1325
   146
//  caveat:
krista@1325
   147
//      the encrypted, encoded mime text will go to the ownership of the caller; mimetext
krista@1325
   148
//      will remain in the ownership of the caller
krista@1325
   149
DYNAMIC_API PEP_STATUS MIME_encrypt_message(
krista@1325
   150
    PEP_SESSION session,
krista@1325
   151
    const char *mimetext,
krista@1325
   152
    size_t size,
krista@1325
   153
    stringlist_t* extra,
krista@1325
   154
    char** mime_ciphertext,
krista@1325
   155
    PEP_enc_format enc_format,
krista@1325
   156
    PEP_encrypt_flags_t flags
krista@1325
   157
);
krista@1325
   158
roker@1869
   159
krista@1641
   160
// MIME_encrypt_message_for_self() - encrypt MIME message for user's identity only,
krista@1641
   161
//                              ignoring recipients and other identities from
krista@1641
   162
//                              the message, with MIME output
krista@1641
   163
//  parameters:
krista@1641
   164
//      session (in)            session handle
roker@1869
   165
//      target_id (in)          self identity this message should be encrypted for
krista@1641
   166
//      mimetext (in)           MIME encoded text to encrypt
krista@1641
   167
//      size (in)               size of input mime text
krista@2588
   168
//      extra (in)              extra keys for encryption
krista@1641
   169
//      mime_ciphertext (out)   encrypted, encoded message
krista@1641
   170
//      enc_format (in)         encrypted format
krista@1641
   171
//      flags (in)              flags to set special encryption features
krista@1641
   172
//
krista@1641
   173
//  return value:
krista@1641
   174
//      PEP_STATUS_OK           if everything worked
krista@1641
   175
//      PEP_BUFFER_TOO_SMALL    if encoded message size is too big to handle
krista@1641
   176
//      PEP_CANNOT_CREATE_TEMP_FILE
krista@1641
   177
//                              if there are issues with temp files; in
krista@1641
   178
//                              this case errno will contain the underlying
krista@1641
   179
//                              error
krista@1641
   180
//      PEP_OUT_OF_MEMORY       if not enough memory could be allocated
krista@1641
   181
//
krista@1641
   182
//  caveat:
krista@1641
   183
//      the encrypted, encoded mime text will go to the ownership of the caller; mimetext
krista@1641
   184
//      will remain in the ownership of the caller
krista@1641
   185
DYNAMIC_API PEP_STATUS MIME_encrypt_message_for_self(
krista@1641
   186
    PEP_SESSION session,
krista@1641
   187
    pEp_identity* target_id,
krista@1641
   188
    const char *mimetext,
krista@1641
   189
    size_t size,
krista@2588
   190
    stringlist_t* extra,
krista@1641
   191
    char** mime_ciphertext,
krista@1641
   192
    PEP_enc_format enc_format,
krista@1641
   193
    PEP_encrypt_flags_t flags
krista@1641
   194
);
krista@1641
   195
krista@1641
   196
vb@1004
   197
typedef enum _PEP_rating {
vb@237
   198
    PEP_rating_undefined = 0,
vb@256
   199
    PEP_rating_cannot_decrypt,
vb@267
   200
    PEP_rating_have_no_key,
vb@237
   201
    PEP_rating_unencrypted,
vb@486
   202
    PEP_rating_unencrypted_for_some,
vb@237
   203
    PEP_rating_unreliable,
vb@237
   204
    PEP_rating_reliable,
vb@237
   205
    PEP_rating_trusted,
vb@237
   206
    PEP_rating_trusted_and_anonymized,
vb@237
   207
    PEP_rating_fully_anonymous,   
vb@189
   208
Edouard@442
   209
    PEP_rating_mistrust = -1,
Edouard@442
   210
    PEP_rating_b0rken = -2,
vb@436
   211
    PEP_rating_under_attack = -3
vb@1004
   212
} PEP_rating;
vb@1004
   213
vb@1004
   214
typedef enum _PEP_color {
vb@1004
   215
    PEP_color_no_color = 0,
vb@1004
   216
    PEP_color_yellow,
vb@1004
   217
    PEP_color_green,
vb@1004
   218
    PEP_color_red = -1,
vb@232
   219
} PEP_color;
vb@189
   220
roker@1869
   221
vb@1007
   222
// color_from_rating - calculate color from rating
vb@1007
   223
//
vb@1007
   224
//  parameters:
vb@1007
   225
//      rating (in)         rating
vb@1007
   226
//
vb@1007
   227
//  return value:           color representing that rating
vb@1004
   228
DYNAMIC_API PEP_color color_from_rating(PEP_rating rating);
vb@1004
   229
Edouard@728
   230
typedef enum _PEP_decrypt_flags {
edouard@1355
   231
    PEP_decrypt_flag_own_private_key = 0x1,
edouard@1369
   232
    PEP_decrypt_flag_consume = 0x2,
krista@2623
   233
    PEP_decrypt_flag_ignore = 0x4,
krista@2623
   234
    PEP_decrypt_flag_src_modified = 0x8,
krista@2623
   235
    // input flags    
krista@2623
   236
    PEP_decrypt_flag_untrusted_server = 0x100
Edouard@728
   237
} PEP_decrypt_flags; 
Edouard@728
   238
vb@939
   239
typedef unsigned int PEP_decrypt_flags_t;
Edouard@728
   240
roker@1869
   241
vb@251
   242
// decrypt_message() - decrypt message in memory
vb@251
   243
//
vb@251
   244
//  parameters:
vb@251
   245
//      session (in)        session handle
krista@2624
   246
//      src (inout)         message to decrypt
vb@251
   247
//      dst (out)           pointer to new decrypted message or NULL on failure
vb@251
   248
//      keylist (out)       stringlist with keyids
roker@1218
   249
//      rating (out)        rating for the message
krista@2624
   250
//      flags (inout)       flags to signal special decryption features
vb@251
   251
//
vb@251
   252
//  return value:
edouard@1858
   253
//      error status 
edouard@1858
   254
//      or PEP_DECRYPTED if message decrypted but not verified
krista@2624
   255
//      or PEP_CANNOT_REENCRYPT if message was decrypted (and possibly
krista@2624
   256
//         verified) but a reencryption operation is expected by the caller
krista@2624
   257
//         and failed
edouard@1858
   258
//      or PEP_STATUS_OK on success
vb@251
   259
//
krista@2624
   260
//  flag values:
krista@2624
   261
//      in:
krista@2624
   262
//          PEP_decrypt_flag_untrusted_server
krista@2624
   263
//              used to signal that decrypt function should engage in behaviour
krista@2624
   264
//              specified for when the server storing the source is untrusted
krista@2624
   265
//      out:
krista@2624
   266
//          PEP_decrypt_flag_own_private_key
krista@2624
   267
//              private key was imported for one of our addresses (NOT trusted
krista@2624
   268
//              or set to be used - handshake/trust is required for that)
krista@2624
   269
//          PEP_decrypt_flag_src_modified
krista@2624
   270
//              indicates that the src object has been modified. At the moment,
krista@2624
   271
//              this is always as a direct result of the behaviour driven
krista@2624
   272
//              by the input flags. This flag is the ONLY value that should be
krista@2624
   273
//              relied upon to see if such changes have taken place.
krista@2624
   274
//          PEP_decrypt_flag_consume
krista@2624
   275
//              used by sync 
krista@2624
   276
//          PEP_decrypt_flag_ignore
krista@2624
   277
//              used by sync 
krista@2624
   278
//
krista@2624
   279
//
roker@1869
   280
// caveat:
krista@2624
   281
//      the ownership of src remains with the caller - however, the contents 
krista@2624
   282
//          might be modified (strings freed and allocated anew or set to NULL,
krista@2624
   283
//          etc) intentionally; when this happens, PEP_decrypt_flag_src_modified
krista@2624
   284
//          is set.
roker@1869
   285
//      the ownership of dst goes to the caller
roker@1869
   286
//      the ownership of keylist goes to the caller
roker@1869
   287
//      if src is unencrypted this function returns PEP_UNENCRYPTED and sets
krista@2624
   288
//         dst to NULL
vb@251
   289
DYNAMIC_API PEP_STATUS decrypt_message(
vb@251
   290
        PEP_SESSION session,
vb@251
   291
        message *src,
vb@251
   292
        message **dst,
vb@251
   293
        stringlist_t **keylist,
vb@1004
   294
        PEP_rating *rating,
vb@939
   295
        PEP_decrypt_flags_t *flags
Edouard@728
   296
);
vb@251
   297
roker@1869
   298
krista@1325
   299
// MIME_decrypt_message() - decrypt a MIME message, with MIME output
krista@1325
   300
//
krista@1325
   301
//  parameters:
krista@1325
   302
//      session (in)            session handle
krista@1325
   303
//      mimetext (in)           MIME encoded text to decrypt
krista@1331
   304
//      size (in)               size of mime text to decode (in order to decrypt)
krista@1325
   305
//      mime_plaintext (out)    decrypted, encoded message
krista@1325
   306
//      keylist (out)           stringlist with keyids
krista@1325
   307
//      rating (out)            rating for the message
krista@2624
   308
//      flags (inout)           flags to signal special decryption features (see below)
krista@2623
   309
//      modified_src (out)      modified source string, if decrypt had reason to change it
krista@1325
   310
//
krista@1325
   311
//  return value:
krista@1644
   312
//      decrypt status          if everything worked with MIME encode/decode, 
krista@1644
   313
//                              the status of the decryption is returned 
krista@1644
   314
//                              (PEP_STATUS_OK or decryption error status)
krista@1325
   315
//      PEP_BUFFER_TOO_SMALL    if encoded message size is too big to handle
krista@1325
   316
//      PEP_CANNOT_CREATE_TEMP_FILE
krista@1325
   317
//                              if there are issues with temp files; in
krista@1325
   318
//                              this case errno will contain the underlying
krista@1325
   319
//                              error
krista@1325
   320
//      PEP_OUT_OF_MEMORY       if not enough memory could be allocated
krista@1325
   321
//
krista@2624
   322
//  flag values:
krista@2624
   323
//      in:
krista@2624
   324
//          PEP_decrypt_flag_untrusted_server
krista@2624
   325
//              used to signal that decrypt function should engage in behaviour
krista@2624
   326
//              specified for when the server storing the source is untrusted.
krista@2624
   327
//      out:
krista@2624
   328
//          PEP_decrypt_flag_own_private_key
krista@2624
   329
//              private key was imported for one of our addresses (NOT trusted
krista@2624
   330
//              or set to be used - handshake/trust is required for that)
krista@2624
   331
//          PEP_decrypt_flag_src_modified
krista@2624
   332
//              indicates that the modified_src field should contain a modified
krista@2624
   333
//              version of the source, at the moment always as a result of the
krista@2624
   334
//              input flags. 
krista@2624
   335
//          PEP_decrypt_flag_consume
krista@2624
   336
//              used by sync 
krista@2624
   337
//          PEP_decrypt_flag_ignore
krista@2624
   338
//              used by sync 
krista@2624
   339
// 
krista@1325
   340
//  caveat:
krista@1325
   341
//      the decrypted, encoded mime text will go to the ownership of the caller; mimetext
krista@1325
   342
//      will remain in the ownership of the caller
krista@1325
   343
DYNAMIC_API PEP_STATUS MIME_decrypt_message(
krista@1325
   344
    PEP_SESSION session,
krista@1325
   345
    const char *mimetext,
krista@1325
   346
    size_t size,
krista@1325
   347
    char** mime_plaintext,
krista@1325
   348
    stringlist_t **keylist,
krista@1325
   349
    PEP_rating *rating,
krista@2623
   350
    PEP_decrypt_flags_t *flags,
krista@2623
   351
    char** modified_src
krista@1325
   352
);
krista@1325
   353
krista@1325
   354
Edouard@728
   355
// own_message_private_key_details() - details on own key in own message
Edouard@728
   356
//
Edouard@728
   357
//  parameters:
Edouard@728
   358
//      session (in)        session handle
Edouard@728
   359
//      msg (in)            message to decrypt
Edouard@728
   360
//      ident (out)         identity containing uid, address and fpr of key
Edouard@728
   361
//
Edouard@728
   362
//  note:
Edouard@728
   363
//      In order to obtain details about key to be possibly imported
Edouard@728
   364
//      as a replacement of key currently used as own identity, 
Edouard@728
   365
//      application passes message that have been previously flagged by 
Edouard@728
   366
//      decrypt_message() as own message containing own key to this function
Edouard@728
   367
//
Edouard@728
   368
//  return value:
Edouard@728
   369
//      error status or PEP_STATUS_OK on success
Edouard@728
   370
//
roker@1869
   371
//  caveat:
roker@1869
   372
//      the ownership of msg remains with the caller
roker@1869
   373
//      the ownership of ident goes to the caller
roker@1869
   374
//      msg MUST be encrypted so that this function can check own signature
Edouard@728
   375
DYNAMIC_API PEP_STATUS own_message_private_key_details(
Edouard@728
   376
        PEP_SESSION session,
Edouard@728
   377
        message *msg,
Edouard@728
   378
        pEp_identity **ident 
Edouard@728
   379
);
vb@251
   380
roker@1869
   381
vb@1009
   382
// outgoing_message_rating() - get rating for an outgoing message
vb@189
   383
//
vb@189
   384
//  parameters:
vb@189
   385
//      session (in)        session handle
vb@1009
   386
//      msg (in)            message to get the rating for
vb@1009
   387
//      rating (out)        rating for the message
vb@189
   388
//
vb@189
   389
//  return value:
vb@189
   390
//      error status or PEP_STATUS_OK on success
vb@190
   391
//
vb@190
   392
//  caveat:
vb@190
   393
//      msg->from must point to a valid pEp_identity
vb@251
   394
//      msg->dir must be PEP_dir_outgoing
vb@251
   395
//      the ownership of msg remains with the caller
vb@1009
   396
DYNAMIC_API PEP_STATUS outgoing_message_rating(
vb@189
   397
        PEP_SESSION session,
vb@190
   398
        message *msg,
vb@1004
   399
        PEP_rating *rating
vb@189
   400
    );
vb@189
   401
vb@239
   402
vb@1009
   403
// identity_rating() - get rating for a single identity
vb@239
   404
//
vb@239
   405
//  parameters:
vb@239
   406
//      session (in)        session handle
vb@1009
   407
//      ident (in)          identity to get the rating for
vb@1009
   408
//      rating (out)        rating for the identity
vb@239
   409
//
vb@239
   410
//  return value:
vb@239
   411
//      error status or PEP_STATUS_OK on success
vb@251
   412
//
vb@251
   413
//  caveat:
vb@251
   414
//      the ownership of ident remains with the caller
vb@1009
   415
DYNAMIC_API PEP_STATUS identity_rating(
vb@239
   416
        PEP_SESSION session,
vb@239
   417
        pEp_identity *ident,
vb@1004
   418
        PEP_rating *rating
vb@239
   419
    );
vb@239
   420
vb@239
   421
vb@507
   422
// get_binary_path() - retrieve path of cryptotech binary if available
vb@507
   423
//
vb@507
   424
//  parameters:
vb@507
   425
//      tech (in)           cryptotech to get the binary for
vb@507
   426
//      path (out)          path to cryptotech binary or NULL if not available
roker@540
   427
//                          **path is owned by the library, do not change it!
vb@507
   428
DYNAMIC_API PEP_STATUS get_binary_path(PEP_cryptotech tech, const char **path);
vb@507
   429
roker@1869
   430
krista@1307
   431
// get_trustwords() - get full trustwords string for a *pair* of identities
krista@1307
   432
//
krista@1307
   433
//    parameters:
krista@1307
   434
//        session (in)        session handle
krista@1307
   435
//        id1 (in)            identity of first party in communication - fpr can't be NULL  
krista@1307
   436
//        id2 (in)            identity of second party in communication - fpr can't be NULL
krista@1307
   437
//        lang (in)           C string with ISO 639-1 language code
krista@1307
   438
//        words (out)         pointer to C string with all trustwords UTF-8 encoded,
krista@1307
   439
//                            separated by a blank each
krista@1307
   440
//                            NULL if language is not supported or trustword
krista@1307
   441
//                            wordlist is damaged or unavailable
krista@1307
   442
//        wsize (out)         length of full trustwords string
krista@1307
   443
//        full (in)           if true, generate ALL trustwords for these identities.
krista@1307
   444
//                            else, generate a fixed-size subset. (TODO: fixed-minimum-entropy
krista@1307
   445
//                            subset in next version)
krista@1307
   446
//
krista@1307
   447
//    return value:
krista@1307
   448
//        PEP_STATUS_OK            trustwords retrieved
krista@1307
   449
//        PEP_OUT_OF_MEMORY        out of memory
krista@1307
   450
//        PEP_TRUSTWORD_NOT_FOUND  at least one trustword not found
krista@1307
   451
//
krista@1307
   452
//    caveat:
krista@1307
   453
//        the word pointer goes to the ownership of the caller
krista@1307
   454
//        the caller is responsible to free() it (on Windoze use pEp_free())
krista@1307
   455
//
krista@1307
   456
DYNAMIC_API PEP_STATUS get_trustwords(
roker@1509
   457
    PEP_SESSION session, const pEp_identity* id1, const pEp_identity* id2,
krista@1307
   458
    const char* lang, char **words, size_t *wsize, bool full
krista@1307
   459
);
vb@507
   460
roker@1869
   461
edouard@1553
   462
// get_message_trustwords() - get full trustwords string for message sender and reciever identities 
edouard@1553
   463
//
edouard@1553
   464
//    parameters:
edouard@1553
   465
//        session (in)        session handle
edouard@1553
   466
//        msg (in)            message to get sender identity from
edouard@1553
   467
//        keylist (in)        NULL if message to be decrypted,
edouard@1553
   468
//                            keylist returned by decrypt_message() otherwise
edouard@1553
   469
//        received_by (in)    identity for account receiving message can't be NULL
edouard@1553
   470
//        lang (in)           C string with ISO 639-1 language code
edouard@1553
   471
//        words (out)         pointer to C string with all trustwords UTF-8 encoded,
edouard@1553
   472
//                            separated by a blank each
edouard@1553
   473
//                            NULL if language is not supported or trustword
edouard@1553
   474
//                            wordlist is damaged or unavailable
edouard@1553
   475
//        full (in)           if true, generate ALL trustwords for these identities.
edouard@1553
   476
//                            else, generate a fixed-size subset. (TODO: fixed-minimum-entropy
edouard@1553
   477
//                            subset in next version)
edouard@1553
   478
//
edouard@1553
   479
//    return value:
edouard@1553
   480
//        PEP_STATUS_OK            trustwords retrieved
edouard@1553
   481
//        PEP_OUT_OF_MEMORY        out of memory
edouard@1553
   482
//        PEP_TRUSTWORD_NOT_FOUND  at least one trustword not found
edouard@1553
   483
//        error status of decrypt_message() if decryption fails.
edouard@1553
   484
//
edouard@1553
   485
//    caveat:
edouard@1553
   486
//        the word pointer goes to the ownership of the caller
edouard@1553
   487
//        the caller is responsible to free() it (on Windoze use pEp_free())
edouard@1553
   488
//
edouard@1553
   489
DYNAMIC_API PEP_STATUS get_message_trustwords(
edouard@1553
   490
    PEP_SESSION session, 
edouard@1553
   491
    message *msg,
edouard@1553
   492
    stringlist_t *keylist,
edouard@1553
   493
    pEp_identity* received_by,
edouard@1553
   494
    const char* lang, char **words, bool full
edouard@1553
   495
);
edouard@1553
   496
edouard@1815
   497
// re_evaluate_message_rating() - re-evaluate already decrypted message rating
edouard@1815
   498
//
edouard@1815
   499
//  parameters:
edouard@1815
   500
//      session (in)            session handle
edouard@1815
   501
//      msg (in)                message to get the rating for
edouard@1815
   502
//      x_keylist (in)          decrypted message recipients keys fpr
edouard@1815
   503
//      x_enc_status (in)       original rating for the decrypted message
edouard@1815
   504
//      rating (out)            rating for the message
edouard@1815
   505
//
edouard@1815
   506
//  return value:
edouard@1815
   507
//      PEP_ILLEGAL_VALUE       if decrypted message doesn't contain 
edouard@1815
   508
//                              X-EncStatus optional field and x_enc_status is 
edouard@1815
   509
//                              pEp_rating_udefined
edouard@1815
   510
//                              or if decrypted message doesn't contain 
edouard@1815
   511
//                              X-Keylist optional field and x_keylist is NULL
edouard@1815
   512
//      PEP_OUT_OF_MEMORY       if not enough memory could be allocated
edouard@1815
   513
//
edouard@1815
   514
//  caveat:
edouard@1815
   515
//      msg->from must point to a valid pEp_identity
edouard@1815
   516
//      the ownership of msg remains with the caller
edouard@1815
   517
//	    the ownership of x_keylist remains with to the caller
edouard@1815
   518
edouard@1815
   519
DYNAMIC_API PEP_STATUS re_evaluate_message_rating(
edouard@1815
   520
    PEP_SESSION session,
edouard@1815
   521
    message *msg,
edouard@1815
   522
    stringlist_t *x_keylist,
edouard@1815
   523
    PEP_rating x_enc_status,
edouard@1815
   524
    PEP_rating *rating
edouard@1815
   525
);
vb@37
   526
#ifdef __cplusplus
vb@37
   527
}
vb@37
   528
#endif