You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+38-23Lines changed: 38 additions & 23 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -54,28 +54,6 @@ you have at least the following parameters set:
54
54
'database.username' => 'user',
55
55
'database.password' => 'password',
56
56
57
-
### Run database migrations
58
-
59
-
The module comes with some default SQL migrations which set up needed tables in the configured database. To run them,
60
-
open the _Federation_ tab from your _SimpleSAMLphp_ installation and select the option _OpenID Connect Installation_
61
-
inside the _Tools_ section. Once there, all you need to do is press the _Install_ button and the schema will be created.
62
-
63
-
Alternatively, in case of automatic / scripted deployments, you can run the 'install.php' script from the command line:
64
-
65
-
php modules/oidc/bin/install.php
66
-
67
-
### Relying Party (RP) Administration
68
-
69
-
The module lets you manage (create, read, update and delete) approved RPs from the module user interface itself.
70
-
71
-
Once the database schema has been created, you can open the _Federation_ tab from your _SimpleSAMLphp_ installation
72
-
and select the option _OpenID Connect Client Registry_ inside the _Tools_ section.
73
-
74
-
Note that clients can be marked as confidential or public. If the client is not marked as confidential (it is public),
75
-
and is using Authorization Code flow, it will have to provide PKCE parameters during the flow.
76
-
77
-
Client ID and secret will be generated, and can be seen after the client creation by clicking on the 'show' button.
78
-
79
57
### Create RSA key pair
80
58
81
59
During the authentication flow, generated ID Token and Access Token will be in a form of signed JSON Web token (JWS).
@@ -99,6 +77,43 @@ or use your passphrase if provided on private key generation:
99
77
100
78
If you use a passphrase, make sure to also configure it in the `module_oidc.php` config file.
101
79
80
+
### Enabling the module
81
+
82
+
At this point we can enable the module by adding `'oidc' => true` to the list of enabled modules in the main simplesamlphp configuration file, `config/config.php`.
83
+
84
+
'module.enable' => [
85
+
'exampleauth' => false,
86
+
'core' => true,
87
+
'admin' => true,
88
+
'saml' => true,
89
+
// enable oidc module
90
+
'oidc' => true
91
+
],
92
+
93
+
This is required the enable the module on the _Federation_ tab in the admin web interface, which can be used in the next two steps to finalize the installation.
94
+
95
+
### Run database migrations
96
+
97
+
The module comes with some default SQL migrations which set up needed tables in the configured database. To run them,
98
+
open the _Federation_ tab from your _SimpleSAMLphp_ installation and select the option _OpenID Connect Installation_
99
+
inside the _Tools_ section. Once there, all you need to do is press the _Install_ button and the schema will be created.
100
+
101
+
Alternatively, in case of automatic / scripted deployments, you can run the 'install.php' script from the command line:
102
+
103
+
php modules/oidc/bin/install.php
104
+
105
+
### Relying Party (RP) Administration
106
+
107
+
The module lets you manage (create, read, update and delete) approved RPs from the module user interface itself.
108
+
109
+
Once the database schema has been created, you can open the _Federation_ tab from your _SimpleSAMLphp_ installation
110
+
and select the option _OpenID Connect Client Registry_ inside the _Tools_ section.
111
+
112
+
Note that clients can be marked as confidential or public. If the client is not marked as confidential (it is public),
113
+
and is using Authorization Code flow, it will have to provide PKCE parameters during the flow.
114
+
115
+
Client ID and secret will be generated, and can be seen after the client creation by clicking on the 'show' button.
116
+
102
117
### Cron hook
103
118
104
119
In order to purge expired tokens, this module requires [cron module](https://simplesamlphp.org/docs/stable/cron:cron)
@@ -332,4 +347,4 @@ See [CONFORMANCE_TEST.md](CONFORMANCE_TEST.md)
0 commit comments