Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/openware/barong
Barong auth server
https://github.com/openware/barong
authentication barong blockchain cryptocurrency-exchanges jwt jwt-authentication kyc microservice microservices-architecture oauth-server peatio
Last synced: 28 days ago
JSON representation
Barong auth server
- Host: GitHub
- URL: https://github.com/openware/barong
- Owner: openware
- License: apache-2.0
- Created: 2017-11-23T22:05:09.000Z (over 6 years ago)
- Default Branch: 2-6-stable
- Last Pushed: 2023-12-21T06:09:41.000Z (7 months ago)
- Last Synced: 2024-05-11T21:35:28.016Z (2 months ago)
- Topics: authentication, barong, blockchain, cryptocurrency-exchanges, jwt, jwt-authentication, kyc, microservice, microservices-architecture, oauth-server, peatio
- Language: Ruby
- Homepage: https://www.openware.com
- Size: 3.32 MB
- Stars: 138
- Watchers: 27
- Forks: 260
- Open Issues: 20
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.md
- Security: docs/security.md
- Roadmap: docs/roadmap.md
Lists
- awesome-stars - barong
- awesome-stars - openware/barong - Barong auth server (Ruby)
README
[openware.com]: https://www.openware.com
# Barong
[](https://ci.openware.work/openware/barong)
Barong is a authentication service for microservice architectures using JWT standard.
It's developped and maintained by [Openware](https://www.openware.com) team.
# Overview
It includes the following features:
- Registration of users
- Role based access control (RBAC)
- Embedded KyC process
- Integrated [KycAID](https://www.openware.com/sdk/docs/barong/kycaid.html) plugin
- Mailing system: event based, support multi-language, secured by cryptographic signatures
- [Service accounts](https://www.openware.com/sdk/docs/barong/service-accounts.html)
- Focused on user privacy: sensitive informations are encrypted in database using vault, masks are applied on fields in user API endpoints
# Development
Prerequisites:
- Ruby version: `2.6.6`
- Bundler preinstalled
- MySQL preinstalled
1. Install RubyGems dependencies
```
bundle install
```
2. Copy initialisation files
```
bin/init_config
```
3. Create database and run migrations
```
bundle exec rake db:create db:migrate
```
4. Start local server
```
bundle exec rails server
```
# Barong Levels
In the process of verification Barong assign different levels to accounts
- Level 0 is default account level
- Level 1 will apply after email verification
- Level 2 will apply after phone verification
- Level 3 will apply after identity & document verification
# Useful links to documentation
[Barong configuration](https://www.openware.com/sdk/docs/barong/configuration.html)
[Troubleshooting](https://www.openware.com/sdk/docs/barong/troubleshooting.html)
[REST Admin API documentation](https://www.openware.com/sdk/docs/barong/api/barong-admin-api-v2.html)
[REST Management API documentation](https://www.openware.com/sdk/docs/barong/api/barong-management-api-v2.html)
[REST User API documentation](https://www.openware.com/sdk/docs/barong/api/barong-user-api-v2.html)
[API Keys creation and usage](https://www.openware.com/sdk/docs/barong/general/api-keys.html)
[Captcha policy overview and configuration](https://www.openware.com/sdk/docs/barong/general/captcha.html)
[Setting up 2FA](https://www.openware.com/sdk/docs/barong/general/2fa.html)
[Barong password hashing](https://www.openware.com/sdk/docs/barong/general/password-hashing.html)
[Barong data encryption](https://www.openware.com/sdk/docs/barong/general/encryption.html)
# License
Barong is released under the terms of the [Apache License 2.0](https://github.com/openware/barong/blob/master/LICENSE.md).