70.1.47. pepsi-helper-auto-pay

drive taler-wallet-cli as the paying user

Manual section:

1

70.1.47.1.1. Name

pepsi-helper-auto-pay - privileged helper that prices or pays a GNU Taler delivery demand by running taler-wallet-cli as the right user.

70.1.47.1.2. Synopsis

pepsi-helper-auto-pay OP ( –uid N | –user NAME –wallet-db KEY ) [–wallet-cli PATH] [OP-OPTIONS]

where OP is one of preview/pay –uri TALER-URI [–pay-option OPT]…, balance, withdraw –amount CURRENCY:VALUE –exchange URL, push –uri TALER-URI [–pay-option OPT]…, or pull –amount CURRENCY:VALUE [–subject TEXT].

70.1.47.1.3. Description

pepsi-helper-auto-pay is a minimal, security-hardened helper that runs taler-wallet-cli against exactly one wallet, as exactly one user, for one wallet operation. It exists so that a trusted but unprivileged caller (a member of the pepsi-wallets group, in practice pepsi-stage-auto-pay(1)) can drive the appropriate wallet — and do nothing else.

The supported operations are: preview (price a taler://pay/… demand without paying) and pay (settle one) for the inbound demand-paying role; and balance, withdraw (set up a manual top-up against an exchange), push (accept an incoming taler://pay-push/… peer payment) and pull (initiate a peer pull, producing a taler://pay-pull/… URI) for the wallet self-service role.

The helper is installed setuid-root, owned root:pepsi-wallets with mode 4750. Only members of the pepsi-wallets group may execute it; when they do, the kernel runs it with an effective uid of root. The helper then:

1. resolves the target account and, in shared mode, the wallet-database path inside that account’s home built from the validated KEY (the path can therefore never escape the home);

2. fully and irreversibly drops privilege to the target user — installs the user’s supplementary groups, then sets the gid, then the uid (real+effective+saved), verifying root cannot be regained — refusing uid 0 and the login root. In local-user mode it additionally refuses any uid below /etc/login.defs UID_MIN (a real recipient is expected there); shared mode is exempt, since its target is the operator-configured WALLET_USER service account (e.g. pepsi-wallets, typically a low uid). (Like pepsi-helper-dot-forward(1) and pepsi-helper-maildir-writer(1), it sheds root completely.)

3. execs taler-wallet-cli — with a sanitised environment (HOME and USER/LOGNAME set to the target account, a fixed PATH, and IFS/BASH_ENV/ENV/CDPATH removed) and, in local-user mode, a ~/wallets directory created mode 0700 — optionally with --wallet-db=…, for the requested operation: preview asks wallet-core for the proposal (api preparePayForUri) and reads the price out of the contract terms — handle-uri cannot be used to quote, since without --yes it stops at a confirmation prompt that does not end on EOF, and prints no price anyway; pay runs handle-uri --choice-index 0 --yes plus any extra --pay-option arguments and runs to completion (a version-1 contract offers a list of choices and cannot be paid until one is named; the first is the one preview priced); push takes two wallet commands — p2p prepare-push-credit for the incoming payment’s transaction id, then p2p confirm-push-credit to accept it (handle-uri does not return for such a URI, so the purse would expire unaccepted); balance, withdraw and pull run the corresponding wallet subcommands and report their result (the balance text, the withdrawal wire instructions, or the pay-pull URI). The exact taler-wallet-cli subcommands are the one wallet-version-dependent point, isolated in the helper.

After a pull, and after accepting a push, the helper runs the wallet’s task loop (run-until-done) for a bounded time. This is not optional housekeeping: p2p initiate-pull-credit only records the request locally, and the purse is created at the exchange by that loop — until it has run, the URI the user is sent is not payable at all, and nothing else would ever run it, since a per-user wallet only wakes up when its owner sends the next command. The bound exists because a peer-pull credit is not “done” until somebody pays it, so the command would otherwise wait forever.

If the wallet reports a KYC (identity verification) requirement for a self-service operation, the helper extracts the KYC URL and exits 3 with the URL on standard output, so the stage can e-mail the link to the user. This is considered only when the operation produced no result of its own: an operation that succeeded is reported as a success even if the wallet’s diagnostic output mentions KYC somewhere, and the URL is taken from the text that mentions it rather than from wherever a URL first appears.

The two account models are selected by the caller. With –uid the helper drops to that local uid and uses that user’s default wallet (WALLET_MODE = local-user in pepsi-stage-auto-pay(1)). With –user and –wallet-db it drops to the named shared account (default pepsi-wallets) and points the wallet at ~NAME/wallets/KEY.json (WALLET_MODE = shared).

This program is not meant to be run by hand; pepsi-stage-auto-pay(1) invokes it. It is documented here because of its privileged installation.

70.1.47.1.4. Options

preview | pay | balance | withdraw | push | pull

The operation. preview prints a demand’s price without paying; pay settles it; balance prints the wallet balance; withdraw sets up a manual top-up and prints the wire instructions; push accepts an incoming peer payment; pull initiates a peer pull and prints the resulting URI.

–uri TALER-URI

The taler://pay/… (preview/pay) or taler://pay-push/… (push) URI to act on. Required for those operations.

–amount CURRENCY:VALUE

The GNU Taler amount, required for withdraw and pull.

–exchange URL

The exchange base URL for a manual withdraw (required).

–subject TEXT

An optional payment subject/summary for pull.

–uid N

Local-user mode: drop to uid N and use that user’s default wallet. Mutually exclusive with –user.

–user NAME –wallet-db KEY

Shared mode: drop to account NAME and use the wallet database named by the opaque, validated KEY under that account’s home. Both are required together.

–wallet-cli PATH

The taler-wallet-cli binary to run (default taler-wallet-cli, resolved on $PATH).

–pay-option OPT

An extra argument appended to the pay/push invocation (repeatable, e.g. --run-until-done). --yes is always added for pay/push.

70.1.47.1.5. Exit Status

0

Success. For preview the proposed amount is on standard output; for balance, withdraw and pull the report text is on standard output; for pay and push standard output is empty.

2

The operation failed (bad arguments, not setuid-root, a refused account, the price could not be read, or the wallet operation failed). A human-readable diagnostic is written to standard output and standard error.

3

The wallet requires KYC (identity verification); the KYC URL is on standard output.

70.1.47.1.6. Security

The helper deliberately does no configuration, database or logging work. Its only privileged action is to become the target user before running the wallet; it refuses to act as root and verifies root is unrecoverable after dropping privilege. Access to it is gated by the pepsi-wallets group, granted to the caller through pepsi-stage-auto-pay(1)’s SGID bit and to no one else.

70.1.47.1.7. See Also

pepsi-stage-auto-pay(1), pepsi-stage-anti-spam(1), pepsi-helper-dot-forward(1), pepsi-dispatch(1), pepsi.conf(5)

70.1.47.1.8. Bugs

Report bugs to the Pepsi issue tracker.