Browse Source

more comments

ENGINE-606
Sofia 10 months ago
parent
commit
cf9f8a4c61
9 changed files with 125 additions and 153 deletions
  1. +1
    -1
      src/base64.c
  2. +4
    -4
      src/message_api.c
  3. +9
    -9
      src/pEpEngine.c
  4. +1
    -1
      src/pEpEngine.h
  5. +27
    -11
      src/pEp_internal.h
  6. +5
    -5
      src/pEp_string.c
  7. +3
    -3
      src/pEp_string.h
  8. +32
    -92
      src/pgp_sequoia.c
  9. +43
    -27
      src/pgp_sequoia.h

+ 1
- 1
src/base64.c View File

@ -87,7 +87,7 @@ static size_t subtract_whitespace(const char* input, int length) {
* trailing whitespace characters
*
* @param[in] *input C string to check
* @param[in,out] *length returns the resulting lenght
* @param[out] *length returns the resulting lenght
*
*/
static void trim_end(const char* input, int* length) {


+ 4
- 4
src/message_api.c View File

@ -3298,8 +3298,8 @@ static PEP_STATUS _get_detached_signature(message* msg,
*
* @param[in] *ptext constchar
* @param[in] psize constsize_t
* @param[in,out] **stext char
* @param[in,out] *ssize size_t
* @param[out] **stext char
* @param[out] *ssize size_t
*
* @retval PEP_STATUS_OK
* @retval PEP_UNKNOWN_ERROR
@ -3389,8 +3389,8 @@ static PEP_STATUS _get_signed_text(const char* ptext, const size_t psize,
*
* @param[in] session session handle
* @param[in] **verify_in stringlist_t
* @param[in,out] **keylist_in_out stringlist_t
* @param[in,out] *from pEp_identity
* @param[out] **keylist_in_out stringlist_t
* @param[in] *from pEp_identity
*
* @retval PEP_STATUS_OK
* @retval PEP_KEY_NOT_FOUND


+ 9
- 9
src/pEpEngine.c View File

@ -1,8 +1,7 @@
/** @file */
/** @brief File description for doxygen missing. FIXME */
// This file is under GNU General Public License 3.0
// see LICENSE.txt
/** @file pEpEngine.c
* @brief implementation of the pEp Engine API
* @license GNU General Public License 3.0 - see LICENSE.txt
*/
#include "pEp_internal.h"
#include "dynamic_api.h"
@ -982,11 +981,11 @@ PEP_STATUS get_identities_by_address(
*
* <!-- exists_identity_entry() -->
*
* @brief TODO
* @brief checks if an identity entry already exists in the DB
*
* @param[in] session session handle
* @param[in] *identity pEp_identity
* @param[in] *exists bool
* @param[out] *exists bool
*
* @retval PEP_STATUS_OK
* @retval PEP_ILLEGAL_VALUE illegal parameter value
@ -1979,7 +1978,8 @@ PEP_STATUS get_trust_by_userid(PEP_SESSION session, const char* user_id,
*
* @param[in] t_old PEP_comm_type
* @param[in] t_new PEP_comm_type
*
*
* @retval PEP_comm_type result
*/
PEP_comm_type reconcile_trust(PEP_comm_type t_old, PEP_comm_type t_new) {
switch (t_new) {
@ -3013,7 +3013,7 @@ static void _clean_log_value(char *text)
* @param[in] *str1 char
* @param[in] *str2 const char
* @param[in] delim char
*
*
*/
static char *_concat_string(char *str1, const char *str2, char delim)
{


+ 1
- 1
src/pEpEngine.h View File

@ -436,7 +436,7 @@ DYNAMIC_API PEP_STATUS config_cipher_suite(PEP_SESSION session,
* @retval PEP_DECRYPT_WRONG_FORMAT message has wrong format to handle
* @retval PEP_DECRYPT_NO_KEY key not available to decrypt and/or verify
* @retval PEP_DECRYPT_SIGNATURE_DOES_NOT_MATCH wrong signature
* @retval PEP_ILLEGAL_VALUE illegal parameter values
* @retval PEP_ILLEGAL_VALUE illegal parameter values
*
* @warning the ownerships of ptext as well as keylist are going to the caller
* the caller must use free() (or an Windoze pEp_free()) and


+ 27
- 11
src/pEp_internal.h View File

@ -328,9 +328,10 @@ struct _pEpSession {
*
* @brief TODO
*
* @param[in] session PEP_SESSION
* @param[in] session session handle
* @param[in] in_first bool
*
* @retval PEP_STATUS_OK
*/
PEP_STATUS init_transport_system(PEP_SESSION session, bool in_first);
@ -339,7 +340,7 @@ PEP_STATUS init_transport_system(PEP_SESSION session, bool in_first);
*
* @brief TODO
*
* @param[in] session PEP_SESSION
* @param[in] session session handle
* @param[in] out_last bool
*
*/
@ -352,7 +353,7 @@ void release_transport_system(PEP_SESSION session, bool out_last);
*
* @brief TODO
*
* @param[in] session PEP_SESSION
* @param[in] session session handle
* @param[in] keylist const stringlist_t*
* @param[in] ptext const char*
* @param[in] psize size_t
@ -421,6 +422,9 @@ typedef enum _normalize_hex_rest_t {
*
* @param[in] hex char*
*
* @retval accept_hex
* @retval irgnore_hex
* @retval reject_hex
*/
static inline normalize_hex_res_t _normalize_hex(char *hex)
{
@ -453,6 +457,9 @@ static inline normalize_hex_res_t _normalize_hex(char *hex)
* @param[in] fprbs size_t
* @param[in] comparison int*
*
* @retval PEP_STATUS_OK
* @retval PEP_ILLEGAL_VALUE illegal parameter values
* @retval PEP_TRUSTWORDS_FPR_WRONG_LENGTH
*/
static inline PEP_STATUS _compare_fprs(
const char* fpra,
@ -541,6 +548,8 @@ static inline PEP_STATUS _compare_fprs(
* @param[in] fprb const char*
* @param[in] fprbs size_t
*
* @retval 0 on equal fingerprints
* @retval non-zero if not equal
*/
static inline int _same_fpr(
const char* fpra,
@ -609,9 +618,11 @@ static inline char* _pEp_subj_copy() {
*
* @brief TODO
*
* @param[in] session PEP_SESSION
* @param[in] session session handle
* @param[in] test_ident const pEp_identity*
*
* @retval true
* @retval false
*/
static inline bool is_me(PEP_SESSION session, const pEp_identity* test_ident) {
bool retval = false;
@ -630,10 +641,12 @@ static inline bool is_me(PEP_SESSION session, const pEp_identity* test_ident) {
/**
* <!-- pEp_version_numeric() -->
*
* @brief TODO
* @brief
*
* @param[in] version_str const char*
*
* @retval float version number
* @retval 0 on failure
*/
static inline float pEp_version_numeric(const char* version_str) {
float retval = 0;
@ -647,7 +660,7 @@ static inline float pEp_version_numeric(const char* version_str) {
/**
* <!-- pEp_version_major_minor() -->
*
* @brief TODO
* @brief get major and minor numbers as integers from version string
*
* @param[in] version_str const char*
* @param[out] major unsigned int*
@ -669,13 +682,16 @@ static inline void pEp_version_major_minor(const char* version_str, unsigned int
/**
* <!-- compare_versions() -->
*
* @brief TODO
* @brief compares two versions by major and minor version numbers
*
* @param[in] first_maj unsigned int
* @param[in] first_min unsigned int
* @param[in] second_maj unsigned int
* @param[in] second_min unsigned int
*
* @retval 1 when first is higher version
* @retval -1 when first is lower version
* @retval 0 when versions are equal
*/
static inline int compare_versions(unsigned int first_maj, unsigned int first_min,
unsigned int second_maj, unsigned int second_min) {
@ -693,14 +709,14 @@ static inline int compare_versions(unsigned int first_maj, unsigned int first_mi
/**
* <!-- set_min_version() -->
*
* @brief TODO
* @brief determine the smaler version from two versions
*
* @param[in] first_maj unsigned int
* @param[in] first_minor unsigned int
* @param[in] second_maj unsigned int
* @param[in] second_minor unsigned int
* @param[in] result_maj unsigned int*
* @param[in] result_minor unsigned int*
* @param[out] result_maj unsigned int*
* @param[out] result_minor unsigned int*
*
*/
static inline void set_min_version(unsigned int first_maj, unsigned int first_minor,
@ -720,7 +736,7 @@ static inline void set_min_version(unsigned int first_maj, unsigned int first_mi
/**
* <!-- set_max_version() -->
*
* @brief TODO
* @brief determine the greater version out of two versions
*
* @param[in] first_maj unsigned int
* @param[in] first_minor unsigned int


+ 5
- 5
src/pEp_string.c View File

@ -1,8 +1,8 @@
/** @file */
/** @brief File description for doxygen missing. FIXME */
// This file is under GNU General Public License 3.0
// see LICENSE.txt
/**
* @file pEp_string.c
* @brief implementation of external interface for allocation and deletion of NUL-terminated char strings within the engine
* @license GNU General Public License 3.0 - see LICENSE.txt
*/
#include "platform.h"
#include "pEp_string.h"


+ 3
- 3
src/pEp_string.h View File

@ -24,9 +24,9 @@ extern "C" {
* @param[in] len length of newly created string or 0 for default
*
* @retval pointer to string object or NULL if out of memory
* @retval calling with str and len is equivalent to strndup()
* @retval calling with str but len=0 is equivalent to strdup()
* @retval calling with str=NULL is equivalent to calloc()
* calling with str and len is equivalent to strndup()
* calling with str but len=0 is equivalent to strdup()
* calling with str=NULL is equivalent to calloc()
*
*
*/


+ 32
- 92
src/pgp_sequoia.c View File

@ -316,7 +316,7 @@ int email_cmp(void *cookie, int a_len, const void *a, int b_len, const void *b)
*
* @brief TODO
*
* @param[in] session PEP_SESSION
* @param[in] session session handle
* @param[in] iter pgp_cert_valid_key_iter_t
* @param[in] *decrypted_key pgp_key_t
*
@ -755,7 +755,7 @@ static char *pgp_fingerprint_canonicalize(const char *fpr)
*
* @brief TODO
*
* @param[in] PEP_SESSION PEP_SESSION
* @param[in] PEP_SESSION session handle
* @param[in] * sqlite3_stmt
* @param[in] * pgp_cert_t
* @param[in] * int
@ -808,7 +808,7 @@ static PEP_STATUS key_load(PEP_SESSION session, sqlite3_stmt *stmt,
*
* @brief TODO
*
* @param[in] PEP_SESSION PEP_SESSION
* @param[in] PEP_SESSION session handle
* @param[in] * sqlite3_stmt
* @param[in] ** pgp_cert_t
* @param[in] * int
@ -866,7 +866,7 @@ static PEP_STATUS key_loadn(PEP_SESSION session, sqlite3_stmt *stmt,
*
* @brief Returns the certificate identified by the provided fingerprint.
*
* @param[in] session PEP_SESSION
* @param[in] session session handle
* @param[in] fpr pgp_fingerprint_t fingerprint
* @param[in] private_only Only return the private key cert?
* (Or only return the cert IF there is one?)
@ -909,7 +909,7 @@ static PEP_STATUS cert_find(PEP_SESSION session,
*
* @brief Returns the certificate identified by the provided keyid.
*
* @param[in] session PEP_SESSION
* @param[in] session session handle
* @param[in] keyid_hex the hex key id of the key to retrieve
* (can be primary or subkey)
* @param[in] private_only if true, only consider certificates with
@ -956,7 +956,7 @@ static PEP_STATUS cert_find_by_keyid_hex(
*
* @brief Returns the certificate identified by the provided keyid.
*
* @param[in] session PEP_SESSION
* @param[in] session session handle
* @param[in] keyid pgp_keyid_t form of the desired key id
* @param[in] private_only if true, only consider certificates with
* some secret key material
@ -987,7 +987,7 @@ PEP_STATUS cert_find_by_keyid(PEP_SESSION session,
*
* @brief Returns the certificate identified by the provided keyid.
*
* @param[in] session PEP_SESSION
* @param[in] session session handle
* @param[in] fpr the pgp_fingerprint_t fingerprint
* of the key to retrieve
* (can be primary or subkey)
@ -1021,7 +1021,7 @@ static PEP_STATUS cert_find_by_fpr(
*
* @brief Returns the certificate identified by the provided keyid.
*
* @param[in] session PEP_SESSION
* @param[in] session session handle
* @param[in] pgp_fpr the fingerprint hex (???)
* of the key to retrieve
* (can be primary or subkey)
@ -1056,7 +1056,7 @@ static PEP_STATUS cert_find_by_fpr_hex(
*
* @brief Returns all known certificates.
*
* @param[in] session PEP_SESSION
* @param[in] session session handle
* @param[in] private_only if true, only return keys which
* contain secret keys (???)
* @param[out] certsp Returns the array of found certs
@ -1085,7 +1085,7 @@ static PEP_STATUS cert_all(PEP_SESSION session, int private_only,
*
* @brief Returns keys that have a user id that matches the specified pattern.
*
* @param[in] session PEP_SESSION
* @param[in] session session handle
* @param[in] pattern pattern to search for in uids
* @param[in] private_only if true, only return keys which
* contain secret keys (???)
@ -1129,7 +1129,7 @@ static PEP_STATUS cert_find_by_email(PEP_SESSION session,
*
* @brief Serialise this certificate (likely for writing to file)
*
* @param[in] session PEP_SESSION
* @param[in] session session handle
* @param[in] cert certificate to be serialised
* @param[out] buffer_ptr Serialised certificate data
* @param[out] buffer_size_ptr Size of serialised certificate data
@ -2359,10 +2359,10 @@ PEP_STATUS pgp_sign_only(
* <!-- pgp_encrypt_sign_optional() -->
*
* @brief internal function used by pgp_encrypt_only() and
* pgp_encrypt_and_sign() to to encryption, and, where
* pgp_encrypt_and_sign() to do encryption, and, where
* indication, signing of the input text
*
* @param[in] session PEP_SESSION
* @param[in] session session handle
* @param[in] keylist const stringlist_t*
* @param[in] ptext const char*
* @param[in] psize size_t
@ -2703,9 +2703,9 @@ static char* _flatten_to_alphanum(const char* input) {
*
* @brief Internal logic for pgp_generate_keypair
*
* @param[in] session PEP_SESSION
* @param[in] *identity pEp_identity
* @param[in] when time_t
* @param[in] session session handle
* @param[in] *identity pEp_identity
* @param[in] when time_t
*
*/
PEP_STATUS _pgp_generate_keypair(PEP_SESSION session, pEp_identity *identity, time_t when)
@ -2896,9 +2896,9 @@ static unsigned int count_keydata_parts(const char* key_data, size_t size) {
*
* @brief TODO
*
* @param[in] session PEP_SESSION
* @param[in] session session handle
* @param[in] *key_data const char
* @param[in] size size_t
* @param[in] size size_t
* @param[in] **private_idents identity_list
* @param[in] **imported_keys stringlist_t
* @param[in] *changed_bitvec uint64_t
@ -3299,7 +3299,7 @@ static char *_undot_address(const char* address) {
*
* @brief TODO
*
* @param[in] session PEP_SESSION
* @param[in] session session handle
* @param[in,out] keyinfo_list if present, a list of <fpr, openpgp userid> tuples
* to which such information from the input cert and, if present, the
* input fpr should be added
@ -3320,7 +3320,7 @@ static char *_undot_address(const char* address) {
*
* @brief TODO
*
* @param[in] session PEP_SESSION
* @param[in] session session handle
* @param[in] *keyinfo_list stringpair_list_t
* @param[in] *keylist stringlist_t
* @param[in] cert pgp_cert_t
@ -3379,7 +3379,7 @@ static stringpair_list_t *add_key(PEP_SESSION session,
* which whose fingerprints match a fingerprint
* contained in the pattern
*
* @param[in] session PEP_SESSION
* @param[in] session session handle
* @param[in] pattern pattern to search for
* @param[in] private_only only return matches for keys which contain
* a private key
@ -3389,21 +3389,10 @@ static stringpair_list_t *add_key(PEP_SESSION session,
* @param[in,out] keylist if present, a list of fprs to which
* information from matching keys should be added
*
* @todo what if both output params are NULL? What does it mean?
*
*/
/**
* @internal
*
* <!-- list_keys() -->
* @retval PEP_STATUS_OK
* @retval any other value on error
*
* @brief TODO
*
* @param[in] session PEP_SESSION
* @param[in] *pattern const char
* @param[in] private_only int
* @param[in] **keyinfo_list stringpair_list_t
* @param[in] **keylist stringlist_t
* @todo what if both output params are NULL? What does it mean?
*
*/
static PEP_STATUS list_keys(PEP_SESSION session,
@ -3792,7 +3781,7 @@ PEP_STATUS pgp_revoke_key(
*
* @brief Returns true if the input cert contains an encryption subkey
*
* @param[in] session PEP_SESSION
* @param[in] session session hadle
* @param[in] cert cert to check
* @param[out] has_subkey true if there's an encryption subkey, else false
*
@ -3803,18 +3792,6 @@ PEP_STATUS pgp_revoke_key(
* I am probably just confused, but check with neal. What does valid mean
* in this respect?
*/
/**
* @internal
*
* <!-- _pgp_contains_encryption_subkey() -->
*
* @brief TODO
*
* @param[in] session PEP_SESSION
* @param[in] cert pgp_cert_t
* @param[in] *has_subkey bool
*
*/
static void _pgp_contains_encryption_subkey(PEP_SESSION session, pgp_cert_t cert, bool* has_subkey) {
pgp_cert_valid_key_iter_t key_iter
= pgp_cert_valid_key_iter(cert, session->policy, 0);
@ -3837,7 +3814,7 @@ static void _pgp_contains_encryption_subkey(PEP_SESSION session, pgp_cert_t cert
*
* @brief Returns true if the input cert contains an encryption subkey
*
* @param[in] session PEP_SESSION
* @param[in] session session handle
* @param[in] cert cert to check
* @param[out] has_subkey true if there's a signing subkey, else false
*
@ -3848,18 +3825,6 @@ static void _pgp_contains_encryption_subkey(PEP_SESSION session, pgp_cert_t cert
* I am probably just confused, but check with neal. What does valid mean
* in this respect?
*/
/**
* @internal
*
* <!-- _pgp_contains_sig_subkey() -->
*
* @brief TODO
*
* @param[in] session PEP_SESSION
* @param[in] cert pgp_cert_t
* @param[in] *has_subkey bool
*
*/
static void _pgp_contains_sig_subkey(PEP_SESSION session, pgp_cert_t cert, bool* has_subkey) {
pgp_cert_valid_key_iter_t key_iter
= pgp_cert_valid_key_iter(cert, session->policy, 0);
@ -3881,7 +3846,7 @@ static void _pgp_contains_sig_subkey(PEP_SESSION session, pgp_cert_t cert, bool*
* @brief Check to see that key, at a minimum, even contains encryption and signing subkeys;
* if not, return false
*
* @param[in] session PEP_SESSION
* @param[in] session session handle
* @param[in] cert cert to check
* @param[out] is_broken false if both encryption and signing subkeys exist for this key,
* else true
@ -3892,18 +3857,6 @@ static void _pgp_contains_sig_subkey(PEP_SESSION session, pgp_cert_t cert, bool*
* I am probably just confused, but check with neal. What does valid mean
* in this respect?
*/
/**
* @internal
*
* <!-- _pgp_key_broken() -->
*
* @brief TODO
*
* @param[in] session PEP_SESSION
* @param[in] cert pgp_cert_t
* @param[in] *is_broken bool
*
*/
static void _pgp_key_broken(PEP_SESSION session, pgp_cert_t cert, bool* is_broken) {
*is_broken = false;
bool unbroken = false;
@ -3924,25 +3877,12 @@ static void _pgp_key_broken(PEP_SESSION session, pgp_cert_t cert, bool* is_broke
*
* @brief TODO
*
* @param[in] session PEP_SESSION
* @param[in] session session handle
* @param[in] cert pgp_cert_t
* @param[in] when consttime_t
* @param[out] expired contains true if key expired, else false
*
*/
/**
* @internal
*
* <!-- _pgp_key_expired() -->
*
* @brief TODO
*
* @param[in] session PEP_SESSION
* @param[in] cert pgp_cert_t
* @param[in] when const time_t
* @param[in] *expired bool
*
*/
static void _pgp_key_expired(PEP_SESSION session, pgp_cert_t cert, const time_t when, bool* expired)
{
// Is the certificate live?
@ -4052,8 +3992,8 @@ PEP_STATUS pgp_key_expired(PEP_SESSION session, const char *fpr,
*
* @brief TODO
*
* @param[in] session PEP_SESSION
* @param[in] cert pgp_cert_t
* @param[in] session session handle
* @param[in] cert pgp_cert_t
* @param[in] *revoked bool
*
*/
@ -4064,8 +4004,8 @@ PEP_STATUS pgp_key_expired(PEP_SESSION session, const char *fpr,
*
* @brief TODO
*
* @param[in] session PEP_SESSION
* @param[in] cert pgp_cert_t
* @param[in] session session handle
* @param[in] cert pgp_cert_t
* @param[in] *revoked bool
*
*/


+ 43
- 27
src/pgp_sequoia.h View File

@ -23,10 +23,12 @@
*
* @brief initialise the sequoia driver for this session
*
* @param[in] session PEP_SESSION
* @param[in] session session handle
* @param[in] in_first true if this is the first pEp session running
* after startup, else false
*
* @retval PEP_STATUS_OK
* @retval any other value on error
*/
PEP_STATUS pgp_init(PEP_SESSION session, bool in_first);
@ -35,7 +37,7 @@ PEP_STATUS pgp_init(PEP_SESSION session, bool in_first);
*
* @brief release resources used by the sequoia driver in this session
*
* @param[in] session PEP_SESSION
* @param[in] session session handle
* @param[in] out_last true if this is the last extant pEp session
* running, else false
*
@ -47,7 +49,7 @@ void pgp_release(PEP_SESSION session, bool out_last);
*
* @brief TODO
*
* @param[in] session PEP_SESSION
* @param[in] session session handle
* @param[in] ctext const char*
* @param[in] csize size_t
* @param[in] dsigtext const char*
@ -57,6 +59,8 @@ void pgp_release(PEP_SESSION session, bool out_last);
* @param[in] keylist stringlist_t**
* @param[in] filename_ptr char**
*
* @retval PEP_STATUS_OK
* @retval any other value on error
*/
PEP_STATUS pgp_decrypt_and_verify(
PEP_SESSION session, const char *ctext, size_t csize,
@ -70,13 +74,15 @@ PEP_STATUS pgp_decrypt_and_verify(
*
* @brief TODO
*
* @param[in] session PEP_SESSION
* @param[in] session session handle
* @param[in] keylist const stringlist_t*
* @param[in] ptext const char*
* @param[in] psize size_t
* @param[out] ctext char**
* @param[out] csize size_t*
*
* @retval PEP_STATUS_OK
* @retval any other value on error
*/
PEP_STATUS pgp_encrypt_and_sign(
PEP_SESSION session, const stringlist_t *keylist, const char *ptext,
@ -88,13 +94,15 @@ PEP_STATUS pgp_encrypt_and_sign(
*
* @brief TODO
*
* @param[in] session PEP_SESSION
* @param[in] session session handle
* @param[in] fpr const char*
* @param[in] ptext const char*
* @param[in] psize size_t
* @param[out] stext char**
* @param[out] ssize size_t*
*
* @retval PEP_STATUS_OK
* @retval any other value on error
*/
PEP_STATUS pgp_sign_only(
PEP_SESSION session, const char* fpr, const char *ptext,
@ -106,13 +114,15 @@ PEP_STATUS pgp_sign_only(
*
* @brief TODO
*
* @param[in] session PEP_SESSION
* @param[in] session session handle
* @param[in] keylist const stringlist_t*
* @param[in] ptext const char*
* @param[in] psize size_t
* @param[out] ctext char**
* @param[out] csize size_t*
*
* @retval PEP_STATUS_OK
* @retval any other value on error
*/
PEP_STATUS pgp_encrypt_only(
PEP_SESSION session, const stringlist_t *keylist, const char *ptext,
@ -125,13 +135,15 @@ PEP_STATUS pgp_encrypt_only(
*
* @brief TODO
*
* @param[in] session PEP_SESSION
* @param[in] session session handle
* @param[in] text const char*
* @param[in] size size_t
* @param[in] signature const char*
* @param[in] sig_size size_t
* @param[in] keylist stringlist_t**
*
* @retval PEP_STATUS_OK
* @retval any other value on error
*/
PEP_STATUS pgp_verify_text(
PEP_SESSION session, const char *text, size_t size,
@ -143,9 +155,11 @@ PEP_STATUS pgp_verify_text(
*
* @brief TODO
*
* @param[in] session PEP_SESSION
* @param[in] session session handle
* @param[in] fpr const char*
*
* @retval PEP_STATUS_OK
* @retval any other value on error
*/
PEP_STATUS pgp_delete_keypair(PEP_SESSION session, const char *fpr);
@ -154,12 +168,14 @@ PEP_STATUS pgp_delete_keypair(PEP_SESSION session, const char *fpr);
*
* @brief TODO
*
* @param[in] session PEP_SESSION
* @param[in] session session handle
* @param[in] fpr const char*
* @param[in] key_data char**
* @param[in] size size_t*
* @param[in] secret bool
*
* @retval PEP_STATUS_OK
* @retval any other value on error
*/
PEP_STATUS pgp_export_keydata(
PEP_SESSION session, const char *fpr, char **key_data, size_t *size,
@ -172,7 +188,7 @@ PEP_STATUS pgp_export_keydata(
* @brief Find all keys (as fpr strings) which match this fpr or OpenPGP
* userid pattern
*
* @param[in] session PEP_SESSION
* @param[in] session session handle
* @param[in] pattern Pattern to search for; could be empty,
* an fpr, or a mailbox (email, URI, etc).
* @param[in,out] keylist A list of fprs containing matching keys.
@ -191,7 +207,7 @@ PEP_STATUS pgp_find_keys(
* @brief Find all keys (returning <fpr, OpenPGP uid> pairs) which match this fpr
* or OpenPGP userid pattern
*
* @param[in] session PEP_SESSION
* @param[in] session session handle
* @param[in] pattern Pattern to search for; could be empty,
* an fpr, or a mailbox (email, URI, etc).
* @param[in,out] keyinfo_list A list of <fpr, OpenPGP userid> tuples for the
@ -208,7 +224,7 @@ PEP_STATUS pgp_list_keyinfo(
*
* @brief TODO
*
* @param[in] session PEP_SESSION
* @param[in] session session handle
* @param[in] identity pEp_identity*
*
*/
@ -221,7 +237,7 @@ PEP_STATUS pgp_generate_keypair(
*
* @brief TODO
*
* @param[in] session PEP_SESSION
* @param[in] session session handle
* @param[in] fpr const char*
* @param[in] comm_type PEP_comm_type*
*
@ -237,7 +253,7 @@ PEP_STATUS pgp_get_key_rating(
*
* @brief TODO
*
* @param[in] session PEP_SESSION
* @param[in] session session handle
* @param[in] key_data const char *
* @param[in] size size_t
* @param[in] private_idents identity_list **
@ -255,7 +271,7 @@ PEP_STATUS pgp_import_keydata(PEP_SESSION session, const char *key_data,
*
* @brief TODO
*
* @param[in] session PEP_SESSION
* @param[in] session session handle
* @param[in] key_data const char*
* @param[in] size size_t
* @param[in] private_idents identity_list**
@ -269,7 +285,7 @@ PEP_STATUS pgp_import_private_keydata(PEP_SESSION session, const char *key_data,
*
* @brief TODO
*
* @param[in] session PEP_SESSION
* @param[in] session session handle
* @param[in] pattern const char*
*
*/
@ -279,7 +295,7 @@ PEP_STATUS pgp_recv_key(PEP_SESSION session, const char *pattern);
*
* @brief TODO
*
* @param[in] session PEP_SESSION
* @param[in] session session handle
* @param[in] pattern const char*
*
*/
@ -290,7 +306,7 @@ PEP_STATUS pgp_send_key(PEP_SESSION session, const char *pattern);
*
* @brief TODO
*
* @param[in] session PEP_SESSION
* @param[in] session session handle
* @param[in] fpr const char*
* @param[in] ts const timestamp*
*
@ -306,7 +322,7 @@ PEP_STATUS pgp_renew_key(
*
* @brief TODO
*
* @param[in] session PEP_SESSION
* @param[in] session session handle
* @param[in] fpr const char*
* @param[in] reason const char*
*
@ -322,7 +338,7 @@ PEP_STATUS pgp_revoke_key(
*
* @brief TODO
*
* @param[in] session PEP_SESSION
* @param[in] session session handle
* @param[in] fpr const char*
* @param[in] when const time_t
* @param[in] expired bool*
@ -340,7 +356,7 @@ PEP_STATUS pgp_key_expired(
*
* @brief TODO
*
* @param[in] session PEP_SESSION
* @param[in] session session handle
* @param[in] fpr const char*
* @param[out] revoked bool*
*
@ -356,7 +372,7 @@ PEP_STATUS pgp_key_revoked(
*
* @brief TODO
*
* @param[in] session PEP_SESSION
* @param[in] session session handle
* @param[in] fpr const char*
* @param[out] created time_t*
*
@ -372,9 +388,9 @@ PEP_STATUS pgp_key_created(
*
* @brief TODO
*
* @param[in] session PEP_SESSION
* @param[in] fpr const char*
* @param[in] has_private bool*
* @param[in] session session handle
* @param[in] fpr const char*
* @param[in] has_private bool*
*
*/
PEP_STATUS pgp_contains_priv_key(
@ -388,7 +404,7 @@ PEP_STATUS pgp_contains_priv_key(
* @brief Find all keys (as fpr strings) which match this fpr or OpenPGP
* userid pattern AND contain a private key
*
* @param[in] session PEP_SESSION
* @param[in] session session handle
* @param[in] pattern Pattern to search for; could be empty,
* an fpr, or a mailbox (email, URI, etc).
* @param[in,out] keylist A list of fprs containing matching keys.
@ -416,7 +432,7 @@ PEP_STATUS pgp_binary(const char **path);
*
* @brief TODO
*
* @param[in] session PEP_SESSION
* @param[in] session session handle
* @param[in] suite PEP_CIPHER_SUITE
*
*/


Loading…
Cancel
Save