ZIP Imports: Added API examples, finished testing

[bookstack] / app / Access / Oidc / OidcProviderSettings.php

diff --git a/app/Access/Oidc/OidcProviderSettings.php b/app/Access/Oidc/OidcProviderSettings.php
index fa3f579b18a8db4a667fb4597d71f00c85743db6..71c3b573421593e686d625e2ec4e84525c204ae1 100644 (file)
--- a/app/Access/Oidc/OidcProviderSettings.php
+++ b/app/Access/Oidc/OidcProviderSettings.php
@@ -18,9 +18,10 @@ class OidcProviderSettings
     public string $issuer;
     public string $clientId;
     public string $clientSecret;
     public string $issuer;
     public string $clientId;
     public string $clientSecret;

-    public ?string $redirectUri;

     public ?string $authorizationEndpoint;
     public ?string $tokenEndpoint;
     public ?string $authorizationEndpoint;
     public ?string $tokenEndpoint;

+    public ?string $endSessionEndpoint;
+    public ?string $userinfoEndpoint;

 
     /**
      * @var string[]|array[]
 
     /**
      * @var string[]|array[]


@@ -36,7 +37,7 @@ class OidcProviderSettings
     /**
      * Apply an array of settings to populate setting properties within this class.
      */
     /**
      * Apply an array of settings to populate setting properties within this class.
      */

-    protected function applySettingsFromArray(array $settingsArray)
+    protected function applySettingsFromArray(array $settingsArray): void

     {
         foreach ($settingsArray as $key => $value) {
             if (property_exists($this, $key)) {
     {
         foreach ($settingsArray as $key => $value) {
             if (property_exists($this, $key)) {


@@ -50,9 +51,9 @@ class OidcProviderSettings
      *
      * @throws InvalidArgumentException
      */
      *
      * @throws InvalidArgumentException
      */

-    protected function validateInitial()
+    protected function validateInitial(): void

     {
     {

-        $required = ['clientId', 'clientSecret', 'redirectUri', 'issuer'];
+        $required = ['clientId', 'clientSecret', 'issuer'];

         foreach ($required as $prop) {
             if (empty($this->$prop)) {
                 throw new InvalidArgumentException("Missing required configuration \"{$prop}\" value");
         foreach ($required as $prop) {
             if (empty($this->$prop)) {
                 throw new InvalidArgumentException("Missing required configuration \"{$prop}\" value");


@@ -72,12 +73,20 @@ class OidcProviderSettings
     public function validate(): void
     {
         $this->validateInitial();
     public function validate(): void
     {
         $this->validateInitial();

+

         $required = ['keys', 'tokenEndpoint', 'authorizationEndpoint'];
         foreach ($required as $prop) {
             if (empty($this->$prop)) {
                 throw new InvalidArgumentException("Missing required configuration \"{$prop}\" value");
             }
         }
         $required = ['keys', 'tokenEndpoint', 'authorizationEndpoint'];
         foreach ($required as $prop) {
             if (empty($this->$prop)) {
                 throw new InvalidArgumentException("Missing required configuration \"{$prop}\" value");
             }
         }

+
+        $endpointProperties = ['tokenEndpoint', 'authorizationEndpoint', 'userinfoEndpoint'];
+        foreach ($endpointProperties as $prop) {
+            if (is_string($this->$prop) && !str_starts_with($this->$prop, 'https://')) {
+                throw new InvalidArgumentException("Endpoint value for \"{$prop}\" must start with https://");
+            }
+        }

     }
 
     /**
     }
 
     /**


@@ -85,7 +94,7 @@ class OidcProviderSettings
      *
      * @throws OidcIssuerDiscoveryException
      */
      *
      * @throws OidcIssuerDiscoveryException
      */

-    public function discoverFromIssuer(ClientInterface $httpClient, Repository $cache, int $cacheMinutes)
+    public function discoverFromIssuer(ClientInterface $httpClient, Repository $cache, int $cacheMinutes): void

     {
         try {
             $cacheKey = 'oidc-discovery::' . $this->issuer;
     {
         try {
             $cacheKey = 'oidc-discovery::' . $this->issuer;


@@ -127,11 +136,19 @@ class OidcProviderSettings
             $discoveredSettings['tokenEndpoint'] = $result['token_endpoint'];
         }
 
             $discoveredSettings['tokenEndpoint'] = $result['token_endpoint'];
         }
 

+        if (!empty($result['userinfo_endpoint'])) {
+            $discoveredSettings['userinfoEndpoint'] = $result['userinfo_endpoint'];
+        }
+

         if (!empty($result['jwks_uri'])) {
             $keys = $this->loadKeysFromUri($result['jwks_uri'], $httpClient);
             $discoveredSettings['keys'] = $this->filterKeys($keys);
         }
 
         if (!empty($result['jwks_uri'])) {
             $keys = $this->loadKeysFromUri($result['jwks_uri'], $httpClient);
             $discoveredSettings['keys'] = $this->filterKeys($keys);
         }
 

+        if (!empty($result['end_session_endpoint'])) {
+            $discoveredSettings['endSessionEndpoint'] = $result['end_session_endpoint'];
+        }
+

         return $discoveredSettings;
     }
 
         return $discoveredSettings;
     }
 


@@ -170,9 +187,9 @@ class OidcProviderSettings
     /**
      * Get the settings needed by an OAuth provider, as a key=>value array.
      */
     /**
      * Get the settings needed by an OAuth provider, as a key=>value array.
      */

-    public function arrayForProvider(): array
+    public function arrayForOAuthProvider(): array

     {
     {

-        $settingKeys = ['clientId', 'clientSecret', 'redirectUri', 'authorizationEndpoint', 'tokenEndpoint'];
+        $settingKeys = ['clientId', 'clientSecret', 'authorizationEndpoint', 'tokenEndpoint', 'userinfoEndpoint'];

         $settings = [];
         foreach ($settingKeys as $setting) {
             $settings[$setting] = $this->$setting;
         $settings = [];
         foreach ($settingKeys as $setting) {
             $settings[$setting] = $this->$setting;