path: root/src/lib/exchange_api_purse_create_with_merge.c

/*
   This file is part of TALER
   Copyright (C) 2022-2023 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 lib/exchange_api_purse_create_with_merge.c
 * @brief Implementation of the client to create a
 *        purse for an account
 * @author Christian Grothoff
 */
#include "platform.h"
#include <jansson.h>
#include <microhttpd.h> /* just for HTTP status codes */
#include <gnunet/gnunet_util_lib.h>
#include <gnunet/gnunet_json_lib.h>
#include <gnunet/gnunet_curl_lib.h>
#include "taler_json_lib.h"
#include "taler_exchange_service.h"
#include "exchange_api_handle.h"
#include "exchange_api_common.h"
#include "taler_signatures.h"
#include "exchange_api_curl_defaults.h"


/**
 * @brief A purse create with merge handle
 */
struct TALER_EXCHANGE_PurseCreateMergeHandle
{

  /**
   * The keys of the exchange this request handle will use
   */
  struct TALER_EXCHANGE_Keys *keys;

  /**
   * The url for this request.
   */
  char *url;

  /**
   * The exchange base URL.
   */
  char *exchange_url;

  /**
   * Context for #TEH_curl_easy_post(). Keeps the data that must
   * persist for Curl to make the upload.
   */
  struct TALER_CURL_PostContext ctx;

  /**
   * Handle for the request.
   */
  struct GNUNET_CURL_Job *job;

  /**
   * Function to call with the result.
   */
  TALER_EXCHANGE_PurseCreateMergeCallback cb;

  /**
   * Closure for @a cb.
   */
  void *cb_cls;

  /**
   * The encrypted contract (if any).
   */
  struct TALER_EncryptedContract econtract;

  /**
   * Expected value in the purse after fees.
   */
  struct TALER_Amount purse_value_after_fees;

  /**
   * Public key of the reserve public key.
   */
  struct TALER_ReservePublicKeyP reserve_pub;

  /**
   * Reserve signature affirming our merge.
   */
  struct TALER_ReserveSignatureP reserve_sig;

  /**
   * Merge capability key.
   */
  struct TALER_PurseMergePublicKeyP merge_pub;

  /**
   * Our merge signature (if any).
   */
  struct TALER_PurseMergeSignatureP merge_sig;

  /**
   * Public key of the purse.
   */
  struct TALER_PurseContractPublicKeyP purse_pub;

  /**
   * Request data we signed over.
   */
  struct TALER_PurseContractSignatureP purse_sig;

  /**
   * Hash over the purse's contrac terms.
   */
  struct TALER_PrivateContractHashP h_contract_terms;

  /**
   * When does the purse expire.
   */
  struct GNUNET_TIME_Timestamp purse_expiration;

  /**
   * When does the purse get merged/created.
   */
  struct GNUNET_TIME_Timestamp merge_timestamp;
};


/**
 * Function called when we're done processing the
 * HTTP /reserves/$RID/purse request.
 *
 * @param cls the `struct TALER_EXCHANGE_PurseCreateMergeHandle`
 * @param response_code HTTP response code, 0 on error
 * @param response parsed JSON result, NULL on error
 */
