update README

Author: kwibus

README.md

@@ -1,10 +1,35 @@
-# OAuth2 Server Plugin for Moodle
+# OAuth2/OpenID Connect Server Plugin for Moodle
 
-It provides an [OAuth2](https://tools.ietf.org/html/rfc6749 "RFC6749") server so that a user can use its Moodle account to log in to your application.
-Oauth2 Library has been taken from https://github.com/bshaffer/oauth2-server-php
+It provides an [OAuth2](https://tools.ietf.org/html/rfc6749 "RFC6749") [OpenID Connect](https://openid.net/specs/openid-connect-core-1_0-final.html) server so that a user can use its Moodle account to log in to your application.
+So if you want give all you moodle users access to other website:
+
+* You can't use LTI for this
+* You can't use a existing IdP. That can be used by Moodle via auth plugin, and also would works for you other application.
+* Website support OAuth2 or OpenID Connect
+
+Then this plugin might be the solution for you.
+
+This plugin uses the php library https://github.com/bshaffer/oauth2-server-php to make moodle a OAuht/OpenID Connect IDP
+
+This plugin is used in Production by AT Computing. But we are still working on it. So its' has *MATURITY* status of *ALPHA*
+
+## What is different from the original
+
+This plug was original created by: https://github.com/projectestac/moodle-local_oauth
+
+This difference between this plugin and the original are:
+
+* It not only follows OAuth2 but also the OpenID connection specifications.
+* Besides haveing scopes for the OpenID Connect claims: openid, profile, email, address And phone.
+  It also implemnt a new claim enrolments. That gives client a list of course the user is enroled in.
+* Is has some update to follow the current Moodle plugin  best practices.
+    - replacemnt of deprecated function like `print_error`
+    - implement privacy api
+    - follow reconmendation from [moodle-plugin-ci](https://github.com/moodlehq/moodle-plugin-ci)
+* Move php dependencie bshaffer/oauth2-server-php. to vendor directory to make it easier to upgrade
 
 ## Requirements
-* #### Moodle 2.8 o higher installed
+* #### Moodle 4.0 or higher installed
 * #### Admin account
 
 ## Instalation steps
@@ -26,29 +51,30 @@ Oauth2 Library has been taken from https://github.com/bshaffer/oauth2-server-php
 
 9. Fill in the form. Your Client Identifier and Client Secret (which will be given later) will be used for you to authenticate. The Redirect URL must be the URL mapping to your client that will be used.
 
-## How to use 
+## How to use
 
 1. From your application, redirect the user to this URL: `http://moodledomain.com/local/oauth/login.php?client_id=EXAMPLE&response_type=code` *(remember to replace the URL domain with the domain of Moodle and replace EXAMPLE with the Client Identifier given in the form.)*
 
 2. The user must log in to Moodle and authorize your application to use its basic info.
 
 3. If it went all ok, the plugin should redirect the user to something like: `http://yourapplicationdomain.com/foo?code=55c057549f29c428066cbbd67ca6b17099cb1a9e` *(that's a GET request to the Redirect URL given with the code parameter)*
 
-4. Using the code given, your application must send a POST request to `http://moodledomain.com/local/oauth/token.php`  having the following parameters: `{'code': '55c057549f29c428066cbbd67ca6b17099cb1a9e', 'client_id': 'EXAMPLE', 'client_secret': 'codeGivenAfterTheFormWasFilled', 'grant_type': 'authorization_code',   'scope': 'user_info'}`. 
+4. Using the code given, your application must send a POST request to `http://moodledomain.com/local/oauth/token.php`  having the following parameters: `{'code': '55c057549f29c428066cbbd67ca6b17099cb1a9e', 'client_id': 'EXAMPLE', 'client_secret': 'codeGivenAfterTheFormWasFilled', 'grant_type': 'authorization_code',   'scope': 'user_info'}`.
 
 5. If the correct credentials were given, the response should a JSON be like this: `{"access_token":"79d687a0ea4910c6662b2e38116528fdcd65f0d1","expires_in":3600,"token_type":"Bearer","scope":"user_info","refresh_token":"c1de730eef1b2072b48799000ec7cde4ea6d2af0"}`
 
-6. Finally, send a POST request to `http://moodledomain.com/local/oauth/user_info.php` passing the access token as a parameter, like: `{'access_token':'79d687a0ea4910c6662b2e38116528fdcd65f0d1'}`. 
+6. Finally, send a POST request to `http://moodledomain.com/local/oauth/user_info.php` passing the access token as a parameter, like: `{'access_token':'79d687a0ea4910c6662b2e38116528fdcd65f0d1'}`.
 
 7. If the token given is valid, a JSON containing the user information is returned. Ex: `{"id":"22","username":"foobar","idnumber":"","firstname":"Foo","lastname":"Bar","email":"[email protected]","lang":"en","phone1":"5551619192"}`
 
 
 
-**This plugin has been tested on Moodle 2.8 and Moodle 3.0**
+**This plugin has been tested on Moodle 4
 
 
 ## Contributors
-Apart from people in this repository, also have contributed:
 
+- [projectestac] (https://github.com/projectestac/moodle-local_oauth) original plugin
+- [examus] (https://github.com/examus/moodle-local_oauth). This project i original found and forked from
 - [igorpf] (https://github.com/igorpf)
 

tests/privacy/provider_test.php

@@ -258,6 +258,8 @@ private function setup_test_scenario_data($userid) {
 
         $client = "dummy_client";
         $scope = "dummy_scopes";
+
+        // Test will fail if not all refreshtoken are unique.
         $refreshtoken = bin2hex(openssl_random_pseudo_bytes(10));
 
         // Fill local_oauth_access_tokens table.

version.php

@@ -26,3 +26,4 @@
 $plugin->version  = 2022031102;   // The (date) version of this plugin.
 $plugin->requires = 2011021900;   // Requires this Moodle version.
 $plugin->component = 'local_oauth';
+$plugin->maturity = MATURITY_ALPHA;