README.md

OpenID Connect Provider for Nodejs (@interop/oidc-op)

Embeddable OpenID Connect Provider for Nodejs

This library aims to implement a minimal OpenID Connect Provider for Nodejs. It is not intended to be used directly by most developers, but rather via a complete self-contained server such as Life Server. Some applications require an embedded identity provider, such as entertainment or IoT appliances. This package can be used directly in these cases.

The module should make available an OIDCProvider class which can be instantiated multiple times to support multitenancy use cases. It should also have a method that provides a mountable router or app for widely used frameworks like Express.

Table of Contents

• Security
• Background
• Install
• Develop
• Maintainers
• Contribute
• MIT License

Security

...

Background

Internal Interface

OpenID Connect makes no provisions for how a user is initially authenticated by the IdP. It's up to the implementer to determine whether to use passwords, LDAP, SAML, OAuth, or some other means. The host system is responsible for other dependencies of the OIDC authentication flows as well, such as persistence, managing user attributes, multi-factor auth and so on.

In addition to implementing OpenID Connect Provider functions, this library defines an interface between OpenID Connect and the host application.

The goal of the interface is to manage the flow of responsibility between the OpenID Connect implementation and functions provided by the host application, such as local user authentication, persistence, and domain specific event handing.

Install

$ npm install @interop/oidc-op --save

Develop

Test

npm test

Maintainers

• Dmitri Zagidulin

Contribute

Style guide

• ES6
• Standard JavaScript
• jsdocs

Code of conduct

• @interop/oidc-op follows the Contributor Covenant Code of Conduct.

MIT License

The MIT License

Copyright (c) 2016 Anvil Research, Inc.
Copyright (c) 2017-2019 Dmitri Zagidulin and The Solid Project