arrow-left

Only this pageAll pages
gitbookPowered by GitBook
1 of 25

한국어

Loading...

Quick Start

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

OIDC PROVIDER

Loading...

Identity Provider

Loading...

Development

Loading...

Miscellaneous

Loading...

Loading...

Loading...

Loading...

Loading...

Setup phone/email verification

Setup OP and IDP

Define a client

Query identities

Quick Examples

Overview

CHANGELOG

hashtag
0.3.9 - 2020-12-16

hashtag
Added

  • Created gitbook documentation:

https://moleculer-api.gitbook.io/iam/arrow-up-right

Supporters

hashtag
QMIT Inc.

A company which analyzes data of sports players to help recovery, training.

hashtag

Overview

Setup federations (social login)

Migrate old claims

Define custom claims

Rest password, Sign out, other interactions

Test authentication flow

Overview

Introduction

hashtag
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.

arrow-up-right arrow-up-right arrow-up-right arrow-up-right arrow-up-right arrow-up-right

hashtag
Features

  • Identity Provider

    • based on RDBMS

    • declarative claims schema definition for validation

hashtag
Demo

hashtag
OpenID Connect Provider and React web application

hashtag
Dynamically define claims schema

hashtag
Internal moleculer service actions

hashtag
Usage

hashtag
1. Documents

hashtag
2. Examples

hashtag
3. Quick Start

...

hashtag
Development

hashtag
build

  • yarn build-all

hashtag
1. moleculer-iam

hashtag
OIDC Provider + IDP + Moleculer service

  • yarn workspace moleculer-iam dev [example=simple] - Start development with (nodemon with ts-node)

  • yarn workspace moleculer-iam lint - Run TSLint

  • yarn workspace moleculer-iam build

hashtag
2. moleculer-iam-app

hashtag
React Application for OIDC interactions with browser

  • yarn workspace moleculer-iam-app dev - Start Server Application development (webpack)

  • yarn workspace moleculer-iam-app build- Transpile client-side ts/tsx to js

  • yarn workspace moleculer-iam-app build-server

hashtag
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.

hashtag
License

The project is available under the .

hashtag
Contact

Copyright (c) 2019 QMIT Inc.

Contributors

hashtag
Maintainers

hashtag
Contributors

Nobody yet

Get Started

FAQ

hashtag
What would be the major reason to use this rather than popular IAM solutions?

WIP...

https://en.plco.siteen.plco.sitechevron-right

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

  • 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 and react-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

  • - Transpile ts to js
  • yarn workspace moleculer-iam deps- Update dependencies

  • yarn workspace moleculer-iam test - Run tests & generate coverage report

  • yarn workspace moleculer-iam test --watch - Watch and run tests

  • - Transpile server-side ts to js
  • yarn workspace moleculer-iam-app test - Run tests

  • Features and details: ./docsarrow-up-right
    MoleculerJs: ./src/examplesarrow-up-right
    ./examplesarrow-up-right
    MIT licensearrow-up-right
    Project Architecture Diagram
    mol1
    hashtag

    Project Roadmap

    ════════════════════════════════════════════════════════════════════════════════════════════════════════════════════
    ╟ action                     │Params
    ╟────────────────────────────┼──────────────────────────────────────────────────────────────────────────────────────
    ║ iam.client.count           │ where                                                                       
    ║ iam.client.create          │ client_id, client_name, client_secret, client_uri, logo_uri, policy_uri, ...
    ║ iam.client.delete          │ id                                                                          
    ║ iam.client.find             │ id                                                                          
    ║ iam.client.get             │ where, offset, limit                                                        
    ║ iam.client.update          │ client_id, client_name, reset_client_secret, client_secret, client_uri, logo
    ║ iam.id.count               │ where                                                                       
    ║ iam.id.create              │ scope, metadata, claims, credentials                                        
    ║ iam.id.delete              │ id, permanently                                                             
    ║ iam.id.find                 │ id, email, phone_number, where, scope                                       
    ║ iam.id.get                 │ where, offset, limit, scope
    ║ iam.id.refresh             │ id, where                                                                   
    ║ iam.id.restore             │ id                                                                          
    ║ iam.id.update              │ id, scope, claims, metadata, credentials                                    
    ║ iam.id.validate            │ id, scope, claims, credenti                                              
    ║ iam.id.validateCredentials │ password                                                                    
    ║ iam.model.count            │ kind, where                                                                 
    ║ iam.model.delete           │ kind, where, offset, limit                                                  
    ║ iam.model.get              │ kind, where, offset, limit                                                  
    ║ iam.schema.define           │ scope, key, description, unique, immutable, validation, migration, parentVersion, ...
    ║ iam.schema.find             │ key, version, active                                                         
    ║ iam.schema.get             │ scope, key, version, active                                                  
    ╚════════════════════════════╧═══════════════════════════════════════════════════════════════════════════════════════
    yarn add moleculer-iam

    In-Memory adapter (for testing and development)

  • [] test and support Device code flow, also QR code

  • [] Identity Provider

    • [] 2FA

  • [] Account manager application

    • [] manage profile/session/credentials/devices/grants

  • [] Documentation
  • Build Status
    Coverage Status
    David
    Known Vulnerabilities
    NPM version
    app2
    dehypnosis - OverviewGitHubchevron-right
    Logo
    Moleculer
    app1