Lint

Author: cicnavi

README.md

@@ -1,7 +1,8 @@
-# simplesamlphp-module-oidc
+# SimpleSAMLphp Module OIDC
+
 > A SimpleSAMLphp module for OIDC OP support.
 
-[![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) 
+[![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)
 [![Coverage Status](https://codecov.io/gh/simplesamlphp/simplesamlphp-module-oidc/branch/master/graph/badge.svg)](https://app.codecov.io/gh/simplesamlphp/simplesamlphp-module-oidc)
 [![SimpleSAMLphp](https://img.shields.io/badge/simplesamlphp-2.3-brightgreen)](https://simplesamlphp.org/)
 

docs/configuration.md

@@ -84,8 +84,8 @@ perform the key switch.
 
 ## Apache Authorization header note
 
-Apache may strip the `Authorization` header (Bearer) from requests, a known
-issue: https://github.com/symfony/symfony/issues/19693
+Apache may strip the `Authorization` header (Bearer) from requests (a known
+[issue](https://github.com/symfony/symfony/issues/19693)).
 
 Although the module includes a fallback, it has performance implications.
 Configure Apache to preserve the header using one of these snippets:
@@ -126,8 +126,8 @@ $config = [
 
 ## Attribute translation
 
-Default SAML-to-OIDC claim mapping follows the REFEDS guidance:
-https://wiki.refeds.org/display/GROUPS/Mapping+SAML+attributes+to+OIDC+Claims
+Default SAML-to-OIDC claim mapping follows the
+[REFEDS guidance](https://wiki.refeds.org/display/GROUPS/Mapping+SAML+attributes+to+OIDC+Claims).
 
 You can change or extend this mapping in `module_oidc.php`. Example:
 
@@ -217,4 +217,4 @@ $config = [
 
 Users can visit the following link for administration:
 
-- https://example.com/simplesaml/module.php/oidc/clients/
+- [https://example.com/simplesaml/module.php/oidc/clients/](https://example.com/simplesaml/module.php/oidc/clients/)

docs/conformance.md

@@ -24,7 +24,7 @@ docker-compose up
 
 This starts the Java conformance app and a MongoDB server. Then:
 
-- Visit https://localhost:8443/
+- Visit [https://localhost:8443/](https://localhost:8443/)
 - Create a new plan:
   "OpenID Connect Core: Basic Certification Profile Authorization server test"
 - Click the JSON tab and paste
@@ -48,8 +48,8 @@ warnings as needed.
 
 ### Run automated tests
 
-Once manual tests pass, you can automate the browser portion:
-https://gitlab.com/openid/conformance-suite/-/wikis/Design/BrowserControl
+Once manual tests pass, you can
+[automate the browser portion](https://gitlab.com/openid/conformance-suite/-/wikis/Design/BrowserControl).
 
 From the `simplesamlphp-module-oidc` directory:
 
@@ -97,7 +97,7 @@ pre-populated with data for the tests. Build and run the image.
 
 ### Register and create conformance tests
 
-Visit https://openid.net/certification/instructions/
+Visit [https://openid.net/certification/instructions/](https://openid.net/certification/instructions/).
 
 Use the `json` configs under `conformance-tests` to configure your cloud
 instances. Update `discoveryUrl` to the deployed location. Adjust `alias`

docs/docker.md

@@ -30,11 +30,11 @@ docker run --name ssp-oidc-dev \
 
 Then visit:
 
-- https://localhost/simplesaml/
+- [https://localhost/simplesaml/](https://localhost/simplesaml/)
 
 The OIDC configuration endpoint is available at:
 
-- https://localhost/.well-known/openid-configuration
+- [https://localhost/.well-known/openid-configuration](https://localhost/.well-known/openid-configuration)
 
 ## Local testing with other DBs
 
@@ -78,7 +78,8 @@ When running Docker, adjust `COMPOSER_REQUIRE` to include the module:
  simplesamlphp/simplesamlphp-module-preprodwarning"
 ```
 
-You can register a client from https://oidcdebugger.com/ to test.
+You can register a client from
+[https://oidcdebugger.com/](https://oidcdebugger.com/) to test.
 
 ## Build image for conformance tests
 
@@ -132,4 +133,4 @@ OIDC_VERSION=dev-master docker-compose -f docker/docker-compose.yml --project-di
 
 Visit the OP and verify a few clients exist:
 
-- https://op.local.stack-dev.cirrusidentity.com/simplesaml/
+- [https://op.local.stack-dev.cirrusidentity.com/simplesaml/](https://op.local.stack-dev.cirrusidentity.com/simplesaml/)

docs/oidc.md

@@ -6,6 +6,7 @@ and is based on the
 [OAuth2 Server from the PHP League](https://oauth2.thephpleague.com/).
 
 Supported flows:
+
 - Authorization Code, with PKCE (response_type: `code`)
 - Implicit (response_type: `id_token token` or `id_token`)
 - Refresh Token
@@ -21,6 +22,7 @@ capabilities. OIDFed can be enabled or disabled in the module
 configuration.
 
 Currently supported OIDFed features:
+
 - Automatic client registration using a Request Object (by value)
 - Federation participation limiting based on Trust Marks
 - Endpoint for issuing a configuration entity statement (about itself)
@@ -34,14 +36,16 @@ OIDFed is implemented using the
 
 Minor versions listed show which SimpleSAMLphp versions were used during
 module development. SimpleSAMLphp follows semantic versioning for its
-API since v2.0. For example, v5.* of the OIDC module should work with
-any v2.* of SimpleSAMLphp. PHP version requirements may differ.
-
-- OIDC v6.*  → SimpleSAMLphp v2.3.*, v2.4.*   → PHP >= 8.2 (recommended)
-- OIDC v5.*  → SimpleSAMLphp v2.1.*           → PHP >= 8.1
-- OIDC v4.*  → SimpleSAMLphp v2.0.*           → PHP >= 8.0
-- OIDC v3.*  → SimpleSAMLphp v2.0.*           → PHP >= 7.4
-- OIDC v2.*  → SimpleSAMLphp v1.19.*          → PHP >= 7.4
+API since v2.0. For example, v5.\* of the OIDC module should work with
+any v2.\* of SimpleSAMLphp. PHP version requirements may differ.
+
+| OIDC module | Tested SimpleSAMLphp |  PHP   | Note        |
+|:------------|:---------------------|:------:|-------------|
+| v6.\*       | v2.3.\*, v2.4.\*     | \>=8.2 | Recommended |
+| v5.\*       | v2.1.\*              | \>=8.1 |             |
+| v4.\*       | v2.0.\*              | \>=8.0 |             |
+| v3.\*       | v2.0.\*              | \>=7.4 |             |
+| v2.\*       | v1.19.\*             | \>=7.4 |             |
 
 Upgrading? See the [upgrade guide](upgrade.md).
 

docs/upgrade.md

@@ -1,7 +1,7 @@
 # Upgrade guide
 
 This is an upgrade guide from versions 1 → 6. Review the changes and
-apply those relevant to your deployment. 
+apply those relevant to your deployment.
 
 ## Version 5 to 6
 
@@ -149,7 +149,7 @@ someone will upgrade from the legacy OAuth2 module to v6 of oidc module.
 If needed, one can upgrade to earlier versions of the `oidc` module, and then
 to v6.
 
-# Version 4 to 5
+## Version 4 to 5
 
 Major impact changes:
 
@@ -180,14 +180,14 @@ like using constructor property promotion, match expressions...
 - removed dependency on steverhoades/oauth2-openid-connect-server
 (low maintenance)
 
-# Version 3 to 4
+## Version 3 to 4
 
 - PHP version requirement was bumped to v8.0 to enable updating important
 dependent packages like 'league/oauth2-server' which has already moved to
 PHPv8 between their minor releases.
 - SimpleSAMLphp version used during development was bumped v2.0
 
-# Version 2 to 3
+## Version 2 to 3
 
 - Module code was refactored to make it compatible with SimpleSAMLphp v2
 - The default key name was changed from oidc_module.pem to oidc_module.key.
@@ -197,7 +197,7 @@ oidc_module.pem to oidc_module.key.
 - Removed config option 'alwaysIssueRefreshToken'
 - Removed config option 'alwaysAddClaimsToIdToken'
 
-# Version 1 to 2
+## Version 1 to 2
 
 There are many DB changes that need to be applied. Perform the migration by
 logging in as an SSP admin to
@@ -237,6 +237,6 @@ the change. Note that in that case the client must have the
 
 Token endpoint was renamed from '.../access_token.php' to '.../token.php'.
 This is a potential breaking change for clients that do not fetch
-OP configuration from the /.well-known/openid-configuration URI dynamically, but 
-instead hardcode endpoints in their configuration. You should probably warn
-existing Relying Parties about this change.
+OP configuration from the /.well-known/openid-configuration URI dynamically,
+but instead hardcode endpoints in their configuration. You should probably
+warn existing Relying Parties about this change.