-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathREADME.txt
111 lines (76 loc) · 2.72 KB
/
README.txt
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
CONTENTS OF THIS FILE
---------------------
* Introduction
* Usage
* Requirements
* Features
* Installation
* Configuration
* Troubleshooting
* Maintainers
* Known Issues
INTRODUCTION
------------
The OpenID Connect module provides a pluggable client implementation for the
OpenID Connect protocol. The server implementation of the protocol is provided
by OAuth2 Server.
OpenID Connect 1.0 is a simple identity layer on top of the OAuth 2.0 protocol.
It allows Clients to verify the identity of the End-User based on the
authentication performed by an Authorization Server, as well as to obtain basic
profile information about the End-User in an interoperable and REST-like manner.
USAGE
-----
The module allows you to use an external OpenID Connect login provider to
authenticate and log in users on your site. If a user signs in with a login
provider for the first time on the website, a new Drupal user will be created.
Google for instance uses OpenID Connect to authenticate users across all of
their services.
REQUIREMENTS
------------
No special requirements.
FEATURES
--------
* Supported login providers
* Login with Google
* Client configuration
* Fetching user profile information
* Sign in block
For a more detailed description and instructions please refer to the
documentation (https://www.drupal.org/node/2274339).
PERMISSIONS:
The module adds a new permission section entitled OpenID Connect API with
three new user rights:
* Administer OpenID Connect clients
* Manage own connected accounts
* Set a password for local authentication.
INSTALLATION
------------
Install as you would normally install a contributed Drupal module.
Visit: https://www.drupal.org/project/openid_connect for further information.
CONFIGURATION
-------------
Configuration options are available at
Administration >> Configuration >> Services >> OpenID Connect.
You can enable clients for login providers and configure their client ID and
client secret which are necessary credentials for authenticating with an OAuth2
server.
TROUBLESHOOTING
---------------
A standard Drupal block is available to sign in with the login providers for
which clients are enabled.
A single button is shown for each login provider.
In case if the login block does not display on the user's login page, check it
in the blocks list Administration >> Structure >> Block layout
MAINTAINERS
-----------
Current maintainers:
* Stefan Auditor (sanduhrs)
* Patrick Dawkins (pjcdawkins)
* Bojan Živanović (bojanz)
* Bálint Kléri (balintk)
Development is sponsored by:
* Commerce Guys and thanks to Bojan Živanović (bojanz) for helping to architect
the module.
KNOWN ISSUES
------------
Issues: https://www.drupal.org/project/issues/openid_connect?categories=All