0.2.12 • Published 4 years ago
moleculer-iam-app-renderer v0.2.12
moleculer-iam
Centralized IAM module for moleculer. Including a certified OIDC provider and an Identity provider for user profile, credentials, and custom claims management feature. Custom claims could be defined/updated by declarative schema which contains claims validation and migration strategy. Also including default interaction React.js application for login/logout/registration and other OP interactions, and the account management React.js application.
Features
- Identity Provider
- based on RDBMS
- declarative claims schema definition for validation
- dynamic update for claims schema and scope
- versioned claims with robust claims schema migration support
- each identities are cached as JSON value for performance
- support complex query for fetching identity
- basic OpenID claims battery included
- ready for distributed system
- OpenID Connect Provider
- based on
panva/node-oidc-provider
- OpenID certified library
- ready for basic interactions for below react app
- federation presets for google and facebook, kakaotalk based on passport, also extendable
- support i18n; for now ko-KR, en-US
- based on
- Moleculer integrated actions and events
- manage IDP claims schema and identity
- manage OP client and other models
- React App for OP interaction rendering
- based on
react-native-ui-kitten
andreact-navigation
- session based
- support i18n; for now ko-KR, en-US
- support login/logout/register/findEmail/resetPassword/verifyEmail/verifyPhone/consent
- support theming and various customization option without rebuild from server configuration
- this whole app can be replaced to custom one from server configuration
- based on
Usage
1. Documents
2. Examples
3. Quick Start
yarn add moleculer-iam
...
Development
build
yarn build-all
1. moleculer-iam
OIDC Provider + IDP + Moleculer service
yarn workspace moleculer-iam dev [example=simple]
- Start development with ./examples (nodemon with ts-node)yarn workspace moleculer-iam lint
- Run TSLintyarn workspace moleculer-iam build
- Transpile ts to jsyarn workspace moleculer-iam deps
- Update dependenciesyarn workspace moleculer-iam test
- Run tests & generate coverage reportyarn workspace moleculer-iam test --watch
- Watch and run tests
2. moleculer-iam-app-renderer
React Application for OIDC interactions with browser
yarn workspace moleculer-iam-app-renderer dev
- Start Server Application development (webpack)yarn workspace moleculer-iam-app-renderer build
- Transpile client-side ts/tsx to jsyarn workspace moleculer-iam-app-renderer build-server
- Transpile server-side ts to jsyarn workspace moleculer-iam-app-renderer test
- Run tests
Release Road-map
- 0.1.x Pre-alpha
- OIDC Provider
- hack
oidc-provider
module to be programmable
- hack
- OIDC Provider
- 0.2.x Alpha
- Identity Provider
- Storage
- In-Memory adapter (for testing and development)
- RDBMS adapter (MySQL, PostgreSQL, ...)
- OIDC scope and claims definition
- Declarative claims schema
- Robust migration support for versioned claims
- Battery included OIDC scopes
- openid
- profile (name, picture)
- email (email, email_verified)
- phone (phone_number, phone_number_verified)
- gender
- birthdate
- Dynamic scope grant without definition (eg. repo:read, calendar:create, whatever:dynamic:permissions)
- Storage
- Federation
- OAuth
- Google (OIDC)
- KakaoTalk
- OAuth
- Application Renderer (React.js)
- token management
- login
- logout / change account
- consent
- account management
- find email
- reset password
- phone verification
- email verification
- registration
- token management
- Identity Provider
- [] 0.3.x Beta
- [] Application renderer simple test cases
- [] OIDC Provider
- [] test and support Device code flow, also QR code
- [] Identity Provider
- [] 2FA
- [] Account manager application
- [] manage profile/session/credentials/devices/grants
- [] 1.0.x First Stable Release
- [] Rate limiter
- [] IP filter
- [] Documentation
- []
moleculer-api
integration example
Contribution
Please send pull requests improving the usage and fixing bugs, improving documentation and providing better examples, or providing some testing, because these things are important.
License
The project is available under the MIT license.
Contact
Copyright (c) 2019 QMIT Inc.