Browse Source

deprecation information, more adjustments

pull/22/head
parent
commit
dcd20da5c0
9 changed files with 77 additions and 34 deletions
  1. +20
    -10
      src/aux_mime_msg.h
  2. +14
    -1
      src/base64.h
  3. +4
    -1
      src/baseprotocol.h
  4. +22
    -5
      src/blacklist.h
  5. +1
    -1
      src/dynamic_api.h
  6. +5
    -8
      src/growing_buf.h
  7. +8
    -6
      src/resource.h
  8. +2
    -1
      src/status_to_string.h
  9. +1
    -1
      src/wrappers.h

+ 20
- 10
src/aux_mime_msg.h View File

@ -1,10 +1,14 @@
/**
* @file aux_mime_msg.h
*
* @brief Auxilliary file which provides the MIME* functions for the enigmail/pEp implementation and some tests.
* @brief Auxiliary file which provides the MIME* functions for the enigmail/pEp implementation and some tests.
* Provides access to pEp functions for messages fed in in MIME string format instead of
* through the message struct.
*
*
* @deprecated These functions should no longer be used, and these files will be removed shortly.
*
* @warning No version of the engine which implements pEp sync should use these functions
*
* @license GNU General Public License 3.0 - see LICENSE.txt
*/
@ -23,14 +27,16 @@ extern "C" {
/**
* <!-- MIME_encrypt_message() -->
*
*
* @deprecated
*
* @brief Encrypt a MIME message, with MIME output
*
* @param[in] session session handle
* @param[in] mimetext MIME encoded text to encrypt
* @param[in] size size of input mime text
* @param[in] extra extra keys for encryption
* @param[out] mime_ciphertext encrypted, encoded message
* @param[out] mime_ciphertext encrypted, encoded message
* @param[in] enc_format encrypted format
* @param[in] flags flags to set special encryption features
*
@ -44,7 +50,7 @@ extern "C" {
* @ownership
* - the encrypted, encoded mime text will go to the ownership of the caller
* - the original mimetext will remain in the ownership of the caller
*
*
*/
DYNAMIC_API PEP_STATUS MIME_encrypt_message(
PEP_SESSION session,
@ -59,7 +65,9 @@ DYNAMIC_API PEP_STATUS MIME_encrypt_message(
/**
* <!-- MIME_encrypt_message_for_self() -->
*
*
* @deprecated
*
* @brief Encrypt MIME message for user's identity only,
* ignoring recipients and other identities from
* the message, with MIME output
@ -100,12 +108,14 @@ DYNAMIC_API PEP_STATUS MIME_encrypt_message_for_self(
/**
* <!-- MIME_decrypt_message() -->
*
*
* @deprecated
*
* @brief Decrypt a MIME message, with MIME output
*
* @param[in] session session handle
* @param[in] mimetext MIME encoded text to decrypt
* @param[in] size size of mime text to decode (in order to decrypt)
* @param[in] session session handle
* @param[in] mimetext MIME encoded text to decrypt
* @param[in] size size of mime text to decode (in order to decrypt)
* @param[out] mime_plaintext decrypted, encoded message
* @param[in,out] keylist in: stringlist with additional keyids for reencryption if needed
* (will be freed and replaced with output keylist)


+ 14
- 1
src/base64.h View File

@ -1,6 +1,8 @@
/**
* @file base64.h
* @brief Convert base64 to a binary blob
* @brief Convert base64 to a binary blob - this is a convenience function
* used mainly to convert keys which are base64 rather than radix64
* (i.e. PGP armoured) encoded
* @license GNU General Public License 3.0 - see LICENSE.txt
*/
@ -13,6 +15,17 @@
extern "C" {
#endif
/**
* <!-- base64_str_to_binary_blob() -->
*
* @brief Decode a base64 string and return binary format
*
* @param[in] input base64 string
* @param[in] length string length
*
* @retval decoded binary blob of input string
*
*/
bloblist_t* base64_str_to_binary_blob(const char* input, int length);
#ifdef __cplusplus


+ 4
- 1
src/baseprotocol.h View File

@ -1,6 +1,9 @@
/**
* @file baseprotocol.h
* @brief base protocol (FIXME: derived from filename)
* @brief Basic functions for administrative pEp messages (preparation,
* decoration, payload, extraction, etc.). These are used for
* protocol messages in, for example, key sync and key reset.
* The payloads of these messages are, in general, not human-readable.
* @license GNU General Public License 3.0 - see LICENSE.txt
*/


+ 22
- 5
src/blacklist.h View File

@ -1,6 +1,15 @@
/**
* @file blacklist.h
* @brief blacklist (FIXME: derived from filename)
* @brief Functions for maintaining a key blacklist for OpenPGP keys
* (i.e. keys received from OpenPGP partners). This is currently
* used by users when an OpenPGP partner has indicated that they
* do not want us to use a particular key we may have for them.
* This is marked as deprecated because we want users to use
* key reset instead, and this code will be in fact removed
* in Release 2.2.0 when key election is also removed.
*
* @deprecated These files are still in use as of Release 2.1 and will be removed with key election removal.
*
* @license GNU General Public License 3.0 - see LICENSE.txt
*/
@ -14,7 +23,9 @@ extern "C" {
/**
* <!-- blacklist_add() -->
*
*
* @deprecated As of Release 2.2.0
*
* @brief Add to blacklist
*
* @param[in] session session to use
@ -33,7 +44,9 @@ DYNAMIC_API PEP_STATUS blacklist_add(PEP_SESSION session, const char *fpr);
/**
* <!-- blacklist_delete() -->
*
*
* @deprecated As of Release 2.2.0
*
* @brief Delete from blacklist
*
* @param[in] session session to use
@ -47,7 +60,9 @@ DYNAMIC_API PEP_STATUS blacklist_delete(PEP_SESSION session, const char *fpr);
/**
* <!-- blacklist_is_listed() -->
*
*
* @deprecated As of Release 2.2.0
*
* @brief Is listed in blacklist
*
* @param[in] session session to use
@ -66,7 +81,9 @@ DYNAMIC_API PEP_STATUS blacklist_is_listed(
/**
* <!-- blacklist_retrieve() -->
*
*
* @deprecated As of Release 2.2.0
*
* @brief Retrieve full blacklist of key fingerprints
*
* @param[in] session session to use


+ 1
- 1
src/dynamic_api.h View File

@ -1,6 +1,6 @@
/**
* @file dynamic_api.h
* @brief dynamic api (FIXME: derived from filename)
* @brief defines for windows API export
* @license GNU General Public License 3.0 - see LICENSE.txt
*/


+ 5
- 8
src/growing_buf.h View File

@ -16,13 +16,11 @@ extern "C" {
#endif
// this is a growing buffer, which is needed by the ASN.1 implementation
// i.e. for encoding to XER
/**
* @struct growing_buf_t
*
* @brief TODO
* @brief this is a growing buffer, which is needed by the ASN.1 implementation
* i.e. for encoding to XER
*
*/
typedef struct growing_buf {
@ -66,11 +64,10 @@ void free_growing_buf(growing_buf_t *buf);
* @param[in] size size of new data
* @param[in] dst growing buffer where new data will be appended
*
* @retval 1 on succes, -1 on failure
*
*
* @retval 1 on success
* @retval -1 on failure
*
*/
int growing_buf_consume(const void *src, size_t size, growing_buf_t *dst);


+ 8
- 6
src/resource.h View File

@ -1,9 +1,11 @@
/** @file */
/** @brief File description for doxygen missing. FIXME */
// This file is under GNU General Public License 3.0
// see LICENSE.txt
/**
* @file resource.h
* @brief Windows platform-specific implementation details
* @license GNU General Public License 3.0 - see LICENSE.txt
* @note If this file is overwritten when generated, please fix it to
* generate or merge this header information before committing.
*/
//{{NO_DEPENDENCIES}}
// Microsoft Visual C++ generated include file.
// Used by pEpEngine.rc


+ 2
- 1
src/status_to_string.h View File

@ -1,7 +1,8 @@
/**
* @file status_to_string.h
* @brief status to string (FIXME: derived from filename)
* @brief Convert various statuses and enums into string format (generally for logs)
* @license GNU General Public License 3.0 - see LICENSE.txt
* @todo generate this file
*/
#ifdef __cplusplus
extern "C" {


+ 1
- 1
src/wrappers.h View File

@ -1,6 +1,6 @@
/**
* @file wrappers.h
* @brief File maniupation wrappers
* @brief File manipulation wrappers
* @license GNU General Public License 3.0 - see LICENSE.txt
*/


Loading…
Cancel
Save