/* This file is part of TALER (C) 2014, 2015, 2016 INRIA TALER is free software; you can redistribute it and/or modify it under the terms of the GNU Lesser 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, If not, see */ /** * @file merchant/plugin_merchantdb_postgres.c * @brief database helper functions for postgres used by the merchant * @author Sree Harsha Totakura * @author Christian Grothoff */ #include "platform.h" #include #include #include #include #include "taler_merchantdb_plugin.h" /** * Type of the "cls" argument given to each of the functions in * our API. */ struct PostgresClosure { /** * Postgres connection handle. */ PGconn *conn; }; /** * Log error from PostGres. * * @param kind log level to use * @param cmd command that failed * @param res postgres result object with error details */ #define PQSQL_strerror(kind, cmd, res) \ GNUNET_log_from (kind, "merchantdb-postgres", \ "SQL %s failed at %s:%u with error: %s", \ cmd, __FILE__, __LINE__, PQresultErrorMessage (res)); /** * Macro to run @a s SQL statement using #GNUNET_POSTGRES_exec() * and return with #GNUNET_SYSERR if the operation fails. * * @param pg context for running the statement * @param s SQL statement to run */ #define PG_EXEC(pg,s) do { \ if (GNUNET_OK != GNUNET_POSTGRES_exec (pg->conn, s)) \ { \ GNUNET_break (0); \ return GNUNET_SYSERR; \ } \ } while (0) /** * Macro to run @a s SQL statement using #GNUNET_POSTGRES_exec(). * Ignore errors, they happen. * * @param pg context for running the statement * @param s SQL statement to run */ #define PG_EXEC_INDEX(pg,s) do { \ PGresult *result = PQexec (pg->conn, s); \ PQclear (result); \ } while (0) /** * Prepare an SQL statement and log errors on failure. * * @param pg context for running the preparation * @param n name of the prepared statement * @param s SQL statement to run * @param c number of arguments @a s expects */ #define PG_PREPARE(pg,n,s,c) do { \ ExecStatusType status; \ PGresult *res = PQprepare (pg->conn, n, s, c, NULL); \ if ( (NULL == res) || \ (PGRES_COMMAND_OK != (status = PQresultStatus (res))) ) \ { \ if (NULL != res) \ { \ PQSQL_strerror (GNUNET_ERROR_TYPE_ERROR, "PQprepare", res); \ PQclear (res); \ } \ return GNUNET_SYSERR; \ } \ PQclear (res); \ } while (0) /** * Log a really unexpected PQ error. * * @param result PQ result object of the PQ operation that failed */ #define BREAK_DB_ERR(result) do { \ GNUNET_break (0); \ GNUNET_log (GNUNET_ERROR_TYPE_ERROR, \ "Database failure: %s\n", \ PQresultErrorMessage (result)); \ } while (0) /** * Drop merchant tables * * @param cls closure our `struct Plugin` * @return #GNUNET_OK upon success; #GNUNET_SYSERR upon failure */ static int postgres_drop_tables (void *cls) { struct PostgresClosure *pg = cls; PG_EXEC_INDEX (pg, "DROP TABLE merchant_transfers;"); PG_EXEC_INDEX (pg, "DROP TABLE merchant_deposits;"); PG_EXEC_INDEX (pg, "DROP TABLE merchant_transactions;"); PG_EXEC_INDEX (pg, "DROP TABLE merchant_proofs;"); return GNUNET_OK; } /** * Initialize merchant tables * * @param cls closure our `struct Plugin` * @return #GNUNET_OK upon success; #GNUNET_SYSERR upon failure */ static int postgres_initialize (void *cls) { struct PostgresClosure *pg = cls; /* Setup tables */ PG_EXEC (pg, "CREATE TABLE IF NOT EXISTS merchant_transactions (" " transaction_id INT8 PRIMARY KEY" ",exchange_uri VARCHAR NOT NULL" ",h_contract BYTEA NOT NULL CHECK (LENGTH(h_contract)=64)" ",h_wire BYTEA NOT NULL CHECK (LENGTH(h_wire)=64)" ",timestamp INT8 NOT NULL" ",refund_deadline INT8 NOT NULL" ",total_amount_val INT8 NOT NULL" ",total_amount_frac INT4 NOT NULL" ",total_amount_curr VARCHAR(" TALER_CURRENCY_LEN_STR ") NOT NULL" ");"); PG_EXEC (pg, "CREATE TABLE IF NOT EXISTS merchant_deposits (" " transaction_id INT8 REFERENCES merchant_transactions (transaction_id)" ",coin_pub BYTEA NOT NULL CHECK (LENGTH(coin_pub)=32)" ",amount_with_fee_val INT8 NOT NULL" ",amount_with_fee_frac INT4 NOT NULL" ",amount_with_fee_curr VARCHAR(" TALER_CURRENCY_LEN_STR ") NOT NULL" ",deposit_fee_val INT8 NOT NULL" ",deposit_fee_frac INT4 NOT NULL" ",deposit_fee_curr VARCHAR(" TALER_CURRENCY_LEN_STR ") NOT NULL" ",signkey_pub BYTEA NOT NULL CHECK (LENGTH(signkey_pub)=32)" ",exchange_proof BYTEA NOT NULL" ",PRIMARY KEY (transaction_id, coin_pub)" ");"); PG_EXEC (pg, "CREATE TABLE IF NOT EXISTS merchant_proofs (" " exchange_uri VARCHAR NOT NULL" ",wtid BYTEA CHECK (LENGTH(wtid)=32)" ",signkey_pub BYTEA NOT NULL CHECK (LENGTH(signkey_pub)=32)" ",proof BYTEA NOT NULL" ",PRIMARY KEY (wtid, exchange_uri)" ");"); /* Note that transaction_id + coin_pub may actually be unknown to us, e.g. someone else deposits something for us at the exchange. Hence those cannot be foreign keys into deposits/transactions! */ PG_EXEC (pg, "CREATE TABLE IF NOT EXISTS merchant_transfers (" " transaction_id INT8" ",coin_pub BYTEA NOT NULL CHECK (LENGTH(coin_pub)=32)" ",wtid BYTEA NOT NULL CHECK (LENGTH(wtid)=32)" ",PRIMARY KEY (transaction_id, coin_pub)" ");"); PG_EXEC_INDEX (pg, "CREATE INDEX IF NOT EXISTS merchant_transfers_by_coin " " ON merchant_transfers (transaction_id, coin_pub)"); PG_EXEC_INDEX (pg, "CREATE INDEX IF NOT EXISTS merchant_transfers_by_wtid " " ON merchant_transfers (wtid)"); /* Setup prepared "INSERT" statements */ PG_PREPARE (pg, "insert_transaction", "INSERT INTO merchant_transactions" "(transaction_id" ",exchange_uri" ",h_contract" ",h_wire" ",timestamp" ",refund_deadline" ",total_amount_val" ",total_amount_frac" ",total_amount_curr" ") VALUES " "($1, $2, $3, $4, $5, $6, $7, $8, $9)", 9); PG_PREPARE (pg, "insert_deposit", "INSERT INTO merchant_deposits" "(transaction_id" ",coin_pub" ",amount_with_fee_val" ",amount_with_fee_frac" ",amount_with_fee_curr" ",deposit_fee_val" ",deposit_fee_frac" ",deposit_fee_curr" ",signkey_pub" ",exchange_proof) VALUES " "($1, $2, $3, $4, $5, $6, $7, $8, $9, $10)", 10); PG_PREPARE (pg, "insert_transfer", "INSERT INTO merchant_transfers" "(transaction_id" ",coin_pub" ",wtid) VALUES " "($1, $2, $3)", 3); PG_PREPARE (pg, "insert_proof", "INSERT INTO merchant_proofs" "(exchange_uri" ",wtid" ",signkey_pub" ",proof) VALUES " "($1, $2, $3, $4)", 4); /* Setup prepared "SELECT" statements */ PG_PREPARE (pg, "find_transaction", "SELECT" " exchange_uri" ",h_contract" ",h_wire" ",timestamp" ",refund_deadline" ",total_amount_val" ",total_amount_frac" ",total_amount_curr" " FROM merchant_transactions" " WHERE transaction_id=$1", 1); PG_PREPARE (pg, "find_deposits", "SELECT" " coin_pub" ",amount_with_fee_val" ",amount_with_fee_frac" ",amount_with_fee_curr" ",deposit_fee_val" ",deposit_fee_frac" ",deposit_fee_curr" ",exchange_proof" " FROM merchant_deposits" " WHERE transaction_id=$1", 1); PG_PREPARE (pg, "find_transfers_by_transaction_id", "SELECT" " coin_pub" ",wtid" ",merchant_proofs.proof" " FROM merchant_transfers" " JOIN merchant_proofs USING (wtid)" " WHERE transaction_id=$1", 1); PG_PREPARE (pg, "find_deposits_by_wtid", "SELECT" " merchant_transfers.transaction_id" ",merchant_transfers.coin_pub" ",merchant_deposits.amount_with_fee_val" ",merchant_deposits.amount_with_fee_frac" ",merchant_deposits.amount_with_fee_curr" ",merchant_deposits.deposit_fee_val" ",merchant_deposits.deposit_fee_frac" ",merchant_deposits.deposit_fee_curr" ",merchant_deposits.exchange_proof" " FROM merchant_transfers" " JOIN merchant_deposits" " ON (merchant_deposits.transaction_id = merchant_transfers.transaction_id" " AND" " merchant_deposits.coin_pub = merchant_transfers.coin_pub)" " WHERE wtid=$1", 1); PG_PREPARE (pg, "find_proof_by_wtid", "SELECT" " proof" " FROM merchant_proofs" " WHERE wtid=$1" " AND exchange_uri=$2", 2); return GNUNET_OK; } /** * Insert transaction data into the database. * * @param cls closure * @param transaction_id of the contract * @param exchange_uri URI of the exchange * @param h_contract hash of the contract * @param h_wire hash of our wire details * @param timestamp time of the confirmation * @param refund refund deadline * @param total_amount total amount we receive for the contract after fees * @return #GNUNET_OK on success, #GNUNET_SYSERR upon error */ static int postgres_store_transaction (void *cls, uint64_t transaction_id, const char *exchange_uri, const struct GNUNET_HashCode *h_contract, const struct GNUNET_HashCode *h_wire, struct GNUNET_TIME_Absolute timestamp, struct GNUNET_TIME_Absolute refund, const struct TALER_Amount *total_amount) { struct PostgresClosure *pg = cls; PGresult *result; int ret; struct GNUNET_PQ_QueryParam params[] = { GNUNET_PQ_query_param_uint64 (&transaction_id), GNUNET_PQ_query_param_string (exchange_uri), GNUNET_PQ_query_param_auto_from_type (h_contract), GNUNET_PQ_query_param_auto_from_type (h_wire), GNUNET_PQ_query_param_absolute_time (×tamp), GNUNET_PQ_query_param_absolute_time (&refund), TALER_PQ_query_param_amount (total_amount), GNUNET_PQ_query_param_end }; result = GNUNET_PQ_exec_prepared (pg->conn, "insert_transaction", params); if (PGRES_COMMAND_OK != PQresultStatus (result)) { ret = GNUNET_SYSERR; BREAK_DB_ERR (result); } else { ret = GNUNET_OK; } PQclear (result); return ret; } /** * Insert payment confirmation from the exchange into the database. * * @param cls closure * @param transaction_id of the contract * @param coin_pub public key of the coin * @param amount_with_fee amount the exchange will deposit for this coin * @param deposit_fee fee the exchange will charge for this coin * @param signkey_pub public key used by the exchange for @a exchange_proof * @param exchange_proof proof from exchange that coin was accepted * @return #GNUNET_OK on success, #GNUNET_SYSERR upon error */ static int postgres_store_deposit (void *cls, uint64_t transaction_id, const struct TALER_CoinSpendPublicKeyP *coin_pub, const struct TALER_Amount *amount_with_fee, const struct TALER_Amount *deposit_fee, const struct TALER_ExchangePublicKeyP *signkey_pub, const json_t *exchange_proof) { struct PostgresClosure *pg = cls; PGresult *result; int ret; struct GNUNET_PQ_QueryParam params[] = { GNUNET_PQ_query_param_uint64 (&transaction_id), GNUNET_PQ_query_param_auto_from_type (coin_pub), TALER_PQ_query_param_amount (amount_with_fee), TALER_PQ_query_param_amount (deposit_fee), GNUNET_PQ_query_param_auto_from_type (signkey_pub), TALER_PQ_query_param_json (exchange_proof), GNUNET_PQ_query_param_end }; result = GNUNET_PQ_exec_prepared (pg->conn, "insert_deposit", params); if (PGRES_COMMAND_OK != PQresultStatus (result)) { ret = GNUNET_SYSERR; BREAK_DB_ERR (result); } else { ret = GNUNET_OK; } PQclear (result); return ret; } /** * Insert mapping of @a coin_pub and @a transaction_id to * corresponding @a wtid. * * @param cls closure * @param transaction_id ID of the contract * @param coin_pub public key of the coin * @param wtid identifier of the wire transfer in which the exchange * send us the money for the coin deposit * @return #GNUNET_OK on success, #GNUNET_SYSERR upon error */ static int postgres_store_coin_to_transfer (void *cls, uint64_t transaction_id, const struct TALER_CoinSpendPublicKeyP *coin_pub, const struct TALER_WireTransferIdentifierRawP *wtid) { struct PostgresClosure *pg = cls; PGresult *result; int ret; struct GNUNET_PQ_QueryParam params[] = { GNUNET_PQ_query_param_uint64 (&transaction_id), GNUNET_PQ_query_param_auto_from_type (coin_pub), GNUNET_PQ_query_param_auto_from_type (wtid), GNUNET_PQ_query_param_end }; result = GNUNET_PQ_exec_prepared (pg->conn, "insert_transfer", params); if (PGRES_COMMAND_OK != PQresultStatus (result)) { ret = GNUNET_SYSERR; BREAK_DB_ERR (result); } else { ret = GNUNET_OK; } PQclear (result); return ret; } /** * Insert wire transfer confirmation from the exchange into the database. * * @param cls closure * @param exchange_uri URI of the exchange * @param wtid identifier of the wire transfer * @param signkey_pub public key used by the exchange for @a exchange_proof * @param exchange_proof proof from exchange about what the deposit was for * @return #GNUNET_OK on success, #GNUNET_SYSERR upon error */ static int postgres_store_transfer_to_proof (void *cls, const char *exchange_uri, const struct TALER_WireTransferIdentifierRawP *wtid, const struct TALER_ExchangePublicKeyP *signkey_pub, const json_t *exchange_proof) { struct PostgresClosure *pg = cls; PGresult *result; int ret; struct GNUNET_PQ_QueryParam params[] = { GNUNET_PQ_query_param_string (exchange_uri), GNUNET_PQ_query_param_auto_from_type (wtid), GNUNET_PQ_query_param_auto_from_type (signkey_pub), TALER_PQ_query_param_json (exchange_proof), GNUNET_PQ_query_param_end }; result = GNUNET_PQ_exec_prepared (pg->conn, "insert_proof", params); if (PGRES_COMMAND_OK != PQresultStatus (result)) { ret = GNUNET_SYSERR; BREAK_DB_ERR (result); } else { ret = GNUNET_OK; } PQclear (result); return ret; } /** * Find information about a transaction. * * @param cls our plugin handle * @param transaction_id the transaction id to search * @param cb function to call with transaction data * @param cb_cls closure for @a cb * @return #GNUNET_OK if found, #GNUNET_NO if not, #GNUNET_SYSERR * upon error */ static int postgres_find_transaction_by_id (void *cls, uint64_t transaction_id, TALER_MERCHANTDB_TransactionCallback cb, void *cb_cls) { struct PostgresClosure *pg = cls; PGresult *result; struct GNUNET_PQ_QueryParam params[] = { GNUNET_PQ_query_param_uint64 (&transaction_id), GNUNET_PQ_query_param_end }; result = GNUNET_PQ_exec_prepared (pg->conn, "find_transaction", params); if (PGRES_TUPLES_OK != PQresultStatus (result)) { BREAK_DB_ERR (result); PQclear (result); return GNUNET_SYSERR; } if (0 == PQntuples (result)) { PQclear (result); return GNUNET_NO; } if (1 != PQntuples (result)) { GNUNET_break (0); PQclear (result); return GNUNET_SYSERR; } { char *exchange_uri; struct GNUNET_HashCode h_contract; struct GNUNET_HashCode h_wire; struct GNUNET_TIME_Absolute timestamp; struct GNUNET_TIME_Absolute refund_deadline; struct TALER_Amount total_amount; struct GNUNET_PQ_ResultSpec rs[] = { GNUNET_PQ_result_spec_string ("exchange_uri", &exchange_uri), GNUNET_PQ_result_spec_auto_from_type ("h_contract", &h_contract), GNUNET_PQ_result_spec_auto_from_type ("h_wire", &h_wire), GNUNET_PQ_result_spec_auto_from_type ("timestamp", ×tamp), GNUNET_PQ_result_spec_absolute_time ("refund_deadline", &refund_deadline), TALER_PQ_result_spec_amount ("total_amount", &total_amount), GNUNET_PQ_result_spec_end }; if (GNUNET_OK != GNUNET_PQ_extract_result (result, rs, 0)) { GNUNET_break (0); PQclear (result); return GNUNET_SYSERR; } cb (cb_cls, transaction_id, exchange_uri, &h_contract, &h_wire, timestamp, refund_deadline, &total_amount); } PQclear (result); return GNUNET_OK; } /** * Lookup information about coin payments by transaction ID. * * @param cls closure * @param transaction_id key for the search * @param cb function to call with payment data * @param cb_cls closure for @a cb * @return #GNUNET_OK on success, #GNUNET_NO if transaction Id is unknown, * #GNUNET_SYSERR on hard errors */ static int postgres_find_payments_by_id (void *cls, uint64_t transaction_id, TALER_MERCHANTDB_CoinDepositCallback cb, void *cb_cls) { struct PostgresClosure *pg = cls; PGresult *result; unsigned int i; struct GNUNET_PQ_QueryParam params[] = { GNUNET_PQ_query_param_uint64 (&transaction_id), GNUNET_PQ_query_param_end }; result = GNUNET_PQ_exec_prepared (pg->conn, "find_deposits", params); if (PGRES_TUPLES_OK != PQresultStatus (result)) { BREAK_DB_ERR (result); PQclear (result); return GNUNET_SYSERR; } if (0 == PQntuples (result)) { PQclear (result); return GNUNET_NO; } for (i=0;iconn, "find_transfers_by_transaction_id", params); if (PGRES_TUPLES_OK != PQresultStatus (result)) { BREAK_DB_ERR (result); PQclear (result); return GNUNET_SYSERR; } if (0 == PQntuples (result)) { PQclear (result); return GNUNET_NO; } for (i=0;iconn, "find_deposits_by_wtid", params); if (PGRES_TUPLES_OK != PQresultStatus (result)) { BREAK_DB_ERR (result); PQclear (result); return GNUNET_SYSERR; } if (0 == PQntuples (result)) { PQclear (result); return GNUNET_NO; } for (i=0;iconn, "find_proof_by_wtid", params); if (PGRES_TUPLES_OK != PQresultStatus (result)) { BREAK_DB_ERR (result); PQclear (result); return GNUNET_SYSERR; } if (0 == PQntuples (result)) { PQclear (result); return GNUNET_NO; } if (1 != PQntuples (result)) { GNUNET_break (0); PQclear (result); return GNUNET_SYSERR; } { json_t *proof; struct GNUNET_PQ_ResultSpec rs[] = { TALER_PQ_result_spec_json ("proof", &proof), GNUNET_PQ_result_spec_end }; if (GNUNET_OK != GNUNET_PQ_extract_result (result, rs, 0)) { GNUNET_break (0); PQclear (result); return GNUNET_SYSERR; } cb (cb_cls, proof); GNUNET_PQ_cleanup_result (rs); } PQclear (result); return GNUNET_OK; } /** * Initialize Postgres database subsystem. * * @param cls a configuration instance * @return NULL on error, otherwise a `struct TALER_MERCHANTDB_Plugin` */ void * libtaler_plugin_merchantdb_postgres_init (void *cls) { struct GNUNET_CONFIGURATION_Handle *cfg = cls; struct PostgresClosure *pg; struct TALER_MERCHANTDB_Plugin *plugin; const char *ec; pg = GNUNET_new (struct PostgresClosure); ec = getenv ("TALER_MERCHANTDB_POSTGRES_CONFIG"); if (NULL != ec) { GNUNET_CONFIGURATION_set_value_string (cfg, "merchantdb-postgres", "CONFIG", ec); } else { if (GNUNET_OK != GNUNET_CONFIGURATION_have_value (cfg, "merchantdb-postgres", "CONFIG")) { GNUNET_log_config_missing (GNUNET_ERROR_TYPE_ERROR, "merchantdb-postgres", "CONFIG"); return NULL; } } pg->conn = GNUNET_POSTGRES_connect (cfg, "merchantdb-postgres"); plugin = GNUNET_new (struct TALER_MERCHANTDB_Plugin); plugin->cls = pg; plugin->drop_tables = &postgres_drop_tables; plugin->initialize = &postgres_initialize; plugin->store_transaction = &postgres_store_transaction; plugin->store_deposit = &postgres_store_deposit; plugin->store_coin_to_transfer = &postgres_store_coin_to_transfer; plugin->store_transfer_to_proof = &postgres_store_transfer_to_proof; plugin->find_transaction_by_id = &postgres_find_transaction_by_id; plugin->find_payments_by_id = &postgres_find_payments_by_id; plugin->find_transfers_by_id = &postgres_find_transfers_by_id; plugin->find_deposits_by_wtid = &postgres_find_deposits_by_wtid; plugin->find_proof_by_wtid = &postgres_find_proof_by_wtid; return plugin; } /** * Shutdown Postgres database subsystem. * * @param cls a `struct TALER_MERCHANTDB_Plugin` * @return NULL (always) */ void * libtaler_plugin_merchantdb_postgres_done (void *cls) { struct TALER_MERCHANTDB_Plugin *plugin = cls; struct PostgresClosure *pg = plugin->cls; PQfinish (pg->conn); GNUNET_free (pg); GNUNET_free (plugin); return NULL; } /* end of plugin_merchantdb_postgres.c */