/*
   This file is part of TALER
   Copyright (C) 2022 Taler Systems SA

   TALER is free software; you can redistribute it and/or modify it under the
   terms of the GNU General Public License as published by the Free Software
   Foundation; either version 3, or (at your option) any later version.

   TALER 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
   TALER; see the file COPYING.  If not, see <http://www.gnu.org/licenses/>
 */
/**
 * @file src/include/exchange-database/iterate_active_signkeys.h
 * @brief implementation of the iterate_active_signkeys function for Postgres
 * @author Christian Grothoff
 */
#ifndef EXCHANGE_DATABASE_ITERATE_ACTIVE_SIGNKEYS_H
#define EXCHANGE_DATABASE_ITERATE_ACTIVE_SIGNKEYS_H

#include "taler/taler_json_lib.h"
#include "exchangedb_lib.h"


/**
 * Signature of a function called with information about the exchange's
 * online signing keys.
 *
 * @param cls closure with a `struct TEH_KeyStateHandle *`
 * @param exchange_pub public key of the exchange
 * @param meta meta data information about the signing type (expirations)
 * @param master_sig master signature affirming the validity of this denomination
 */
#ifndef TALER_EXCHANGEDB_ACTIVE_SIGNKEYS_RESULT_CLOSURE
/**
 * Type of the closure for #TALER_EXCHANGEDB_ActiveSignkeysCallback.
 */
#define TALER_EXCHANGEDB_ACTIVE_SIGNKEYS_RESULT_CLOSURE void
#endif
typedef void
(*TALER_EXCHANGEDB_ActiveSignkeysCallback)(
  TALER_EXCHANGEDB_ACTIVE_SIGNKEYS_RESULT_CLOSURE *cls,
  const struct TALER_ExchangePublicKeyP *exchange_pub,
  const struct TALER_EXCHANGEDB_SignkeyMetaData *meta,
  const struct TALER_MasterSignatureP *master_sig);


/* Callback typedefs */
/**
 * Signature of a function called with information about the exchange's
 * online signing keys.
 *
 * @param cls closure with a `struct TEH_KeyStateHandle *`
 * @param exchange_pub public key of the exchange
 * @param meta meta data information about the signing type (expirations)
 * @param master_sig master signature affirming the validity of this denomination
 */
typedef void
(*TALER_EXCHANGEDB_ActiveSignkeysCallback)(
  TALER_EXCHANGEDB_ACTIVE_SIGNKEYS_RESULT_CLOSURE *cls,
  const struct TALER_ExchangePublicKeyP *exchange_pub,
  const struct TALER_EXCHANGEDB_SignkeyMetaData *meta,
  const struct TALER_MasterSignatureP *master_sig);

/**
 * Function called to invoke @a cb on every non-revoked exchange signing key
 * that has been signed by the master key.  Revoked and (for signing!)
 * expired keys are skipped. Runs in its own read-only transaction.
 *
 * @param pg the database context
 * @param cb function to call on each signing key
 * @param cb_cls closure for @a cb
 * @return transaction status code
 */
enum GNUNET_DB_QueryStatus
TALER_EXCHANGEDB_iterate_active_signkeys (struct
                                          TALER_EXCHANGEDB_PostgresContext *pg,
                                          TALER_EXCHANGEDB_ActiveSignkeysCallback
                                          cb,
                                          TALER_EXCHANGEDB_ACTIVE_SIGNKEYS_RESULT_CLOSURE
                                          *cb_cls);

#endif
