commit 9383d65c117f7d4bf2529a0c23f9d6840b57ef9e
parent db1676f87dabca440bfd5350c9319d5c56b7d95e
Author: Marcello Stanisci <stanisci.m@gmail.com>
Date: Wed, 29 Jan 2020 13:05:37 +0100
Manage primary keys collisions in the Nexus.
Diffstat:
4 files changed, 170 insertions(+), 111 deletions(-)
diff --git a/nexus/src/main/kotlin/tech/libeufin/nexus/JSON.kt b/nexus/src/main/kotlin/tech/libeufin/nexus/JSON.kt
@@ -4,6 +4,10 @@ data class EbicsBackupRequest(
val passphrase: String
)
+data class NexusError(
+ val message: String
+)
+
data class EbicsDateRange(
/**
* ISO 8601 calendar dates: YEAR-MONTH(01-12)-DAY(1-31)
diff --git a/nexus/src/main/kotlin/tech/libeufin/nexus/Main.kt b/nexus/src/main/kotlin/tech/libeufin/nexus/Main.kt
@@ -516,18 +516,25 @@ fun main() {
val pairA = CryptoUtil.generateRsaKeyPair(2048)
val pairB = CryptoUtil.generateRsaKeyPair(2048)
val pairC = CryptoUtil.generateRsaKeyPair(2048)
- val row = transaction {
- EbicsSubscriberEntity.new(id = expectId(call.parameters["id"])) {
- ebicsURL = body.ebicsURL
- hostID = body.hostID
- partnerID = body.partnerID
- userID = body.userID
- systemID = body.systemID
- signaturePrivateKey = SerialBlob(pairA.private.encoded)
- encryptionPrivateKey = SerialBlob(pairB.private.encoded)
- authenticationPrivateKey = SerialBlob(pairC.private.encoded)
+ val row = try {
+ transaction {
+ EbicsSubscriberEntity.new(id = expectId(call.parameters["id"])) {
+ ebicsURL = body.ebicsURL
+ hostID = body.hostID
+ partnerID = body.partnerID
+ userID = body.userID
+ systemID = body.systemID
+ signaturePrivateKey = SerialBlob(pairA.private.encoded)
+ encryptionPrivateKey = SerialBlob(pairB.private.encoded)
+ authenticationPrivateKey = SerialBlob(pairC.private.encoded)
+ }
}
+ } catch (e: Exception) {
+ print(e)
+ call.respond(NexusError("Could not store the new account into database"))
+ return@post
}
+
call.respondText(
"Subscriber registered, ID: ${row.id.value}",
ContentType.Text.Plain,
diff --git a/nexus/src/test/script/prepare_subscriber.sh b/nexus/src/test/script/prepare_subscriber.sh
@@ -3,57 +3,76 @@
# This program allocates a new customer into the Sandbox
# and Nexus systems.
+
usage () {
printf "Usage: ./prepare_subscriber.sh <salt>\n"
- printf "<salt> is any chars used to form user and partner IDs.\n"
+ printf "<salt> is any chars used to form user/partner/host IDs.\n"
+}
+
+continue_input () {
+ read -p "Continue? Press <Y/n> followed by <enter>" x
+ if test "$x" = "n"; then
+ printf "Aborting..\n"
+ exit
+ fi
}
exe_echo () {
echo \$ "$@"; "$@"
}
+if ! which libeufin-cli > /dev/null; then
+ printf "Please make sure 'libeufin-cli' is in the PATH\n"
+ exit 1
+fi
+
if [ -z "$1" ]; then
usage
exit 1
fi
-printf "\nFirst: the new subscriber must exist in the Sandbox. For\n"
-printf "this reason, we invoke the \"admin\" part of its API.\n"
-printf "Press <enter> key to proceed.."
+ACCOUNT_ID="account-$1"
+BANK_BASE_URL="http://localhost:5000"
+NEXUS_BASE_URL="http://localhost:5001"
+
+printf "\nFirst: the new subscriber must exist at the Bank.\n"
+printf "For this reason, we invoke the \"admin\" part of its API.\n"
+printf "Press <enter> to proceed.."
read x
printf "\n"
+exe_echo libeufin-cli admin add-host \
+ --host-id "host$1" \
+ --ebics-version "2.5" $BANK_BASE_URL && sleep 1
+
exe_echo libeufin-cli admin add-subscriber \
- --sandbox-url http://localhost:5000/admin/add/subscriber \
--user-id "user$1" \
--partner-id "partner$1" \
--host-id "host$1" \
- --name "name $1" && sleep 1
+ --name "\"name $1\"" $BANK_BASE_URL && sleep 1
-printf "\nSecond: the Nexus must persist the same information,\n"
-printf "and associate a numerical ID to it.\n"
-printf "Press <enter> key to proceed.."
+continue_input
+
+printf "\nSecond: the Nexus must persist the same information\n"
+printf "and associate an alpha-numerical ID to it.\nPress <enter> to proceed.."
read x
printf "\n"
exe_echo libeufin-cli ebics new-subscriber \
+ --account-id $ACCOUNT_ID \
--ebics-url http://localhost:5000/ebicsweb \
--user-id "user$1" \
--partner-id "partner$1" \
- --host-id "host$1" && sleep 1
-
+ --host-id "host$1" $NEXUS_BASE_URL && sleep 1
-# Finally, the numerical ID just created can be used
-# to drive all the EBICS operations. Request it with:
+continue_input
-printf "\nA new subscriber was created at the Sandbox and\n"
-printf "at the Nexus. Press <enter> for more useful commands.."
-read x
+printf "Below are some common commands:\n"
-printf "\nSee again your ID:\n"
-printf "\tcurl http://localhost:5001/ebics/subscribers\n"
+printf "\nSee again your account ID:\n"
+printf "\tlibeufin-cli ebics subscribers $NEXUS_BASE_URL\n"
printf "Request INI, HIA, and HPB, with:\n"
-printf "\tlibeufin-cli ebics ini --customer-id=\$ID_NUMBER\n"
-printf "\tlibeufin-cli ebics hia --customer-id=\$ID_NUMBER\n"
-printf "\tlibeufin-cli ebics sync --customer-id=\$ID_NUMBER\n\n"
+printf "\tlibeufin-cli ebics ini --account-id=$ACCOUNT_ID $NEXUS_BASE_URL\n"
+printf "\tlibeufin-cli ebics hia --account-id=$ACCOUNT_ID $NEXUS_BASE_URL\n"
+printf "\tlibeufin-cli ebics sync --account-id=$ACCOUNT_ID $NEXUS_BASE_URL\n\n"
diff --git a/sandbox/src/main/python/libeufin-cli b/sandbox/src/main/python/libeufin-cli
@@ -15,14 +15,11 @@ def cli():
pass
@cli.group()
-@click.argument(
- "bank-base-url"
-)
@click.pass_context
-def admin(ctx, bank_base_url):
- ctx.obj = dict(bank_base_url=bank_base_url)
+def admin(ctx):
+ pass
-@admin.command(help="Instruct the Sandbox to create a new EBICS host ID.")
+@admin.command(help="Instruct the Bank to create a new EBICS host ID.")
@click.option(
"--host-id",
help="EBICS host ID",
@@ -33,9 +30,12 @@ def admin(ctx, bank_base_url):
help="EBICS version to support",
required=True
)
+@click.argument(
+ "bank-base-url"
+)
@click.pass_obj
-def add_host(obj, host_id, ebics_version):
- url = urljoin(obj["bank_base_url"], "/ebics/hosts")
+def add_host(obj, host_id, ebics_version, bank_base_url):
+ url = urljoin(bank_base_url, "/ebics/hosts")
body = dict(
hostId=host_id,
ebicsVersion=ebics_version
@@ -70,7 +70,10 @@ def add_host(obj, host_id, ebics_version):
help="Name of the person associated with the user ID",
required=True
)
-def add_subscriber(obj, user_id, partner_id, host_id, name):
+@click.argument(
+ "bank-base-url"
+)
+def add_subscriber(obj, user_id, partner_id, host_id, name, bank_base_url):
body = dict(
userID=user_id,
partnerID=partner_id,
@@ -78,7 +81,7 @@ def add_subscriber(obj, user_id, partner_id, host_id, name):
name=name
)
- url = urljoin(obj["bank_base_url"], "/admin/add/subscriber")
+ url = urljoin(bank_base_url, "/admin/add/subscriber")
try:
resp = post(url, json=body)
except Exception as e:
@@ -88,20 +91,12 @@ def add_subscriber(obj, user_id, partner_id, host_id, name):
print(resp.content.decode("utf-8"))
@cli.group()
-@click.argument(
- "nexus-base-url"
-)
@click.pass_context
-def ebics(ctx, nexus_base_url):
- ctx.obj = dict(nexus_base_url=nexus_base_url)
+def ebics(ctx):
+ pass
@cli.group()
-@click.argument(
- "bank-base-url"
-)
-@click.pass_context
-def native(ctx, bank_base_url):
- ctx.obj.update(bank_base_url=bank_base_url)
+def native():
pass
@ebics.command(help="Send the HEV message to the bank.")
@@ -111,8 +106,11 @@ def native(ctx, bank_base_url):
help="Customer id",
required=True
)
-def hev(obj, account_id):
- url = urljoin(obj["nexus_base_url"], "/ebics/{}/sendHev".format(account_id))
+@click.argument(
+ "nexus-base-url"
+)
+def hev(obj, account_id, nexus_base_url):
+ url = urljoin(nexus_base_url, "/ebics/{}/sendHev".format(account_id))
try:
resp = get(url)
except Exception:
@@ -126,14 +124,17 @@ def hev(obj, account_id):
@click.option(
"--account-id",
help="Numerical ID of the customer at the Nexus",
- required=False,
- default=1)
+ required=True
+)
@click.option(
"--backup-file",
help="File where the backup is stored",
required=False,
default="/tmp/backup.json")
-def restore(obj, account_id, backup_file):
+@click.argument(
+ "nexus-base-url"
+)
+def restore(obj, account_id, backup_file, nexus_base_url):
try:
backup = open(backup_file, "r")
except Exception:
@@ -145,7 +146,7 @@ def restore(obj, account_id, backup_file):
passphrase = getpass("Passphrase: ")
backup_json["passphrase"] = passphrase
- url = urljoin(obj["nexus_base_url"], "/ebics/subscribers/{}/restoreBackup".format(account_id))
+ url = urljoin(nexus_base_url, "/ebics/subscribers/{}/restoreBackup".format(account_id))
try:
response = post(url, json=backup_json)
@@ -165,14 +166,17 @@ def restore(obj, account_id, backup_file):
@click.option(
"--account-id",
help="Numerical ID of the customer at the Nexus",
- required=False,
- default=1)
+ required=True
+)
@click.option(
"--output-file",
help="File that will store the backup",
required=False,
default="/tmp/backup.json")
-def backup(obj, account_id, output_file):
+@click.argument(
+ "nexus-base-url"
+)
+def backup(obj, account_id, output_file, nexus_base_url):
passphrase = getpass("Passphrase: ")
passphrase_again = getpass("Passphrase (again): ")
@@ -180,7 +184,7 @@ def backup(obj, account_id, output_file):
print("Passphrase differs, exiting.")
return
- url = urljoin(obj["nexus_base_url"], "/ebics/subscribers/{}/backup".format(account_id))
+ url = urljoin(nexus_base_url, "/ebics/subscribers/{}/backup".format(account_id))
try:
response = post(url, json=dict(passphrase=passphrase))
@@ -204,11 +208,14 @@ def backup(obj, account_id, output_file):
@click.option(
"--account-id",
help="Numerical ID of the customer at the Nexus",
- required=False,
- default=1)
-def tst(obj, account_id):
+ required=True
+)
+@click.argument(
+ "nexus-base-url"
+)
+def tst(obj, account_id, nexus_base_url):
- url = urljoin(obj["nexus_base_url"], "/ebics/subscribers/{}/sendTst".format(account_id))
+ url = urljoin(nexus_base_url, "/ebics/subscribers/{}/sendTst".format(account_id))
try:
resp = post(url)
except Exception:
@@ -217,18 +224,19 @@ def tst(obj, account_id):
print(resp.content.decode("utf-8"))
-
-
@ebics.command(help="Send C52 message")
@click.pass_obj
@click.option(
"--account-id",
help="Numerical ID of the customer at the Nexus",
- required=False,
- default=1)
-def c52(obj, account_id):
+ required=True
+)
+@click.argument(
+ "nexus-base-url"
+)
+def c52(obj, account_id, nexus_base_url):
- url = urljoin(obj["nexus_base_url"], "/ebics/subscribers/{}/sendC52".format(account_id))
+ url = urljoin(nexus_base_url, "/ebics/subscribers/{}/sendC52".format(account_id))
try:
resp = post(url, json=dict(start="1970-01-01", end="2020-12-31"))
except Exception:
@@ -243,11 +251,14 @@ def c52(obj, account_id):
@click.option(
"--account-id",
help="Numerical ID of the customer at the Nexus",
- required=False,
- default=1)
-def ini(obj, account_id):
+ required=True
+)
+@click.argument(
+ "nexus-base-url"
+)
+def ini(obj, account_id, nexus_base_url):
- url = urljoin(obj["nexus_base_url"], "/ebics/subscribers/{}/sendIni".format(account_id))
+ url = urljoin(nexus_base_url, "/ebics/subscribers/{}/sendIni".format(account_id))
try:
resp = post(url)
except Exception:
@@ -257,41 +268,44 @@ def ini(obj, account_id):
print(resp.content.decode("utf-8"))
-
-
@ebics.command(help="Give and get keys.")
@click.pass_context
@click.option(
"--account-id",
help="Numerical ID of the customer at the Nexus",
- required=False,
- default=1)
-def prepare(ctx, account_id):
- ctx.invoke(ini)
- ctx.invoke(hia)
- ctx.invoke(sync)
-
+ required=True
+)
+@click.argument(
+ "nexus-base-url"
+)
+def prepare(ctx, account_id, nexus_base_url):
+ ctx.invoke(ini, account_id=account_id, nexus_base_url=nexus_base_url)
+ ctx.invoke(hia, account_id=account_id, nexus_base_url=nexus_base_url)
+ ctx.invoke(sync, account_id=account_id, nexus_base_url=nexus_base_url)
@ebics.command(help="Send HTD message")
@click.pass_context
@click.option(
"--account-id",
help="Numerical ID of the customer at the Nexus",
- required=False,
- default=1)
+ required=True
+)
@click.option(
"--prepare/--no-prepare",
help="Gets keying done before requesting HTD",
required=False,
default=False)
-def htd(ctx, account_id, prepare):
+@click.argument(
+ "nexus-base-url"
+)
+def htd(ctx, account_id, prepare, nexus_base_url):
if prepare:
ctx.invoke(ini)
ctx.invoke(hia)
ctx.invoke(sync)
- url = urljoin(ctx.obj["nexus_base_url"], "/ebics/subscribers/{}/sendHtd".format(account_id))
+ url = urljoin(nexus_base_url, "/ebics/subscribers/{}/sendHtd".format(account_id))
try:
resp = get(url)
except Exception:
@@ -305,11 +319,14 @@ def htd(ctx, account_id, prepare):
@click.option(
"--account-id",
help="Numerical ID of the customer at the Nexus",
- required=False,
- default=1)
-def hia(obj, account_id):
+ required=True
+)
+@click.argument(
+ "nexus-base-url"
+)
+def hia(obj, account_id, nexus_base_url):
- url = urljoin(obj["nexus_base_url"], "/ebics/subscribers/{}/sendHia".format(account_id))
+ url = urljoin(nexus_base_url, "/ebics/subscribers/{}/sendHia".format(account_id))
try:
resp = post(url)
except Exception:
@@ -323,11 +340,14 @@ def hia(obj, account_id):
@click.option(
"--account-id",
help="Numerical ID of the customer at the Nexus",
- required=False,
- default=1)
-def sync(obj, account_id):
+ required=True
+)
+@click.argument(
+ "nexus-base-url"
+)
+def sync(obj, account_id, nexus_base_url):
- url = urljoin(obj["nexus_base_url"], "/ebics/subscribers/{}/sync".format(account_id))
+ url = urljoin(nexus_base_url, "/ebics/subscribers/{}/sync".format(account_id))
try:
resp = post(url)
except Exception:
@@ -339,9 +359,12 @@ def sync(obj, account_id):
@ebics.command(help="Retrieve all the customers managed by Nexus")
@click.pass_obj
-def subscribers(obj):
+@click.argument(
+ "nexus-base-url"
+)
+def subscribers(obj, nexus_base_url):
- url = urljoin(obj["nexus_base_url"], "/ebics/subscribers")
+ url = urljoin(nexus_base_url, "/ebics/subscribers")
try:
resp = get(url)
except Exception:
@@ -382,8 +405,11 @@ def subscribers(obj):
help="ID of the EBICS server" ,
required=True
)
-def new_subscriber(obj, account_id, user_id, partner_id, system_id, host_id, ebics_url):
- nexus_url = urljoin(obj["nexus_base_url"], "/ebics/{}/subscribers".format(account_id))
+@click.argument(
+ "nexus-base-url"
+)
+def new_subscriber(obj, account_id, user_id, partner_id, system_id, host_id, ebics_url, nexus_base_url):
+ nexus_url = urljoin(nexus_base_url, "/ebics/{}/subscribers".format(account_id))
body = dict(
ebicsURL=ebics_url,
userID=user_id,
@@ -406,8 +432,7 @@ def new_subscriber(obj, account_id, user_id, partner_id, system_id, host_id, ebi
@click.option(
"--user-id",
help="ID of the bank customer (no EBICS correlation implied/needed)" ,
- required=False,
- default=1
+ required=True
)
@click.option(
"--start",
@@ -421,10 +446,12 @@ def new_subscriber(obj, account_id, user_id, partner_id, system_id, host_id, ebi
required=False,
default=None
)
-@click.pass_obj
-def history(obj, user_id, start, end):
+@click.argument(
+ "bank-base-url"
+)
+def history(user_id, start, end, bank_base_url):
- url = urljoin(obj["bank_base_url"], f"/{user_id}/history")
+ url = urljoin(bank_base_url, f"/{user_id}/history")
print(url)
try:
resp = post(url, json=dict(start=start, end=end))
@@ -438,14 +465,16 @@ def history(obj, user_id, start, end):
@native.command(help="Ask the balance for a given customer of the bank")
@click.option(
"--user-id",
- help="ID of the bank customer (no EBICS correlation implied/needed)" ,
- required=False,
- default=1
+ help="ID of the bank customer (no EBICS correlation implied/needed)",
+ required=True
+)
+@click.argument(
+ "bank-base-url"
)
@click.pass_obj
-def balance(obj, user_id):
+def balance(obj, user_id, bank_base_url):
- url = urljoin(obj["bank_base_url"], f"/{user_id}/balance")
+ url = urljoin(bank_base_url, f"/{user_id}/balance")
print(url)
try:
resp = get(url)
