diff options
Diffstat (limited to 'libeufin/concepts.rst')
| -rw-r--r-- | libeufin/concepts.rst | 56 |
1 files changed, 28 insertions, 28 deletions
diff --git a/libeufin/concepts.rst b/libeufin/concepts.rst index 00afe9a6..da48d7f8 100644 --- a/libeufin/concepts.rst +++ b/libeufin/concepts.rst @@ -57,42 +57,42 @@ The information stored about it includes: with their state (sent or not sent, acknowledged in bank statement or not). * Error reports (e.g. failed payment requests, bank statement items that were not understood by LibEuFin) -* A default bank transport (if configured) that is used by default +* A default bank connection (if configured) that is used by default for operations on the account -* Other connected bank transports +* Other enabled bank connections Examples: .. code:: none - # Download latest transactions via the default bank transport and store them locally + # Download latest transactions via the default bank connection and store them locally curl -XPOST $AUTHEADER https://example1.libeufin.tech/bank-accounts/my-acct/collect-transactions -Bank Transports ---------------- +Bank Connections +---------------- -Bank transports connect the local LibEuFin bank account to the real bank. -The bank transport includes the following data: +Bank connections connect the local LibEuFin bank account to the real bank. +The bank connection includes the following data: -* Local alias ("nickname") of the bank transport -* the type of transport (EBICS, FinTS, loopback, sandbox) -* credentials to use the transport (e.g. password, EBICS subscriber keys) +* Local alias ("nickname") of the bank connection +* the type of connection, i.e. the protocol used (EBICS, FinTS, loopback, sandbox) * protocol configuration (hostname, port, protocol sub-version/flags) +* credentials to use the connection (e.g. password, EBICS subscriber keys) -Bank transports provide the following actions: +Bank connections provide the following actions: -* Initial setup of the transport +* Initial setup of the connection * Execute protocol-specific actions (e.g. EBICS: C53, C52, CCT, CRZ) * These actions do not have any effect on the LibEuFin local bank account. To persist changes to the local bank account (transaction history, payment request status), - the bank transport must be invoked via the bank account. + the bank connection must be invoked via the bank account. * Import bank accounts - * Some bank transport protocols allow LibEuFin to query a list of bank - accounts that the transport has access to. This makes setup easier, + * Some bank connection protocols allow LibEuFin to query a list of bank + accounts that the connection has access to. This makes setup easier, as the user doesn't have to create the local bank account manually. Examples: @@ -100,22 +100,22 @@ Examples: .. code:: none # Manually request the inter-day account report via the EBICS C52 order - curl -XPOST $AUTHEADER https://example1.libeufin.tech/bank-transports/my-ebics-testacct/send-c52 + curl -XPOST $AUTHEADER https://example1.libeufin.tech/bank-connections/my-ebics-testacct/send-c52 - # Download available bank accounts that can be accessed through this transport, + # Download available bank accounts that can be accessed through this connection, # according to the bank server (with EBICS, does a HTD request). # For each of them, create a bank account resource in LibEuFin. - curl -XPOST $AUTHEADER https://example1.libeufin.tech/bank-transports/my-ebics-testacct/import-accounts + curl -XPOST $AUTHEADER https://example1.libeufin.tech/bank-connection/my-ebics-testacct/import-accounts Facades ------- Facades allow extra domain-specific functionality to be implemented on top of users, bank accounts -and bank transports. Facades store the following information: +and bank connections. Facades store the following information: * Local name of the facade * Facade type and options specific to the type -* Associated bank accounts and bank transports that can be accessed by the layer +* Associated bank accounts and bank connections that can be accessed by the layer * Internal tables used by the facade (i.e. facades are stateful) The only facade currently supported by LibEuFin is the "Taler Wire Gateway API" layer. @@ -135,7 +135,7 @@ Access Control The goal of access control in LibEuFin is to allow the following scenarios: -* The Nexus can be used by multiple clients for different bank accounts/transports, +* The Nexus can be used by multiple clients for different bank accounts/connections and these users can't access each other's bank accounts * For monitoring / dashboard (e.g. Taler rejected transactions, blacklists), some users should only be able to have read-only access. @@ -146,15 +146,15 @@ spending limits or more fine-grained read/write permissions. Users can be normal users or superusers. Permission checks do not apply to superusers, and only superusers can create other users. -Each top-level object (bank account, bank transport, layer) has a list of +Each top-level object (bank account, bank connection, facade) has a list of nexus users with write access, and a list of users with read access. -When using a bank transport through a bank account, permission checks must -succeed for both the bank account and the bank transport. +When using a bank connection through a bank account, permission checks must +succeed for both the bank account and the bank connection -This works differently for layers: A layer has a set of associated bank transports +This works differently for facades: A facade has a set of associated bank connections and bank accounts it can access. Permissions on these associated objects -are checked when the layer is *created*. When invoking operations on the layer, -the nexus only checks if the current nexus user can access the layer and *not* the -underlying objects abstracted by the layer. +are checked when the facade is *created*. When invoking operations on the facade, +the nexus only checks if the current nexus user can access the facade and *not* the +underlying objects abstracted by the facade. |