static void
handle_purse_create_with_merge_finished (void *cls,
                                         long response_code,
                                         const void *response)
{
  struct TALER_EXCHANGE_PurseCreateMergeHandle *pcm = cls;
  const json_t *j = response;
  struct TALER_EXCHANGE_PurseCreateMergeResponse dr = {
    .hr.reply = j,
    .hr.http_status = (unsigned int) response_code,
    .reserve_sig = &pcm->reserve_sig
  };

  pcm->job = NULL;
  switch (response_code)
  {
  case 0:
    dr.hr.ec = TALER_EC_GENERIC_INVALID_RESPONSE;
    break;
  case MHD_HTTP_OK:
    {
      struct GNUNET_TIME_Timestamp etime;
      struct TALER_Amount total_deposited;
      struct TALER_ExchangeSignatureP exchange_sig;
      struct TALER_ExchangePublicKeyP exchange_pub;
      struct GNUNET_JSON_Specification spec[] = {
        TALER_JSON_spec_amount_any ("total_deposited",
                                    &total_deposited),
        GNUNET_JSON_spec_fixed_auto ("exchange_sig",
                                     &exchange_sig),
        GNUNET_JSON_spec_fixed_auto ("exchange_pub",
                                     &exchange_pub),
        GNUNET_JSON_spec_timestamp ("exchange_timestamp",
                                    &etime),
        GNUNET_JSON_spec_end ()
      };

      if (GNUNET_OK !=
          GNUNET_JSON_parse (j,
                             spec,
                             NULL, NULL))
      {
        GNUNET_break_op (0);
        dr.hr.http_status = 0;
        dr.hr.ec = TALER_EC_GENERIC_REPLY_MALFORMED;
        break;
      }
      if (GNUNET_OK !=
          TALER_EXCHANGE_test_signing_key (pcm->keys,
                                           &exchange_pub))
      {
        GNUNET_break_op (0);
        dr.hr.http_status = 0;
        dr.hr.ec = TALER_EC_GENERIC_REPLY_MALFORMED;
        break;
      }
      if (GNUNET_OK !=
          TALER_exchange_online_purse_created_verify (
            etime,
            pcm->purse_expiration,
            &pcm->purse_value_after_fees,
            &total_deposited,
            &pcm->purse_pub,
            &pcm->h_contract_terms,
            &exchange_pub,
            &exchange_sig))
      {
        GNUNET_break_op (0);
        dr.hr.http_status = 0;
        dr.hr.ec = TALER_EC_GENERIC_REPLY_MALFORMED;
        break;
      }
    }
    break;
  case MHD_HTTP_BAD_REQUEST:
    /* This should never happen, either us or the exchange is buggy
       (or API version conflict); just pass JSON reply to the application */
    dr.hr.ec = TALER_JSON_get_error_code (j);
    dr.hr.hint = TALER_JSON_get_error_hint (j);
    break;
  case MHD_HTTP_FORBIDDEN:
    dr.hr.ec = TALER_JSON_get_error_code (j);
    dr.hr.hint = TALER_JSON_get_error_hint (j);
    /* Nothing really to verify, exchange says one of the signatures is
       invalid; as we checked them, this should never happen, we
       should pass the JSON reply to the application */
    break;
  case MHD_HTTP_NOT_FOUND:
    dr.hr.ec = TALER_JSON_get_error_code (j);
    dr.hr.hint = TALER_JSON_get_error_hint (j);
    /* Nothing really to verify, this should never
       happen, we should pass the JSON reply to the application */
    break;
  case MHD_HTTP_CONFLICT:
    dr.hr.ec = TALER_JSON_get_error_code (j);
    switch (dr.hr.ec)
    {
    case TALER_EC_EXCHANGE_RESERVES_PURSE_CREATE_CONFLICTING_META_DATA:
      if (GNUNET_OK !=
          TALER_EXCHANGE_check_purse_create_conflict_ (
            &pcm->purse_sig,
            &pcm->purse_pub,
            j))
      {
        dr.hr.http_status = 0;
        dr.hr.ec = TALER_EC_GENERIC_REPLY_MALFORMED;
        break;
      }
      break;
    case TALER_EC_EXCHANGE_RESERVES_PURSE_MERGE_CONFLICTING_META_DATA:
      if (GNUNET_OK !=
          TALER_EXCHANGE_check_purse_merge_conflict_ (
            &pcm->merge_sig,
            &pcm->merge_pub,
            &pcm->purse_pub,
            pcm->exchange_url,
            j))
      {
        GNUNET_break_op (0);
        dr.hr.http_status = 0;
        dr.hr.ec = TALER_EC_GENERIC_REPLY_MALFORMED;
        break;
      }
      break;
    case TALER_EC_EXCHANGE_RESERVES_PURSE_CREATE_INSUFFICIENT_FUNDS:
      /* nothing to verify */
      break;
    case TALER_EC_EXCHANGE_PURSE_ECONTRACT_CONFLICTING_META_DATA:
      if (GNUNET_OK !=
          TALER_EXCHANGE_check_purse_econtract_conflict_ (
            &pcm->econtract.econtract_sig,
            &pcm->purse_pub,
            j))
      {
        GNUNET_break_op (0);
        dr.hr.http_status = 0;
        dr.hr.ec = TALER_EC_GENERIC_REPLY_MALFORMED;
        break;
      }
      break;
    default:
      /* unexpected EC! */
      GNUNET_break_op (0);
      dr.hr.http_status = 0;
      dr.hr.ec = TALER_EC_GENERIC_REPLY_MALFORMED;
      break;
    } /* end inner (EC) switch */
    break;
  case MHD_HTTP_GONE:
    /* could happen if denomination was revoked */
    /* Note: one might want to check /keys for revocation
       signature here, alas tricky in case our /keys
       is outdated => left to clients */
    dr.hr.ec = TALER_JSON_get_error_code (j);
    dr.hr.hint = TALER_JSON_get_error_hint (j);
    break;
  case MHD_HTTP_UNAVAILABLE_FOR_LEGAL_REASONS:
    {
      struct GNUNET_JSON_Specification spec[] = {
        GNUNET_JSON_spec_uint64 (
          "requirement_row",
          &dr.details.unavailable_for_legal_reasons.requirement_row),
        GNUNET_JSON_spec_end ()
      };

      if (GNUNET_OK !=
          GNUNET_JSON_parse (j,
                             spec,
                             NULL, NULL))
      {
        GNUNET_break_op (0);
        dr.hr.http_status = 0;
        dr.hr.ec = TALER_EC_GENERIC_REPLY_MALFORMED;
        break;
      }
    }
    break;
  case MHD_HTTP_INTERNAL_SERVER_ERROR:
    dr.hr.ec = TALER_JSON_get_error_code (j);
    dr.hr.hint = TALER_JSON_get_error_hint (j);
    /* Server had an internal issue; we should retry, but this API
       leaves this to the application */
    break;
  default:
    /* unexpected response code */
    dr.hr.ec = TALER_JSON_get_error_code (j);
    dr.hr.hint = TALER_JSON_get_error_hint (j);
    GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
                "Unexpected response code %u/%d for exchange deposit\n",
                (unsigned int) response_code,
                dr.hr.ec);
    GNUNET_break_op (0);
    break;
  }
  pcm->cb (pcm->cb_cls,
           &dr);
  TALER_EXCHANGE_purse_create_with_merge_cancel (pcm);
}


