Added docs for ENGINE-420's encrypt_message_and_add_priv_key for key import ENGINE-423
authorKrista Bennett <krista@pep-project.org>
Mon, 23 Apr 2018 16:59:27 +0200
branchENGINE-423
changeset 2625d7dd538d402b
parent 2624 06472aa7727d
child 2626 8f319cd5966c
Added docs for ENGINE-420's encrypt_message_and_add_priv_key for key import
src/message_api.h
     1.1 --- a/src/message_api.h	Mon Apr 23 13:57:14 2018 +0200
     1.2 +++ b/src/message_api.h	Mon Apr 23 16:59:27 2018 +0200
     1.3 @@ -76,6 +76,31 @@
     1.4      );
     1.5  
     1.6  
     1.7 +// encrypt_message_and_add_priv_key() - encrypt message in memory, adding an encrypted private
     1.8 +//                                      key (encrypted separately and sent within the inner message)
     1.9 +//
    1.10 +//  parameters:
    1.11 +//      session (in)        session handle
    1.12 +//      src (in)            message to encrypt
    1.13 +//      extra (in)          extra keys for encryption
    1.14 +//      dst (out)           pointer to new encrypted message or NULL if no
    1.15 +//                          encryption could take place
    1.16 +//      to_fpr              fingerprint of the private key that should
    1.17 +//                          be encrypted and attached to the message
    1.18 +//      enc_format (in)     encrypted format
    1.19 +//      flags (in)          flags to set special encryption features
    1.20 +//
    1.21 +//  return value:
    1.22 +//      PEP_STATUS_OK                   on success
    1.23 +//      PEP_KEY_HAS_AMBIG_NAME          at least one of the receipient keys has
    1.24 +//                                      an ambiguous name
    1.25 +//      PEP_UNENCRYPTED                 on demand or no recipients with usable
    1.26 +//                                      key, is left unencrypted, and key is
    1.27 +//                                      attached to it
    1.28 +//
    1.29 +//  caveat:
    1.30 +//      the ownershop of src remains with the caller
    1.31 +//      the ownership of dst goes to the caller
    1.32  DYNAMIC_API PEP_STATUS encrypt_message_and_add_priv_key(
    1.33          PEP_SESSION session,
    1.34          message *src,