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