From 7bb976ec95675a97713f04c270d2ab27802805f1 Mon Sep 17 00:00:00 2001
From: warcooft <syamsuddine9@gmail.com>
Date: Fri, 13 Sep 2024 22:14:31 +0700
Subject: [PATCH 01/10] feat: add support for microsoft services

---
 docs/get_keys.md                    |  14 +++-
 docs/index.md                       |  12 +--
 docs/install.md                     |  25 ++++--
 docs/quickstart.md                  |  29 +++++--
 src/Config/ShieldOAuthConfig.php    |   7 ++
 src/Language/en/ShieldOAuthLang.php |   4 +
 src/Language/fa/ShieldOAuthLang.php |   4 +
 src/Language/fr/ShieldOAuthLang.php |   4 +
 src/Language/id/ShieldOAuthLang.php |   4 +
 src/Libraries/MicrosoftOAuth.php    | 126 ++++++++++++++++++++++++++++
 10 files changed, 206 insertions(+), 23 deletions(-)
 create mode 100644 src/Libraries/MicrosoftOAuth.php

diff --git a/docs/get_keys.md b/docs/get_keys.md
index 54a60ec..81da162 100644
--- a/docs/get_keys.md
+++ b/docs/get_keys.md
@@ -1,19 +1,22 @@
 # How To Get Keys
