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

Mark more stuff as internal

Browse Source
ENGINE-1002--3.x
Gernot Kranz 1 year ago committed by Luca Saiu
parent 291116dade
commit 42c48621c5
26 changed files with 101 additions and 5 deletions
Show Stats Download Patch File Download Diff File

2
src/base64.c
Unescape View File

@ -1,4 +1,5 @@
/**
* @internal
* @file base64.c
* @brief Convert base64 to a binary blob - this is the implementation of
* a convenience function used mainly to convert keys which are
@ -15,6 +16,7 @@
#include "base64.h"
/**
* @internal
* <!-- translate_char_to_bits() -->
* @brief convert ascii value to corresponding base64 digit value
* @param[in] input char to translate

2
src/base64.h
Unescape View File

@ -1,4 +1,5 @@
/**
* @internal
* @file base64.h
* @brief Convert base64 to a binary blob - this is a convenience function
* used mainly to convert keys which are base64 rather than radix64
@ -17,6 +18,7 @@ extern "C" {
#endif
/**
* @internal
* <!-- base64_str_to_binary_blob() -->
*
* @brief Decode a base64 string and return binary format

1
src/baseprotocol.c
Unescape View File

@ -1,4 +1,5 @@
/**
* @internal
* @file baseprotocol.c
* @brief Implementation of basic functions for administrative pEp messages (preparation,
* decoration, payload, extraction, etc.). These are used for

6
src/baseprotocol.h
Unescape View File

@ -1,4 +1,5 @@
/**
* @internal
* @file baseprotocol.h
* @brief Basic functions for administrative pEp messages (preparation,
* decoration, payload, extraction, etc.).
@ -23,6 +24,7 @@ extern "C" {
#define _BASE_PROTO_MIME_TYPE_DIST "application/pEp.distribution"
/**
* @internal
* @enum base_protocol_type
*
* @brief TODO
@ -36,6 +38,7 @@ typedef enum _base_protocol_type {
/**
* @internal
* <!-- base_decorate_message() -->
*
* @brief Given the data payload for an administrative message, add the appropriate
@ -69,6 +72,7 @@ PEP_STATUS base_decorate_message(
/**
* @internal
* <!-- base_prepare_message() -->
*
* @brief Given a protocol data payload and a message type, prepare an administrative
@ -107,6 +111,7 @@ PEP_STATUS base_prepare_message(
/**
* @internal
* <!-- base_extract_message() -->
*
* @brief Extract protocol data from a pEp administrative message
@ -144,6 +149,7 @@ PEP_STATUS base_extract_message(
/**
* @internal
* <!-- try_base_prepare_message() -->
*
* @brief Prepare an administrative message with payload.

1
src/dynamic_api.h
Unescape View File

@ -1,4 +1,5 @@
/**
* @internal
* @file dynamic_api.h
* @brief defines for windows API export
* @license GNU General Public License 3.0 - see LICENSE.txt

1
src/email.c
Unescape View File

@ -1,4 +1,5 @@
/**
* @internal
* @file email.c
* @brief File description for doxygen missing. FIXME
* @license GNU General Public License 3.0 - see LICENSE.txt

3
src/email.h
Unescape View File

@ -1,4 +1,5 @@
/**
* @internal
* @file email.h
* @brief email (FIXME: derived from filename)
* @license GNU General Public License 3.0 - see LICENSE.txt
@ -11,6 +12,7 @@
#include "transport.h"
/**
* @internal
* <!-- email_sendto() -->
*
* @brief TODO
@ -22,6 +24,7 @@
PEP_STATUS email_sendto(PEP_SESSION session, const message *msg);
/**
* @internal
* <!-- email_readnext() -->
*
* @brief TODO

1
src/engine_sql.c
Unescape View File

@ -1,4 +1,5 @@
/**
* @internal
* @file engine_sql.c
* @brief functions to prepare SQL statements
*/

2
src/engine_sql.h
Unescape View File

@ -1,5 +1,6 @@
#pragma once
/**
* @internal
* @file engine_sql.h
* @brief functions to SQL statements and strings to feed into prepared statements
*/
@ -20,6 +21,7 @@ PEP_STATUS pEp_finalize_sql_stmts(PEP_SESSION session);
#define MAYBE_UNUSED __attribute__((__unused__))
/**
* @internal
* Strings to feed into prepared statements
*/
static const char *sql_log MAYBE_UNUSED =

1
src/etpan_mime.c
Unescape View File

