From ed7b39b035fa18b777b71ddc568deff2f7977c82 Mon Sep 17 00:00:00 2001 From: Christian Grothoff Date: Mon, 2 Aug 2021 11:46:53 +0200 Subject: -more documentation fixes --- src/include/anastasis_database_plugin.h | 48 ++++++++++++++++----------------- src/include/anastasis_service.h | 10 +++---- 2 files changed, 28 insertions(+), 30 deletions(-) (limited to 'src/include') diff --git a/src/include/anastasis_database_plugin.h b/src/include/anastasis_database_plugin.h index 488a5af..5f52ae1 100644 --- a/src/include/anastasis_database_plugin.h +++ b/src/include/anastasis_database_plugin.h @@ -244,11 +244,11 @@ struct ANASTASIS_DatabasePlugin * Store encrypted recovery document. * * @param cls closure - * @param anastasis_pub public key of the user's account + * @param account_pub public key of the user's account * @param account_sig signature affirming storage request - * @param data_hash hash of @a data - * @param data contains encrypted_recovery_document - * @param data_size size of data blob + * @param recovery_data_hash hash of @a data + * @param recovery_data contains encrypted recovery document + * @param recovery_data_size size of @a recovery_data blob * @param payment_secret identifier for the payment, used to later charge on uploads * @param[out] version set to the version assigned to the document by the database * @return transaction status, 0 if upload could not be finished because @a payment_secret @@ -257,11 +257,11 @@ struct ANASTASIS_DatabasePlugin enum ANASTASIS_DB_StoreStatus (*store_recovery_document)( void *cls, - const struct ANASTASIS_CRYPTO_AccountPublicKeyP *anastasis_pub, + const struct ANASTASIS_CRYPTO_AccountPublicKeyP *account_pub, const struct ANASTASIS_AccountSignatureP *account_sig, - const struct GNUNET_HashCode *data_hash, - const void *data, - size_t data_size, + const struct GNUNET_HashCode *recovery_data_hash, + const void *recovery_data, + size_t recovery_data_size, const struct ANASTASIS_PaymentSecretP *payment_secret, uint32_t *version); @@ -270,7 +270,7 @@ struct ANASTASIS_DatabasePlugin * Fetch recovery document for user according given version. * * @param cls closure - * @param anastasis_pub public key of the user's account + * @param account_pub public key of the user's account * @param version the version number of the policy the user requests * @param[out] account_sig signature * @param[out] recovery_data_hash hash of the current recovery data @@ -281,7 +281,7 @@ struct ANASTASIS_DatabasePlugin enum GNUNET_DB_QueryStatus (*get_recovery_document)( void *cls, - const struct ANASTASIS_CRYPTO_AccountPublicKeyP *anastasis_pub, + const struct ANASTASIS_CRYPTO_AccountPublicKeyP *account_pub, uint32_t version, struct ANASTASIS_AccountSignatureP *account_sig, struct GNUNET_HashCode *recovery_data_hash, @@ -293,7 +293,7 @@ struct ANASTASIS_DatabasePlugin * Fetch latest recovery document for user. * * @param cls closure - * @param anastasis_pub public key of the user's account + * @param account_pub public key of the user's account * @param account_sig signature * @param recovery_data_hash hash of the current recovery data * @param[out] data_size set to size of @a data blob @@ -304,7 +304,7 @@ struct ANASTASIS_DatabasePlugin enum GNUNET_DB_QueryStatus (*get_latest_recovery_document)( void *cls, - const struct ANASTASIS_CRYPTO_AccountPublicKeyP *anastasis_pub, + const struct ANASTASIS_CRYPTO_AccountPublicKeyP *account_pub, struct ANASTASIS_AccountSignatureP *account_sig, struct GNUNET_HashCode *recovery_data_hash, size_t *data_size, @@ -318,11 +318,10 @@ struct ANASTASIS_DatabasePlugin * @param cls closure * @param truth_uuid the identifier for the Truth * @param key_share_data contains information of an EncryptedKeyShare - * @param method name of method - * @param nonce nonce used to compute encryption key for encrypted_truth - * @param aes_gcm_tag authentication tag of encrypted_truth + * @param mime_type presumed mime type of data in @a encrypted_truth * @param encrypted_truth contains the encrypted Truth which includes the ground truth i.e. H(challenge answer), phonenumber, SMS * @param encrypted_truth_size the size of the Truth + * @param method name of method * @param truth_expiration time till the according data will be stored * @return transaction status */ @@ -379,7 +378,7 @@ struct ANASTASIS_DatabasePlugin * current @a recovery_document_hash. * * @param cls closure - * @param anastasis_pub account identifier + * @param account_pub account identifier * @param[out] paid_until until when is the account paid up? * @param[out] recovery_data_hash set to hash of @a recovery document * @param[out] version set to the recovery policy version @@ -388,7 +387,7 @@ struct ANASTASIS_DatabasePlugin enum ANASTASIS_DB_AccountStatus (*lookup_account)( void *cls, - const struct ANASTASIS_CRYPTO_AccountPublicKeyP *anastasis_pub, + const struct ANASTASIS_CRYPTO_AccountPublicKeyP *account_pub, struct GNUNET_TIME_Absolute *paid_until, struct GNUNET_HashCode *recovery_data_hash, uint32_t *version); @@ -420,7 +419,6 @@ struct ANASTASIS_DatabasePlugin * @param payment_secret payment secret which the user must provide with every upload * @param truth_uuid unique identifier of the truth the user must satisfy the challenge * @param[out] paid bool value to show if payment is paid - * @param[out] valid_counter bool value to show if post_counter is > 0 * @return transaction status */ enum GNUNET_DB_QueryStatus @@ -444,7 +442,7 @@ struct ANASTASIS_DatabasePlugin enum GNUNET_DB_QueryStatus (*increment_lifetime)( void *cls, - const struct ANASTASIS_CRYPTO_AccountPublicKeyP *anastasis_pub, + const struct ANASTASIS_CRYPTO_AccountPublicKeyP *account_pub, const struct ANASTASIS_PaymentSecretP *payment_identifier, struct GNUNET_TIME_Relative lifetime, struct GNUNET_TIME_Absolute *paid_until); @@ -463,7 +461,7 @@ struct ANASTASIS_DatabasePlugin enum GNUNET_DB_QueryStatus (*update_lifetime)( void *cls, - const struct ANASTASIS_CRYPTO_AccountPublicKeyP *anastasis_pub, + const struct ANASTASIS_CRYPTO_AccountPublicKeyP *account_pub, const struct ANASTASIS_PaymentSecretP *payment_identifier, struct GNUNET_TIME_Absolute eol); @@ -474,7 +472,7 @@ struct ANASTASIS_DatabasePlugin * when we increment the account's lifetime.) * * @param cls closure - * @param anastasis_pub anastasis's public key + * @param account_pub anastasis's public key * @param post_counter how many uploads does @a amount pay for * @param payment_secret payment secret which the user must provide with every upload * @param amount how much we asked for @@ -483,7 +481,7 @@ struct ANASTASIS_DatabasePlugin enum GNUNET_DB_QueryStatus (*record_recdoc_payment)( void *cls, - const struct ANASTASIS_CRYPTO_AccountPublicKeyP *anastasis_pub, + const struct ANASTASIS_CRYPTO_AccountPublicKeyP *account_pub, uint32_t post_counter, const struct ANASTASIS_PaymentSecretP *payment_secret, const struct TALER_Amount *amount); @@ -527,14 +525,14 @@ struct ANASTASIS_DatabasePlugin * does not match, the retry counter will be decreased by one. * * @param cls closure - * @param truth_pub identification of the challenge which the code corresponds to + * @param truth_uuid identification of the challenge which the code corresponds to * @param hashed_code code which the user provided and wants to verify * @return transaction status */ enum ANASTASIS_DB_CodeStatus (*verify_challenge_code)( void *cls, - const struct ANASTASIS_CRYPTO_TruthUUIDP *truth_pub, + const struct ANASTASIS_CRYPTO_TruthUUIDP *truth_uuid, const struct GNUNET_HashCode *hashed_code); /** @@ -600,7 +598,7 @@ struct ANASTASIS_DatabasePlugin * Record refund for challenge. * * @param cls closure - * @param truth_key identifier of the challenge to pay + * @param truth_uuid identifier of the challenge to refund * @param payment_secret payment secret which the user must provide with every upload * @return transaction status */ diff --git a/src/include/anastasis_service.h b/src/include/anastasis_service.h index 98ac490..9069035 100644 --- a/src/include/anastasis_service.h +++ b/src/include/anastasis_service.h @@ -388,11 +388,11 @@ typedef void * @param recovery_data policy data to be stored * @param recovery_data_size number of bytes in @a recovery_data * @param payment_years_requested for how many years would the client like the service to store the truth? - * @param paid_order_id payment identifier of last payment + * @param payment_secret payment identifier of last payment * @param payment_timeout how long to wait for the payment, use * #GNUNET_TIME_UNIT_ZERO to let the server pick * @param cb callback processing the response from /policy - * @param cb_cls closure for cb + * @param cb_cls closure for @a cb * @return handle for the operation */ struct ANASTASIS_PolicyStoreOperation * @@ -605,10 +605,10 @@ typedef void * * @param ctx execution context * @param backend_url base URL of the merchant backend - * @param truth_public_key identification of the Truth + * @param truth_uuid identification of the Truth * @param truth_key Key used to Decrypt the Truth on the Server * @param payment_secret secret from the previously done payment NULL to trigger payment - * @param payment_timeout how long to wait for the payment, use + * @param timeout how long to wait for the payment, use * #GNUNET_TIME_UNIT_ZERO to let the server pick * @param hashed_answer hashed answer to the challenge * @param cb callback which will work the response gotten from the backend @@ -631,7 +631,7 @@ ANASTASIS_keyshare_lookup ( /** * Cancel a GET /truth request. * - * @param tlo cancel the truth lookup operation + * @param kslo cancel the key share lookup operation */ void ANASTASIS_keyshare_lookup_cancel ( -- cgit v1.2.3