challenger

OAuth 2.0-based authentication service that validates user can receive messages at a certain address
Log | Files | Refs | Submodules | README | LICENSE

validate_solve_pin.h (2509B)


      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/validate_solve_pin.h
     18  * @brief implementation of the validate_solve_pin function for Postgres
     19  * @author Christian Grothoff
     20  */
     21 #ifndef CHALLENGER_DATABASE_VALIDATE_SOLVE_PIN_H
     22 #define CHALLENGER_DATABASE_VALIDATE_SOLVE_PIN_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 PIN 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 PIN the user entered
     36  * @param[out] solved set to true if the PIN was correct
     37  * @param[out] exhausted set to true if the number of attempts to enter the correct PIN has been exhausted
     38  * @param[out] no_challenge set to true if we never even issued a challenge
     39  * @param[out] state set to client's OAuth2 state if available
     40  * @param[out] addr_left set to number of address changes remaining
     41  * @param[out] auth_attempts_left set to number of authentication attempts remaining
     42  * @param[out] pin_transmissions_left set to number of times the PIN can still be re-requested
     43  * @param[out] client_redirect_uri set to OAuth2 client redirect URI
     44  * @return transaction status:
     45  *   #GNUNET_DB_STATUS_SUCCESS_ONE_RESULT if the nonce was found
     46  *   #GNUNET_DB_STATUS_SUCCESS_NO_RESULTS if we do not know the nonce
     47  *   #GNUNET_DB_STATUS_HARD_ERROR on failure
     48  */
     49 enum GNUNET_DB_QueryStatus
     50 CHALLENGERDB_validate_solve_pin (
     51   struct CHALLENGERDB_PostgresContext *ctx,
     52   const struct CHALLENGER_ValidationNonceP *nonce,
     53   uint32_t new_pin,
     54   bool *solved,
     55   bool *exhausted,
     56   bool *no_challenge,
     57   char **state,
     58   uint32_t *addr_left,
     59   uint32_t *auth_attempts_left,
     60   uint32_t *pin_transmissions_left,
     61   char **client_redirect_uri);
     62 
     63 
     64 #endif