Skip to content

Commit 4690e8d

Browse files
committed
Update readme
1 parent 775aef7 commit 4690e8d

File tree

1 file changed

+22
-10
lines changed

1 file changed

+22
-10
lines changed

README.md

Lines changed: 22 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ Currently supported flows are:
1313

1414
[![Build Status](https://github.com/simplesamlphp/simplesamlphp-module-oidc/actions/workflows/test.yaml/badge.svg)](https://github.com/simplesamlphp/simplesamlphp-module-oidc/actions/workflows/test.yaml)
1515
[![Coverage Status](https://codecov.io/gh/simplesamlphp/simplesamlphp-module-oidc/branch/master/graph/badge.svg)](https://app.codecov.io/gh/simplesamlphp/simplesamlphp-module-oidc)
16-
[![SimpleSAMLphp](https://img.shields.io/badge/simplesamlphp-2.1-brightgreen)](https://simplesamlphp.org/)
16+
[![SimpleSAMLphp](https://img.shields.io/badge/simplesamlphp-2.3-brightgreen)](https://simplesamlphp.org/)
1717

1818
![Main screen capture](docs/oidc.png)
1919

@@ -112,7 +112,7 @@ Once the module is enabled, the database migrations must be run.
112112
### Run database migrations
113113

114114
The module comes with some default SQL migrations which set up needed tables in the configured database. To run them,
115-
go to `OIDC` > `Database Migrations`, and press the available button.
115+
in the SimpleSAMLphp administration area go to `OIDC` > `Database Migrations`, and press the available button.
116116

117117
Alternatively, in case of automatic / scripted deployments, you can run the 'install.php' script from the command line:
118118

@@ -122,7 +122,8 @@ Alternatively, in case of automatic / scripted deployments, you can run the 'ins
122122

123123
The module lets you manage (create, read, update and delete) approved RPs from the module user interface itself.
124124

125-
Once the database schema has been created, you can go to `OIDC` > `Client Registry`.
125+
Once the database schema has been created, in the SimpleSAMLphp administration area go to `OIDC` >
126+
`Client Registry`.
126127

127128
Note that clients can be marked as confidential or public. If the client is not marked as confidential (it is public),
128129
and is using Authorization Code flow, it will have to provide PKCE parameters during the flow.
@@ -136,12 +137,9 @@ to be enabled and configured.
136137

137138
### Endpoint locations
138139

139-
Once you deployed the module, you will need the exact endpoint urls the module provides to configure the relying parties.
140-
You can visit the discovery endpoint to learn this information:
141-
142-
`<basepath>/module.php/oidc/.well-known/openid-configuration`
143-
144-
This endpoint can be used to set up a `.well-known` URL (see below).
140+
Once you deploy the module, in the SimpleSAMLphp administration area go to `OIDC` and then select the
141+
Protocol / Federation Settings page to see the available discovery URLs. These URLs can then be used to set up a
142+
`.well-known` URLs (see below).
145143

146144
### Note when using Apache web server
147145

@@ -161,6 +159,20 @@ SetEnvIf Authorization "(.*)" HTTP_AUTHORIZATION=$1
161159
```
162160
Choose the one which works for you. If you don't set it, you'll get a warnings about this situation in your logs.
163161

162+
### Note on OpenID Federation (OIDF) support
163+
164+
OpenID Federation support is in "draft" phase, as is the
165+
[specification](https://openid.net/specs/openid-federation-1_0) itself. This means that you can expect braking changes
166+
in future releases related to OIDF capabilities. You can enable / disable OIDF support at any time in module
167+
configuration.
168+
169+
Currently, the following OIDF features are supported:
170+
* endpoint for issuing configuration entity statement (statement about itself)
171+
* fetch endpoint for issuing statements about subordinates (registered clients)
172+
* automatic client registration using a Request Object
173+
174+
OIDF support is implemented using the underlying [SimpleSAMLphp OpenID library](https://github.com/simplesamlphp/openid).
175+
164176
## Additional considerations
165177
### Private scopes
166178

@@ -343,7 +355,7 @@ You may view the OIDC configuration endpoint at `https://localhost/.well-known/o
343355
To test local changes against another DB, such as Postgres, we need to:
344356

345357
* Create a docker network layer
346-
* Run a DB container ( and create a DB if one doesn't exist)
358+
* Run a DB container (and create a DB if one doesn't exist)
347359
* Run SSP and use the DB container
348360

349361
```

0 commit comments

Comments
 (0)