-  
+
 Obviously, receiving Keys is not directly related to `Shield OAuth`, however, to improve the documentation and convenience of our users, Therefore, we have provided helpful links on how to get keys from the three most important Google, GitHub and Yahoo. For other services, you can find the relevant steps by searching.
 
 - [How To Get Keys](#how-to-get-keys)
 - [Explanation About Callback](#explanation-about-callback)
 - [Get GitHub Keys](#get-github-keys)
 - [Get Google Keys](#get-google-keys)
+- [Get Microsoft Keys](#get-microsoft-keys)
 - [Get Yahoo Keys](#get-yahoo-keys)
 
-
 # Explanation About Callback
+
 What is important in receiving the keys in each of the services is the **Callback (Redirect)** address. In this regard, you must register the address as below.
+
 ```
 https://yourBaseUrl.com/oauth/call-back
 ```
+
 `Shield OAuth` allows you to put another expression in the place of `call-back`, for this you need to make the necessary changes in the `app/Config/ShieldOAuthConfig.php` file.
 
 ```php
@@ -27,10 +30,17 @@ https://yourBaseUrl.com/oauth/any-name-for-call-back
 ```
 
 # Get GitHub Keys
+
 The guide to get the `client_id` & `client_secret` keys on GitHub is [here](https://docs.github.com/en/developers/apps/building-oauth-apps/creating-an-oauth-app) in full.
 
 # Get Google Keys
+
 The guide to get the `client_id` & `client_secret` keys on Google is [here](https://www.balbooa.com/gridbox-documentation/how-to-get-google-client-id-and-client-secret).
 
+# Get Microsoft Keys
+
+The guide to get the `client_id` & `client_secret` keys on Microsoft is [here](https://docs.microfocus.com/doc/CS_MicrosoftOffice365_Content/1.2.3/GetClientInputs) or [here](https://learn.microsoft.com/en-us/answers/questions/834401/hi-i-want-my-client-id-and-client-secret-key).
+
 # Get Yahoo Keys
+
 The guide to get the `client_id` & `client_secret` keys on Yahoo is [here](https://developer.yahoo.com/apps/create/).
diff --git a/docs/index.md b/docs/index.md
index 9eeb1c4..4425221 100644
--- a/docs/index.md
+++ b/docs/index.md
@@ -1,4 +1,5 @@
 # Shield OAuth Documentation
+
 [![PHPCSFixer](https://github.com/datamweb/shield-oauth/actions/workflows/phpcsfixer.yml/badge.svg)](https://github.com/datamweb/shield-oauth/actions/workflows/phpcsfixer.yml)
 [![PHPStan](https://github.com/datamweb/shield-oauth/actions/workflows/phpstan.yml/badge.svg)](https://github.com/datamweb/shield-oauth/actions/workflows/phpstan.yml)
 [![Rector](https://github.com/datamweb/shield-oauth/actions/workflows/rector.yml/badge.svg)](https://github.com/datamweb/shield-oauth/actions/workflows/rector.yml)
@@ -8,16 +9,15 @@
 
 [![Latest Stable Version](https://poser.pugx.org/datamweb/shield-oauth/v?style=for-the-badge)](https://packagist.org/packages/datamweb/shield-oauth) [![Total Downloads](https://poser.pugx.org/datamweb/shield-oauth/downloads?style=for-the-badge)](https://packagist.org/packages/datamweb/shield-oauth) [![Latest Unstable Version](https://poser.pugx.org/datamweb/shield-oauth/v/unstable?style=for-the-badge)](https://packagist.org/packages/datamweb/shield-oauth) [![License](https://poser.pugx.org/datamweb/shield-oauth/license?style=for-the-badge)](https://packagist.org/packages/datamweb/shield-oauth) [![PHP Version Require](https://poser.pugx.org/datamweb/shield-oauth/require/php?style=for-the-badge)](https://packagist.org/packages/datamweb/shield-oauth)
 
-
-`Shield OAuth` helps you to provide the possibility of login or registering users through the OAuth service. Currently, `Shield OAuth` supports `Google OAuth` and `GitHub OAuth` by default, but it allows you to implement it for any other service, including Yahoo, Facebook, Twitter, LinkedIn, GitLab and ..., this is very easy. Just create a class in route `app\Libraries\ShieldOAuth`! 
+`Shield OAuth` helps you to provide the possibility of login or registering users through the OAuth service. Currently, `Shield OAuth` supports `Google OAuth`, `GitHub OAuth` and `Microsoft OAuth` by default, but it allows you to implement it for any other service, including Yahoo, Facebook, Twitter, LinkedIn, GitLab and ..., this is very easy. Just create a class in route `app\Libraries\ShieldOAuth`!
 more info see [How to add other services](add_other_oauth.md).
 
 ## Links:
 
-* [Installation Guide](install.md)
-* [How To Get Keys](get_keys.md)
-* [How to add other services](add_other_oauth.md)
-* [Quick Start](quickstart.md)
+- [Installation Guide](install.md)
+- [How To Get Keys](get_keys.md)
+- [How to add other services](add_other_oauth.md)
+- [Quick Start](quickstart.md)
 
 ## Acknowledgements
 
diff --git a/docs/install.md b/docs/install.md
index 791d23a..0dc6b1c 100644
--- a/docs/install.md
+++ b/docs/install.md
@@ -25,15 +25,17 @@ If you have it installed as a phar, or otherwise you will need to adjust the way
 ```console
 composer require datamweb/shield-oauth:dev-develop
 ```
+
 > **Note**
-> You can manually install `Shield OAuth` by extracting the project file to path `app\ThirdParty\shield-oauth` and then adding 
-> 
->```php     
+> You can manually install `Shield OAuth` by extracting the project file to path `app\ThirdParty\shield-oauth` and then adding
+>
+> ```php
 > public $psr4 = [
 >     // add this line
 >     'Datamweb\ShieldOAuth' => APPPATH . 'ThirdParty/shield-oauth/src',
 > ];
-> ``` 
+> ```
+>
 > to the `app/Config/Autoload.php` file, however we do not recommend this. Please use the Composer.
 
 ## Add Required Columns
@@ -47,6 +49,7 @@ Data of Table "users":
 | id | username | status | ... | first_name | last_name | avatar |
 +----+----------+--------+-...-+------------+-----------+--------+
 ```
+
 Therefore, you can add `first_name`, `last_name`, and `avatar` columns to table `users` by any method you want or run the migrations:
 
 ```console
@@ -57,7 +60,7 @@ php spark migrate -n Datamweb\ShieldOAuth
 > By default, `Shield OAuth` uses columns named `first_name`, `last_name`, and `avatar`.
 > For any reason, if you want to consider another name for them columns, you can do it through the config file(`config/ShieldOAuthConfig.php`) and set the desired values in:
 
-```php 
+```php
 public array $usersColumnsName = [
     'first_name' => 'first_name',
     'last_name'  => 'last_name',
@@ -79,7 +82,7 @@ public $globals = [
 ];
 ```
 
-## Set keys 
+## Set keys
 
 Receive keys `client_id` and `client_secret` from each OAuth server.
 To connect to any of the servers, you need to receive`client_id` and `client_secret` from them and then set them in file **.env** Or `app/Config/ShieldOAuthConfig`.
@@ -112,17 +115,26 @@ public array $oauthConfigs = [
             'client_secret' => 'fsdfsdfsgdgrdg',
         // ...
     ],
+    'microsoft' => [
+            'client_id'     => 'example-098a-43sd-9813-9747f3gg6f6h',
+            'client_secret' => 'example-qw53-446r-tyy1-856ff9ue8fdf',
+        // ...
+    ],
     // and other services...
 ```
 
 ## Adding all login button with OAuth in View
+
 The last step is to, You can create your own buttons in views, what is important is that the addresses should be as follows:
+
 ```html
 http://localhost:8080/oauth/google
 http://localhost:8080/oauth/github
 http://localhost:8080/oauth/yahoo
+http://localhost:8080/oauth/microsoft
 <!-- and other OAuth !>
 ```
+
 However, `Shield OAuth` suggests the following for ease of use. By adding the following commands to the `vendor/codeigniter4/shield/src/Views/login.php` and `vendor/codeigniter4/shield/src/Views/register.php` file, `Shield OAuth` will automatically display all the OAuth you provide as buttons in login/register views.
 
 ```html
@@ -132,6 +144,7 @@ However, `Shield OAuth` suggests the following for ease of use. By adding the fo
 ```html
 {{ShieldOAuthButtonForRegisterPage}}
 ```
+
 Because we have used Bootstrap to make the dropdown button, you need to add the following items at the end of the views file.
 
 ```php
diff --git a/docs/quickstart.md b/docs/quickstart.md
index 7fb2284..984d484 100644
--- a/docs/quickstart.md
+++ b/docs/quickstart.md
@@ -2,9 +2,10 @@
 
 It is strongly recommended that only people who have already read the documents in full should use this section. The purpose of providing this section is to save the time of people and developers who frequently use `Shield OAuth` in different projects.
 
-### Step 1 : 
+### Step 1 :
 
 Installing the package by Composer :
+
 ```console
 composer require datamweb/shield-oauth:dev-develop
 ```
@@ -17,24 +18,27 @@ Add `first_name`, `last_name`, and `avatar` columns to table `users` :
 php spark migrate -n Datamweb\ShieldOAuth
 ```
 
-### Step 3 : 
+### Step 3 :
+
+- Add `{{ShieldOAuthButtonForLoginPage}}` to `vendor\codeigniter4\shield\src\Views\login.php`
+- Add `{{ShieldOAuthButtonForRegisterPage}}` to `vendor\codeigniter4\shield\src\Views\register.php`
+- Add
 
- - Add `{{ShieldOAuthButtonForLoginPage}}` to `vendor\codeigniter4\shield\src\Views\login.php`
- - Add `{{ShieldOAuthButtonForRegisterPage}}` to `vendor\codeigniter4\shield\src\Views\register.php`
- - Add
 ```php
 <?= $this->section('pageScripts') ?>
 <script src='https://cdn.jsdelivr.net/npm/@popperjs/core@2.11.6/dist/umd/popper.min.js' integrity='sha384-oBqDVmMz9ATKxIep9tiCxS/Z9fNfEXiDAYTujMAeBAsjFuCZSmKbSSUnQlmh/jp3' crossorigin='anonymous'></script>
 <script src='https://cdn.jsdelivr.net/npm/bootstrap@5.2.2/dist/js/bootstrap.min.js' integrity='sha384-IDwe1+LCz02ROU9k972gdyvl+AESN10+x7tBKgc9I5HFtuNz0wWnPclzo6p9vxnk' crossorigin='anonymous'></script>
 <?= $this->endSection() ?>
 ```
- to `vendor\codeigniter4\shield\src\Views\login.php` and `vendor\codeigniter4\shield\src\Views\register.php`.
- 
-### Step 4 : 
+
+to `vendor\codeigniter4\shield\src\Views\login.php` and `vendor\codeigniter4\shield\src\Views\register.php`.
+
+### Step 4 :
 
 Receive keys `client_id` and `client_secret` from each OAuth server. and setting them in file `app\Config\ShieldOAuthConfig.php`.
 
 callBack address is `https://yourBaseURL.com/oauth/call-back`.
+
 ```php
 public array $oauthConfigs = [
     'github' => [
@@ -47,6 +51,11 @@ public array $oauthConfigs = [
             'client_secret' => 'fsdfsdfsgdgrdg',
         // ...
     ],
+    'microsoft' => [
+            'client_id'     => 'example-098a-43sd-9813-9747f3gg6f6h',
+            'client_secret' => 'example-qw53-446r-tyy1-856ff9ue8fdf',
+        // ...
+    ],
     // and other services...
 ```
 
@@ -57,9 +66,10 @@ public array $oauthConfigs = [
 > php spark make:oauthconfig
 > ```
 
-### Step 5 : 
+### Step 5 :
 
 Cancel filter for `Shield OAuth` routes.
+
 ```php
 public $globals = [
     'before' => [
@@ -71,4 +81,5 @@ public $globals = [
 ```
 
 ### Step 6 :
+
 See `https://yourBaseURL.com/login` Or `https://yourBaseURL.com/register` Use and enjoy!
diff --git a/src/Config/ShieldOAuthConfig.php b/src/Config/ShieldOAuthConfig.php
index 6fb0107..20bd238 100644
--- a/src/Config/ShieldOAuthConfig.php
+++ b/src/Config/ShieldOAuthConfig.php
@@ -46,6 +46,13 @@ class ShieldOAuthConfig extends BaseConfig
             'allow_login'    => true,
             'allow_register' => true,
         ],
+        'microsoft' => [
+            'client_id'     => 'Get it from Microsoft',
+            'client_secret' => 'Get it from Microsoft',
+
+            'allow_login'    => true,
+            'allow_register' => true,
+        ],
         // 'yahoo' => [
         //     'client_id'     => 'Get it from Yahoo',
         //     'client_secret' => 'Get it from Yahoo',
diff --git a/src/Language/en/ShieldOAuthLang.php b/src/Language/en/ShieldOAuthLang.php
index 50ec242..520863d 100644
--- a/src/Language/en/ShieldOAuthLang.php
+++ b/src/Language/en/ShieldOAuthLang.php
@@ -36,6 +36,10 @@
         'google'    => 'Google',
         'not_allow' => "Now you can't login or register with Google!",
     ],
+    'Microsoft' => [
+        'google'    => 'Microsoft',
+        'not_allow' => "Now you can't login or register with Microsoft!",
+    ],
     // 'Yahoo' => [
     //     'yahoo'     => 'Yahoo',
     //     'not_allow' => "Now you can't login or register with Yahoo!",
diff --git a/src/Language/fa/ShieldOAuthLang.php b/src/Language/fa/ShieldOAuthLang.php
index bf86863..63fc285 100644
--- a/src/Language/fa/ShieldOAuthLang.php
+++ b/src/Language/fa/ShieldOAuthLang.php
@@ -36,6 +36,10 @@
         'google'    => 'گوگل',
         'not_allow' => 'اکنون امکان ورود و یا ثبت نام با گوگل وجود ندارد.',
     ],
+    'Microsoft' => [
+        'microsoft' => 'Microsoft',
+        'not_allow' => "(To be translated) Now you can't login or register with Microsoft!",
+    ],
     // 'Yahoo' => [
     //     'yahoo'     => 'یاهو',
     //     'not_allow' => "اکنون امکان ورود و یا ثبت نام با یاهو وجود ندارد!",
diff --git a/src/Language/fr/ShieldOAuthLang.php b/src/Language/fr/ShieldOAuthLang.php
index 80eb7e4..27e4f56 100644
--- a/src/Language/fr/ShieldOAuthLang.php
+++ b/src/Language/fr/ShieldOAuthLang.php
@@ -36,6 +36,10 @@
         'google'    => 'Google',
         'not_allow' => 'Vous ne pouvez pas vous connecter ou vous inscrire avec Google maintenant!',
     ],
+    'Microsoft' => [
+        'microsoft' => 'Microsoft',
+        'not_allow' => 'Vous ne pouvez pas vous connecter ou vous inscrire avec Microsoft maintenant!',
+    ],
     // 'Yahoo' => [
     //     'yahoo'     => 'Yahoo',
     //     'not_allow' => "Vous ne pouvez pas vous connecter ou vous inscrire avec Yahoo maintenant!",
diff --git a/src/Language/id/ShieldOAuthLang.php b/src/Language/id/ShieldOAuthLang.php
index b3c6071..15bba8c 100644
--- a/src/Language/id/ShieldOAuthLang.php
+++ b/src/Language/id/ShieldOAuthLang.php
@@ -36,6 +36,10 @@
         'google'    => 'Google',
         'not_allow' => 'Sekarang Anda tidak bisa masuk atau mendaftar dengan Google!',
     ],
+    'Microsoft' => [
+        'microsoft' => 'Microsoft',
+        'not_allow' => 'Sekarang Anda tidak bisa masuk atau mendaftar dengan Microsoft!',
+    ],
     // 'Yahoo' => [
     //     'yahoo'     => 'Yahoo',
     //     'not_allow' => 'Sekarang Anda tidak bisa masuk atau mendaftar dengan Yahoo!',
diff --git a/src/Libraries/MicrosoftOAuth.php b/src/Libraries/MicrosoftOAuth.php
new file mode 100644
index 0000000..7b593cc
--- /dev/null
+++ b/src/Libraries/MicrosoftOAuth.php
@@ -0,0 +1,126 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Datamweb\ShieldOAuth\Libraries;
+
+use CodeIgniter\HTTP\CURLRequest;
+use Config\Services;
+use Datamweb\ShieldOAuth\Config\ShieldOAuthConfig;
+use Datamweb\ShieldOAuth\Libraries\Basic\AbstractOAuth;
+use Exception;
+
+class MicrosoftOAuth extends AbstractOAuth
+{
+    private static $API_CODE_URL      = 'https://login.microsoftonline.com/common/oauth2/v2.0/authorize';
+    private static $API_TOKEN_URL     = 'https://login.microsoftonline.com/common/oauth2/v2.0/token';
+    private static $API_USER_INFO_URL = 'https://graph.microsoft.com/v1.0/me';
+    private static $APPLICATION_NAME  = 'ShieldOAuth';
+
+    protected string $token;
+    protected CURLRequest $client;
+    protected ShieldOAuthConfig $config;
+    protected string $client_id;
+    protected string $client_secret;
+    protected string $callback_url;
+
+    public function __construct(string $token = '')
+    {
+        $this->token         = $token;
+        $this->client        = Services::curlrequest();
+        $this->config        = config('ShieldOAuthConfig');
+        $this->callback_url  = base_url('oauth/' . $this->config->call_back_route);
+        $this->client_id     = env('ShieldOAuthConfig.microsoft.client_id', $this->config->oauthConfigs['microsoft']['client_id']);
+        $this->client_secret = env('ShieldOAuthConfig.microsoft.client_secret', $this->config->oauthConfigs['microsoft']['client_secret']);
+    }
+
+    public function makeGoLink(string $state): string
+    {
+        $query = http_build_query([
+            'client_id'       => $this->client_id,
+            'response_type'   => 'code',
+            'redirect_uri'    => $this->callback_url,
+            'response_mode'   => 'query',
+            'approval_prompt' => 'auto',
+            'scope'           => 'User.Read',
+            'state'           => $state,
+            'sso_reload'      => true
+        ]);
+
+        return self::$API_CODE_URL . '?' . $query;
+    }
+
+    public function fetchAccessTokenWithAuthCode(array $allGet): void
+    {
+        try {
+            $response = $this->client->request('POST', self::$API_TOKEN_URL, [
+                'form_params' => [
+                    'client_id'     => $this->client_id,
+                    'client_secret' => $this->client_secret,
+                    'code'          => $allGet['code'],
+                    'redirect_uri'  => $this->callback_url,
+                    'grant_type'    => 'authorization_code',
+                ],
+                'headers' => [
+                    'User-Agent' => self::$APPLICATION_NAME . '/1.0',
+                    'Accept'     => 'application/json',
+                ],
+            ]);
+        } catch (Exception $e) {
+            exit($e->getMessage());
+        }
+
+        $token = json_decode($response->getBody())->access_token;
+
+        $this->setToken($token);
+    }
+
+    public function fetchUserInfoWithToken(): object
+    {
+        try {
+            $response = $this->client->request('GET', self::$API_USER_INFO_URL, [
+                'headers' => [
+                    'Accept'        => 'application/json',
+                    'User-Agent'    => self::$APPLICATION_NAME . '/1.0',
+                    'Authorization' => 'Bearer ' . $this->getToken(),
+                ],
+                'http_errors' => false,
+            ]);
+        } catch (Exception $e) {
+            exit($e->getMessage());
+        }
+
+        $userInfo = json_decode($response->getBody());
+
+        $userInfo->email = $userInfo->mail;
+
+        return $userInfo;
+    }
+
+    public function setColumnsName(string $nameOfProcess, object $userInfo): array
+    {
+        if ($nameOfProcess === 'syncingUserInfo') {
+            return [
+                $this->config->usersColumnsName['first_name'] => $userInfo->givenName,
+                $this->config->usersColumnsName['last_name']  => $userInfo->surname ?? null,
+                $this->config->usersColumnsName['avatar']     => null,
+            ];
+        }
+
+        if ($nameOfProcess === 'newUser') {
+            helper('text');
+
+            return [
+                'username'                                    => $userInfo->mail,
+                'email'                                       => $userInfo->mail,
+                'password'                                    => random_string('crypto', 32),
+                'active'                                      => 1, // if microsoft authentication is valid then the user account does not require an email activator
+                $this->config->usersColumnsName['first_name'] => $userInfo->givenName,
+                $this->config->usersColumnsName['last_name']  => $userInfo->surname ?? null,
+                $this->config->usersColumnsName['avatar']     => null
+            ];
+        }
+
+        return [];
+    }
+}

From b89edded4964c3f530b4f7032cdce0b88c6c31cc Mon Sep 17 00:00:00 2001
From: warcooft <syamsuddine9@gmail.com>
Date: Fri, 13 Sep 2024 22:42:39 +0700
Subject: [PATCH 02/10] make PHPStan happy

---
 docs/get_keys.md                 |  2 +-
 src/Libraries/MicrosoftOAuth.php | 20 ++++++++++----------
 2 files changed, 11 insertions(+), 11 deletions(-)

diff --git a/docs/get_keys.md b/docs/get_keys.md
index 81da162..27b7fbb 100644
--- a/docs/get_keys.md
+++ b/docs/get_keys.md
@@ -1,6 +1,6 @@
 # How To Get Keys
 
-Obviously, receiving Keys is not directly related to `Shield OAuth`, however, to improve the documentation and convenience of our users, Therefore, we have provided helpful links on how to get keys from the three most important Google, GitHub and Yahoo. For other services, you can find the relevant steps by searching.
+Obviously, receiving Keys is not directly related to `Shield OAuth`, however, to improve the documentation and convenience of our users, Therefore, we have provided helpful links on how to get keys from the three most important Google, GitHub, Microsoft and Yahoo. For other services, you can find the relevant steps by searching.
 
 - [How To Get Keys](#how-to-get-keys)
 - [Explanation About Callback](#explanation-about-callback)
diff --git a/src/Libraries/MicrosoftOAuth.php b/src/Libraries/MicrosoftOAuth.php
index 7b593cc..0201109 100644
--- a/src/Libraries/MicrosoftOAuth.php
+++ b/src/Libraries/MicrosoftOAuth.php
@@ -12,11 +12,10 @@
 
 class MicrosoftOAuth extends AbstractOAuth
 {
-    private static $API_CODE_URL      = 'https://login.microsoftonline.com/common/oauth2/v2.0/authorize';
-    private static $API_TOKEN_URL     = 'https://login.microsoftonline.com/common/oauth2/v2.0/token';
-    private static $API_USER_INFO_URL = 'https://graph.microsoft.com/v1.0/me';
-    private static $APPLICATION_NAME  = 'ShieldOAuth';
-
+    private static string $API_CODE_URL      = 'https://login.microsoftonline.com/common/oauth2/v2.0/authorize';
+    private static string $API_TOKEN_URL     = 'https://login.microsoftonline.com/common/oauth2/v2.0/token';
+    private static string $API_USER_INFO_URL = 'https://graph.microsoft.com/v1.0/me';
+    private static string $APPLICATION_NAME  = 'ShieldOAuth';
     protected string $token;
     protected CURLRequest $client;
     protected ShieldOAuthConfig $config;
@@ -44,12 +43,15 @@ public function makeGoLink(string $state): string
             'approval_prompt' => 'auto',
             'scope'           => 'User.Read',
             'state'           => $state,
-            'sso_reload'      => true
+            'sso_reload'      => true,
         ]);
 
         return self::$API_CODE_URL . '?' . $query;
     }
 
+    /**
+     * @param array<string, string> $allGet
+     */
     public function fetchAccessTokenWithAuthCode(array $allGet): void
     {
         try {
@@ -108,16 +110,14 @@ public function setColumnsName(string $nameOfProcess, object $userInfo): array
         }
 
         if ($nameOfProcess === 'newUser') {
-            helper('text');
-
             return [
                 'username'                                    => $userInfo->mail,
                 'email'                                       => $userInfo->mail,
-                'password'                                    => random_string('crypto', 32),
+                'password'                                    => bin2hex(random_bytes(16)),
                 'active'                                      => 1, // if microsoft authentication is valid then the user account does not require an email activator
                 $this->config->usersColumnsName['first_name'] => $userInfo->givenName,
                 $this->config->usersColumnsName['last_name']  => $userInfo->surname ?? null,
-                $this->config->usersColumnsName['avatar']     => null
+                $this->config->usersColumnsName['avatar']     => null,
             ];
         }
 

From 7207536958bd7e8eb8fcca12a7f44f1e6351292b Mon Sep 17 00:00:00 2001
From: warcooft <syamsuddine9@gmail.com>
Date: Fri, 13 Sep 2024 23:04:37 +0700
Subject: [PATCH 03/10] add PHPDoc

---
 src/Libraries/MicrosoftOAuth.php | 24 +++++++++++++++++++++---
 1 file changed, 21 insertions(+), 3 deletions(-)

diff --git a/src/Libraries/MicrosoftOAuth.php b/src/Libraries/MicrosoftOAuth.php
index 0201109..b3a8394 100644
--- a/src/Libraries/MicrosoftOAuth.php
+++ b/src/Libraries/MicrosoftOAuth.php
@@ -2,6 +2,15 @@
 
 declare(strict_types=1);
 
+/**
+ * This file is part of Shield OAuth.
+ *
+ * (c) Datamweb <pooya_parsa_dadashi@yahoo.com>
+ *
+ * For the full copyright and license information, please view
+ * the LICENSE file that was distributed with this source code.
+ */
+
 namespace Datamweb\ShieldOAuth\Libraries;
 
 use CodeIgniter\HTTP\CURLRequest;
@@ -52,7 +61,7 @@ public function makeGoLink(string $state): string
     /**
      * @param array<string, string> $allGet
      */
-    public function fetchAccessTokenWithAuthCode(array $allGet): void
+    protected function fetchAccessTokenWithAuthCode(array $allGet): void
     {
         try {
             $response = $this->client->request('POST', self::$API_TOKEN_URL, [
@@ -77,7 +86,7 @@ public function fetchAccessTokenWithAuthCode(array $allGet): void
         $this->setToken($token);
     }
 
-    public function fetchUserInfoWithToken(): object
+    protected function fetchUserInfoWithToken(): object
     {
         try {
             $response = $this->client->request('GET', self::$API_USER_INFO_URL, [
@@ -99,7 +108,16 @@ public function fetchUserInfoWithToken(): object
         return $userInfo;
     }
 
-    public function setColumnsName(string $nameOfProcess, object $userInfo): array
+    /**
+     * Sets the column names and values based on the process name.
+     *
+     * @param string $nameOfProcess The name of the process, such as 'syncingUserInfo' or 'newUser'.
+     * @param object $userInfo An object containing user information, such as 'givenName', 'surname', and 'mail'.
+     *                         This object should be of type `object<string, mixed>`, where the keys represent user attributes.
+     * 
+     * @return array<int|string, mixed> Returns an associative array mapping column names to their corresponding values.
+     */
+    protected function setColumnsName(string $nameOfProcess, object $userInfo): array
     {
         if ($nameOfProcess === 'syncingUserInfo') {
             return [

From 0f021efcc023efa0678221bbb7ebbae2c3127f74 Mon Sep 17 00:00:00 2001
From: warcooft <syamsuddine9@gmail.com>
Date: Fri, 13 Sep 2024 23:08:09 +0700
Subject: [PATCH 04/10] improve PHPDoc

---
 src/Libraries/MicrosoftOAuth.php | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/src/Libraries/MicrosoftOAuth.php b/src/Libraries/MicrosoftOAuth.php
index b3a8394..4c51d11 100644
--- a/src/Libraries/MicrosoftOAuth.php
+++ b/src/Libraries/MicrosoftOAuth.php
@@ -112,8 +112,8 @@ protected function fetchUserInfoWithToken(): object
      * Sets the column names and values based on the process name.
      *
      * @param string $nameOfProcess The name of the process, such as 'syncingUserInfo' or 'newUser'.
-     * @param object $userInfo An object containing user information, such as 'givenName', 'surname', and 'mail'.
-     *                         This object should be of type `object<string, mixed>`, where the keys represent user attributes.
+     * @param object $userInfo      An object containing user information, such as 'givenName', 'surname', and 'mail'.
+     *                              This object should be of type `object<string, mixed>`, where the keys represent user attributes.
      * 
      * @return array<int|string, mixed> Returns an associative array mapping column names to their corresponding values.
      */

From 082657b9662aa7815db37b49b2ad09412b601b2f Mon Sep 17 00:00:00 2001
From: warcooft <syamsuddine9@gmail.com>
Date: Fri, 13 Sep 2024 23:10:07 +0700
Subject: [PATCH 05/10] rm white space

---
 src/Libraries/MicrosoftOAuth.php | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/src/Libraries/MicrosoftOAuth.php b/src/Libraries/MicrosoftOAuth.php
index 4c51d11..05f169c 100644
--- a/src/Libraries/MicrosoftOAuth.php
+++ b/src/Libraries/MicrosoftOAuth.php
@@ -114,7 +114,7 @@ protected function fetchUserInfoWithToken(): object
      * @param string $nameOfProcess The name of the process, such as 'syncingUserInfo' or 'newUser'.
      * @param object $userInfo      An object containing user information, such as 'givenName', 'surname', and 'mail'.
      *                              This object should be of type `object<string, mixed>`, where the keys represent user attributes.
-     * 
+     *
      * @return array<int|string, mixed> Returns an associative array mapping column names to their corresponding values.
      */
     protected function setColumnsName(string $nameOfProcess, object $userInfo): array

From e21fcdd21ca72df91c962981c48c2d70fcfca210 Mon Sep 17 00:00:00 2001
From: warcooft <syamsuddine9@gmail.com>
Date: Sun, 15 Sep 2024 00:15:28 +0700
Subject: [PATCH 06/10] docs: update README.md

---
 README.md | 11 +++++++----
 1 file changed, 7 insertions(+), 4 deletions(-)

diff --git a/README.md b/README.md
index 6acd9ef..7693be0 100644
--- a/README.md
+++ b/README.md
@@ -1,17 +1,17 @@
 [Farsi](./README.fa-IR.md) | English
-##  Codeigniter Shield OAuth
+
+## Codeigniter Shield OAuth
+
 [![PHPCSFixer](https://github.com/datamweb/shield-oauth/actions/workflows/phpcsfixer.yml/badge.svg)](https://github.com/datamweb/shield-oauth/actions/workflows/phpcsfixer.yml)
 [![PHPStan](https://github.com/datamweb/shield-oauth/actions/workflows/phpstan.yml/badge.svg)](https://github.com/datamweb/shield-oauth/actions/workflows/phpstan.yml)
 [![Rector](https://github.com/datamweb/shield-oauth/actions/workflows/rector.yml/badge.svg)](https://github.com/datamweb/shield-oauth/actions/workflows/rector.yml)
 [![PHPCPD](https://github.com/datamweb/shield-oauth/actions/workflows/phpcpd.yml/badge.svg)](https://github.com/datamweb/shield-oauth/actions/workflows/phpcpd.yml)
 
-
 <p align="center"><img src="https://github.com/datamweb/my-repository-files/blob/main/shield-oauth/image/shieldOAuthLogo.png" alt="Logo Shield OAuth"></p>
 
 [![Latest Stable Version](https://poser.pugx.org/datamweb/shield-oauth/v?style=for-the-badge)](https://packagist.org/packages/datamweb/shield-oauth) [![Total Downloads](https://poser.pugx.org/datamweb/shield-oauth/downloads?style=for-the-badge)](https://packagist.org/packages/datamweb/shield-oauth) [![Latest Unstable Version](https://poser.pugx.org/datamweb/shield-oauth/v/unstable?style=for-the-badge)](https://packagist.org/packages/datamweb/shield-oauth) [![License](https://poser.pugx.org/datamweb/shield-oauth/license?style=for-the-badge)](https://packagist.org/packages/datamweb/shield-oauth) [![PHP Version Require](https://poser.pugx.org/datamweb/shield-oauth/require/php?style=for-the-badge)](https://packagist.org/packages/datamweb/shield-oauth)
 
-
-`Shield OAuth` helps you to provide the possibility of login or registering users through the OAuth service. Currently, `Shield OAuth` supports `Google OAuth` and `GitHub OAuth` by default, but it allows you to implement it for any other service, including **Yahoo**, **Facebook**, **Twitter**, **LinkedIn**, **GitLab** and ...
+`Shield OAuth` helps you to provide the possibility of login or registering users through the OAuth service. Currently, `Shield OAuth` supports `Google OAuth`, `GitHub and `Microsoft` OAuth` by default, but it allows you to implement it for any other service, including **Yahoo**, **Facebook**, **Twitter**, **LinkedIn**, **GitLab** and ...
 
 In `Shield OAuth`, it has been considered to be easy to use by developers and the possibility of expansion to connect to other services in the shortest possible time.
 
@@ -25,12 +25,15 @@ In `Shield OAuth`, it has been considered to be easy to use by developers and th
 - [cURL Library](https://www.php.net/manual/en/book.curl.php) to be installed in your version of PHP
 
 ## Shield OAuth Documentation
+
 In the documentation, I have explained how to **install**, **configure**, and how to **create custom class `NewOAuth`** connections to other services. Documentation for `Shield OAuth` can be found on the [docs](https://www.shield-oauth.codeigniter4.ir/).
 
 ## License
+
 This project is licensed under the MIT License - see the [LICENSE](/LICENSE) file for details.
 
 ## Acknowledgements
+
 Every open-source project depends on it's contributors to be a success. The following users have contributed in one manner or another in making Codeigniter `Shield OAuth`:
 
 <a href="https://github.com/datamweb/shield-oauth/graphs/contributors">

From c5de7815fe0ff5b1750ec4035d2d0a09e74fdad1 Mon Sep 17 00:00:00 2001
From: warcooft <syamsuddine9@gmail.com>
Date: Sun, 15 Sep 2024 00:18:14 +0700
Subject: [PATCH 07/10] lang: small typo

---
 src/Language/en/ShieldOAuthLang.php | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/src/Language/en/ShieldOAuthLang.php b/src/Language/en/ShieldOAuthLang.php
index 520863d..fbd11f7 100644
--- a/src/Language/en/ShieldOAuthLang.php
+++ b/src/Language/en/ShieldOAuthLang.php
@@ -37,7 +37,7 @@
         'not_allow' => "Now you can't login or register with Google!",
     ],
     'Microsoft' => [
-        'google'    => 'Microsoft',
+        'microsoft'    => 'Microsoft',
         'not_allow' => "Now you can't login or register with Microsoft!",
     ],
     // 'Yahoo' => [

From 3993ca06a66595a0f6e5125f6571fc82d4336bf4 Mon Sep 17 00:00:00 2001
From: warcooft <syamsuddine9@gmail.com>
Date: Sun, 15 Sep 2024 00:21:36 +0700
Subject: [PATCH 08/10] add microsoft oauth button

---
 src/Libraries/Basic/ShieldOAuth.php | 5 +++--
 1 file changed, 3 insertions(+), 2 deletions(-)

diff --git a/src/Libraries/Basic/ShieldOAuth.php b/src/Libraries/Basic/ShieldOAuth.php
index c232fa2..2eed5ef 100644
--- a/src/Libraries/Basic/ShieldOAuth.php
+++ b/src/Libraries/Basic/ShieldOAuth.php
@@ -99,7 +99,7 @@ private function otherOAuth()
     {
         $pieces = explode('|', $this->allOAuth());
 
-        return array_diff($pieces, ['github', 'google']);
+        return array_diff($pieces, ['github', 'google', 'microsoft']);
     }
 
     /**
@@ -127,10 +127,11 @@ public function makeOAuthButton(string $forPage = 'login'): string
 
         $Button .= '<a href=' . base_url('oauth/google') . " class='btn btn-outline-secondary' aria-current='page'>" . lang('ShieldOAuthLang.Google.google') . '</a>';
         $Button .= '<a href=' . base_url('oauth/github') . " class='btn btn-outline-secondary' aria-current='page'>" . lang('ShieldOAuthLang.Github.github') . '</a>';
+        $Button .= '<a href=' . base_url('oauth/microsoft') . " class='btn btn-outline-secondary' aria-current='page'>" . lang('ShieldOAuthLang.Microsoft.microsoft') . '</a>';
         if ($this->otherOAuth() !== []) {
             $Button .= "<div class='btn-group' role='group'>
                             <button type='button' class='btn btn-outline-secondary dropdown-toggle' data-bs-toggle='dropdown' aria-expanded='false'>"
-                            . lang('ShieldOAuthLang.other') . "
+                . lang('ShieldOAuthLang.other') . "
                             </button>
                             <ul class='dropdown-menu'>";
 

From 2ad2750e442d5fcf814439e66557299067df4fd6 Mon Sep 17 00:00:00 2001
From: warcooft <syamsuddine9@gmail.com>
Date: Sun, 15 Sep 2024 00:25:17 +0700
Subject: [PATCH 09/10] rm avatar attributes from syncing user info to avoid
 replacing the current avatar to null

---
 src/Libraries/MicrosoftOAuth.php | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/src/Libraries/MicrosoftOAuth.php b/src/Libraries/MicrosoftOAuth.php
index 05f169c..1798577 100644
--- a/src/Libraries/MicrosoftOAuth.php
+++ b/src/Libraries/MicrosoftOAuth.php
@@ -123,7 +123,7 @@ protected function setColumnsName(string $nameOfProcess, object $userInfo): arra
             return [
                 $this->config->usersColumnsName['first_name'] => $userInfo->givenName,
                 $this->config->usersColumnsName['last_name']  => $userInfo->surname ?? null,
-                $this->config->usersColumnsName['avatar']     => null,
+                // $this->config->usersColumnsName['avatar']     => null,
             ];
         }
 

From 28960c2f9d7bb0ebe91c24f3436341458b2b9143 Mon Sep 17 00:00:00 2001
From: warcooft <syamsuddine9@gmail.com>
Date: Sun, 15 Sep 2024 00:27:41 +0700
Subject: [PATCH 10/10] fix coding standards

---
 src/Language/en/ShieldOAuthLang.php | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/src/Language/en/ShieldOAuthLang.php b/src/Language/en/ShieldOAuthLang.php
index fbd11f7..36e798b 100644
--- a/src/Language/en/ShieldOAuthLang.php
+++ b/src/Language/en/ShieldOAuthLang.php
@@ -37,7 +37,7 @@
         'not_allow' => "Now you can't login or register with Google!",
     ],
     'Microsoft' => [
-        'microsoft'    => 'Microsoft',
+        'microsoft' => 'Microsoft',
         'not_allow' => "Now you can't login or register with Microsoft!",
     ],
     // 'Yahoo' => [