/* This file is part of GNU Taler (C) 2019 Taler Systems S.A. GNU 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. GNU 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 GNU Taler; see the file COPYING. If not, see */ /** * Imports. */ import { Amounts, BlindedDenominationSignature, codecForMerchantTipResponseV2, codecForTipPickupGetResponse, DenomKeyType, encodeCrock, getRandomBytes, j2s, Logger, parseTipUri, PrepareTipResult, TalerErrorCode, TalerProtocolTimestamp, TipPlanchetDetail, URL, } from "@gnu-taler/taler-util"; import { DerivedTipPlanchet } from "../crypto/cryptoTypes.js"; import { CoinRecord, CoinSourceType, CoinStatus, DenominationRecord, OperationAttemptResult, OperationAttemptResultType, TipRecord, } from "../db.js"; import { makeErrorDetail } from "../errors.js"; import { InternalWalletState } from "../internal-wallet-state.js"; import { getHttpResponseErrorDetails, readSuccessResponseJsonOrThrow, } from "../util/http.js"; import { checkDbInvariant, checkLogicInvariant } from "../util/invariants.js"; import { updateExchangeFromUrl } from "./exchanges.js"; import { getCandidateWithdrawalDenoms, getExchangeWithdrawalInfo, selectWithdrawalDenominations, updateWithdrawalDenoms, } from "./withdraw.js"; const logger = new Logger("operations/tip.ts"); export async function prepareTip( ws: InternalWalletState, talerTipUri: string, ): Promise { const res = parseTipUri(talerTipUri); if (!res) { throw Error("invalid taler://tip URI"); } let tipRecord = await ws.db .mktx((x) => ({ tips: x.tips, })) .runReadOnly(async (tx) => { return tx.tips.indexes.byMerchantTipIdAndBaseUrl.get([ res.merchantTipId, res.merchantBaseUrl, ]); }); if (!tipRecord) { const tipStatusUrl = new URL( `tips/${res.merchantTipId}`, res.merchantBaseUrl, ); logger.trace("checking tip status from", tipStatusUrl.href); const merchantResp = await ws.http.get(tipStatusUrl.href); const tipPickupStatus = await readSuccessResponseJsonOrThrow( merchantResp, codecForTipPickupGetResponse(), ); logger.trace(`status ${j2s(tipPickupStatus)}`); const amount = Amounts.parseOrThrow(tipPickupStatus.tip_amount); logger.trace("new tip, creating tip record"); await updateExchangeFromUrl(ws, tipPickupStatus.exchange_url); //FIXME: is this needed? withdrawDetails is not used // * if the intention is to update the exchange information in the database // maybe we can use another name. `get` seems like a pure-function const withdrawDetails = await getExchangeWithdrawalInfo( ws, tipPickupStatus.exchange_url, amount, undefined ); const walletTipId = encodeCrock(getRandomBytes(32)); await updateWithdrawalDenoms(ws, tipPickupStatus.exchange_url); const denoms = await getCandidateWithdrawalDenoms( ws, tipPickupStatus.exchange_url, ); const selectedDenoms = selectWithdrawalDenominations(amount, denoms); const secretSeed = encodeCrock(getRandomBytes(64)); const denomSelUid = encodeCrock(getRandomBytes(32)); const newTipRecord: TipRecord = { walletTipId: walletTipId, acceptedTimestamp: undefined, tipAmountRaw: amount, tipExpiration: tipPickupStatus.expiration, exchangeBaseUrl: tipPickupStatus.exchange_url, merchantBaseUrl: res.merchantBaseUrl, createdTimestamp: TalerProtocolTimestamp.now(), merchantTipId: res.merchantTipId, tipAmountEffective: selectedDenoms.totalCoinValue, denomsSel: selectedDenoms, pickedUpTimestamp: undefined, secretSeed, denomSelUid, }; await ws.db .mktx((x) => ({ tips: x.tips, })) .runReadWrite(async (tx) => { await tx.tips.put(newTipRecord); }); tipRecord = newTipRecord; } const tipStatus: PrepareTipResult = { accepted: !!tipRecord && !!tipRecord.acceptedTimestamp, tipAmountRaw: Amounts.stringify(tipRecord.tipAmountRaw), exchangeBaseUrl: tipRecord.exchangeBaseUrl, merchantBaseUrl: tipRecord.merchantBaseUrl, expirationTimestamp: tipRecord.tipExpiration, tipAmountEffective: Amounts.stringify(tipRecord.tipAmountEffective), walletTipId: tipRecord.walletTipId, }; return tipStatus; } export async function processTip( ws: InternalWalletState, walletTipId: string, options: { forceNow?: boolean; } = {}, ): Promise { const tipRecord = await ws.db .mktx((x) => ({ tips: x.tips, })) .runReadOnly(async (tx) => { return tx.tips.get(walletTipId); }); if (!tipRecord) { return { type: OperationAttemptResultType.Finished, result: undefined, }; } if (tipRecord.pickedUpTimestamp) { logger.warn("tip already picked up"); return { type: OperationAttemptResultType.Finished, result: undefined, }; } const denomsForWithdraw = tipRecord.denomsSel; const planchets: DerivedTipPlanchet[] = []; // Planchets in the form that the merchant expects const planchetsDetail: TipPlanchetDetail[] = []; const denomForPlanchet: { [index: number]: DenominationRecord } = []; for (const dh of denomsForWithdraw.selectedDenoms) { const denom = await ws.db .mktx((x) => ({ denominations: x.denominations, })) .runReadOnly(async (tx) => { return tx.denominations.get([ tipRecord.exchangeBaseUrl, dh.denomPubHash, ]); }); checkDbInvariant(!!denom, "denomination should be in database"); for (let i = 0; i < dh.count; i++) { const deriveReq = { denomPub: denom.denomPub, planchetIndex: planchets.length, secretSeed: tipRecord.secretSeed, }; logger.trace(`deriving tip planchet: ${j2s(deriveReq)}`); const p = await ws.cryptoApi.createTipPlanchet(deriveReq); logger.trace(`derive result: ${j2s(p)}`); denomForPlanchet[planchets.length] = denom; planchets.push(p); planchetsDetail.push({ coin_ev: p.coinEv, denom_pub_hash: denom.denomPubHash, }); } } const tipStatusUrl = new URL( `tips/${tipRecord.merchantTipId}/pickup`, tipRecord.merchantBaseUrl, ); const req = { planchets: planchetsDetail }; logger.trace(`sending tip request: ${j2s(req)}`); const merchantResp = await ws.http.postJson(tipStatusUrl.href, req); logger.trace(`got tip response, status ${merchantResp.status}`); // FIXME: Why do we do this? if ( (merchantResp.status >= 500 && merchantResp.status <= 599) || merchantResp.status === 424 ) { logger.trace(`got transient tip error`); // FIXME: wrap in another error code that indicates a transient error return { type: OperationAttemptResultType.Error, errorDetail: makeErrorDetail( TalerErrorCode.WALLET_UNEXPECTED_REQUEST_ERROR, getHttpResponseErrorDetails(merchantResp), "tip pickup failed (transient)", ), }; } let blindedSigs: BlindedDenominationSignature[] = []; const response = await readSuccessResponseJsonOrThrow( merchantResp, codecForMerchantTipResponseV2(), ); blindedSigs = response.blind_sigs.map((x) => x.blind_sig); if (blindedSigs.length !== planchets.length) { throw Error("number of tip responses does not match requested planchets"); } const newCoinRecords: CoinRecord[] = []; for (let i = 0; i < blindedSigs.length; i++) { const blindedSig = blindedSigs[i]; const denom = denomForPlanchet[i]; checkLogicInvariant(!!denom); const planchet = planchets[i]; checkLogicInvariant(!!planchet); if (denom.denomPub.cipher !== DenomKeyType.Rsa) { throw Error("unsupported cipher"); } if (blindedSig.cipher !== DenomKeyType.Rsa) { throw Error("unsupported cipher"); } const denomSigRsa = await ws.cryptoApi.rsaUnblind({ bk: planchet.blindingKey, blindedSig: blindedSig.blinded_rsa_signature, pk: denom.denomPub.rsa_public_key, }); const isValid = await ws.cryptoApi.rsaVerify({ hm: planchet.coinPub, pk: denom.denomPub.rsa_public_key, sig: denomSigRsa.sig, }); if (!isValid) { return { type: OperationAttemptResultType.Error, errorDetail: makeErrorDetail( TalerErrorCode.WALLET_TIPPING_COIN_SIGNATURE_INVALID, {}, "invalid signature from the exchange (via merchant tip) after unblinding", ), }; } newCoinRecords.push({ blindingKey: planchet.blindingKey, coinPriv: planchet.coinPriv, coinPub: planchet.coinPub, coinSource: { type: CoinSourceType.Tip, coinIndex: i, walletTipId: walletTipId, }, currentAmount: denom.value, denomPubHash: denom.denomPubHash, denomSig: { cipher: DenomKeyType.Rsa, rsa_signature: denomSigRsa.sig }, exchangeBaseUrl: tipRecord.exchangeBaseUrl, status: CoinStatus.Fresh, suspended: false, coinEvHash: planchet.coinEvHash, }); } await ws.db .mktx((x) => ({ coins: x.coins, tips: x.tips, withdrawalGroups: x.withdrawalGroups, })) .runReadWrite(async (tx) => { const tr = await tx.tips.get(walletTipId); if (!tr) { return; } if (tr.pickedUpTimestamp) { return; } tr.pickedUpTimestamp = TalerProtocolTimestamp.now(); await tx.tips.put(tr); for (const cr of newCoinRecords) { await tx.coins.put(cr); } }); return { type: OperationAttemptResultType.Finished, result: undefined, }; } export async function acceptTip( ws: InternalWalletState, tipId: string, ): Promise { const found = await ws.db .mktx((x) => ({ tips: x.tips, })) .runReadWrite(async (tx) => { const tipRecord = await tx.tips.get(tipId); if (!tipRecord) { logger.error("tip not found"); return false; } tipRecord.acceptedTimestamp = TalerProtocolTimestamp.now(); await tx.tips.put(tipRecord); return true; }); if (found) { await processTip(ws, tipId); } }