From f3ed6ea694e83e45d257fb64b5ae23e73bc81465 Mon Sep 17 00:00:00 2001 From: Christian Grothoff Date: Mon, 2 Aug 2021 15:58:53 +0200 Subject: misc doxygen fixes --- .../anastasis_authorization_plugin_email.c | 3 +- .../anastasis_authorization_plugin_file.c | 1 + .../anastasis_authorization_plugin_post.c | 3 +- .../anastasis_authorization_plugin_sms.c | 1 + src/backend/anastasis-httpd.c | 27 +- src/backend/anastasis-httpd_mhd.c | 18 +- src/backend/anastasis-httpd_mhd.h | 4 - src/backend/anastasis-httpd_policy.c | 2 +- src/backend/anastasis-httpd_policy.h | 2 +- src/backend/anastasis-httpd_policy_upload.c | 4 +- src/backend/anastasis-httpd_truth.c | 11 +- src/backend/anastasis-httpd_truth.h | 6 +- src/backend/anastasis-httpd_truth_upload.c | 2 +- src/cli/anastasis-cli-redux.c | 5 +- src/include/anastasis.h | 6 +- src/include/anastasis_authorization_lib.h | 6 +- src/include/anastasis_json.h | 410 --------------------- src/include/anastasis_redux.h | 12 +- src/include/anastasis_service.h | 1 - src/include/anastasis_testing_lib.h | 40 +- src/include/platform.h | 2 +- src/lib/anastasis_backup.c | 3 +- src/lib/anastasis_recovery.c | 9 +- src/reducer/anastasis_api_backup_redux.c | 19 +- src/reducer/anastasis_api_recovery_redux.c | 20 +- src/reducer/anastasis_api_redux.c | 2 +- src/reducer/anastasis_api_redux.h | 44 +-- src/reducer/validation_CH_AHV.c | 2 +- src/reducer/validation_DE_SVN.c | 2 +- src/reducer/validation_IN_AADHAR.c | 2 +- src/testing/testing_api_cmd_config.c | 7 +- src/testing/testing_api_cmd_keyshare_lookup.c | 2 +- src/testing/testing_api_cmd_policy_lookup.c | 22 +- src/testing/testing_api_cmd_policy_store.c | 3 +- src/testing/testing_api_cmd_truth_store.c | 5 +- src/testing/testing_api_helpers.c | 2 +- src/testing/testing_api_trait_account_priv.c | 24 +- src/testing/testing_api_trait_account_pub.c | 24 +- src/testing/testing_api_trait_code.c | 28 +- src/testing/testing_api_trait_eks.c | 8 +- src/testing/testing_api_trait_hash.c | 2 +- 41 files changed, 136 insertions(+), 660 deletions(-) delete mode 100644 src/include/anastasis_json.h (limited to 'src') diff --git a/src/authorization/anastasis_authorization_plugin_email.c b/src/authorization/anastasis_authorization_plugin_email.c index 3e13625..bcee662 100644 --- a/src/authorization/anastasis_authorization_plugin_email.c +++ b/src/authorization/anastasis_authorization_plugin_email.c @@ -177,7 +177,7 @@ get_message (const json_t *messages, * * @param cls closure * @param connection HTTP client request (for queuing response) - * @param truth_mime mime type of @e data + * @param mime_type mime type of @e data * @param data input to validate (i.e. is it a valid phone number, etc.) * @param data_length number of bytes in @a data * @return #GNUNET_OK if @a data is valid, @@ -229,6 +229,7 @@ email_validate (void *cls, * @param code secret code that the user has to provide back to satisfy the challenge in * the main anastasis protocol * @param data input to validate (i.e. is it a valid phone number, etc.) + * @param data_length number of bytes in @a data * @return state to track progress on the authorization operation, NULL on failure */ static struct ANASTASIS_AUTHORIZATION_State * diff --git a/src/authorization/anastasis_authorization_plugin_file.c b/src/authorization/anastasis_authorization_plugin_file.c index 9b18d38..9f7eba6 100644 --- a/src/authorization/anastasis_authorization_plugin_file.c +++ b/src/authorization/anastasis_authorization_plugin_file.c @@ -110,6 +110,7 @@ file_validate (void *cls, * @param code secret code that the user has to provide back to satisfy the challenge in * the main anastasis protocol * @param data input to validate (i.e. is it a valid phone number, etc.) + * @param data_length number of bytes in @a data * @return state to track progress on the authorization operation, NULL on failure */ static struct ANASTASIS_AUTHORIZATION_State * diff --git a/src/authorization/anastasis_authorization_plugin_post.c b/src/authorization/anastasis_authorization_plugin_post.c index 8fa5979..3664776 100644 --- a/src/authorization/anastasis_authorization_plugin_post.c +++ b/src/authorization/anastasis_authorization_plugin_post.c @@ -172,7 +172,7 @@ get_message (const json_t *messages, * * @param cls closure * @param connection HTTP client request (for queuing response) - * @param truth_mime mime type of @e data + * @param mime_type mime type of @e data * @param data input to validate (i.e. is it a valid phone number, etc.) * @param data_length number of bytes in @a data * @return #GNUNET_OK if @a data is valid, @@ -256,6 +256,7 @@ post_validate (void *cls, * @param code secret code that the user has to provide back to satisfy the challenge in * the main anastasis protocol * @param data input to validate (i.e. is it a valid phone number, etc.) + * @param data_length number of bytes in @a data * @return state to track progress on the authorization operation, NULL on failure */ static struct ANASTASIS_AUTHORIZATION_State * diff --git a/src/authorization/anastasis_authorization_plugin_sms.c b/src/authorization/anastasis_authorization_plugin_sms.c index 6421884..0d69e77 100644 --- a/src/authorization/anastasis_authorization_plugin_sms.c +++ b/src/authorization/anastasis_authorization_plugin_sms.c @@ -228,6 +228,7 @@ sms_validate (void *cls, * @param code secret code that the user has to provide back to satisfy the challenge in * the main anastasis protocol * @param data input to validate (i.e. is it a valid phone number, etc.) + * @param data_length number of bytes in @a data * @return state to track progress on the authorization operation, NULL on failure */ static struct ANASTASIS_AUTHORIZATION_State * diff --git a/src/backend/anastasis-httpd.c b/src/backend/anastasis-httpd.c index ee7aea7..7c4b068 100644 --- a/src/backend/anastasis-httpd.c +++ b/src/backend/anastasis-httpd.c @@ -127,12 +127,12 @@ static struct MHD_Daemon *mhd; struct ANASTASIS_DatabasePlugin *db; /** - * Reschedule context for #SH_ctx. + * Reschedule context for #AH_ctx. */ static struct GNUNET_CURL_RescheduleContext *rc; /** - * Set if we should immediately #MHD_run again. + * Set if we should immediately MHD_run() again. */ static int triggered; @@ -232,24 +232,25 @@ AH_trigger_curl (void) /** * A client has requested the given url using the given method - * (#MHD_HTTP_METHOD_GET, #MHD_HTTP_METHOD_PUT, - * #MHD_HTTP_METHOD_DELETE, #MHD_HTTP_METHOD_POST, etc). The callback + * (MHD_HTTP_METHOD_GET, MHD_HTTP_METHOD_PUT, + * MHD_HTTP_METHOD_DELETE, MHD_HTTP_METHOD_POST, etc). The callback * must call MHD callbacks to provide content to give back to the - * client and return an HTTP status code (i.e. #MHD_HTTP_OK, - * #MHD_HTTP_NOT_FOUND, etc.). + * client and return an HTTP status code (i.e. MHD_HTTP_OK, + * MHD_HTTP_NOT_FOUND, etc.). * * @param cls argument given together with the function * pointer when the handler was registered with MHD + * @param connection MHD connection handle with further request details * @param url the requested url - * @param method the HTTP method used (#MHD_HTTP_METHOD_GET, - * #MHD_HTTP_METHOD_PUT, etc.) + * @param method the HTTP method used (MHD_HTTP_METHOD_GET, + * MHD_HTTP_METHOD_PUT, etc.) * @param version the HTTP version string (i.e. - * #MHD_HTTP_VERSION_1_1) + * MHD_HTTP_VERSION_1_1) * @param upload_data the data being uploaded (excluding HEADERS, * for a POST that fits into memory and that is encoded * with a supported encoding, the POST data will NOT be * given in upload_data and is instead available as - * part of #MHD_get_connection_values; very large POST + * part of MHD_get_connection_values(); very large POST * data *will* be made available incrementally in * @a upload_data) * @param upload_data_size set initially to the size of the @@ -262,8 +263,8 @@ AH_trigger_curl (void) * with plenty of upload data) this allows the application * to easily associate some request-specific state. * If necessary, this state can be cleaned up in the - * global #MHD_RequestCompletedCallback (which - * can be set with the #MHD_OPTION_NOTIFY_COMPLETED). + * global MHD_RequestCompletedCallback (which + * can be set with the MHD_OPTION_NOTIFY_COMPLETED). * Initially, `*con_cls` will be NULL. * @return #MHD_YES if the connection was handled successfully, * #MHD_NO if the socket must be closed due to a serious @@ -537,7 +538,7 @@ handle_mhd_completion_callback (void *cls, * Function that queries MHD's select sets and * starts the task waiting for them. * - * @param daemon_handle HTTP server to prepare to run + * @return task handle for the daemon */ static struct GNUNET_SCHEDULER_Task * prepare_daemon (void) diff --git a/src/backend/anastasis-httpd_mhd.c b/src/backend/anastasis-httpd_mhd.c index c39a54c..6d2d898 100644 --- a/src/backend/anastasis-httpd_mhd.c +++ b/src/backend/anastasis-httpd_mhd.c @@ -27,14 +27,6 @@ #include "anastasis-httpd_mhd.h" -/** - * Function to call to handle the request by sending - * back static data from the @a rh. - * - * @param rh context of the handler - * @param connection the MHD connection to handle - * @return MHD result code - */ MHD_RESULT TMH_MHD_handler_static_response (struct AH_RequestHandler *rh, struct MHD_Connection *connection) @@ -49,21 +41,13 @@ TMH_MHD_handler_static_response (struct AH_RequestHandler *rh, } -/** - * Function to call to handle the request by sending - * back a redirect to the AGPL source code. - * - * @param rh context of the handler - * @param connection the MHD connection to handle - * @return MHD result code - */ MHD_RESULT TMH_MHD_handler_agpl_redirect (struct AH_RequestHandler *rh, struct MHD_Connection *connection) { (void) rh; return TALER_MHD_reply_agpl (connection, - "http://www.git.taler.net/anastasis.git"); + "https://git.taler.net/anastasis.git"); } diff --git a/src/backend/anastasis-httpd_mhd.h b/src/backend/anastasis-httpd_mhd.h index 628abfa..2aa9b28 100644 --- a/src/backend/anastasis-httpd_mhd.h +++ b/src/backend/anastasis-httpd_mhd.h @@ -34,10 +34,6 @@ * * @param rh context of the handler * @param connection the MHD connection to handle - * @param[in,out] connection_cls the connection's closure (can be updated) - * @param upload_data upload data - * @param[in,out] upload_data_size number of bytes (left) in @a upload_data - * @param mi merchant backend instance, NULL is allowed in this case! * @return MHD result code */ MHD_RESULT diff --git a/src/backend/anastasis-httpd_policy.c b/src/backend/anastasis-httpd_policy.c index 2417e15..0b6597a 100644 --- a/src/backend/anastasis-httpd_policy.c +++ b/src/backend/anastasis-httpd_policy.c @@ -43,7 +43,7 @@ * using @a default_http_status on success. * * @param connection MHD connection to use - * @param account account to query + * @param account_pub account to query * @return MHD result code */ static MHD_RESULT diff --git a/src/backend/anastasis-httpd_policy.h b/src/backend/anastasis-httpd_policy.h index 9fb630d..e40ade9 100644 --- a/src/backend/anastasis-httpd_policy.h +++ b/src/backend/anastasis-httpd_policy.h @@ -48,7 +48,7 @@ AH_policy_get (struct MHD_Connection *connection, * Handle POST /policy/$ACCOUNT_PUB request. * * @param connection the MHD connection to handle - * @param con_cls the connection's closure + * @param hc request context * @param account_pub public key of the account * @param upload_data upload data * @param upload_data_size number of bytes (left) in @a upload_data diff --git a/src/backend/anastasis-httpd_policy_upload.c b/src/backend/anastasis-httpd_policy_upload.c index bff6028..68eb509 100644 --- a/src/backend/anastasis-httpd_policy_upload.c +++ b/src/backend/anastasis-httpd_policy_upload.c @@ -227,8 +227,7 @@ cleanup_ctx (struct TM_HandlerContext *hc) /** * Transmit a payment request for @a order_id on @a connection * - * @param connection MHD connection - * @param order_id our backend's order ID + * @param[in,out] puc details about the operation * @return #GNUNET_OK on success */ static int @@ -507,7 +506,6 @@ check_payment_cb (void *cls, * a payment for the user's account. * * @param puc context to begin payment for. - * @param timeout when to give up trying */ static void await_payment (struct PolicyUploadContext *puc) diff --git a/src/backend/anastasis-httpd_truth.c b/src/backend/anastasis-httpd_truth.c index b0b6530..f8962b4 100644 --- a/src/backend/anastasis-httpd_truth.c +++ b/src/backend/anastasis-httpd_truth.c @@ -277,9 +277,8 @@ AH_truth_shutdown (void) /** * Callback to process a POST /orders/ID/refund request * - * @param cls closure - * @param http_status HTTP status code for this request - * @param ec taler-specific error code + * @param cls closure with a `struct RefundEntry *` + * @param hr HTTP response details * @param taler_refund_uri the refund uri offered to the wallet * @param h_contract hash of the contract a Browser may need to authorize * obtaining the HTTP response. @@ -876,12 +875,6 @@ run_authorization_process (struct MHD_Connection *connection, } -/** - * @param connection the MHD connection to handle - * @param url handles a URL of the format "/truth/$UUID[&response=$RESPONSE]" - * @param hc - * @return MHD result code - */ MHD_RESULT AH_handler_truth_get ( struct MHD_Connection *connection, diff --git a/src/backend/anastasis-httpd_truth.h b/src/backend/anastasis-httpd_truth.h index 7a1b95f..c0ee474 100644 --- a/src/backend/anastasis-httpd_truth.h +++ b/src/backend/anastasis-httpd_truth.h @@ -44,7 +44,7 @@ AH_truth_upload_shutdown (void); * * @param connection the MHD connection to handle * @param truth_uuid the truth UUID - * @param con_cls + * @param hc connection context * @return MHD result code */ MHD_RESULT @@ -58,13 +58,13 @@ AH_handler_truth_get ( * Handle a POST to /truth/$UUID. * * @param connection the MHD connection to handle - * @param con_cls the connection's closure + * @param hc connection context * @param truth_uuid the truth UUID * @param truth_data truth data * @param truth_data_size number of bytes (left) in @a truth_data * @return MHD result code */ -int +MHD_RESULT AH_handler_truth_post ( struct MHD_Connection *connection, struct TM_HandlerContext *hc, diff --git a/src/backend/anastasis-httpd_truth_upload.c b/src/backend/anastasis-httpd_truth_upload.c index 130876f..30bd8e6 100644 --- a/src/backend/anastasis-httpd_truth_upload.c +++ b/src/backend/anastasis-httpd_truth_upload.c @@ -508,7 +508,7 @@ begin_payment (struct TruthUploadContext *tuc) } -int +MHD_RESULT AH_handler_truth_post ( struct MHD_Connection *connection, struct TM_HandlerContext *hc, diff --git a/src/cli/anastasis-cli-redux.c b/src/cli/anastasis-cli-redux.c index 7b533c2..409b0ed 100644 --- a/src/cli/anastasis-cli-redux.c +++ b/src/cli/anastasis-cli-redux.c @@ -124,12 +124,11 @@ persist_new_state (json_t *state, /** - * Function called with the results of #ANASTASIS_backup_action - * or #ANASTASIS_recovery_action. + * Function called with the results of #ANASTASIS_redux_action(). * * @param cls closure * @param error_code Error code - * @param new_state new state as result + * @param result_state new state as result */ static void action_cb (void *cls, diff --git a/src/include/anastasis.h b/src/include/anastasis.h index 1591106..d253868 100644 --- a/src/include/anastasis.h +++ b/src/include/anastasis.h @@ -613,6 +613,7 @@ typedef void * * @param ctx the CURL context used to connect to the backend * @param user_id user identifier derived from user data and backend salt + * @param provider_url base URL of the provider to upload to * @param type defines the type of the challenge (secure question, sms, email) * @param instructions depending on @a type! usually only for security question/answer! * @param mime_type format of the challenge @@ -648,6 +649,7 @@ ANASTASIS_truth_upload ( * * @param ctx the CURL context used to connect to the backend * @param user_id user identifier derived from user data and backend salt + * @param provider_url base URL of the provider to upload to * @param type defines the type of the challenge (secure question, sms, email) * @param instructions depending on @a type! usually only for security question/answer! * @param mime_type format of the challenge @@ -946,11 +948,9 @@ struct ANASTASIS_ProviderDetails * @param providers array of providers with URLs to upload the policies to * @param pss_length length of the @a providers array * @param policies list of policies which are included in this recovery document - * @param policies_length length of the @a policies array + * @param policies_len length of the @a policies array * @param payment_years_requested for how many years would the client like the service to store the truth? * @param pay_timeout how long to wait for payment - * @param spc payment callback is opened to pay the upload - * @param spc_cls closure for the @a spc payment callback * @param src callback for the upload process * @param src_cls closure for the @a src upload callback * @param secret_name name of the core secret diff --git a/src/include/anastasis_authorization_lib.h b/src/include/anastasis_authorization_lib.h index 80740be..99a4602 100644 --- a/src/include/anastasis_authorization_lib.h +++ b/src/include/anastasis_authorization_lib.h @@ -30,7 +30,7 @@ * * @param method name of the method to load * @param AH_cfg configuration to use - * @param[out] set to the cost for using the plugin during recovery + * @param[out] cost set to the cost for using the plugin during recovery * @return #GNUNET_OK on success */ struct ANASTASIS_AuthorizationPlugin * @@ -41,9 +41,7 @@ ANASTASIS_authorization_plugin_load ( /** - * shutdown all loaded plugins. - * - * @param void + * Shutdown all loaded plugins. */ void ANASTASIS_authorization_plugin_shutdown (void); diff --git a/src/include/anastasis_json.h b/src/include/anastasis_json.h deleted file mode 100644 index d2523a2..0000000 --- a/src/include/anastasis_json.h +++ /dev/null @@ -1,410 +0,0 @@ -/* - This file is part of Anastasis - Copyright (C) 2020 Taler Systems SA - - Anastasis is free software; you can redistribute it and/or modify it under the - terms of the GNU Lesser General Public License as published by the Free Software - Foundation; either version 3, or (at your option) any later version. - - Anastasis is distributed in the hope that it will be useful, but WITHOUT ANY - WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR - A PARTICULAR PURPOSE. See the GNU General Public License for more details. - - You should have received a copy of the GNU General Public License along with - Anastasis; see the file COPYING.GPL. If not, see -*/ -/** - * @file include/anastasis_json.h - * @brief anastasis de-/serialization api - * @author Christian Grothoff - * @author Dominik Meister - * @author Dennis Neufeld - */ -#ifndef ANASTASIS_JSON_H -#define ANASTASIS_JSON_H - -#include -#include -#include "anastasis_error_codes.h" - -/** - * Enumeration of possible backup process status. - */ -enum ANASTASIS_BackupStatus -{ - ANASTASIS_BS_INITIAL, - ANASTASIS_BS_SELECT_CONTINENT, - ANASTASIS_BS_SELECT_COUNTRY, - ANASTASIS_BS_ENTER_USER_ATTRIBUTES, - ANASTASIS_BS_ADD_AUTHENTICATION_METHOD, - ANASTASIS_BS_ADD_POLICY, - ANASTASIS_BS_PAY -}; - -/** - * Enumeration of possible recovery process status. - */ -enum ANASTASIS_RecoveryStatus -{ - ANASTASIS_RS_INITIAL, - ANASTASIS_RS_SELECT_CONTINENT, - ANASTASIS_RS_SELECT_COUNTRY, - ANASTASIS_RS_ENTER_USER_ATTRIBUTES, - ANASTASIS_RS_SOLVE_CHALLENGE -}; - -// A state for the backup process. -struct ANASTASIS_BackupState -{ - enum ANASTASIS_BackupStatus status; - - union - { - - struct - { - // empty! - } select_continent; - - struct - { - const char *continent; - } select_country; - - struct - { - const char *continent; - const char *country; - const char *currency; // derived or per manual override! - json_t *user_attributes; - } enter_attributes; - - struct - { - const char *continent; - const char *country; - const char *currency; - json_t *user_attributes; - - struct AuthenticationDetails - { - enum AuthenticationMethod - { - SMS, - VIDEO, - SECQUEST, - EMAIL, - SNAILMAIL - }; - char *provider_url; - union Truth - { - - struct - { - char *phone_number; - } sms; - - struct - { - char *question; - char *answer; // FIXME: Reasonable to store answer in clear text here? - } secquest; - - struct - { - char *mailaddress; - } email; - - struct - { - char *full_name; - char *street; // street name + number - char *postal_code; - char *city; - char *country; - } snailmail; - - struct - { - char *path_to_picture; - } video; - } truth; - }*ad; // array - size_t ad_length; - } add_authentication; - struct - { - const char *continent; - const char *country; - const char *currency; - json_t *user_attributes; - - struct AuthenticationDetails - { - enum AuthenticationMethod - { - SMS, - VIDEO, - SECQUEST, - EMAIL, - SNAILMAIL - }; - char *provider_url; - union Truth - { - - struct - { - char *phone_number; - } sms; - - struct - { - char *question; - char *answer; // FIXME: Reasonable to store answer in clear text here? - } secquest; - - struct - { - char *mailaddress; - } email; - - struct - { - char *full_name; - char *street; // street name + number - char *postal_code; - char *city; - char *country; - } snailmail; - - struct - { - char *path_to_picture; - } video; - } truth; - }*ad; // array - size_t ad_length; - - struct PolicyDetails - { - struct AuthenticationDetails *ad; // array - }*pd; // array - size_t pd_length; - } add_policy; - // FIXME: add_payment - } details; -}; - - -// A state for the recovery process. -struct ANASTASIS_RecoveryState -{ - enum ANASTASIS_RecoveryStatus status; - - struct - { - // empty! - } select_continent; - - struct - { - const char *continent; - } select_country; - - struct - { - const char *continent; - const char *country; - const char *currency; // derived or per manual override! - json_t *user_attributes; - } enter_attributes; - - struct - { - const char *continent; - const char *country; - const char *currency; - json_t *user_attributes; - - struct ChallengeDetails - { - enum AuthenticationMethod - { - SMS, - VIDEO, - SECQUEST, - EMAIL, - SNAILMAIL - }; - char *provider_url; - union Challenge - { - - struct - { - char *phone_number; - char *code; - } sms; - - struct - { - char *question; - char *answer; // FIXME: Reasonable to store answer in clear text here? - } secquest; - - struct - { - char *mailaddress; - char *code; - } email; - - struct - { - char *full_name; - char *street; // street name + number - char *postal_code; - char *city; - char *country; - char *code; - } snailmail; - - struct - { - char *path_to_picture; - char *code; - } video; - } truth; - }*cd; // array - size_t cd_length; - } solve_challenge; -}; - -/** - * Definition of actions on ANASTASIS_BackupState. - */ -struct ANASTASIS_BackupAction -{ - enum action - { - ANASTASIS_BA_GET_SELECT_CONTINENT, - ANASTASIS_BA_GET_SELECT_COUNTRY, - ANASTASIS_BA_GET_ENTER_USER_ATTRIBUTES, - ANASTASIS_BA_GET_ADD_AUTHENTICATION_METHOD, - ANASTASIS_BA_GET_ADD_POLICY, - ANASTASIS_BA_GET_PAY, - ANASTASIS_BA_SET_SELECT_CONTINENT, - ANASTASIS_BA_SET_SELECT_COUNTRY, - ANASTASIS_BA_SET_ENTER_USER_ATTRIBUTES, - ANASTASIS_BA_SET_ADD_AUTHENTICATION_METHOD, - ANASTASIS_BA_SET_ADD_POLICY, - ANASTASIS_BA_SET_PAY - }; -}; - -/** - * Definition of actions on ANASTASIS_RecoveryState. - */ -struct ANASTASIS_RecoveryAction -{ - enum action - { - ANASTASIS_RS_GET_SELECT_CONTINENT, - ANASTASIS_RS_GET_SELECT_COUNTRY, - ANASTASIS_RS_GET_ENTER_USER_ATTRIBUTES, - ANASTASIS_RS_GET_SOLVE_CHALLENGE, - ANASTASIS_RS_SET_SELECT_CONTINENT, - ANASTASIS_RS_SET_SELECT_COUNTRY, - ANASTASIS_RS_SET_ENTER_USER_ATTRIBUTES, - ANASTASIS_RS_SET_SOLVE_CHALLENGE - }; -}; - - -/** - * Signature of the callback bassed to #ANASTASIS_apply_anastasis_backup_action - * for asynchronous actions on a #ANASTASIS_BackupState. - * - * @param cls closure - * @param new_bs the new #ANASTASIS_BackupState - * @param error error code - */ -typedef void -(*ANASTASIS_BackupApplyActionCallback)( - void *cls, - const struct ANASTASIS_BackupState *new_bs, - enum TALER_ErrorCode error); - - -/** - * Signature of the callback bassed to #ANASTASIS_apply_anastasis_recovery_action - * for asynchronous actions on a #ANASTASIS_RecoveryState. - * - * @param cls closure - * @param new_bs the new #ANASTASIS_RecoveryState - * @param error error code - */ -typedef void -(*ANASTASIS_RecoveryApplyActionCallback)( - void *cls, - const struct ANASTASIS_RecoveryState *new_rs, - enum TALER_ErrorCode error); - - -/** - * Returns an initial ANASTASIS_BackupState. - * - * @return initial ANASTASIS_BackupState - */ -struct ANASTASIS_BackupState * -ANASTASIS_get_initial_backup_state (); - - -/** - * Returns an initial ANASTASIS_RecoveryState. - * - * @return initial ANASTASIS_RecoveryState - */ -struct ANASTASIS_RecoveryState * -ANASTASIS_get_initial_recovery_state (); - - -/** - * Operates on a backup state depending on given #ANASTASIS_BackupState - * and #ANASTASIS_BackupAction. The new #ANASTASIS_BackupState is returned - * by a callback function. - * This function can do network access to talk to anastasis service providers. - * - * @param ctx url context for the event loop - * @param bs the previous *ANASTASIS_BackupState - * @param ba the action to do on #ANASTASIS_BackupState - * @param cb callback function to call with the action - */ -void -ANASTASIS_apply_anastasis_backup_action ( - struct GNUNET_CURL_Context *ctx, - struct ANASTASIS_BackupState *bs, - struct ANASTASIS_BackupAction *ba, - ANASTASIS_BackupApplyActionCallback cb); - - -/** - * Operates on a recovery state depending on given #ANASTASIS_RecoveryState - * and #ANASTASIS_RecoveryAction. The new #ANASTASIS_RecoveryState is returned - * by a callback function. - * This function can do network access to talk to anastasis service providers. - * - * @param ctx url context for the event loop - * @param bs the previous *ANASTASIS_RecoveryState - * @param ba the action to do on #ANASTASIS_RecoveryState - * @param cb callback function to call with the action - */ -void -ANASTASIS_apply_anastasis_recovery_action ( - struct GNUNET_CURL_Context *ctx, - struct ANASTASIS_RecoveryState *rs, - struct ANASTASIS_RecoveryAction *ra, - ANASTASIS_RecoveryApplyActionCallback cb); - -#endif /* _ANASTASIS_JSON_H */ diff --git a/src/include/anastasis_redux.h b/src/include/anastasis_redux.h index 7a0ff53..3a0b3f1 100644 --- a/src/include/anastasis_redux.h +++ b/src/include/anastasis_redux.h @@ -73,8 +73,7 @@ ANASTASIS_recovery_start (const struct GNUNET_CONFIGURATION_Handle *cfg); /** - * Signature of the callback passed to #ANASTASIS_backup_action and - * #ANASTASIS_recover_action. + * Signature of the callback passed to #ANASTASIS_redux_action() * * @param cls closure * @param error error code, #TALER_EC_NONE if @a new_bs is the new successful state @@ -93,12 +92,9 @@ struct ANASTASIS_ReduxAction; /** - * Operates on a state depending on given #ANASTASIS_BackupState - * or #ANASTASIS_RecoveryState and #ANASTASIS_BackupAction or - * #ANASTASIS_RecoveryAction. - * The new #ANASTASIS_BackupState or #ANASTASIS_RecoveryState is returned - * by a callback function. - * This function can do network access to talk to anastasis service providers. + * Operates on a state. The new state is returned by a callback + * function. This function can do network access to talk to Anastasis + * service providers. * * @param state input state * @param action what action to perform diff --git a/src/include/anastasis_service.h b/src/include/anastasis_service.h index 9069035..8e12b02 100644 --- a/src/include/anastasis_service.h +++ b/src/include/anastasis_service.h @@ -661,7 +661,6 @@ typedef void * @param ctx the CURL context used to connect to the backend * @param backend_url backend's base URL, including final "/" * @param uuid unique identfication of the Truth Upload - * @param prev_truth_data_hash hash of the previous truth upload, NULL for the first upload ever * @param type type of the authorization method * @param encrypted_keyshare key material to return to the client upon authorization * @param truth_mime mime type of @e encrypted_truth (after decryption) diff --git a/src/include/anastasis_testing_lib.h b/src/include/anastasis_testing_lib.h index 80018d9..ba6f801 100644 --- a/src/include/anastasis_testing_lib.h +++ b/src/include/anastasis_testing_lib.h @@ -37,17 +37,11 @@ */ #define ANASTASIS_TESTING_TRAIT_HASH_CURRENT 0 -/** - * Index used in #SYNC_TESTING_get_trait_hash() for the previous hash. - */ -#define ANASTASIS_TESTING_TRAIT_HASH_PREVIOUS 1 - /** * Obtain a hash from @a cmd. * * @param cmd command to extract the number from. - * @param index the number's index number, #ANASTASIS_TESTING_TRAIT_HASH_CURRENT or - * #SYNC_TESTING_TRAIT_HASH_PREVIOUS + * @param index the number's index number, use #ANASTASIS_TESTING_TRAIT_HASH_CURRENT * @param[out] h set to the hash coming from @a cmd. * @return #GNUNET_OK on success. */ @@ -107,8 +101,7 @@ ANASTASIS_TESTING_make_trait_truth_key ( */ int ANASTASIS_TESTING_get_trait_account_pub ( - const struct - TALER_TESTING_Command *cmd, + const struct TALER_TESTING_Command *cmd, unsigned int index, const struct ANASTASIS_CRYPTO_AccountPublicKeyP **pub); @@ -216,7 +209,7 @@ ANASTASIS_TESTING_make_trait_truth_uuid ( * * @param cmd command to extract the number from. * @param index the number's index number. - * @param[out] uuid set to the number coming from @a cmd. + * @param[out] eks set to the key share coming from @a cmd. * @return #GNUNET_OK on success. */ int @@ -255,10 +248,10 @@ ANASTASIS_TESTING_get_trait_code ( /** - * Offer a filename. + * Offer an authentication code. * * @param index the number's index number. - * @param tpk the public key to offer. + * @param code the code to offer. * @return trait on success */ struct TALER_TESTING_Trait @@ -300,7 +293,7 @@ TALER_TESTING_run_merchant (const char *config_filename, * anastasis" function to do such tasks. * * @param config_filename configuration filename. - * + * @param anastasis_url URL to use to confirm service running * @return the process, or NULL if the process could not * be started. */ @@ -383,19 +376,32 @@ ANASTASIS_TESTING_cmd_policy_store ( * Make the "policy lookup" command. * * @param label command label - * @param ANASTASIS_url base URL of the ANASTASIS serving - * the policy lookup request. + * @param anastasis_url base URL of the ANASTASIS serving + * the policy store request. * @param http_status expected HTTP status. * @param upload_ref reference to upload command * @return the command */ struct TALER_TESTING_Command ANASTASIS_TESTING_cmd_policy_lookup (const char *label, - const char *ANASTASIS_url, + const char *anastasis_url, unsigned int http_status, const char *upload_ref); +/** + * Make the "policy lookup" command for a non-existent upload. + * + * @param label command label + * @param anastasis_url base URL of the ANASTASIS serving + * the policy lookup request. + * @return the command + */ +struct TALER_TESTING_Command +ANASTASIS_TESTING_cmd_policy_nx (const char *label, + const char *anastasis_url); + + /** * Types of options for performing the upload. Used as a bitmask. */ @@ -482,6 +488,8 @@ ANASTASIS_TESTING_cmd_truth_question ( * @param answer (response to challenge) * @param payment_ref reference to the payment request * @param upload_ref reference to upload command + * @param lookup_mode 0 for security question, 1 for + * code-based * @param ksdd expected status * @return the command */ diff --git a/src/include/platform.h b/src/include/platform.h index d4b8bbe..a44a4a6 100644 --- a/src/include/platform.h +++ b/src/include/platform.h @@ -1,6 +1,6 @@ /* This file is part of TALER - Copyright (C) 2014, 2015, 2016 GNUnet e.V. and INRIA + Copyright (C) 2014, 2015, 2016, 2021 Anastasis SARL TALER is free software; you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software diff --git a/src/lib/anastasis_backup.c b/src/lib/anastasis_backup.c index d97bdae..47017f2 100644 --- a/src/lib/anastasis_backup.c +++ b/src/lib/anastasis_backup.c @@ -611,8 +611,7 @@ struct ANASTASIS_SecretShare * Callback to process a POST /policy request * * @param cls closure - * @param ec anastasis-specific error code - * @param obj the decoded response body + * @param ud the decoded response body */ static void policy_store_cb (void *cls, diff --git a/src/lib/anastasis_recovery.c b/src/lib/anastasis_recovery.c index 2a606d2..e921cb1 100644 --- a/src/lib/anastasis_recovery.c +++ b/src/lib/anastasis_recovery.c @@ -236,8 +236,7 @@ struct ANASTASIS_Recovery * Function called with the results of a #ANASTASIS_keyshare_lookup(). * * @param cls closure - * @param http_status HTTP status of the request - * @param ud details about the lookup operation + * @param dd details about the lookup operation */ static void keyshare_lookup_cb (void *cls, @@ -536,11 +535,11 @@ ANASTASIS_challenge_abort (struct ANASTASIS_Challenge *c) /** - * Function called with the results of a ANASTASIS_policy_lookup + * Function called with the results of a #ANASTASIS_policy_lookup() * * @param cls closure - * @param http_status HTTP status of the request - * @param ud details about the lookup operation + * @param http_status HTTp status code. + * @param dd details about the lookup operation */ static void policy_lookup_cb (void *cls, diff --git a/src/reducer/anastasis_api_backup_redux.c b/src/reducer/anastasis_api_backup_redux.c index 2f44688..cfe9f31 100644 --- a/src/reducer/anastasis_api_backup_redux.c +++ b/src/reducer/anastasis_api_backup_redux.c @@ -1388,7 +1388,7 @@ find_best_map (struct PolicyBuilder *pb, * Select cheapest policy combinations and add them to the JSON ``policies`` * array in @a pb * - * @param[in,out] policy builder with our state + * @param[in,out] pb policy builder with our state */ static void select_policies (struct PolicyBuilder *pb) @@ -3383,7 +3383,7 @@ truth_upload_cb (void *cls, * @a truth for policy reference @a pmr. If such a truth object * already exists, append @a pmr to its list of reasons. * - * @param[in,out] our upload context + * @param[in,out] uc our upload context * @param pmr policy method combination that requires the truth * @param provider_url the URL of the Anastasis provider to upload * the truth to, used to check for existing entries @@ -3556,7 +3556,7 @@ add_truth_object (struct UploadContext *uc, * policy reference @a pmr. If the upload is already queued, * append @a pmr to its list of reasons. * - * @param[in,out] our upload context + * @param[in,out] uc our upload context * @param pmr policy method combination that requires the truth * @param provider_url the URL of the Anastasis provider to upload * the truth to, used to check for existing entries @@ -3755,7 +3755,6 @@ check_truth_upload (struct UploadContext *uc, * and change providers/policies), or payment, or finished. * * @param state state to operate on - * @param truth_indices indices of truths to upload explicitly * @param cb callback (#ANASTASIS_ActionCallback) to call after upload * @param cb_cls callback closure */ @@ -4482,18 +4481,6 @@ typedef struct ANASTASIS_ReduxAction * void *cb_cls); -/** - * Operates on a backup state depending on given #ANASTASIS_BackupState - * and #ANASTASIS_BackupAction. The new #ANASTASIS_BackupState is returned - * by a callback function. - * This function can do network access to talk to anastasis service providers. - * - * @param[in,out] state input/output state (to be modified) - * @param action what action to perform - * @param arguments data for the @a action - * @param cb function to call with the result - * @param cb_cls closure for @a cb - */ struct ANASTASIS_ReduxAction * ANASTASIS_backup_action_ (json_t *state, const char *action, diff --git a/src/reducer/anastasis_api_recovery_redux.c b/src/reducer/anastasis_api_recovery_redux.c index 0d395bc..84db8fe 100644 --- a/src/reducer/anastasis_api_recovery_redux.c +++ b/src/reducer/anastasis_api_recovery_redux.c @@ -261,7 +261,7 @@ update_state_by_error (json_t *state, * On success, the secret is returned in @a secret. * * @param cls handle for the callback - * @param ec error code + * @param rc error code * @param secret contains the core secret which is passed to the user * @param secret_size defines the size of the core secret */ @@ -1655,18 +1655,6 @@ typedef struct ANASTASIS_ReduxAction * void *cb_cls); -/** - * Operates on a recovery state depending on given #ANASTASIS_RecoveryState - * and #ANASTASIS_RecoveryAction. The new #ANASTASIS_RecoveryState is returned - * by a callback function. - * This function can do network access to talk to anastasis service providers. - * - * @param[in,out] state input/output state (to be modified) - * @param action what action to perform - * @param arguments data for the @a action - * @param cb function to call with the result - * @param cb_cls closure for @a cb - */ struct ANASTASIS_ReduxAction * ANASTASIS_recovery_action_ (json_t *state, const char *action, @@ -1919,9 +1907,9 @@ struct RecoverSecretState /** - * Function to free a #RecoverSecretState. + * Function to free a `struct RecoverSecretState` * - * @param cls closure for a #RecoverSecretState. + * @param cls must be a `struct RecoverSecretState` */ static void free_rss (void *cls) @@ -1967,7 +1955,7 @@ free_rss (void *cls) * we are called, it is because of some fatal error. * * @param cls a `struct PolicyDownloadEntry` - * @param ec error code + * @param rc error code * @param secret contains the core secret which is passed to the user * @param secret_size defines the size of the core secret */ diff --git a/src/reducer/anastasis_api_redux.c b/src/reducer/anastasis_api_redux.c index 41b3fd7..c41d801 100644 --- a/src/reducer/anastasis_api_redux.c +++ b/src/reducer/anastasis_api_redux.c @@ -332,7 +332,7 @@ ANASTASIS_redux_init (struct GNUNET_CURL_Context *ctx) /** - * Function to free a #ConfigRequest, an async operation. + * Function to free a `struct ConfigRequest`, an async operation. * * @param cr state for a "get config" operation */ diff --git a/src/reducer/anastasis_api_redux.h b/src/reducer/anastasis_api_redux.h index b388fd3..ef0962b 100644 --- a/src/reducer/anastasis_api_redux.h +++ b/src/reducer/anastasis_api_redux.h @@ -100,6 +100,8 @@ ANASTASIS_redux_done (void); /** * Produce an initial state with an initialized list of * continents. + * + * @return list of continents */ json_t * ANASTASIS_REDUX_load_continents_ (void); @@ -108,8 +110,8 @@ ANASTASIS_REDUX_load_continents_ (void); /** * Returns the enum value to a string value of a state. * - * @param state_string - * @return #ANASTASIS_GENERIC_STATE_ERROR on error + * @param state_string string to convert + * @return ANASTASIS_GENERIC_STATE_ERROR on error */ enum ANASTASIS_GenericState ANASTASIS_generic_state_from_string_ (const char *state_string); @@ -118,7 +120,7 @@ ANASTASIS_generic_state_from_string_ (const char *state_string); /** * Returns the string value of a state. * - * @param state_string + * @param gs state value to convert * @return NULL on error */ const char * @@ -128,8 +130,8 @@ ANASTASIS_generic_state_to_string_ (enum ANASTASIS_GenericState gs); /** * Returns the enum value to a string value of a state. * - * @param state_string - * @return #ANASTASIS_BACKUP_STATE_ERROR on error + * @param state_string string to convert + * @return ANASTASIS_BACKUP_STATE_ERROR on error */ enum ANASTASIS_BackupState ANASTASIS_backup_state_from_string_ (const char *state_string); @@ -138,7 +140,7 @@ ANASTASIS_backup_state_from_string_ (const char *state_string); /** * Returns the string value of a state. * - * @param state_string + * @param bs state to convert to a string * @return NULL on error */ const char * @@ -148,8 +150,8 @@ ANASTASIS_backup_state_to_string_ (enum ANASTASIS_BackupState bs); /** * Returns the enum value to a string value of a state. * - * @param state_string - * @return XXX on error + * @param state_string value to convert + * @return ANASTASIS_RECOVERY_STATE_ERROR on error */ enum ANASTASIS_RecoveryState ANASTASIS_recovery_state_from_string_ (const char *state_string); @@ -158,7 +160,7 @@ ANASTASIS_recovery_state_from_string_ (const char *state_string); /** * Returns the string value of a state. * - * @param state_string + * @param rs value to convert * @return NULL on error */ const char * @@ -205,7 +207,7 @@ ANASTASIS_add_provider_ (json_t *state, * imports it into @a state. If not, queries the provider, * generating a success or failure outcome asynchronously. * - * @param cr the config request + * @param url the provider's base URL to add * @param[in,out] state the json state to operate on * @param cb callback to call during/after operation * @param cb_cls callback closure @@ -223,10 +225,10 @@ ANASTASIS_REDUX_add_provider_to_state_ (const char *url, * A generic DispatchHandler/Callback function which is called for a * "back" action. * - * @param state state to operate on + * @param[in,out] state state to operate on * @param arguments arguments to use for operation on state * @param cb callback to call during/after operation - * @param cb_cls callback closure + * @param cb_cls callback closure for @a cb * @return NULL (no asynchronous action) */ struct ANASTASIS_ReduxAction * @@ -240,19 +242,17 @@ ANASTASIS_back_generic_decrement_ (json_t *state, * Function to load json containing all countries. * Returns the countries. * - * @return json_t * + * @return list of countries */ const json_t * ANASTASIS_redux_countries_init_ (void); /** - * Operates on a recovery state depending on given #ANASTASIS_RecoveryState - * and #ANASTASIS_RecoveryAction. The new #ANASTASIS_RecoveryState is returned + * Operates on a recovery state. The new state is returned * by a callback function. * This function can do network access to talk to anastasis service providers. * - * @param ctx the CURL context used to connect to the backend * @param[in,out] state input/output state (to be modified) * @param action what action to perform * @param arguments data for the @a action @@ -276,8 +276,9 @@ ANASTASIS_recovery_action_ (json_t *state, * Returns an #ANASTASIS_ReduxAction. * * @param state state to operate on + * @param arguments data for the operation * @param cb callback to call during/after operation - * @param cb_cls callback closure + * @param cb_cls callback closure for @a cb * @return NULL */ struct ANASTASIS_ReduxAction * @@ -293,9 +294,10 @@ ANASTASIS_REDUX_recovery_challenge_begin_ (json_t *state, * arguments provided were OK and the state transition was * initiated. Begins the actual backup logic. * - * Returns an #ANASTASIS_ReduxAction. + * Returns a `struct ANASTASIS_ReduxAction`. * * @param state state to operate on + * @param arguments data for the operation * @param cb callback to call during/after operation * @param cb_cls callback closure */ @@ -307,12 +309,10 @@ ANASTASIS_REDUX_backup_begin_ (json_t *state, /** - * Operates on a backup state depending on given #ANASTASIS_BackupState - * and #ANASTASIS_BackupAction. The new #ANASTASIS_BackupState is returned - * by a callback function. + * Operates on a backup state and returns the new state via a + * callback function. * This function can do network access to talk to anastasis service providers. * - * @param ctx the CURL context used to connect to the backend * @param[in,out] state input/output state (to be modified) * @param action what action to perform * @param arguments data for the @a action diff --git a/src/reducer/validation_CH_AHV.c b/src/reducer/validation_CH_AHV.c index 5bf6fb3..5f852ad 100644 --- a/src/reducer/validation_CH_AHV.c +++ b/src/reducer/validation_CH_AHV.c @@ -26,7 +26,7 @@ /** * Function to validate a Swiss AHV number. * - * @param avh_number ahv number to validate (input) + * @param ahv_number ahv number to validate (input) * @return true if validation passed, else false */ bool diff --git a/src/reducer/validation_DE_SVN.c b/src/reducer/validation_DE_SVN.c index 0bfe02e..81faf43 100644 --- a/src/reducer/validation_DE_SVN.c +++ b/src/reducer/validation_DE_SVN.c @@ -47,7 +47,7 @@ q (unsigned int v) * and https://de.wikipedia.org/wiki/Versicherungsnummer * for the structure! * - * @param avh_number ahv number to validate (input) + * @param ssn_number social security number to validate (input) * @return true if validation passed, else false */ bool diff --git a/src/reducer/validation_IN_AADHAR.c b/src/reducer/validation_IN_AADHAR.c index ee38f3f..8ce2bc2 100644 --- a/src/reducer/validation_IN_AADHAR.c +++ b/src/reducer/validation_IN_AADHAR.c @@ -58,7 +58,7 @@ static int p[10][10] = { * Converts a string to a reversed integer array. * * @param input The numeric string data converted to reversed int array. - * @param[out] Integer array containing the digits in the numeric string + * @param[out] output array containing the digits in the numeric string * in reverse order */ static bool diff --git a/src/testing/testing_api_cmd_config.c b/src/testing/testing_api_cmd_config.c index 7ff42c9..cf6979c 100644 --- a/src/testing/testing_api_cmd_config.c +++ b/src/testing/testing_api_cmd_config.c @@ -14,12 +14,11 @@ TALER; see the file COPYING. If not, see */ /** - * @file testing/testing_api_cmd_config.c + * @file anastasis/src/testing/testing_api_cmd_config.c * @brief command to obtain the configuration of an anastasis backend service. * @author Dennis Neufeld * @author Dominik Meister */ - #include "platform.h" #include "anastasis_testing_lib.h" #include @@ -59,7 +58,7 @@ struct ConfigState /** - * Function called with the results of a #ANASTASIS_config(). + * Function called with the results of a #ANASTASIS_get_config(). * * @param cls closure * @param http_status HTTP status of the request @@ -156,7 +155,7 @@ config_cleanup (void *cls, * Offer internal data to other commands. * * @param cls closure - * @param ret[out] result (could be anything) + * @param[out] ret result (could be anything) * @param trait name of the trait * @param index index number of the object to extract. * @return #GNUNET_OK on success diff --git a/src/testing/testing_api_cmd_keyshare_lookup.c b/src/testing/testing_api_cmd_keyshare_lookup.c index efc8c9a..45e1e26 100644 --- a/src/testing/testing_api_cmd_keyshare_lookup.c +++ b/src/testing/testing_api_cmd_keyshare_lookup.c @@ -14,7 +14,7 @@ Anastasis; see the file COPYING.GPL. If not, see */ /** - * @file testing/anastasis_api_keyshare_lookup.c + * @file testing/testing_api_cmd_keyshare_lookup.c * @brief Testing of Implementation of the /truth GET * @author Christian Grothoff * @author Dennis Neufeld diff --git a/src/testing/testing_api_cmd_policy_lookup.c b/src/testing/testing_api_cmd_policy_lookup.c index 0906491..6608d90 100644 --- a/src/testing/testing_api_cmd_policy_lookup.c +++ b/src/testing/testing_api_cmd_policy_lookup.c @@ -69,11 +69,11 @@ struct PolicyLookupState /** - * Function called with the results of a #ANASTASIS_lookup(). + * Function called with the results of a #ANASTASIS_policy_lookup(). * * @param cls closure * @param http_status HTTP status of the request - * @param ud details about the lookup operation + * @param dd details about the lookup operation */ static void policy_lookup_cb (void *cls, @@ -197,16 +197,6 @@ policy_lookup_cleanup (void *cls, } -/** - * Make the "policy lookup" command. - * - * @param label command label - * @param anastasis_url base URL of the ANASTASIS serving - * the policy store request. - * @param http_status expected HTTP status. - * @param upload_ref reference to upload command - * @return the command - */ struct TALER_TESTING_Command ANASTASIS_TESTING_cmd_policy_lookup (const char *label, const char *anastasis_url, @@ -233,14 +223,6 @@ ANASTASIS_TESTING_cmd_policy_lookup (const char *label, } -/** - * Make the "policy lookup" command for a non-existent upload. - * - * @param label command label - * @param anastasis_url base URL of the ANASTASIS serving - * the policy lookup request. - * @return the command - */ struct TALER_TESTING_Command ANASTASIS_TESTING_cmd_policy_nx (const char *label, const char *anastasis_url) diff --git a/src/testing/testing_api_cmd_policy_store.c b/src/testing/testing_api_cmd_policy_store.c index d5062c0..9f4a80a 100644 --- a/src/testing/testing_api_cmd_policy_store.c +++ b/src/testing/testing_api_cmd_policy_store.c @@ -125,10 +125,9 @@ struct PolicyStoreState }; /** - * Function called with the results of a #policy_store(). + * Function called with the results of an #ANASTASIS_policy_store() operation. * * @param cls closure - * @param http_status HTTP status of the request * @param ud details about the upload operation */ static void diff --git a/src/testing/testing_api_cmd_truth_store.c b/src/testing/testing_api_cmd_truth_store.c index 40c4d32..816a285 100644 --- a/src/testing/testing_api_cmd_truth_store.c +++ b/src/testing/testing_api_cmd_truth_store.c @@ -112,11 +112,10 @@ struct TruthStoreState }; /** - * Function called with the results of a #truth_store(). + * Function called with the results of an #ANASTASIS_truth_store() + * operation. * * @param cls closure - * @param ec ANASTASIS error code - * @param http_status HTTP status of the request * @param ud details about the upload operation */ static void diff --git a/src/testing/testing_api_helpers.c b/src/testing/testing_api_helpers.c index fb3cb48..e64f506 100644 --- a/src/testing/testing_api_helpers.c +++ b/src/testing/testing_api_helpers.c @@ -18,7 +18,7 @@ */ /** - * @file testing/testing_api_helpers.c + * @file anastasis/src/testing/testing_api_helpers.c * @brief helper functions for test library. * @author Christian Grothoff * @author Marcello Stanisci diff --git a/src/testing/testing_api_trait_account_priv.c b/src/testing/testing_api_trait_account_priv.c index a40e9d2..a666f7a 100644 --- a/src/testing/testing_api_trait_account_priv.c +++ b/src/testing/testing_api_trait_account_priv.c @@ -27,17 +27,9 @@ #define ANASTASIS_TESTING_TRAIT_ACCOUNT_PRIV "anastasis-account_priv" -/** - * Obtain an account private key from @a cmd. - * - * @param cmd command to extract the private key from. - * @param index the private key's index number. - * @param n[out] set to the private key coming from @a cmd. - * @return #GNUNET_OK on success. - */ int -ANASTASIS_TESTING_get_trait_account_priv - (const struct TALER_TESTING_Command *cmd, +ANASTASIS_TESTING_get_trait_account_priv ( + const struct TALER_TESTING_Command *cmd, unsigned int index, const struct ANASTASIS_CRYPTO_AccountPrivateKeyP **priv) { @@ -48,16 +40,9 @@ ANASTASIS_TESTING_get_trait_account_priv } -/** - * Offer an account private key. - * - * @param index usually zero - * @param priv the account_priv to offer. - * @return #GNUNET_OK on success. - */ struct TALER_TESTING_Trait -ANASTASIS_TESTING_make_trait_account_priv - (unsigned int index, +ANASTASIS_TESTING_make_trait_account_priv ( + unsigned int index, const struct ANASTASIS_CRYPTO_AccountPrivateKeyP *priv) { struct TALER_TESTING_Trait ret = { @@ -65,6 +50,7 @@ ANASTASIS_TESTING_make_trait_account_priv .trait_name = ANASTASIS_TESTING_TRAIT_ACCOUNT_PRIV, .ptr = (const void *) priv }; + return ret; } diff --git a/src/testing/testing_api_trait_account_pub.c b/src/testing/testing_api_trait_account_pub.c index 19ba79f..9a6a45a 100644 --- a/src/testing/testing_api_trait_account_pub.c +++ b/src/testing/testing_api_trait_account_pub.c @@ -27,17 +27,9 @@ #define ANASTASIS_TESTING_TRAIT_ACCOUNT_PUB "anastasis-account_pub" -/** - * Obtain an account public key from @a cmd. - * - * @param cmd command to extract the public key from. - * @param index the public key's index number. - * @param n[out] set to the public key coming from @a cmd. - * @return #GNUNET_OK on success. - */ int -ANASTASIS_TESTING_get_trait_account_pub - (const struct TALER_TESTING_Command *cmd, +ANASTASIS_TESTING_get_trait_account_pub ( + const struct TALER_TESTING_Command *cmd, unsigned int index, const struct ANASTASIS_CRYPTO_AccountPublicKeyP **pub) { @@ -48,16 +40,9 @@ ANASTASIS_TESTING_get_trait_account_pub } -/** - * Offer an account public key. - * - * @param index usually zero - * @param h the account_pub to offer. - * @return #GNUNET_OK on success. - */ struct TALER_TESTING_Trait -ANASTASIS_TESTING_make_trait_account_pub - (unsigned int index, +ANASTASIS_TESTING_make_trait_account_pub ( + unsigned int index, const struct ANASTASIS_CRYPTO_AccountPublicKeyP *h) { struct TALER_TESTING_Trait ret = { @@ -65,6 +50,7 @@ ANASTASIS_TESTING_make_trait_account_pub .trait_name = ANASTASIS_TESTING_TRAIT_ACCOUNT_PUB, .ptr = (const void *) h }; + return ret; } diff --git a/src/testing/testing_api_trait_code.c b/src/testing/testing_api_trait_code.c index 9989dec..5892065 100644 --- a/src/testing/testing_api_trait_code.c +++ b/src/testing/testing_api_trait_code.c @@ -17,7 +17,7 @@ */ /** - * @file testing/testing_api_trait_string.c + * @file testing/testing_api_trait_code.c * @brief traits to offers a code for a challenge * @author Dominik Meister * @author Christian Grothoff @@ -28,17 +28,9 @@ #define ANASTASIS_TESTING_TRAIT_CODE "anastasis-code" -/** - * Obtain a code from @a cmd. - * - * @param cmd command to extract the number from. - * @param index the number's index number. - * @param n[out] set to the number coming from @a cmd. - * @return #GNUNET_OK on success. - */ int -ANASTASIS_TESTING_get_trait_code - (const struct TALER_TESTING_Command *cmd, +ANASTASIS_TESTING_get_trait_code ( + const struct TALER_TESTING_Command *cmd, unsigned int index, const char **code) { @@ -49,16 +41,9 @@ ANASTASIS_TESTING_get_trait_code } -/** - * Offer a code. - * - * @param index the number's index number. - * @param code the code to offer. - * @return #GNUNET_OK on success. - */ struct TALER_TESTING_Trait -ANASTASIS_TESTING_make_trait_code - (unsigned int index, +ANASTASIS_TESTING_make_trait_code ( + unsigned int index, const char *code) { struct TALER_TESTING_Trait ret = { @@ -66,8 +51,9 @@ ANASTASIS_TESTING_make_trait_code .trait_name = ANASTASIS_TESTING_TRAIT_CODE, .ptr = (const void *) code }; + return ret; } -/* end of testing_api_trait_string.c */ +/* end of testing_api_trait_code.c */ diff --git a/src/testing/testing_api_trait_eks.c b/src/testing/testing_api_trait_eks.c index f374433..1c19233 100644 --- a/src/testing/testing_api_trait_eks.c +++ b/src/testing/testing_api_trait_eks.c @@ -29,8 +29,8 @@ int -ANASTASIS_TESTING_get_trait_eks - (const struct TALER_TESTING_Command *cmd, +ANASTASIS_TESTING_get_trait_eks ( + const struct TALER_TESTING_Command *cmd, unsigned int index, const struct ANASTASIS_CRYPTO_EncryptedKeyShareP **eks) { @@ -42,8 +42,8 @@ ANASTASIS_TESTING_get_trait_eks struct TALER_TESTING_Trait -ANASTASIS_TESTING_make_trait_eks - (unsigned int index, +ANASTASIS_TESTING_make_trait_eks ( + unsigned int index, const struct ANASTASIS_CRYPTO_EncryptedKeyShareP *eks) { struct TALER_TESTING_Trait ret = { diff --git a/src/testing/testing_api_trait_hash.c b/src/testing/testing_api_trait_hash.c index fb5015e..5f3a1a0 100644 --- a/src/testing/testing_api_trait_hash.c +++ b/src/testing/testing_api_trait_hash.c @@ -17,7 +17,7 @@ */ /** - * @file testing/testing_api_trait_hash.c + * @file anastasis/src/testing/testing_api_trait_hash.c * @brief traits to offer a hash * @author Christian Grothoff */ -- cgit v1.2.3