do_solve_challenge.h (2932B)
1 /* 2 This file is part of Challenger 3 Copyright (C) 2023 Taler Systems SA 4 5 Challenger is free software; you can redistribute it and/or modify it under the 6 terms of the GNU General Public License as published by the Free Software 7 Foundation; either version 3, or (at your option) any later version. 8 9 Challenger is distributed in the hope that it will be useful, but WITHOUT ANY 10 WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR 11 A PARTICULAR PURPOSE. See the GNU General Public License for more details. 12 13 You should have received a copy of the GNU General Public License along with 14 Challenger; see the file COPYING. If not, see <http://www.gnu.org/licenses/> 15 */ 16 /** 17 * @file src/include/challenger-database/do_solve_challenge.h 18 * @brief implementation of the do_solve_challenge function for Postgres 19 * @author Christian Grothoff 20 */ 21 #ifndef CHALLENGER_DATABASE_DO_SOLVE_CHALLENGE_H 22 #define CHALLENGER_DATABASE_DO_SOLVE_CHALLENGE_H 23 24 #include <taler/taler_util.h> 25 #include <taler/taler_json_lib.h> 26 #include "challenger_util.h" 27 #include "challenger_database_lib.h" 28 29 30 /** 31 * Check TAN entered to validate an address. 32 * 33 * @param cls 34 * @param nonce unique nonce to use to identify the validation 35 * @param new_pin the TAN the user entered 36 * @param[out] solved set to true if the TAN was correct 37 * @param[out] exhausted set to true if the number of attempts to enter the correct TAN was exhausted before this call and @a new_pin was not evaluated 38 * @param[out] no_challenge set to true if we never even issued a challenge 39 * @param[out] failed set to true if the validation failed permanently: no 40 * address change, TAN transmission or TAN attempt is left, so it can 41 * never succeed anymore 42 * @param[out] state set to client's OAuth2 state if available 43 * @param[out] addr_left set to number of address changes remaining 44 * @param[out] auth_attempts_left set to number of authentication attempts 45 * remaining; only meaningful when @a solved is false (on the solved 46 * path the stored procedure uses a -1 sentinel, which is normalized 47 * to 0 here) 48 * @param[out] pin_transmissions_left set to number of times the TAN can still be re-requested 49 * @param[out] client_redirect_uri set to OAuth2 client redirect URI 50 * @return transaction status: 51 * #GNUNET_DB_STATUS_SUCCESS_ONE_RESULT if the nonce was found 52 * #GNUNET_DB_STATUS_SUCCESS_NO_RESULTS if we do not know the nonce 53 * #GNUNET_DB_STATUS_HARD_ERROR on failure 54 */ 55 enum GNUNET_DB_QueryStatus 56 CHALLENGERDB_do_solve_challenge ( 57 struct CHALLENGERDB_PostgresContext *ctx, 58 const struct CHALLENGER_ValidationNonceP *nonce, 59 uint32_t new_pin, 60 bool *solved, 61 bool *exhausted, 62 bool *no_challenge, 63 bool *failed, 64 char **state, 65 uint32_t *addr_left, 66 uint32_t *auth_attempts_left, 67 uint32_t *pin_transmissions_left, 68 char **client_redirect_uri); 69 70 71 #endif