114 lines
3.1 KiB
Markdown
114 lines
3.1 KiB
Markdown
<div dir="rtl">
|
|
|
|
# Dalan — احراز هویت Fibitex (Barong)
|
|
|
|
**Dalan** فورک [Barong](https://github.com/openware/barong) 2.6 برای JWT، KYC، و مدیریت کاربر Fibitex.
|
|
|
|
| OpenDAX | Fibitex |
|
|
|---------|---------|
|
|
| Barong | **Dalan** |
|
|
| `/api/v2/barong` | `/api/v2/dalan` |
|
|
|
|
## پیشنیازها
|
|
|
|
Ruby 2.6.6، MySQL، Vault (در stack Alvand-P)
|
|
|
|
## راهاندازی سریع
|
|
|
|
<div dir="ltr">
|
|
|
|
```bash
|
|
cd ../Alvand-P && rake service:all
|
|
```
|
|
|
|
</div>
|
|
|
|
## مستندات
|
|
|
|
| سند | موضوع |
|
|
|-----|--------|
|
|
| [`Docs/03-dalan-microservice.md`](../Docs/03-dalan-microservice.md) | معماری Dalan |
|
|
| [`Docs/Fibitex-staging-deploy.md`](../Docs/Fibitex-staging-deploy.md) | Deploy |
|
|
| [`Alvand-P/Docs/QA-troubleshooting.md`](../Alvand-P/Docs/QA-troubleshooting.md) | عیبیابی |
|
|
| [`Docs/README.md`](../Docs/README.md) | فهرست مرکزی |
|
|
|
|
</div>
|
|
|
|
---
|
|
|
|
# Dalan
|
|
it is fork project of barong
|
|
|
|
### 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 API documentation](https://www.openware.com/sdk/docs/barong/rest-api.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/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)
|
|
|