@ -1,4 +1,5 @@
/**
* @internal
* @file etpan_mime.c
* @brief File description for doxygen missing. FIXME
* @license GNU General Public License 3.0 - see LICENSE.txt

2
src/fsm_common.h
Unescape View File

@ -1,4 +1,5 @@
/**
* @internal
* @file src/fsm_common.h
* @brief Generate state machine code
* @license GNU General Public License 3.0 - see LICENSE.txt
@ -17,6 +18,7 @@ extern "C" {
// error values
/**
* @internal
* @enum fsm_error
*
* @brief TODO

3
src/internal_format.h
Unescape View File

@ -1,5 +1,6 @@
/**
* @file internal_format.h
* @internal
* @brief internal format (FIXME: derived from filename)
* @license GNU General Public License 3.0 - see LICENSE.txt
*/
@ -16,6 +17,7 @@ extern "C" {
#endif
/**
* @internal
* <!-- encode_internal() -->
*
* @brief Encode to the internal message format
@ -50,6 +52,7 @@ DYNAMIC_API PEP_STATUS encode_internal(
/**
* @internal
* <!-- decode_internal() -->
*
* @brief Decode from internal message format

2
src/keymanagement.h
Unescape View File

@ -1,5 +1,5 @@
/**
* @file keymanagement.h
* @file keymanagement.h
* @brief Functions to manage keys (and identities when in relation to keys)
* @license GNU General Public License 3.0 - see LICENSE.txt
*/

2
src/pEpEngine_internal.h
Unescape View File

@ -1,6 +1,6 @@
/**
* @file pEpEngine_internal.h
* @internal
* @internal
* @brief Exposed internal functions and structures.
* @license GNU General Public License 3.0 - see LICENSE.txt
*/

2
src/pEp_internal.h
Unescape View File

@ -1,5 +1,5 @@
/**
* @internal
* @internal
* @file pEp_internal.h
* @brief pEp internal structs, functions, defines, and values
* @license GNU General Public License 3.0 - see LICENSE.txt

1
src/pgp_netpgp.c
Unescape View File

@ -1,4 +1,5 @@
/**
* @internal
* @file pgp_netpgp.c
* @brief Implementation of NetPGP
* @license This file is under GNU General Public License 3.0 see LICENSE.txt

30
src/pgp_netpgp.h
Unescape View File

@ -1,5 +1,6 @@
/**
* @file src/pgp_netpgp.h
* @internal
*
* @brief NETPGP driver - implements required cryptotech
* functions for the engine using netpgp with SSL
@ -13,9 +14,10 @@
#include "pEpEngine.h"
/**
* @internal
* <!-- pgp_init() -->
*
* @brief initialise the sequoia driver for this session
* @brief initialise the netpgp driver for this session
*
* @param[in] session session handle
* @param[in] in_first true if this is the first pEp session running
@ -27,9 +29,10 @@
PEP_STATUS pgp_init(PEP_SESSION session, bool in_first);
/**
* @internal
* <!-- pgp_release() -->
*
* @brief release resources used by the sequoia driver in this session
* @brief release resources used by the netpgp driver in this session
*
* @param[in] session session handle
* @param[in] out_last true if this is the last extant pEp session
@ -39,6 +42,7 @@ PEP_STATUS pgp_init(PEP_SESSION session, bool in_first);
void pgp_release(PEP_SESSION session, bool out_last);
/**
* @internal
* <!-- pgp_decrypt_and_verify() -->
*
* @brief TODO
@ -64,6 +68,7 @@ PEP_STATUS pgp_decrypt_and_verify(
);
/**
* @internal
* <!-- pgp_encrypt_and_sign() -->
*
* @brief TODO
@ -84,6 +89,7 @@ PEP_STATUS pgp_encrypt_and_sign(
);
/**
* @internal
* <!-- pgp_sign_only() -->
*
* @brief TODO
@ -104,6 +110,7 @@ PEP_STATUS pgp_sign_only(
);
/**
* @internal
* <!-- pgp_encrypt_only() -->
*
* @brief TODO
@ -125,6 +132,7 @@ PEP_STATUS pgp_encrypt_only(
/**
* @internal
* <!-- pgp_verify_text() -->
*
* @brief TODO
@ -145,6 +153,7 @@ PEP_STATUS pgp_verify_text(
);
/**
* @internal
* <!-- pgp_delete_keypair() -->
*
* @brief TODO
@ -158,6 +167,7 @@ PEP_STATUS pgp_verify_text(
PEP_STATUS pgp_delete_keypair(PEP_SESSION session, const char *fpr);
/**
* @internal
* <!-- pgp_export_keydata() -->
*
* @brief TODO
@ -177,6 +187,7 @@ PEP_STATUS pgp_export_keydata(
);
/**
* @internal
* <!-- pgp_find_keys() -->
*
* @brief Find all keys (as fpr strings) which match this fpr or OpenPGP
@ -196,6 +207,7 @@ PEP_STATUS pgp_find_keys(
);
/**
* @internal
* <!-- pgp_list_keyinfo() -->
*
* @brief Find all keys (returning <fpr, OpenPGP uid> pairs) which match this fpr
@ -214,6 +226,7 @@ PEP_STATUS pgp_list_keyinfo(
);
/**
* @internal
* <!-- pgp_generate_keypair() -->
*
* @brief TODO
@ -227,6 +240,7 @@ PEP_STATUS pgp_generate_keypair(
);
/**
* @internal
* <!-- pgp_get_key_rating() -->
*
* @brief TODO
@ -243,6 +257,7 @@ PEP_STATUS pgp_get_key_rating(
);
/**
* @internal
* <!-- pgp_import_keydata() -->
*
* @brief TODO
@ -261,6 +276,7 @@ PEP_STATUS pgp_import_keydata(PEP_SESSION session, const char *key_data,
uint64_t* changed_key_index);
/**
* @internal
* <!-- pgp_import_private_keydata() -->
*
* @brief TODO
@ -275,6 +291,7 @@ PEP_STATUS pgp_import_private_keydata(PEP_SESSION session, const char *key_data,
size_t size, identity_list **private_idents);
/**
* @internal
* <!-- pgp_recv_key() -->
*
* @brief TODO
@ -285,6 +302,7 @@ PEP_STATUS pgp_import_private_keydata(PEP_SESSION session, const char *key_data,
*/
PEP_STATUS pgp_recv_key(PEP_SESSION session, const char *pattern);
/**
* @internal
* <!-- pgp_send_key() -->
*
* @brief TODO
@ -296,6 +314,7 @@ PEP_STATUS pgp_recv_key(PEP_SESSION session, const char *pattern);
PEP_STATUS pgp_send_key(PEP_SESSION session, const char *pattern);
/**
* @internal
* <!-- pgp_renew_key() -->
*
* @brief TODO
@ -312,6 +331,7 @@ PEP_STATUS pgp_renew_key(
);
/**
* @internal
* <!-- pgp_revoke_key() -->
*
* @brief TODO
@ -328,6 +348,7 @@ PEP_STATUS pgp_revoke_key(
);
/**
* @internal
* <!-- pgp_key_expired() -->
*
* @brief TODO
@ -346,6 +367,7 @@ PEP_STATUS pgp_key_expired(
);
/**
* @internal
* <!-- pgp_key_revoked() -->
*
* @brief TODO
@ -362,6 +384,7 @@ PEP_STATUS pgp_key_revoked(
);
/**
* @internal
* <!-- pgp_key_created() -->
*
* @brief TODO
@ -378,6 +401,7 @@ PEP_STATUS pgp_key_created(
);
/**
* @internal
* <!-- pgp_contains_priv_key() -->
*
* @brief TODO
@ -393,6 +417,7 @@ PEP_STATUS pgp_contains_priv_key(
bool *has_private);
/**
* @internal
* <!-- pgp_find_private_keys() -->
*
* @brief Find all keys (as fpr strings) which match this fpr or OpenPGP
@ -412,6 +437,7 @@ PEP_STATUS pgp_find_private_keys(
);
/**
* @internal
* <!-- pgp_config_cipher_suite() -->
*
* @brief TODO

1
src/pgp_sequoia.c
Unescape View File

@ -1,4 +1,5 @@
/**
* @internal
* @file pgp_sequoia.c
* @brief Implementation of functions used to speak to Sequoia-PGP backend
*/

27
src/pgp_sequoia.h
Unescape View File

@ -1,4 +1,5 @@
/**
* @internal
* @file src/pgp_sequoia.h
*
* @brief Sequoia PGP driver - implements required cryptotech
@ -19,6 +20,7 @@
#include "pEpEngine.h"
/**
* @internal
* <!-- pgp_init() -->
*
* @brief initialise the sequoia driver for this session
@ -33,6 +35,7 @@
PEP_STATUS pgp_init(PEP_SESSION session, bool in_first);
/**
* @internal
* <!-- pgp_release() -->
*
* @brief release resources used by the sequoia driver in this session
@ -45,6 +48,7 @@ PEP_STATUS pgp_init(PEP_SESSION session, bool in_first);
void pgp_release(PEP_SESSION session, bool out_last);
/**
* @internal
* <!-- pgp_decrypt_and_verify() -->
*
* @brief TODO
@ -70,6 +74,7 @@ PEP_STATUS pgp_decrypt_and_verify(
);
/**
* @internal
* <!-- pgp_encrypt_and_sign() -->
*
* @brief TODO
@ -90,6 +95,7 @@ PEP_STATUS pgp_encrypt_and_sign(
);
/**
* @internal
* <!-- pgp_sign_only() -->
*
* @brief TODO
@ -110,6 +116,7 @@ PEP_STATUS pgp_sign_only(
);
/**
* @internal
* <!-- pgp_encrypt_only() -->
*
* @brief TODO
@ -131,6 +138,7 @@ PEP_STATUS pgp_encrypt_only(
/**
* @internal
* <!-- pgp_verify_text() -->
*
* @brief TODO
@ -151,6 +159,7 @@ PEP_STATUS pgp_verify_text(
);
/**
* @internal
* <!-- pgp_delete_keypair() -->
*
* @brief TODO
@ -164,6 +173,7 @@ PEP_STATUS pgp_verify_text(
PEP_STATUS pgp_delete_keypair(PEP_SESSION session, const char *fpr);
/**
* @internal
* <!-- pgp_export_keydata() -->
*
* @brief TODO
@ -183,6 +193,7 @@ PEP_STATUS pgp_export_keydata(
);
/**
* @internal
* <!-- pgp_find_keys() -->
*
* @brief Find all keys (as fpr strings) which match this fpr or OpenPGP
@ -202,6 +213,7 @@ PEP_STATUS pgp_find_keys(
);
/**
* @internal
* <!-- pgp_list_keyinfo() -->
*
* @brief Find all keys (returning <fpr, OpenPGP uid> pairs) which match this fpr
@ -220,6 +232,7 @@ PEP_STATUS pgp_list_keyinfo(
);
/**
* @internal
* <!-- pgp_generate_keypair() -->
*
* @brief TODO
@ -233,6 +246,7 @@ PEP_STATUS pgp_generate_keypair(
);
/**
* @internal
* <!-- pgp_get_key_rating() -->
*
* @brief TODO
@ -249,6 +263,7 @@ PEP_STATUS pgp_get_key_rating(
);
/**
* @internal
* <!-- pgp_import_keydata() -->
*
* @brief TODO
@ -267,6 +282,7 @@ PEP_STATUS pgp_import_keydata(PEP_SESSION session, const char *key_data,
uint64_t* changed_key_index);
/**
* @internal
* <!-- pgp_import_private_keydata() -->
*
* @brief TODO
@ -281,6 +297,7 @@ PEP_STATUS pgp_import_private_keydata(PEP_SESSION session, const char *key_data,
size_t size, identity_list **private_idents);
/**
* @internal
* <!-- pgp_recv_key() -->
*
* @brief TODO
@ -291,6 +308,7 @@ PEP_STATUS pgp_import_private_keydata(PEP_SESSION session, const char *key_data,
*/
PEP_STATUS pgp_recv_key(PEP_SESSION session, const char *pattern);
/**
* @internal
* <!-- pgp_send_key() -->
*
* @brief TODO
@ -302,6 +320,7 @@ PEP_STATUS pgp_recv_key(PEP_SESSION session, const char *pattern);
PEP_STATUS pgp_send_key(PEP_SESSION session, const char *pattern);
/**
* @internal
* <!-- pgp_renew_key() -->
*
* @brief TODO
@ -318,6 +337,7 @@ PEP_STATUS pgp_renew_key(
);
/**
* @internal
* <!-- pgp_revoke_key() -->
*
* @brief TODO
@ -334,6 +354,7 @@ PEP_STATUS pgp_revoke_key(
);
/**
* @internal
* <!-- pgp_key_expired() -->
*
* @brief TODO
@ -352,6 +373,7 @@ PEP_STATUS pgp_key_expired(
);
/**
* @internal
* <!-- pgp_key_revoked() -->
*
* @brief TODO
@ -368,6 +390,7 @@ PEP_STATUS pgp_key_revoked(
);
/**
* @internal
* <!-- pgp_key_created() -->
*
* @brief TODO
@ -384,6 +407,7 @@ PEP_STATUS pgp_key_created(
);
/**
* @internal
* <!-- pgp_contains_priv_key() -->
*
* @brief TODO
@ -399,6 +423,7 @@ PEP_STATUS pgp_contains_priv_key(
bool *has_private);
/**
* @internal
* <!-- pgp_find_private_keys() -->
*
* @brief Find all keys (as fpr strings) which match this fpr or OpenPGP
@ -418,6 +443,7 @@ PEP_STATUS pgp_find_private_keys(
);
/**
* @internal
* <!-- pgp_binary() -->
*
* @brief TODO
@ -428,6 +454,7 @@ PEP_STATUS pgp_find_private_keys(
PEP_STATUS pgp_binary(const char **path);
/**
* @internal
* <!-- pgp_config_cipher_suite() -->
*
* @brief TODO

1
src/resource.h
Unescape View File

@ -1,4 +1,5 @@
/**
* @internal
* @file resource.h
* @brief Windows platform-specific implementation details
* @license GNU General Public License 3.0 - see LICENSE.txt

1
src/resource_id.c
Unescape View File

@ -1,4 +1,5 @@
/**
* @internal
* @file resource_id.c
* @brief File description for doxygen missing. FIXME
* @license This file is under GNU General Public License 3.0

10
src/resource_id.h
Unescape View File

@ -1,4 +1,5 @@
/**
* @internal
* @file resource_id.h
* @brief resource id (filenames, uids) structs and access/generation/manipulation functions
* @license GNU General Public License 3.0 - see LICENSE.txt
@ -9,6 +10,7 @@
/* structs to contain info about parsed resource ids (filenames, uids) */
/**
* @internal
* @enum pEp_resource_id_type
*
* @brief TODO
@ -22,6 +24,7 @@ typedef enum _resource_id_type {
typedef struct pEp_rid_list_t pEp_rid_list_t;
/**
* @internal
* @struct pEp_rid_list_t
*
* @brief TODO
@ -36,6 +39,7 @@ struct pEp_rid_list_t {
pEp_rid_list_t* new_rid_node(pEp_resource_id_type type, const char* resource);
/**
* @internal
* <!-- free_rid_list() -->
*
* @brief TODO
@ -46,6 +50,7 @@ pEp_rid_list_t* new_rid_node(pEp_resource_id_type type, const char* resource);
void free_rid_list(pEp_rid_list_t* list);
/**
* @internal
* <!-- parse_uri() -->
*
* @brief TODO
@ -56,6 +61,7 @@ void free_rid_list(pEp_rid_list_t* list);
pEp_rid_list_t* parse_uri(const char* uri);
/**
* @internal
* <!-- build_uri() -->
*
* @brief TODO
@ -67,6 +73,7 @@ pEp_rid_list_t* parse_uri(const char* uri);
char* build_uri(const char* uri_prefix, const char* resource);
/**
* @internal
* <!-- get_resource_ptr_noown() -->
*
* @brief TODO
@ -77,6 +84,7 @@ char* build_uri(const char* uri_prefix, const char* resource);
const char* get_resource_ptr_noown(const char* uri);
/**
* @internal
* <!-- get_resource() -->
*
* @brief TODO
@ -87,6 +95,7 @@ const char* get_resource_ptr_noown(const char* uri);
char* get_resource(char* uri);
/**
* @internal
* <!-- is_file_uri() -->
*
* @brief TODO
@ -97,6 +106,7 @@ char* get_resource(char* uri);
bool is_file_uri(char* str);
/**
* @internal
* <!-- is_cid_uri() -->
*
* @brief TODO

1
src/security_checks.c
Unescape View File

@ -1,4 +1,5 @@
/**
* @internal
* @file security_checks.c
* @brief Security checks (whatever is meant to be here is not yet implemented)
*

1
src/security_checks.h
Unescape View File

@ -1,4 +1,5 @@
/**
* @internal
* @file security_checks.h
* @brief security checks (whatever is meant here is not yet implemented)
* @license GNU General Public License 3.0 - see LICENSE.txt

1
src/trans_auto.h
Unescape View File

@ -1,5 +1,6 @@
/**
* @file src/trans_auto.h
* @internal
* @brief transport auto functions? (FIXME: derived from filename)
* @license GNU General Public License 3.0 - see LICENSE.txt
*/

1
src/wrappers.h
Unescape View File

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

Write Preview
Loading…
Cancel
Save