summaryrefslogtreecommitdiff
path: root/src/include/anastasis_database_plugin.h
diff options
context:
space:
mode:
authorChristian Grothoff <christian@grothoff.org>2021-08-02 11:46:53 +0200
committerChristian Grothoff <christian@grothoff.org>2021-08-02 11:47:25 +0200
commited7b39b035fa18b777b71ddc568deff2f7977c82 (patch)
treea0b6e7b61deb1ee359d73dc5087452cdd166319b /src/include/anastasis_database_plugin.h
parent3e8be4c4f824a09df14734ac4ccb9bcc5b2535d2 (diff)
downloadanastasis-ed7b39b035fa18b777b71ddc568deff2f7977c82.tar.gz
anastasis-ed7b39b035fa18b777b71ddc568deff2f7977c82.tar.bz2
anastasis-ed7b39b035fa18b777b71ddc568deff2f7977c82.zip
-more documentation fixes
Diffstat (limited to 'src/include/anastasis_database_plugin.h')
-rw-r--r--src/include/anastasis_database_plugin.h48
1 files changed, 23 insertions, 25 deletions
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
*/