Skip to content

Commit 1329bf9

Browse files
committed
Update docs
1 parent 201f2ba commit 1329bf9

1 file changed

Lines changed: 8 additions & 7 deletions

File tree

config/module_oidc.php.dist

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -22,14 +22,15 @@ declare(strict_types=1);
2222
*/
2323

2424
use SimpleSAML\Module\oidc\ModuleConfig;
25+
use SimpleSAML\OpenID\Codebooks\AtContextsEnum;
2526
use SimpleSAML\OpenID\Codebooks\ClaimsEnum;
2627
use SimpleSAML\OpenID\Codebooks\CredentialFormatIdentifiersEnum;
2728
use SimpleSAML\OpenID\Codebooks\CredentialTypesEnum;
2829
use SimpleSAML\OpenID\Codebooks\LanguageTagsEnum;
2930

3031
$config = [
3132
/**
32-
* (optional) Issuer (OP) identifier which will be used as an issuer (iss)
33+
* (optional) Issuer (OP) identifier that will be used as an issuer (iss)
3334
* claim in tokens. If not set, it will fall back to the current HTTP
3435
* scheme, host and port number if no standard port is used.
3536
* Description of the issuer from OIDC Core specification: "Verifiable
@@ -55,16 +56,16 @@ $config = [
5556
* example, for key-rollover scenarios. Just add those entries later in
5657
* the list, so they can be published on the OP JWKS discovery endpoint.
5758
*
58-
* The format is array of associative arrays, where each array value
59+
* The format is an array of associative arrays, where each array value
5960
* consists of the following properties (keys):
6061
* - ModuleConfig::KEY_ALGORITHM - \SimpleSAML\OpenID\Algorithms\SignatureAlgorithmEnum case
6162
* representing the algorithm.
6263
* - ModuleConfig::KEY_PRIVATE_KEY_FILENAME - the name of the file
63-
* containing private key inPEM format, which is available in SSP `cert`
64+
* containing a private key in PEM format, which is available in SSP `cert`
6465
* folder.
6566
* - ModuleConfig::KEY_PUBLIC_KEY_FILENAME - the name of the file containing
66-
* corresponding public key in PEM format, which is available in SSP `cert`
67-
* folder.
67+
* the corresponding public key in PEM format, which is available in
68+
* the SSP `cert` folder.
6869
* - ModuleConfig::KEY_PRIVATE_KEY_PASSWORD - private key password, if
6970
* needed.
7071
* - ModuleConfig::KEY_KEY_ID - Optional string representing key identifier.
@@ -286,7 +287,7 @@ $config = [
286287
/**
287288
* If this OP supports ACRs, indicate which usable auth source supports
288289
* which ACRs. Order of ACRs is important, more important ones being first.
289-
* Syntax: array<string,string[]> (array with an auth source as a key and
290+
* Syntax: array<string, string[]> (array with an auth source as a key and
290291
* value being array of ACR values as strings)
291292
*/
292293

@@ -339,7 +340,7 @@ $config = [
339340
* Source and destination will have entity IDs corresponding to the OP
340341
* issuer ID and Client ID respectively.
341342
* - ['Source']['entityid'] - contains OpenId Provider issuer ID
342-
* - ['Destination']['entityid'] - contains Relying Party (OIDC Client) ID
343+
* - ['Destination']['entityid'] - contains Relying Party (OIDC Client) ID.
343344
* In addition to that, the following OIDC related data will be available
344345
* in the state array:
345346
* - ['Oidc']['OpenIdProviderMetadata'] - contains information otherwise

0 commit comments

Comments
 (0)