sync

testing_api_cmd_block_common.h (6190B)

---

 /*
   This file is part of SYNC
   Copyright (C) 2014-2026 Taler Systems SA
 
   SYNC 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.
 
   SYNC 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 SYNC; see the file COPYING.  If not, see
   <http://www.gnu.org/licenses/>
 */
 /**
  * @file testing/testing_api_cmd_block_common.h
  * @brief shared internal state for block upload commands
  * @author Iván Ávalos
  */
 #ifndef TESTING_API_CMD_BLOCK_COMMON_H
 #define TESTING_API_CMD_BLOCK_COMMON_H
 
 #include "platform.h"
 #include "sync/sync_service.h"
 #include "sync/sync_testing_lib.h"
 #include <taler/taler_util.h>
 #include <taler/taler_signatures.h>
 #include <taler/taler_testing_lib.h>
 #include <taler/merchant/common.h>
 #include <gnunet/gnunet_curl_lib.h>
 
 
 /**
  * Maximum number of object references a block command can carry.
  */
 #define MAX_BLOCK_OBJECT_REFS 32
 
 
 /**
  * State for a "block upload" CMD.
  */
 struct BlockUploadState
 {
 
   /**
    * Eddsa private key.
    */
   struct SYNC_AccountPrivateKeyP sync_priv;
 
   /**
    * Eddsa public key.
    */
   struct SYNC_AccountPublicKeyP sync_pub;
 
   /**
    * Nonce for the block.
    */
   struct SYNC_BlockNonce nonce;
 
   /**
    * Nonce of the preceding block, all zeros for none.
    */
   struct SYNC_BlockNonce prev_nonce;
 
   /**
    * Nonce of the succeeding block, all zeros for none.
    */
   struct SYNC_BlockNonce next_nonce;
 
   /**
    * Hash of old data, all zeros for append.
    */
   struct GNUNET_HashCode old_data_hash;
 
   /**
    * Hash of new block data (exposed as curr_hash trait).
    */
   struct GNUNET_HashCode new_data_hash;
 
   /**
    * URL of the sync backend.
    */
   const char *sync_url;
 
   /**
    * Reference to a command that can provide account keys,
    * NULL to generate fresh keys.
    */
   const char *upload_reference;
 
   /**
    * Function to process a reference command: inherit keys,
    * nonce, old_data_hash, and/or set prev_nonce depending
    * on the upload mode (retry, append-after, update, etc.).
    *
    * @param[in,out] bus state to populate
    * @param ref reference command to inherit from
    * @return #GNUNET_OK on success, #GNUNET_SYSERR on failure
    */
   enum GNUNET_GenericReturnValue
     (*process_ref)(
     struct BlockUploadState *bus,
     const struct TALER_TESTING_Command *ref);
 
   /**
    * Function to start the upload operation.
    */
   struct SYNC_BlockOperation *
   (*start_upload)(
     struct GNUNET_CURL_Context *ctx,
     const char *sync_url,
     const struct SYNC_AccountPrivateKeyP *sync_priv,
     const struct SYNC_BlockNonce *nonce,
     const struct SYNC_BlockNonce *prev_nonce,
     const struct SYNC_BlockNonce *next_nonce,
     const struct GNUNET_HashCode *old_data_hash,
     size_t block_data_size,
     const void *block_data,
     size_t refs_len,
     const struct SYNC_ObjectUID *object_uids,
     const int16_t *object_incs,
     const struct SYNC_BlockListEntry *prev_entry,
     SYNC_BlockOperationCallback cb,
     void *cb_cls);
 
   /**
    * Block data to upload.
    */
   const void *block_data;
 
   /**
    * Number of bytes in @e block_data.
    */
   size_t block_data_size;
 
   /**
    * Number of entries in @e object_uids and @e object_incs.
    */
   unsigned int refs_len;
 
   /**
    * Array of object UIDs referenced by this block (array of
    * @e refs_len, up to #MAX_BLOCK_OBJECT_REFS).
    */
   struct SYNC_ObjectUID object_uids[MAX_BLOCK_OBJECT_REFS];
 
   /**
    * Array of reference count adjustments (array of @e refs_len,
    * up to #MAX_BLOCK_OBJECT_REFS).
    */
   int16_t object_incs[MAX_BLOCK_OBJECT_REFS];
 
   /**
    * Hash over the object references of this block.
    */
   struct GNUNET_HashCode refs_hash;
 
   /**
    * Entry of the block at @e prev_nonce (the tail on an append),
    * used to build its relink signature; NULL if there is no such
    * block.
    */
   struct SYNC_BlockListEntry prev_entry;
 
   /**
    * True if the relink target entry is available.
    */
   bool have_relink_target;
 
   /**
    * Expected HTTP status code.
    */
   unsigned int http_status;
 
   /**
    * The interpreter state.
    */
   struct TALER_TESTING_Interpreter *is;
 
   /**
    * Payment order ID extracted from the 402 taler://pay URI.
    */
   char *payment_order_id;
 
   /**
    * Claim token extracted from the 402 taler://pay URI.
    */
   struct TALER_ClaimTokenP claim_token;
 
   /**
    * Handle for the library block upload operation.
    */
   struct SYNC_BlockOperation *bop;
 };
 
 
 /**
  * Copy the account key pair offered by @a ref into @a bus.
  *
  * @param[in,out] bus state to populate
  * @param ref reference command to inherit the keys from
  * @return #GNUNET_OK on success, #GNUNET_SYSERR if @a ref
  *         does not offer the account key traits
  */
 enum GNUNET_GenericReturnValue
 SYNC_TESTING_inherit_account_keys_ (
   struct BlockUploadState *bus,
   const struct TALER_TESTING_Command *ref);
 
 
 /**
  * Run a "block upload" CMD.
  *
  * @param cls closure.
  * @param cmd command currently being run.
  * @param is interpreter state.
  */
 void
 SYNC_TESTING_block_upload_run_ (
   void *cls,
   const struct TALER_TESTING_Command *cmd,
   struct TALER_TESTING_Interpreter *is);
 
 
 /**
  * Free the state of a "block upload" CMD, and possibly
  * cancel it if it did not complete.
  *
  * @param cls closure.
  * @param cmd command being freed.
  */
 void
 SYNC_TESTING_block_upload_cleanup_ (
   void *cls,
   const struct TALER_TESTING_Command *cmd);
 
 
 /**
  * Offer the internal data of a "block upload" CMD to other commands.
  *
  * @param cls closure
  * @param[out] ret result (could be anything)
  * @param trait name of the trait
  * @param index index number of the object to extract.
  * @return #GNUNET_OK on success
  */
 enum GNUNET_GenericReturnValue
 SYNC_TESTING_block_upload_traits_ (
   void *cls,
   const void **ret,
   const char *trait,
   unsigned int index);
 
 
 #endif