From 9816fc3a6c17570a86bb753de88b9ab512590983 Mon Sep 17 00:00:00 2001 From: Dominik Korsa Date: Tue, 9 Feb 2021 15:02:20 +0100 Subject: [PATCH 1/3] Update README.md --- README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/README.md b/README.md index dc66ff7..487c565 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,6 @@ +[English version of README](README.md) # Wulkanowy Bridge + ## Czym jest Wulkanowy Bridge? Wulkanowy Bridge to serwis umożliwiający dostęp do danych z dziennika VULCAN UONET+ poprzez udokumentowane API. From fb3ecd29ca5ccd1ff3987e6a0cfacbca1b3cacf9 Mon Sep 17 00:00:00 2001 From: Dominik Korsa Date: Tue, 9 Feb 2021 15:03:12 +0100 Subject: [PATCH 2/3] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 487c565..775c106 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -[English version of README](README.md) +[English version of README](README.en.md) # Wulkanowy Bridge ## Czym jest Wulkanowy Bridge? From b7398ac75750d20e09a5902b165c395efdde7a56 Mon Sep 17 00:00:00 2001 From: Dominik Korsa Date: Tue, 9 Feb 2021 15:28:03 +0100 Subject: [PATCH 3/3] Create README.en.md --- README.en.md | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) create mode 100644 README.en.md diff --git a/README.en.md b/README.en.md new file mode 100644 index 0000000..d4457ee --- /dev/null +++ b/README.en.md @@ -0,0 +1,18 @@ +[Polska wersja README](README.md) +# Wulkanowy Bridge + +## What is Wulkanowy Bridge? +Wulkanowy Bridge is a service, which allows apps to access data from VULCAN UONET+ using a well-documented API. + +## Project features +- Uses [wulkanowy/sdk-node](https://github.com/wulkanowy/sdk-node) +- Implements **OAuth2.0** protocol +- API uses **GraphQL** and supports [schema introspection](https://graphql.org/learn/introspection/) +- Apps (clients) don't have access to user's login and password +- [We encrypt data stored in our database, to limit the scope of an attack](#how-does-wulkanowy-bridge-protect-login-info-of-users) +- Apps specify the access scope and user is informed about it + +## How does Wulkanowy Bridge protect login info of users? +To reduce the consequences of unauthorised access to our server or database, login and session information is encrypted in the database. The key needed to decrypt the information is in the access token generated for an app, so accessing the database doesn't, by itself, allow to decrypt the information. +**Wulkanowy Bridge ma możliwość odszyfrowania tych informacji wyłącznie podczas zapytania przez aplikację (przy każdym zapytaniu wysyłany jest token)** +**Wulkanowy Bridge can decrypt the information only when a request is made by an app (the access token is sent with every request)**