Skip to content

Commit 092bf54

Browse files
committed
Merge with version 7
1 parent 32ddccc commit 092bf54

File tree

3 files changed

+49
-1
lines changed

3 files changed

+49
-1
lines changed

docs/2-oidc-installation.md

Lines changed: 40 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,12 +34,14 @@ and ensure at least the following parameters are set:
3434

3535
Note: SQLite, PostgreSQL, and MySQL are supported.
3636

37-
## 4. Create RSA key pairs
37+
## 4. Create key pairs
3838

3939
ID and Access tokens are signed JWTs. Create a public/private RSA key
4040
pair for OIDC protocol operations. If you plan to use OpenID Federation,
4141
create a separate key pair for federation operations.
4242

43+
### RSA key pair generation
44+
4345
Generate private keys without a passphrase:
4446

4547
```bash
@@ -73,6 +75,43 @@ openssl rsa -in cert/oidc_module_federation.key -passin pass:myPassPhrase -pubou
7375
If you use different file names or a passphrase, update
7476
`config/module_oidc.php` accordingly.
7577

78+
### EC key pair generation
79+
80+
If you prefer to use Elliptic Curve Cryptography (ECC) instead of RSA.
81+
82+
Generate private keys without a passphrase:
83+
84+
```bash
85+
openssl ecparam -name prime256v1 -genkey -noout -out cert/oidc_module.key
86+
openssl ecparam -name prime256v1 -genkey -noout -out cert/oidc_module_federation.key
87+
```
88+
89+
Generate private keys with a passphrase:
90+
91+
```bash
92+
openssl ecparam -genkey -name secp384r1 -noout -out cert/oidc_module.key -passout pass:myPassPhrase
93+
openssl ecparam -genkey -name secp384r1 -noout -out cert/oidc_module_federation.key -passout pass:myPassPhrase
94+
```
95+
96+
Extract public keys:
97+
98+
Without passphrase:
99+
100+
```bash
101+
openssl ec -in cert/oidc_module.key -pubout -out cert/oidc_module.crt
102+
openssl ec -in cert/oidc_module_federation.key -pubout -out cert/oidc_module_federation.crt
103+
```
104+
105+
With a passphrase:
106+
107+
```bash
108+
openssl ec -in cert/oidc_module.key -passin pass:myPassPhrase -pubout -out cert/oidc_module.crt
109+
openssl ec -in cert/oidc_module.key -passin pass:myPassPhrase -pubout -out cert/oidc_module.crt
110+
```
111+
112+
If you use different file names or a passphrase, update
113+
`config/module_oidc.php` accordingly.
114+
76115
## 5. Enable the module
77116

78117
Edit `config/config.php` and enable `oidc`:

docs/3-oidc-configuration.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -54,6 +54,12 @@ There you can see discovery URLs. Typical discovery endpoints are:
5454
[https://yourserver/simplesaml/module.php/oidc/.well-known/openid-configuration](https://yourserver/simplesaml/module.php/oidc/.well-known/openid-configuration)
5555
- OpenID Federation configuration:
5656
[https://yourserver/simplesaml/module.php/oidc/.well-known/openid-federation](https://yourserver/simplesaml/module.php/oidc/.well-known/openid-federation)
57+
- OpenID for Verifiable Credential Issuance configuration:
58+
[https://yourserver/simplesaml/module.php/oidc/.well-known/openid-credential-issuer](https://yourserver/simplesaml/module.php/oidc/.well-known/openid-credential-issuer)
59+
- OAuth2 Authorization Server configuration:
60+
[https://yourserver/simplesaml/module.php/oidc/.well-known/oauth-authorization-server](https://yourserver/simplesaml/module.php/oidc/.well-known/oauth-authorization-server)
61+
- JWT VC Issuer configuration:
62+
[https://yourserver/simplesaml/module.php/oidc/.well-known/jwt-vc-issuer](https://yourserver/simplesaml/module.php/oidc/.well-known/jwt-vc-issuer)
5763

5864
You may publish these as ".well-known" URLs at the web root using your
5965
web server. For example, for `openid-configuration`:

docs/6-oidc-upgrade.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,9 @@
33
This is an upgrade guide from versions 1 → 7. Review the changes and
44
apply those relevant to your deployment.
55

6+
## TODO mivanci
7+
* Move to specific simplesamlphp/openid release (composer.json).
8+
69
## Version 6 to 7
710

811
New features:

0 commit comments

Comments
 (0)