struct TALER_EXCHANGE_PurseCreateMergeHandle *
TALER_EXCHANGE_purse_create_with_merge (
  struct GNUNET_CURL_Context *ctx,
  const char *url,
  struct TALER_EXCHANGE_Keys *keys,
  const struct TALER_ReservePrivateKeyP *reserve_priv,
  const struct TALER_PurseContractPrivateKeyP *purse_priv,
  const struct TALER_PurseMergePrivateKeyP *merge_priv,
  const struct TALER_ContractDiffiePrivateP *contract_priv,
  const json_t *contract_terms,
  bool upload_contract,
  bool pay_for_purse,
  struct GNUNET_TIME_Timestamp merge_timestamp,
  TALER_EXCHANGE_PurseCreateMergeCallback cb,
  void *cb_cls)
{
  struct TALER_EXCHANGE_PurseCreateMergeHandle *pcm;
  json_t *create_with_merge_obj;
  CURL *eh;
  char arg_str[sizeof (pcm->reserve_pub) * 2 + 32];
  uint32_t min_age = 0;
  struct TALER_Amount purse_fee;
  enum TALER_WalletAccountMergeFlags flags;

  pcm = GNUNET_new (struct TALER_EXCHANGE_PurseCreateMergeHandle);
  pcm->cb = cb;
  pcm->cb_cls = cb_cls;
  if (GNUNET_OK !=
      TALER_JSON_contract_hash (contract_terms,
                                &pcm->h_contract_terms))
  {
    GNUNET_break (0);
    GNUNET_free (pcm);
    return NULL;
  }
  pcm->merge_timestamp = merge_timestamp;
  GNUNET_CRYPTO_eddsa_key_get_public (&purse_priv->eddsa_priv,
                                      &pcm->purse_pub.eddsa_pub);
  GNUNET_CRYPTO_eddsa_key_get_public (&reserve_priv->eddsa_priv,
                                      &pcm->reserve_pub.eddsa_pub);
  GNUNET_CRYPTO_eddsa_key_get_public (&merge_priv->eddsa_priv,
                                      &pcm->merge_pub.eddsa_pub);

  {
    struct GNUNET_JSON_Specification spec[] = {
      TALER_JSON_spec_amount_any ("amount",
                                  &pcm->purse_value_after_fees),
      GNUNET_JSON_spec_mark_optional (
        GNUNET_JSON_spec_uint32 ("minimum_age",
                                 &min_age),
        NULL),
      GNUNET_JSON_spec_timestamp ("pay_deadline",
                                  &pcm->purse_expiration),
      GNUNET_JSON_spec_end ()
    };

    if (GNUNET_OK !=
        GNUNET_JSON_parse (contract_terms,
                           spec,
                           NULL, NULL))
    {
      GNUNET_break (0);
      GNUNET_free (pcm);
      return NULL;
    }
  }
  if (pay_for_purse)
  {
    const struct TALER_EXCHANGE_GlobalFee *gf;

    gf = TALER_EXCHANGE_get_global_fee (
      keys,
      GNUNET_TIME_timestamp_get ());
    purse_fee = gf->fees.purse;
    flags = TALER_WAMF_MODE_CREATE_WITH_PURSE_FEE;
  }
  else
  {
    GNUNET_assert (GNUNET_OK ==
                   TALER_amount_set_zero (pcm->purse_value_after_fees.currency,
                                          &purse_fee));
    flags = TALER_WAMF_MODE_CREATE_FROM_PURSE_QUOTA;
  }

  {
    char pub_str[sizeof (pcm->reserve_pub) * 2];
    char *end;

    end = GNUNET_STRINGS_data_to_string (
      &pcm->reserve_pub,
      sizeof (pcm->reserve_pub),
      pub_str,
      sizeof (pub_str));
    *end = '\0';
    GNUNET_snprintf (arg_str,
                     sizeof (arg_str),
                     "reserves/%s/purse",
                     pub_str);
  }
  pcm->url = TALER_url_join (url,
                             arg_str,
                             NULL);
  if (NULL == pcm->url)
  {
    GNUNET_break (0);
    GNUNET_free (pcm);
    return NULL;
  }
  TALER_wallet_purse_create_sign (pcm->purse_expiration,
                                  &pcm->h_contract_terms,
                                  &pcm->merge_pub,
                                  min_age,
                                  &pcm->purse_value_after_fees,
                                  purse_priv,
                                  &pcm->purse_sig);
  {
    char *payto_uri;

    payto_uri = TALER_reserve_make_payto (url,
                                          &pcm->reserve_pub);
    TALER_wallet_purse_merge_sign (payto_uri,
                                   merge_timestamp,
                                   &pcm->purse_pub,
                                   merge_priv,
                                   &pcm->merge_sig);
    GNUNET_free (payto_uri);
  }
  TALER_wallet_account_merge_sign (merge_timestamp,
                                   &pcm->purse_pub,
                                   pcm->purse_expiration,
                                   &pcm->h_contract_terms,
                                   &pcm->purse_value_after_fees,
                                   &purse_fee,
                                   min_age,
                                   flags,
                                   reserve_priv,
                                   &pcm->reserve_sig);
  if (upload_contract)
  {
    TALER_CRYPTO_contract_encrypt_for_deposit (
      &pcm->purse_pub,
      contract_priv,
      contract_terms,
      &pcm->econtract.econtract,
      &pcm->econtract.econtract_size);
    GNUNET_CRYPTO_ecdhe_key_get_public (&contract_priv->ecdhe_priv,
                                        &pcm->econtract.contract_pub.ecdhe_pub);
    TALER_wallet_econtract_upload_sign (
      pcm->econtract.econtract,
      pcm->econtract.econtract_size,
      &pcm->econtract.contract_pub,
      purse_priv,
      &pcm->econtract.econtract_sig);
  }
  create_with_merge_obj = GNUNET_JSON_PACK (
    TALER_JSON_pack_amount ("purse_value",
                            &pcm->purse_value_after_fees),
    GNUNET_JSON_pack_uint64 ("min_age",
                             min_age),
    GNUNET_JSON_pack_allow_null (
      TALER_JSON_pack_econtract ("econtract",
                                 upload_contract
                                 ? &pcm->econtract
                                 : NULL)),
    GNUNET_JSON_pack_allow_null (
      pay_for_purse
      ? TALER_JSON_pack_amount ("purse_fee",
                                &purse_fee)
      : GNUNET_JSON_pack_string ("dummy2",
                                 NULL)),
    GNUNET_JSON_pack_data_auto ("merge_pub",
                                &pcm->merge_pub),
    GNUNET_JSON_pack_data_auto ("merge_sig",
                                &pcm->merge_sig),
    GNUNET_JSON_pack_data_auto ("reserve_sig",
                                &pcm->reserve_sig),
    GNUNET_JSON_pack_data_auto ("purse_pub",
                                &pcm->purse_pub),
    GNUNET_JSON_pack_data_auto ("purse_sig",
                                &pcm->purse_sig),
    GNUNET_JSON_pack_data_auto ("h_contract_terms",
                                &pcm->h_contract_terms),
    GNUNET_JSON_pack_timestamp ("merge_timestamp",
                                merge_timestamp),
    GNUNET_JSON_pack_timestamp ("purse_expiration",
                                pcm->purse_expiration));
  GNUNET_assert (NULL != create_with_merge_obj);
  eh = TALER_EXCHANGE_curl_easy_get_ (pcm->url);
  if ( (NULL == eh) ||
       (GNUNET_OK !=
        TALER_curl_easy_post (&pcm->ctx,
                              eh,
                              create_with_merge_obj)) )
  {
    GNUNET_break (0);
    if (NULL != eh)
      curl_easy_cleanup (eh);
    json_decref (create_with_merge_obj);
    GNUNET_free (pcm->econtract.econtract);
    GNUNET_free (pcm->url);
    GNUNET_free (pcm);
    return NULL;
  }
  json_decref (create_with_merge_obj);
  GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
              "URL for purse create_with_merge: `%s'\n",
              pcm->url);
  pcm->keys = TALER_EXCHANGE_keys_incref (keys);
  pcm->exchange_url = GNUNET_strdup (url);
  pcm->job = GNUNET_CURL_job_add2 (ctx,
                                   eh,
                                   pcm->ctx.headers,
                                   &handle_purse_create_with_merge_finished,
                                   pcm);
  return pcm;
}


void
TALER_EXCHANGE_purse_create_with_merge_cancel (
  struct TALER_EXCHANGE_PurseCreateMergeHandle *pcm)
{
  if (NULL != pcm->job)
  {
    GNUNET_CURL_job_cancel (pcm->job);
    pcm->job = NULL;
  }
  GNUNET_free (pcm->url);
  GNUNET_free (pcm->exchange_url);
  TALER_curl_easy_post_finished (&pcm->ctx);
  TALER_EXCHANGE_keys_decref (pcm->keys);
  GNUNET_free (pcm->econtract.econtract);
  GNUNET_free (pcm);
}


/* end of exchange_api_purse_create_with_merge.c */