Skip to content

Commit 32fd41c

Browse files
Add archival / deprecation notice to README.
1 parent 8b76e28 commit 32fd41c

1 file changed

Lines changed: 5 additions & 46 deletions

File tree

README.md

Lines changed: 5 additions & 46 deletions
Original file line numberDiff line numberDiff line change
@@ -1,53 +1,12 @@
11
# OpenID Connect for Nodejs
22

3-
[![Build Status](https://travis-ci.org/solid/oidc-op.svg?branch=master)](https://travis-ci.org/solid/oidc-op)
4-
[![codecov](https://codecov.io/gh/solid/oidc-op/branch/master/graph/badge.svg)](https://codecov.io/gh/solid/oidc-op)
3+
## Deprecation Notice
54

5+
This repository has been archived, and will no longer be maintained by the
6+
Solid Project.
67

7-
This library aims to implement a full-featured OpenID Connect Provider for
8-
Nodejs. It is not intended to be used directly by most developers, but rather
9-
via a complete self-contained server such as Anvil Connect. Some applications
10-
require an embedded identity provider, such as entertainment or IoT appliances.
11-
This package can be used directly in these cases.
12-
13-
The module should make available an OIDCProvider class which can be
14-
instantiated multiple times to support multitenancy use cases. It should also
15-
have a method that provides a mountable router or app for widely used frameworks
16-
like Express.
17-
18-
## Scope
19-
20-
- Core
21-
- Discovery
22-
- Dynamic Registration
23-
- OAuth 2.0 Multiple Response Types
24-
- OAuth 2.0 Form Post Response Types
25-
- Session Management
26-
- Front-Channel Logout
27-
- Back-Channel Logout
28-
- OAuth 2.0 Client Credentials Grant
29-
- Proof Key for Code Exchange by OAuth Clients (PKCE)
30-
31-
## Out of Scope
32-
33-
- Local Authentication
34-
- Persistence
35-
36-
## Internal Interface
37-
38-
OpenID Connect makes no provisions for how a user is initially authenticated
39-
by the IdP. It's up to the implementer to determine whether to use passwords,
40-
LDAP, SAML, OAuth, or some other means. The host system is responsible for
41-
other dependencies of the OIDC authentication flows as well, such as
42-
persistence, managing user attributes, multi-factor auth and so on.
43-
44-
In addition to implementing OpenID Connect Provider functions, this library
45-
defines an interface between OpenID Connect and the host application.
46-
47-
The goal of the interface is to manage the flow of responsibility between the
48-
OpenID Connect implementation and functions provided by the host application,
49-
such as local user authentication, persistence, and domain specific event
50-
handing.
8+
Active maintenance has been moved to
9+
**[interop-alliance/oidc-op](https://github.com/interop-alliance/oidc-op)**.
5110

5211
## MIT License
5312

0 commit comments

Comments
 (0)