pEp.foundation
/
pEpEngine
16
2
Fork 17
Code Issues 19 Pull Requests 2 Releases 46 Wiki Activity

Mark a first batch of stuff as internal

Browse Source
ENGINE-1002--3.x
Gernot Kranz 1 year ago committed by Luca Saiu
parent 91a92b0c9c
commit b4ec944b86
11 changed files with 105 additions and 1 deletions
Show Stats Download Patch File Download Diff File

25
src/etpan_mime.h
Unescape View File

@ -1,4 +1,5 @@
/**
* @internal
* @file etpan_mime.h
* @brief Driver for the libetpan MIME implementation (@see mime.h for the general API)
* @license GNU General Public License 3.0 - see LICENSE.txt
@ -18,6 +19,7 @@
#include "timestamp.h"
/**
* @internal
* <!-- part_new_empty() -->
*
* @brief TODO
@ -36,6 +38,7 @@ struct mailmime * part_new_empty(
);
/**
* @internal
* <!-- get_pgp_encrypted_part() -->
*
* @brief TODO
@ -45,6 +48,7 @@ struct mailmime * part_new_empty(
struct mailmime * get_pgp_encrypted_part(void);
/**
* @internal
* <!-- get_text_part() -->
*
* @brief TODO
@ -65,6 +69,7 @@ struct mailmime * get_text_part(
);
/**
* @internal
* <!-- get_file_part() -->
*
* @brief TODO
@ -85,6 +90,7 @@ struct mailmime * get_file_part(
);
/**
* @internal
* <!-- part_multiple_new() -->
*
* @brief TODO
@ -97,6 +103,7 @@ struct mailmime * part_multiple_new(const char *type);
typedef void *(*_new_func_t)(void *);
/**
* @internal
* <!-- _new_field() -->
*
* @brief TODO
@ -113,6 +120,7 @@ struct mailimf_field * _new_field(
);
/**
* @internal
* <!-- _free_field() -->
*
* @brief TODO
@ -123,6 +131,7 @@ struct mailimf_field * _new_field(
void _free_field(struct mailimf_field *field);
/**
* @internal
* <!-- _append_field() -->
*
* @brief TODO
@ -141,6 +150,7 @@ int _append_field(
);
/**
* @internal
* <!-- timestamp_to_etpantime() -->
*
* @brief TODO
@ -150,6 +160,7 @@ int _append_field(
*/
struct mailimf_date_time * timestamp_to_etpantime(const timestamp *ts);
/**
* @internal
* <!-- etpantime_to_timestamp() -->
*
* @brief TODO
@ -160,6 +171,7 @@ struct mailimf_date_time * timestamp_to_etpantime(const timestamp *ts);
timestamp * etpantime_to_timestamp(const struct mailimf_date_time *et);
/**
* @internal
* <!-- mailbox_from_string() -->
*
* @brief TODO
@ -174,6 +186,7 @@ struct mailimf_mailbox * mailbox_from_string(
);
/**
* @internal
* <!-- create_optional_field() -->
*
* @brief TODO
@ -188,6 +201,7 @@ struct mailimf_field * create_optional_field(
);
/**
* @internal
* <!-- _append_optional_field() -->
*
* @brief TODO
@ -204,6 +218,7 @@ int _append_optional_field(
);
/**
* @internal
* <!-- _get_fields() -->
*
* @brief TODO
@ -213,6 +228,7 @@ int _append_optional_field(
*/
clist * _get_fields(struct mailmime * mime);
/**
* @internal
* <!-- _get_content() -->
*
* @brief TODO
@ -222,6 +238,7 @@ clist * _get_fields(struct mailmime * mime);
*/
struct mailmime_content * _get_content(struct mailmime * mime);
/**
* @internal
* <!-- _get_filename_or_cid() -->
*
* @brief TODO
@ -231,6 +248,7 @@ struct mailmime_content * _get_content(struct mailmime * mime);
*/
char * _get_filename_or_cid(struct mailmime *mime);
/**
* @internal
* <!-- _get_resource_id_list() -->
*
* @brief TODO
@ -240,6 +258,7 @@ char * _get_filename_or_cid(struct mailmime *mime);
*/
pEp_rid_list_t* _get_resource_id_list(struct mailmime *mime);
/**
* @internal
* <!-- _build_uri() -->
*
* @brief TODO
@ -250,6 +269,7 @@ pEp_rid_list_t* _get_resource_id_list(struct mailmime *mime);
*/
char* _build_uri(char* uri_prefix, char* resource);
/**
* @internal
* <!-- _is_multipart() -->
*
* @brief TODO
@ -260,6 +280,7 @@ char* _build_uri(char* uri_prefix, char* resource);
*/
bool _is_multipart(struct mailmime_content *content, const char *subtype);
/**
* @internal
* <!-- _is_PGP_MIME() -->
*
* @brief TODO
@ -269,6 +290,7 @@ bool _is_multipart(struct mailmime_content *content, const char *subtype);
*/
bool _is_PGP_MIME(struct mailmime_content *content);
/**
* @internal
* <!-- _is_text_part() -->
*
* @brief TODO
@ -279,6 +301,7 @@ bool _is_PGP_MIME(struct mailmime_content *content);
*/
bool _is_text_part(struct mailmime_content *content, const char *subtype);
/**
* @internal
* <!-- must_field_value_be_encoded() -->
*
* @brief TODO
@ -288,6 +311,7 @@ bool _is_text_part(struct mailmime_content *content, const char *subtype);
*/
bool must_field_value_be_encoded(const char* field_value);
/**
* @internal
* <!-- must_chunk_be_encoded() -->
*
* @brief TODO
@ -301,6 +325,7 @@ bool must_chunk_be_encoded(const void* value, size_t size, bool ignore_fws);
/**
* @internal
* <!-- _get_content_type() -->
*
* @brief TODO

4
src/group_internal.h
Unescape View File

@ -1,4 +1,5 @@
/// @file group_internal.h
/// @internal
/// @brief Internal functions for representation of groups
/// @license This file is under GNU General Public License 3.0 - see LICENSE.txt
@ -237,6 +238,7 @@ identity_list* member_list_to_identity_list(member_list* memberlist);
/**
*
* @internal
* @param session
* @param group_identity
* @param manager
@ -248,6 +250,7 @@ PEP_STATUS get_group_manager(PEP_SESSION session,
/**
*
* @internal
* @param session
* @param group_identity
* @param own_manager
@ -257,6 +260,7 @@ PEP_STATUS is_group_mine(PEP_SESSION session, pEp_identity* group_identity, bool
/**
*
* @internal
* @param session
* @param group_identity
* @param member

9
src/key_reset_internal.h
Unescape View File

@ -1,4 +1,5 @@
/**
* @internal
* @file key_reset_internal.h
* @brief Functions for resetting partner key defaults and trust and mistrusting and revoking own keys,
* as well as functions to inform partners of own revoked keys and their replacements
@ -20,6 +21,7 @@ extern "C" {
#endif
/**
* @internal
* <!-- key_reset() -->
*
* @brief Reset the database status for a key, removing all trust information
@ -74,6 +76,7 @@ PEP_STATUS key_reset_own_and_deliver_revocations(PEP_SESSION session,
*/
/**
* @internal
* <!-- has_key_reset_been_sent() -->
*
* @brief TODO
@ -96,6 +99,7 @@ PEP_STATUS has_key_reset_been_sent(
bool* contacted);
/**
* @internal
* <!-- set_reset_contact_notified() -->
*
* @brief TODO
@ -117,6 +121,7 @@ PEP_STATUS set_reset_contact_notified(
);
/**
* @internal
* <!-- receive_key_reset() -->
*
* @brief TODO
@ -137,6 +142,7 @@ PEP_STATUS receive_key_reset(PEP_SESSION session,
message* reset_msg);
/**
* @internal
* <!-- create_standalone_key_reset_message() -->
*
* @brief TODO
@ -162,6 +168,7 @@ PEP_STATUS create_standalone_key_reset_message(PEP_SESSION session,
/**
* @internal
* <!-- send_key_reset_to_recents() -->
*
* @brief TODO
@ -182,6 +189,7 @@ PEP_STATUS send_key_reset_to_recents(PEP_SESSION session,
const char* new_fpr);
/**
* @internal
* <!-- key_reset_commands_to_PER() -->
*
* @brief TODO
@ -197,6 +205,7 @@ PEP_STATUS send_key_reset_to_recents(PEP_SESSION session,
PEP_STATUS key_reset_commands_to_PER(const keyreset_command_list *command_list, char **cmds, size_t *size);
/**
* @internal
* <!-- PER_to_key_reset_commands() -->
*
* @brief TODO

2
src/keymanagement.h
Unescape View File

@ -269,6 +269,7 @@ DYNAMIC_API PEP_STATUS own_key_is_listed(
/**
* @internal
* <!-- _own_identities_retrieve() -->
*
* @brief Retrieve all own identities
@ -315,6 +316,7 @@ DYNAMIC_API PEP_STATUS own_identities_retrieve(
);
/**
* @internal
* <!-- _own_keys_retrieve() -->
*
* @brief Retrieve all flagged keypair fingerprints

10
src/keymanagement_internal.h
Unescape View File

@ -1,4 +1,5 @@
/**
* @internal
* @file keymanagement_internal.h
* @brief Functions to manage keys (and identities when in relation to keys)
* @license GNU General Public License 3.0 - see LICENSE.txt
@ -16,6 +17,7 @@ extern "C" {
/**
* @internal
* <!-- _myself() -->
*
* @brief TODO
@ -41,6 +43,7 @@ PEP_STATUS _myself(PEP_SESSION session,
/**
* @internal
* <!-- contains_priv_key() -->
*
* @brief TODO
@ -58,6 +61,7 @@ PEP_STATUS contains_priv_key(PEP_SESSION session, const char *fpr,
/**
* @internal
* <!-- get_all_keys_for_user() -->
*
* @brief TODO
@ -79,6 +83,7 @@ PEP_STATUS get_all_keys_for_user(PEP_SESSION session,
/**
* @internal
* <!-- add_mistrusted_key() -->
*
* @brief TODO
@ -93,6 +98,7 @@ PEP_STATUS get_all_keys_for_user(PEP_SESSION session,
PEP_STATUS add_mistrusted_key(PEP_SESSION session, const char* fpr);
/**
* @internal
* <!-- delete_mistrusted_key() -->
*
* @brief TODO
@ -106,6 +112,7 @@ PEP_STATUS add_mistrusted_key(PEP_SESSION session, const char* fpr);
*/
PEP_STATUS delete_mistrusted_key(PEP_SESSION session, const char* fpr);
/**
* @internal
* <!-- is_mistrusted_key() -->
*
* @brief TODO
@ -120,6 +127,7 @@ PEP_STATUS delete_mistrusted_key(PEP_SESSION session, const char* fpr);
*/
PEP_STATUS is_mistrusted_key(PEP_SESSION session, const char* fpr, bool* mistrusted);
/**
* @internal
* <!-- get_user_default_key() -->
*
* @brief TODO
@ -139,6 +147,7 @@ PEP_STATUS get_user_default_key(PEP_SESSION session, const char* user_id,
/**
* @internal
* <!-- get_valid_pubkey() -->
*
* @brief TODO
@ -166,6 +175,7 @@ PEP_STATUS get_valid_pubkey(PEP_SESSION session,
bool* is_address_default);
/**
* @internal
* <!-- get_key_sticky_bit_for_user() -->
*
* @brief Get value of sticky bit for this user and key

5
src/message_api_internal.h
Unescape View File

@ -1,4 +1,5 @@
/// @file message_api_internal.h
/// @internal
/// @author Created by Krista Bennett on 14.04.21.
///
@ -16,6 +17,7 @@ extern "C" {
#endif
/**
* @internal
* <!-- import_attached_keys() -->
*
* @brief TODO
@ -38,6 +40,7 @@ bool import_attached_keys(
);
/**
* @internal
* <!-- attach_own_key() -->
*
* @brief TODO
@ -49,6 +52,7 @@ bool import_attached_keys(
void attach_own_key(PEP_SESSION session, message *msg);
/**
* @internal
* <!-- determine_encryption_format() -->
*
* @brief TODO
@ -59,6 +63,7 @@ void attach_own_key(PEP_SESSION session, message *msg);
PEP_cryptotech determine_encryption_format(message *msg);
/**
* @internal
* <!-- add_opt_field() -->
*
* @brief TODO

1
src/pEpEngine.h
Unescape View File

@ -711,6 +711,7 @@ DYNAMIC_API PEP_STATUS log_service(PEP_SESSION session, const char *title,
log_service((session), (title), (entity), (desc), "service " __FILE__ ":" S_LINE)
/**
* @internal
* <!-- _service_error_log() -->
*
* @brief TODO

38
src/pEpEngine_internal.h
Unescape View File

@ -1,5 +1,6 @@
/**
* @file pEpEngine_internal.h
* @internal
* @brief Exposed internal functions and structures.
* @license GNU General Public License 3.0 - see LICENSE.txt
*/
@ -22,6 +23,7 @@ extern "C" {
#include "timestamp.h"
/**
* @internal
* <!-- replace_identities_fpr() -->
*
* @brief TODO
@ -41,6 +43,7 @@ PEP_STATUS replace_identities_fpr(PEP_SESSION session,
/**
* @internal
* <!-- set_trust() -->
*
* @brief TODO
@ -55,6 +58,7 @@ PEP_STATUS set_trust(PEP_SESSION session,
pEp_identity* identity);
/**
* @internal
* <!-- update_trust_for_fpr() -->
*
* @brief TODO
@ -75,6 +79,7 @@ PEP_STATUS update_trust_for_fpr(PEP_SESSION session,
/**
* @internal
* <!-- get_key_userids() -->
*
* @brief TODO
@ -91,6 +96,7 @@ PEP_STATUS get_key_userids(
);
/**
* @internal
* <!-- key_created() -->
*
* @brief Get creation date of a key
@ -111,6 +117,7 @@ PEP_STATUS key_created(
);
/**
* @internal
* <!-- find_private_keys() -->
*
* @brief Find keys in keyring
@ -132,6 +139,7 @@ PEP_STATUS find_private_keys(PEP_SESSION session, const char* pattern,
/**
* @internal
* <!-- _generate_keypair() -->
*
* @brief TODO
@ -155,6 +163,7 @@ PEP_STATUS _generate_keypair(PEP_SESSION session,
// that may not yet have an FPR attached. See get_identity() for functionality,
// params and caveats.
/**
* @internal
* <!-- get_identity_without_trust_check() -->
*
* @brief
@ -182,6 +191,7 @@ PEP_STATUS get_identity_without_trust_check(
);
/**
* @internal
* <!-- get_identities_by_address() -->
*
* @brief TODO
@ -203,6 +213,7 @@ PEP_STATUS get_identities_by_address(
);
/**
* @internal
* <!-- get_identities_by_userid() -->
*
* @brief TODO
@ -224,6 +235,7 @@ PEP_STATUS get_identities_by_userid(
);
/**
* @internal
* <!-- is_own_address() -->
*
* @brief TODO
@ -242,6 +254,7 @@ PEP_STATUS is_own_address(PEP_SESSION session,
bool* is_own_addr);
/**
* @internal
* <!-- replace_userid() -->
*
* @brief TODO
@ -258,6 +271,7 @@ PEP_STATUS replace_userid(PEP_SESSION session, const char* old_uid,
const char* new_uid);
/**
* @internal
* <!-- remove_key() -->
*
* @brief TODO
@ -273,6 +287,7 @@ PEP_STATUS replace_userid(PEP_SESSION session, const char* old_uid,
PEP_STATUS remove_key(PEP_SESSION session, const char* fpr);
/**
* @internal
* <!-- remove_fpr_as_default() -->
*
* @brief TODO
@ -291,6 +306,7 @@ PEP_STATUS remove_fpr_as_default(PEP_SESSION session,
/**
* @internal
* <!-- get_main_user_fpr() -->
*
* @brief TODO
@ -310,6 +326,7 @@ PEP_STATUS get_main_user_fpr(PEP_SESSION session,
char** main_fpr);
/**
* @internal
* <!-- replace_main_user_fpr() -->
*
* @brief TODO
@ -327,6 +344,7 @@ PEP_STATUS replace_main_user_fpr(PEP_SESSION session, const char* user_id,
const char* new_fpr);
/**
* @internal
* <!-- replace_main_user_fpr_if_equal() -->
*
* @brief TODO
@ -345,6 +363,7 @@ PEP_STATUS replace_main_user_fpr_if_equal(PEP_SESSION session, const char* user_
const char* new_fpr, const char* compare_fpr);
/**
* @internal
* <!-- refresh_userid_default_key() -->
*
* @brief TODO
@ -360,6 +379,7 @@ PEP_STATUS replace_main_user_fpr_if_equal(PEP_SESSION session, const char* user_
PEP_STATUS refresh_userid_default_key(PEP_SESSION session, const char* user_id);
/**
* @internal
* <!-- exists_person() -->
*
* @brief TODO
@ -378,6 +398,7 @@ PEP_STATUS refresh_userid_default_key(PEP_SESSION session, const char* user_id);
PEP_STATUS exists_person(PEP_SESSION session, pEp_identity* identity, bool* exists);
/**
* @internal
* <!-- set_pgp_keypair() -->
*
* @brief TODO
@ -392,6 +413,7 @@ PEP_STATUS exists_person(PEP_SESSION session, pEp_identity* identity, bool* exis
PEP_STATUS set_pgp_keypair(PEP_SESSION session, const char* fpr);
/**
* @internal
* <!-- set_pEp_version() -->
*
* @brief TODO
@ -409,6 +431,7 @@ PEP_STATUS set_pgp_keypair(PEP_SESSION session, const char* fpr);
PEP_STATUS set_pEp_version(PEP_SESSION session, pEp_identity* ident, unsigned int new_ver_major, unsigned int new_ver_minor);
/**
* @internal
* <!-- clear_trust_info() -->
*
* @brief TODO
@ -427,6 +450,7 @@ PEP_STATUS clear_trust_info(PEP_SESSION session,
const char* fpr);
/**
* @internal
* <!-- upgrade_pEp_version_by_user_id() -->
*
* @brief TODO
@ -450,6 +474,7 @@ PEP_STATUS upgrade_pEp_version_by_user_id(PEP_SESSION session,
);
/**
* @internal
* <!-- set_person() -->
*
* @brief TODO
@ -466,6 +491,7 @@ PEP_STATUS upgrade_pEp_version_by_user_id(PEP_SESSION session,
PEP_STATUS set_person(PEP_SESSION session, pEp_identity* identity,
bool guard_transaction);
/**
* @internal
* <!-- bind_own_ident_with_contact_ident() -->
*
* @brief TODO
@ -484,6 +510,7 @@ PEP_STATUS bind_own_ident_with_contact_ident(PEP_SESSION session,
pEp_identity* contact_ident);
/**
* @internal
* <!-- get_last_contacted() -->
*
* @brief TODO
@ -503,6 +530,7 @@ PEP_STATUS get_last_contacted(
);
/**
* @internal
* <!-- get_own_ident_for_contact_id() -->
*
* @brief TODO
@ -521,6 +549,7 @@ PEP_STATUS get_own_ident_for_contact_id(PEP_SESSION session,
pEp_identity** own_ident);
/**
* @internal
* <!-- exists_trust_entry() -->
*
* @brief TODO
@ -538,6 +567,7 @@ PEP_STATUS exists_trust_entry(PEP_SESSION session, pEp_identity* identity,
bool* exists);
/**
* @internal
* <!-- is_own_key() -->
*
* @brief TODO
@ -554,6 +584,7 @@ PEP_STATUS exists_trust_entry(PEP_SESSION session, pEp_identity* identity,
PEP_STATUS is_own_key(PEP_SESSION session, const char* fpr, bool* own_key);
/**
* @internal
* <!-- get_identities_by_main_key_id() -->
*
* @brief TODO
@ -581,6 +612,7 @@ PEP_STATUS get_identities_by_address(
);
/**
* @internal
* <!-- get_default_identity_fpr() -->
*
* @param[in] session
@ -596,6 +628,7 @@ PEP_STATUS get_default_identity_fpr(PEP_SESSION session,
char** main_fpr);
/**
* @internal
* <!-- set_default_identity_fpr() -->
* Set the default key fingerprint for the identity identitified by this address and user_id. Will only
* succeed if identity is already in DB.
@ -614,6 +647,7 @@ PEP_STATUS set_default_identity_fpr(PEP_SESSION session,
const char* fpr);
/**
* @internal
* <!-- sign_only() -->
*
* @brief TODO
@ -637,6 +671,7 @@ PEP_STATUS sign_only(PEP_SESSION session,
size_t *sign_size);
/**
* @internal
* <!-- set_all_userids_to_own() -->
*
* @brief TODO
@ -649,6 +684,7 @@ PEP_STATUS set_all_userids_to_own(PEP_SESSION session,
identity_list* id_list);
/**
* @internal
* <!-- has_partner_contacted_address() -->
*
* @brief TODO
@ -667,6 +703,7 @@ PEP_STATUS has_partner_contacted_address(PEP_SESSION session, const char* partne
const char* own_address, bool* was_contacted);
/*
* @internal
* <!-- exists_identity_entry() -->
* documented in pEpEngine.c
*
@ -675,6 +712,7 @@ PEP_STATUS exists_identity_entry(PEP_SESSION session, pEp_identity* identity,
bool* exists);
/**
* @internal
* <!-- force_set_identity_username() -->
* @param[in] session PEP_SESSION
* @param[in] identity pEp_identity*

6
src/pEp_internal.h
Unescape View File

@ -1,4 +1,5 @@
/**
* @internal
* @file pEp_internal.h
* @brief pEp internal structs, functions, defines, and values
* @license GNU General Public License 3.0 - see LICENSE.txt
@ -129,6 +130,7 @@
struct _pEpSession;
typedef struct _pEpSession pEpSession;
/**
* @internal
* @struct _pEpSession
*
* @brief TODO
@ -318,6 +320,7 @@ struct _pEpSession {
/**
* @internal
* <!-- init_transport_system() -->
*
* @brief TODO
@ -330,6 +333,7 @@ struct _pEpSession {
PEP_STATUS init_transport_system(PEP_SESSION session, bool in_first);
/**
* @internal
* <!-- release_transport_system() -->
*
* @brief TODO
@ -362,6 +366,7 @@ PEP_STATUS encrypt_only(
);
/**
* @internal
* <!-- decorate_message() -->
*
* @brief TODO
@ -398,6 +403,7 @@ void decorate_message(
#endif
/**
* @internal
* @enum _normalize_hex_rest_t
*
* @brief TODO

1
src/pgp_sequoia_internal.h
Unescape View File

@ -1,4 +1,5 @@
/**
* @internal
* @file src/pgp_sequoia_internal.h
* @brief pgp sequoia internal (FIXME: derived from filename)
* @license GNU General Public License 3.0 - see LICENSE.txt

5
src/platform_disable_attributes.h
Unescape View File

@ -3,6 +3,7 @@
/**
* @file platform_disable_attributes.h
* @internal
*
* @brief Disable GNU-style attributes for functions, variables, types and label
* (https://gcc.gnu.org/onlinedocs/gcc/Function-Attributes.html ), turning them
@ -15,7 +16,9 @@
* for the user to directly see.
* */
/** @brief Notice that this definition is extremely conservative: supporting exactly
/**
* @internal
* @brief Notice that this definition is extremely conservative: supporting exactly
one argument would suffice. */
#define __attribute__(...) /* nothing */
#define attribute __attribute__

Write Preview
Loading…
Cancel
Save