get_validation_pkce.h (2843B)
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/get_validation_pkce.h 18 * @brief implementation of the get_validation_pkce function for Postgres 19 * @author Bohdan Potuzhnyi 20 * @author Vlada Svirsh 21 */ 22 #ifndef CHALLENGER_DATABASE_GET_VALIDATION_PKCE_H 23 #define CHALLENGER_DATABASE_GET_VALIDATION_PKCE_H 24 25 #include <taler/taler_util.h> 26 #include <taler/taler_json_lib.h> 27 #include "challenger_util.h" 28 #include "challenger_database_lib.h" 29 30 31 /** 32 * Return validation details. Used by the ``/token`` endpoint to check the 33 * authorization code and the PKCE binding before minting an access token. 34 * 35 * Only returns validations that were actually *solved* (the user entered the 36 * correct PIN); an unsolved, expired or foreign validation is reported as 37 * #GNUNET_DB_STATUS_SUCCESS_NO_RESULTS. The predicate must stay in sync with 38 * the one in CHALLENGERDB_do_insert_token(). 39 * 40 * @param cls 41 * @param nonce unique nonce to use to identify the validation 42 * @param client_id serial id of the authenticated client redeeming the code 43 * @param[out] client_secret set to secret of client (for client that setup the challenge) 44 * @param[out] address set to client-provided address 45 * @param[out] client_scope set to OAuth2 scope 46 * @param[out] client_state set to client state 47 * @param[out] client_redirect_uri set to client redirect URL 48 * @param[out] code_challenge set to PKCE code challenge 49 * @param[out] code_challenge_method set to PKCE code challenge method enum 50 * @return transaction status: 51 * #GNUNET_DB_STATUS_SUCCESS_ONE_RESULT if the nonce was found and solved 52 * #GNUNET_DB_STATUS_SUCCESS_NO_RESULTS if we do not know the nonce, it 53 * expired, it belongs to another client or it was never solved 54 * #GNUNET_DB_STATUS_HARD_ERROR on failure 55 */ 56 enum GNUNET_DB_QueryStatus 57 CHALLENGERDB_get_validation_pkce ( 58 struct CHALLENGERDB_PostgresContext *ctx, 59 const struct CHALLENGER_ValidationNonceP *nonce, 60 uint64_t client_id, 61 char **client_secret, 62 json_t **address, 63 char **client_scope, 64 char **client_state, 65 char **client_redirect_uri, 66 char **code_challenge, 67 uint32_t *code_challenge_method); 68 69 #endif