Skip to content

Commit

Permalink
update doku
Browse files Browse the repository at this point in the history
  • Loading branch information
vladae36 committed Apr 20, 2024
1 parent bbbfaf7 commit bc6145b
Show file tree
Hide file tree
Showing 6 changed files with 57 additions and 62 deletions.
24 changes: 9 additions & 15 deletions docs/TEST.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,18 @@
# Tests


## Run unit tests

![Coverage](../.github/badges/jacoco.svg)

Run tests for the ebics-java-client on linux - it mounts sources into a gradle docker container with java and the maven build tool - so you do not need to install java or gradle on your local machine:

git clone https://github.com/element36-io/ebics-java-service.git
# or git clone [email protected]:element36-io/ebics-java-service.git

cd ebics-java-service
# we test on hyperfridge branch
git checkout hyperfridge
docker run -it -v $PWD:/app -w /app gradle:6-jdk11 gradle clean test


Expand All @@ -18,25 +23,14 @@ Test for vulnerabilities `gradle dependencyCheckAggregate`- see report in `./bui

If you are interested in the Ebics Client implementation as well, look [here](https://github.com/element36-io/ebics-java-client/blob/master/README.md).

# Run with docker

Checkout [hyperfridge](https://github.com/element36-io/hyperfridge-r0) and [banking backend](https://github.com/element36-io/LibEuFin) at same directory as ebics-java-service to build images locally:

git clone [email protected]:element36-io/LibEuFin.git
cd LibEuFin
./bootstrap
cd ..
git cline [email protected]:element36-io/XXXXXXX.git
# Run and test with Docker

Build on Linux:
This starts several docker images: ebics-java-service => libeufin => Postgres. We use 'watchdog.sh' from the hyperfridge image to scan directory for new banking documents which triggers generation of STARK proofs.

cd ebics-java-service
docker compose build

On Mac:
docker compose up

cd ebics-java-service
DOCKERFILE=DockerfileMacOs docker compose build
You should see the setup process of demo-accounts, lauching [Open API/Swagger](http://localhost:8093/ebics/swagger-ui/?url=/ebics/v2/api-docs/) and [banking bankend](manual/manual.md) which we will look at later.


## Test API and download ZK proof
Expand Down
3 changes: 2 additions & 1 deletion docs/manual/manual.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,8 @@

Use OpenAPI/Swagger to crate a payment and doenload the Proof: [http://localhost:8093/ebics/swagger-ui/?url=/ebics/v2/api-do](http://localhost:8093/ebics/swagger-ui/?url=/ebics/v2/api-docs/)

User:
Login with: foo/superpassword

## Create a payment

![Click Endpoint ](1.png)
Expand Down
14 changes: 7 additions & 7 deletions keys/bank_public_key.pem
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
-----BEGIN PUBLIC KEY-----
MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAh8lqYMCn4etXrj8bCmRN
d5k7HO2LFptyMXH9pbW6jGCBZvkOMLAV5JXaRkjygX53PgQ9UMH/4RxIgyFLurxY
PnqWdV+BXn1hFPtUBGnRLHvXMpq4lcQ4NUq7u6U0QXr8WIMuYV1XB+HCSweJiWhD
wPMKHjIuqnW0uamoPIPmj6ZYUdyTQXkH0rtCIIYge0dQ0d47w95o+DSYn2ZX6FBx
4BpcoVHRs7sK+HyURJU6dgtdnuC0p5DD1ageExUuUhSht5QBXVycxmOMmxIGyfRi
Do7WEIzxReMshVZt2UlVqM6Ok/GYGEePt8k46foHN4YRDHEQz8UyAD5yXa+G+g+l
LQIDAQAB
MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAhTb+twnr32d1o64YeMPo
zjFHZR8TDRpVJP3KkCIAXpJ+q5nkz0fYbOnCOgkYUru1uCdYYUWk/f+g8QDoOdDs
XMtgA2XElbOhsgKdJQve3dbJN8P76a8pgL3hIH0F3AEEZ5jFqQuxDTYZKOP9BgBw
GaqNjc8AA9O/f3q3twq0Ns8Ty/MX6NmCKrE0ma1Xx9KjMOYVbrvw64ZFkfDPEFG0
4XZmgGnDSqJwOv1e0f3LnwI0zMevtYgu7EZeER/Am0BR6c93miLXz4SWv9RbTFWO
GQh0412wI8QVRr59iNJ9o1dCvoxcEiv3GaYiFlu3FGw8uwT/WfCAI/Qj8Q+oJqI+
+wIDAQAB
-----END PUBLIC KEY-----
14 changes: 7 additions & 7 deletions keys/bank_public_key.pem-enc
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
-----BEGIN PUBLIC KEY-----
MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAr11VRbdiRkzBARVAe2i1
bZJWEV3c+nVNCJP7Sp+vF3il0OVeoUNBeqwHUr7CPUWTchQAWQE3eTFmvuOxonUX
fOFLcRLRkcx9WAyQPHFnxV4KDpETvz+JRUBJQ+z7t5EGfVkaaZyYHcIph76lLmKS
O1IeArWp+TcqgWHzOUUDGIlnILQB4q6QJME10OEsXQw/XPue5sm8t2sGtxvLxjGp
+dy1J5xJ0NAdX38CcHK7oJ8+Ku6LyV/Zs4gsYGQ8NtK7oZGl8rc9h/VvMayYwpK8
2CmRBPoQ09w+Va7HpjT3MQlv9m35pCgGA2hvjufgG+UDBnRyR6c7avteLok7MYk7
wQIDAQAB
MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAuFjrCHhiDl00bxPZ/4BL
iU60liYhkQytVK3hyq5mB36ix1VORKwBP7pGZl/BHRqT/1IJSEsfJAFVngGUSr75
ivTeVYSQL+PAAO206rkLh4mBJ4dhZcHiFuxEyCY2LEOq3vywW+j6dMdInraCSyl6
+hUMMKty0s3DKwBnD8iigEW1hbkeO6WXlr4/As7Wdq57WHVqb1OcAj67+vCa7yGB
N2leAohumtKcjKKmpKOLvB3ipuJf7/hAZbQwZUcTk3+2VIwB6Aj61+ppun0M6YV9
NDQcMcGQEP1z+VNvapGiMfjHJftD7YANK7K31bwc/OmVtHXzHbBciGjoasPXPMJB
zQIDAQAB
-----END PUBLIC KEY-----
52 changes: 26 additions & 26 deletions keys/client_private_key.pem
Original file line number Diff line number Diff line change
@@ -1,28 +1,28 @@
-----BEGIN PRIVATE KEY-----
MIIEvQIBADANBgkqhkiG9w0BAQEFAASCBKcwggSjAgEAAoIBAQDF7hoYeRuZv7z2
0sdblQSwG8J3BUmU3OKgowGGUkeIdiXC1fH1giKnPla9fucKSOZYSMPem51wyms/
NDHJL75WMN2+u9/cuFnMlxGhEcIvamKjNNpdZl3/dTY510X9Mp+GDSpGFvjW/sJn
sgCBT26CgQ4G04AvezMiFu9GXRzliGjjw+H9+wzr9Y6GdhNtmYOibJxtr5O627uB
weggLdlFpANEAkLwnEPVVrThcdvrRTnCkrhtYv9m8tqFeULKjGamLuIP+AzL5ZHI
H/lPW6PlzgLdzaXbI6mVGoUmL8TlrMY3tHeqqcrIJdK3FcV8nUmfjpgZVWNTAnL5
ZsgpukR3AgMBAAECggEALLspxJwiI7YUY4exLD5aR96OLU3RmkXtJbaREqUnq2xg
Dk9BlmVppXhOLBcw6b8d55fSRE3Q3/uvDyKhmcEjd+ElTASzi/NRwA3oGwmjZAnb
7txz+SW4WpJHxfyjwZweNzJkemCYriX3E25D9PVZmT7HR72mu5RRMwQR4UoLzMeH
+8BDilRx/Sx7VkUnUfoNhJ9vzBGwfU+5oD3fzigpQ8YAtdZPh96LOlenOyCBuovz
8pWvYTm5DRvID0qpvIgLVz1uNJW7avTaYRy/yN+PKx9YxowHu0jzfeSimfVnUIhY
kf+5PBkKok6XkswsHNE5kdGFGYKR7SjmQMhPXxwgOQKBgQD5jR92BSgc3uVmyk4t
xFkTYaC7imS4OmwzBLI9wClo+Np1iMLJOxAZ6M9SUpQL+QjPXg7m+fv8dPIWmgg3
dNdN1Des5Iuz+E6m9ceiTW1GCzmx4BNWeaFf1mYIusdvSuRtmvrRrD6v+jqzVqBd
vS+PfwvrPOc5lkx1rEL97QPphQKBgQDLC3w2jYFMN+LGUvizSsBM4KBiLyDP3odM
5G5MDaPl0WxvFsBgYmQHECvjc7eU4mRD1snsrOOBsfMf/iGAMQ0GcR/07E0u3YGQ
rxC3Awx1R5443SZiiz00utBXClIaE/yugo0r5kjVkvl87kgsZKUVHJFrmC4DTRuz
iWsRgs84ywKBgCEqdlHzIX+kyAw/OuCuRcBjqz8Bh51MdnDZYO8ACQDggfg48tpX
tS4cWOFyBCcLM/aLY6Oi+bB1wm7qjckBCFRZrgSWY1LJ33olFCEn9Svn9gUD6M4H
YEEid3EVkcfixjUi8c7H+5Tbxs1q5+lNaXLCycy7zWdD6GmDOWwSAgEZAoGAblQ4
U4BCoMLBQ9iz8OCOa3enTpKjNrCJPnvlfwfuZiOM0zQ+pmDwT3I3Fum6+Hin2MDu
id9L5B5oqJqzY2/DzxtLLQ/1xKByFcc6wucyLswSqn1orSVRxcQ5DwK5qBfyNnUT
9qW0L/EkBgGIUC8EENusHRXc8shEZCMofaRhq08CgYEAkIaB/ob+Ie4LUatvKKdK
Uzkqp6WHU2frGXdmxmqT7PqbOMwZpvZE1/9IZf3sKQXBWUO1o932RRAGlL0myCku
I3qUAj69EYae4VMclcATFZ5CMUo4oODEp5nAnaXoJPwl58/4LpQFf4bvpQj5rhbI
a2gMDicAD0bzPR2+zd4ecW8=
MIIEvQIBADANBgkqhkiG9w0BAQEFAASCBKcwggSjAgEAAoIBAQC19I6ypikkiY5k
0RAov0u5exgmFbSe58msBtxSOE5f7ANudnCMSaTsZCKMRw4YRSwPFVyrIbYffXEr
8+fwOOoHgWQ9R8HwuU0027SSsSxXfswP+x3y03on85lSZVdyW/1HwU90GrWSTDeT
vxY0veKL0v2Lj6RPQDMaQq25PeXxj5VURyEXXl8a0R5mUXWF5Hzl1W9TKNxaDG+t
D5SkjGaWykVH3sGe9ypZlUbbw8J/Jek0EbDjWRiStYRUseuNKldsPf/PAIkw6nS+
5cENgxb8LYhPbd40LQLMrquo2F691GdbaLZeUvCIQ5lgCXNz/2lpIGXwd1Aln+ts
/xfgA9h3AgMBAAECggEAEm6u0fwxKMliimX/XBFc63JD1P/X500Vyf577TxU/DSd
eGA5MIz5TxUpxsof7Gd9eh2w4IkuuOvtPgWcVmJ9mrsJ24dcZzVuU8958G5QTqDC
rU/EDehMdKWhv44SmLwm4VD86ocWI7bi3m26IyelPoLmOnAXtguL4bolfSF/HMRC
IxTj7/sANSoiJFKutyPhxul/p3PYxeASWMGzlAf7lknvwwUI4HcvtzTCxRGdVb6X
GgIcoRKuSornzeiCLuwe2ZhZruppWblaoYE8merkXJ/psnSEtSqpLYHwK9/+4+j6
pO27HcS5h/u+DY8bfGXvQoSoLz3rXyiJUBH9l87FaQKBgQDYfC4XL5Cgp4FV8LZ7
SXT/zxXm5Ch1BLC1BvXaY6Ud1stTvZPDDo6gG4OrP8CHVQ5tB8E14HR4QFvUVQAl
h+bDVQfNXp3X8fZ4Ft5eHeKDNNeWfeIoqM+khmoiibVRapXV0Oly8T80hXQUQNOf
tCSIyuz95LhiGMhjIXiiZT3ScwKBgQDXKuKXWT/ptVoRFsEmgoO8X7Fvy645OfK4
ujoa5S+jM4pCSV2fdK5nXnq5MQhEU+6n6mg1ev7fIJmvCr/EbEjetxzGde87v4/o
9Sds/oftN84CE6Eai5T1Yn07MvNJBQy6Q5IeFKpC3dwM9Q7XWsXgGWc+GLKuxSmR
6WDWWaLs7QKBgQCpczoYh/Cq77I69LnBctQTz6KTIg/Q2KUAbbxO/yQlYRWyLHfW
fDSDekXr63Dl/VvXV/SSGWjRH39Bim8c8W1dg9chl2fxucF0amIQRVAh52DAuTQn
I0u0ukmlUykL22QBAw9YGyGgGL2thLihDz5xnHU4nqj8j+16Op7Ubm6fpQKBgBDK
PehFhKE+D4sp1WSl5pW6eeQZZrz8cp5LmeEjZTY8/Vry0qVwu3NBgh4VX2nFiuf7
eKpDsMPEjXmFQzWWpZELhOlPpp1o81fgWXU932l5Y0/yLC4gGj2Ts+X8sdNO25Fl
WG+UeTzChztTnBbd9HbqRI4p6zeMFxRVu8K+N+J5AoGAfLZLxloTRKBTJ1DVay7q
4yrBt5T4bzI+YWT4JmawDZlp7CQLOOxAe2GxOTw0yVk86gEC+KUS/REk0BIUS3Bx
g5v4EAR24suvD+wkW97FfjIpxju4nzi00jRLCEeZmobix07JWEeVKnA+mGkUF6yl
nFX+kLHzec6dGLbO3Le8k1g=
-----END PRIVATE KEY-----
12 changes: 6 additions & 6 deletions keys/client_public_key.pem
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
-----BEGIN PUBLIC KEY-----
MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAxe4aGHkbmb+89tLHW5UE
sBvCdwVJlNzioKMBhlJHiHYlwtXx9YIipz5WvX7nCkjmWEjD3pudcMprPzQxyS++
VjDdvrvf3LhZzJcRoRHCL2piozTaXWZd/3U2OddF/TKfhg0qRhb41v7CZ7IAgU9u
goEOBtOAL3szIhbvRl0c5Yho48Ph/fsM6/WOhnYTbZmDomycba+Tutu7gcHoIC3Z
RaQDRAJC8JxD1Va04XHb60U5wpK4bWL/ZvLahXlCyoxmpi7iD/gMy+WRyB/5T1uj
5c4C3c2l2yOplRqFJi/E5azGN7R3qqnKyCXStxXFfJ1Jn46YGVVjUwJy+WbIKbpE
MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAtfSOsqYpJImOZNEQKL9L
uXsYJhW0nufJrAbcUjhOX+wDbnZwjEmk7GQijEcOGEUsDxVcqyG2H31xK/Pn8Djq
B4FkPUfB8LlNNNu0krEsV37MD/sd8tN6J/OZUmVXclv9R8FPdBq1kkw3k78WNL3i
i9L9i4+kT0AzGkKtuT3l8Y+VVEchF15fGtEeZlF1heR85dVvUyjcWgxvrQ+UpIxm
lspFR97BnvcqWZVG28PCfyXpNBGw41kYkrWEVLHrjSpXbD3/zwCJMOp0vuXBDYMW
/C2IT23eNC0CzK6rqNhevdRnW2i2XlLwiEOZYAlzc/9paSBl8HdQJZ/rbP8X4APY
dwIDAQAB
-----END PUBLIC KEY-----

0 comments on commit bc6145b

Please sign in to comment.