├── .github
    ├── ISSUE_TEMPLATE
    │   ├── bug_report.yml
    │   ├── config.yml
    │   ├── feature_request.md
    │   └── planned-work.md
    ├── dependabot.yml
    └── workflows
    │   ├── docs.yml
    │   ├── no-merge-commits.yml
    │   ├── phpcpd.yml
    │   ├── phpcsfixer.yml
    │   ├── phpstan.yml
    │   └── rector.yml
├── .gitignore
├── .php-cs-fixer.dist.php
├── LICENSE
├── README.md
├── admin
    ├── pre-commit
    └── setup.sh
├── composer.json
├── docs
    ├── CNAME
    ├── add_other_oauth.md
    ├── get_keys.md
    ├── index.md
    ├── install.md
    └── quickstart.md
├── mkdocs.yml
├── phpstan-baseline.php
├── phpstan.neon.dist
├── rector.php
└── src
    ├── Commands
        ├── Generators
        │   ├── NewShieldOauthGenerator.php
        │   └── Views
        │   │   └── newoauth.tpl.php
        └── OAuthSetup.php
    ├── Config
        ├── Registrar.php
        ├── Routes.php
        ├── Services.php
        └── ShieldOAuthConfig.php
    ├── Controllers
        └── OAuthController.php
    ├── Database
        └── Migrations
        │   └── 2022-10-20-182737_ShieldOAuth.php
    ├── Language
        ├── en
        │   └── ShieldOAuthLang.php
        ├── fa
        │   └── ShieldOAuthLang.php
        ├── fr
        │   └── ShieldOAuthLang.php
        ├── id
        │   └── ShieldOAuthLang.php
        └── pt-BR
        │   └── ShieldOAuthLang.php
    ├── Libraries
        ├── Basic
        │   ├── AbstractOAuth.php
        │   ├── ControllersInterface.php
        │   └── ShieldOAuth.php
        ├── GithubOAuth.php
        └── GoogleOAuth.php
    ├── Models
        └── ShieldOAuthModel.php
    └── Views
        └── Decorators
            └── ShieldOAuth.php


/.github/ISSUE_TEMPLATE/bug_report.yml:
--------------------------------------------------------------------------------
  1 | name: Bug report
  2 | description: Create a report to help us improve Shield OAuth
  3 | title: "Bug: "
  4 | labels: ['bug']
  5 | 
  6 | body:
  7 |   - type: markdown
  8 |     attributes:
  9 |       value: |
 10 |         Thanks for taking the time to fill out this bug report!
 11 | 
 12 |         Before you begin, **please ensure that there are no existing issues,
 13 |         whether still open or closed, related to your report**.
 14 |         If there is, your report will be closed promptly.
 15 | 
 16 |         ---
 17 | 
 18 |   - type: input
 19 |     id: php-version
 20 |     attributes:
 21 |       label: PHP Version
 22 |       description: |
 23 |         e.g. 8.1.11
 24 |     validations:
 25 |       required: true
 26 | 
 27 |   - type: input
 28 |     id: codeigniter-version
 29 |     attributes:
 30 |       label: CodeIgniter4 Version
 31 |       description: |
 32 |         e.g. 4.2.8
 33 |     validations:
 34 |       required: true
 35 | 
 36 |   - type: input
 37 |     id: shield-version
 38 |     attributes:
 39 |       label: Shield Version
 40 |       description: |
 41 |         e.g. 1.0.0-beta.3
 42 |         If you are not using the [latest version](https://github.com/codeigniter4/shield/releases), please
 43 |         check to see if the problem occurs with the latest version.
 44 |     validations:
 45 |       required: true
 46 | 
 47 |   - type: dropdown
 48 |     id: shield-oauth-version
 49 |     attributes:
 50 |       label: Shield OAuth Version?
 51 |       description: |        
 52 |         e.g. 1.0.0-beta
 53 |         If you are not using the [latest version](https://github.com/datamweb/shield-oauth/releases), please
 54 |         check to see if the problem occurs with the latest version.
 55 |       multiple: true
 56 |       options:
 57 |         - dev-develop
 58 |         - dev-main
 59 |     validations:
 60 |       required: true
 61 | 
 62 |   - type: dropdown
 63 |     id: operating-systems
 64 |     attributes:
 65 |       label: Which operating systems have you tested for this bug?
 66 |       description: You may select more than one.
 67 |       multiple: true
 68 |       options:
 69 |         - macOS
 70 |         - Windows
 71 |         - Linux
 72 |     validations:
 73 |       required: true
 74 | 
 75 |   - type: dropdown
 76 |     id: server
 77 |     attributes:
 78 |       label: Which server did you use?
 79 |       options:
 80 |         - apache
 81 |         - cli
 82 |         - cli-server (PHP built-in webserver)
 83 |         - cgi-fcgi
 84 |         - fpm-fcgi
 85 |         - phpdbg
 86 |     validations:
 87 |       required: true
 88 | 
 89 |   - type: input
 90 |     id: database
 91 |     attributes:
 92 |       label: Database
 93 |       description: e.g. MySQL 5.6, MariaDB 10.2, PostgreSQL 9.6
 94 |     validations:
 95 |       required: true
 96 | 
 97 |   - type: textarea
 98 |     id: add-customization-oauth
 99 |     attributes:
100 |       label: Did you add customize OAuth?
101 |       description: |
102 |         If "YES", please tell for which site(yahoo,tiwtter and ...) you added and how?
103 |         If "No," please indicate "No."
104 |     validations:
105 |       required: true
106 | 
107 |   - type: textarea
108 |     id: description
109 |     attributes:
110 |       label: What happened?
111 |       placeholder: Tell us what you see!
112 |     validations:
113 |       required: true
114 | 
115 |   - type: textarea
116 |     attributes:
117 |       label: Steps to Reproduce
118 |       description: Steps to reproduce the behavior.
119 |     validations:
120 |       required: true
121 | 
122 |   - type: textarea
123 |     attributes:
124 |       label: Expected Output
125 |       description: What do you expect to happen instead of this filed bug?
126 |     validations:
127 |       required: true
128 | 
129 |   - type: textarea
130 |     attributes:
131 |       label: Anything else?
132 |       description: |
133 |         Links? References? Anything that will give us more context about the issue you are encountering!
134 | 
135 |         Tip: You can attach images or log files by clicking this area to highlight it and then dragging files in.
136 |     validations:
137 |       required: false
138 | 


--------------------------------------------------------------------------------
/.github/ISSUE_TEMPLATE/config.yml:
--------------------------------------------------------------------------------
1 | blank_issues_enabled: false
2 | contact_links:
3 |   - name: GitHub Discussions
4 |     url: https://github.com/datamweb/shield-oauth/discussions
5 |     about: Please ask your support questions in the Discussions. Thanks!
6 | 


--------------------------------------------------------------------------------
/.github/ISSUE_TEMPLATE/feature_request.md:
--------------------------------------------------------------------------------
 1 | ---
 2 | name: Feature request
 3 | about: How to submit a feature request
 4 | title: ''
 5 | labels: ''
 6 | assignees: ''
 7 | 
 8 | ---
 9 | 
10 | Please submit feature requests to [Discussions](https://github.com/datamweb/shield-oauth/discussions/categories/ideas).
11 | We use GitHub Issues to track bugs and planned work.
12 | 


--------------------------------------------------------------------------------
/.github/ISSUE_TEMPLATE/planned-work.md:
--------------------------------------------------------------------------------
 1 | ---
 2 | name: Planned work
 3 | about: Approved work planning
 4 | title: 'Dev: '
 5 | labels: dev
 6 | assignees: ''
 7 | 
 8 | ---
 9 | 
10 | Repo maintainers will create "issues" for planned work, so it can be tracked.
11 | 


--------------------------------------------------------------------------------
/.github/dependabot.yml:
--------------------------------------------------------------------------------
 1 | version: 2
 2 | updates:
 3 | - package-ecosystem: composer
 4 |   directory: "/"
 5 |   schedule:
 6 |     interval: daily
 7 |     time: "08:30"
 8 |     timezone: "Asia/Tehran"
 9 |   open-pull-requests-limit: 5
10 |   target-branch: "develop"
11 |   reviewers:
12 |    - "datamweb"
13 |   assignees:
14 |   - "datamweb"
15 |   labels:
16 |    - "dependa bot"
17 |      
18 | - package-ecosystem: "github-actions"
19 |   directory: "/"
20 |   schedule:
21 |     interval: daily
22 |     time: "08:30"
23 |     timezone: "Asia/Tehran"
24 |   open-pull-requests-limit: 5
25 |   target-branch: "develop"
26 |   reviewers:
27 |    - "datamweb"
28 |   assignees:
29 |   - "datamweb"
30 |   labels:
31 |    - "dependa bot"
32 |      
33 | 


--------------------------------------------------------------------------------
/.github/workflows/docs.yml:
--------------------------------------------------------------------------------
 1 | name: docs
 2 | on:
 3 |   push:
 4 |     branches:
 5 |       - develop
 6 |       - main
 7 | permissions:
 8 |   contents: write
 9 | jobs:
10 |   deploy:
11 |     runs-on: ubuntu-latest
12 |     steps:
13 |       - name: Checkout Repository
14 |         uses: actions/checkout@v4
15 |         with:
16 |           fetch-depth: 0
17 |       - name: Setup Python
18 |         uses: actions/setup-python@v5
19 |         with:
20 |           python-version: 3.x
21 |       - name: Install Dependencies
22 |         run: |
23 |           pip3 install mkdocs-material
24 |           pip3 install mkdocs-git-revision-date-localized-plugin
25 |       - name: Publish Documentation
26 |         run: mkdocs gh-deploy --force
27 | 


--------------------------------------------------------------------------------
/.github/workflows/no-merge-commits.yml:
--------------------------------------------------------------------------------
 1 | name: Detect Merge Commits
 2 | 
 3 | on:
 4 |   pull_request:
 5 |     branches:
 6 |       - develop
 7 |       - main
 8 | 
 9 | permissions:
10 |   contents: read
11 |   pull-requests: read
12 | 
13 | jobs:
14 |   test:
15 |     name: Check for merge commits
16 |     runs-on: ubuntu-22.04
17 | 
18 |     steps:
19 |       - name: Checkout
20 |         uses: actions/checkout@v4
21 | 
22 |       - name: Run test
23 |         uses: NexusPHP/no-merge-commits@v2.2.1
24 |         with:
25 |           token: ${{ secrets.GITHUB_TOKEN }}
26 | 


--------------------------------------------------------------------------------
/.github/workflows/phpcpd.yml:
--------------------------------------------------------------------------------
 1 | name: PHPCPD
 2 | 
 3 | on:
 4 |   pull_request:
 5 |     branches:
 6 |       - develop
 7 |     paths:
 8 |       - '**.php'
 9 |       - '.github/workflows/phpcpd.yml'
10 |   push:
11 |     branches:
12 |       - develop
13 |     paths:
14 |       - '**.php'
15 |       - '.github/workflows/phpcpd.yml'
16 | 
17 | jobs:
18 |   build:
19 |     name: Code Copy-Paste Detection
20 |     runs-on: ubuntu-latest
21 |     if: "!contains(github.event.head_commit.message, '[ci skip]')"
22 | 
23 |     steps:
24 |       - name: Checkout
25 |         uses: actions/checkout@v4
26 | 
27 |       - name: Setup PHP
28 |         uses: shivammathur/setup-php@v2
29 |         with:
30 |           php-version: '8.0'
31 |           tools: phpcpd
32 |           extensions: dom, mbstring
33 |           coverage: none
34 | 
35 |       - name: Detect duplicate code
36 |         run: phpcpd src/ --min-lines 35 --exclude src/Database/Migrations/2022-10-20-182737_ShieldOAuth.php


--------------------------------------------------------------------------------
/.github/workflows/phpcsfixer.yml:
--------------------------------------------------------------------------------
 1 | name: PHPCSFixer
 2 | 
 3 | on:
 4 |   pull_request:
 5 |     branches:
 6 |       - develop
 7 |     paths:
 8 |       - '**.php'
 9 |       - '.github/workflows/phpcsfixer.yml'
10 |   push:
11 |     branches:
12 |       - develop
13 |     paths:
14 |       - '**.php'
15 |       - '.github/workflows/phpcsfixer.yml'
16 | 
17 | jobs:
18 |   build:
19 |     name: PHP ${{ matrix.php-versions }} Coding Standards
20 |     runs-on: ubuntu-latest
21 |     if: "!contains(github.event.head_commit.message, '[ci skip]')"
22 |     strategy:
23 |       fail-fast: false
24 |       matrix:
25 |         php-versions: ['7.4', '8.0', '8.1']
26 | 
27 |     steps:
28 |       - name: Checkout
29 |         uses: actions/checkout@v4
30 | 
31 |       - name: Set up PHP
32 |         uses: shivammathur/setup-php@v2
33 |         with:
34 |           php-version: ${{ matrix.php-versions }}
35 |           extensions: json, tokenizer
36 |           coverage: none
37 |         env:
38 |           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
39 | 
40 |       - name: Get composer cache directory
41 |         id: composer-cache
42 |         run: echo "::set-output name=dir::$(composer config cache-files-dir)"
43 | 
44 |       - name: Cache composer dependencies
45 |         uses: actions/cache@v4
46 |         with:
47 |           path: ${{ steps.composer-cache.outputs.dir }}
48 |           key: ${{ runner.os }}-composer-${{ hashFiles('**/composer.json') }}-${{ hashFiles('**/composer.lock') }}
49 |           restore-keys: ${{ runner.os }}-composer-
50 | 
51 |       - name: Install dependencies
52 |         run: |
53 |           if [ -f composer.lock ]; then
54 |             composer install --no-progress --no-interaction --prefer-dist --optimize-autoloader
55 |           else
56 |             composer update --no-progress --no-interaction --prefer-dist --optimize-autoloader
57 |           fi
58 | 
59 |       - name: Check code for standards compliance
60 |         run: vendor/bin/php-cs-fixer fix --verbose --ansi --dry-run --using-cache=no --diff
61 | 


--------------------------------------------------------------------------------
/.github/workflows/phpstan.yml:
--------------------------------------------------------------------------------
 1 | name: PHPStan
 2 | 
 3 | on:
 4 |   pull_request:
 5 |     branches:
 6 |       - develop
 7 |     paths:
 8 |       - '**.php'
 9 |       - 'composer.*'
10 |       - 'phpstan*'
11 |       - '.github/workflows/phpstan.yml'
12 |   push:
13 |     branches:
14 |       - develop
15 |     paths:
16 |       - '**.php'
17 |       - 'composer.*'
18 |       - 'phpstan*'
19 |       - '.github/workflows/phpstan.yml'
20 | 
21 | jobs:
22 |   build:
23 |     name: PHP ${{ matrix.php-versions }} Static Analysis
24 |     runs-on: ubuntu-latest
25 |     if: "!contains(github.event.head_commit.message, '[ci skip]')"
26 |     strategy:
27 |       fail-fast: false
28 |       matrix:
29 |         php-versions: ['7.4', '8.0', '8.1']
30 | 
31 |     steps:
32 |       - name: Checkout
33 |         uses: actions/checkout@v4
34 | 
35 |       - name: Setup PHP
36 |         uses: shivammathur/setup-php@v2
37 |         with:
38 |           php-version: ${{ matrix.php-versions }}
39 |           tools: phpstan, phpunit
40 |           extensions: intl, json, mbstring, xml
41 |           coverage: none
42 |         env:
43 |           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
44 | 
45 |       - name: Get composer cache directory
46 |         run: echo "COMPOSER_CACHE_FILES_DIR=$(composer config cache-files-dir)" >> $GITHUB_ENV
47 | 
48 |       - name: Cache composer dependencies
49 |         uses: actions/cache@v4
50 |         with:
51 |           path: ${{ env.COMPOSER_CACHE_FILES_DIR }}
52 |           key: ${{ runner.os }}-composer-${{ hashFiles('**/composer.json') }}-${{ hashFiles('**/composer.lock') }}
53 |           restore-keys: ${{ runner.os }}-composer-
54 | 
55 |       - name: Create PHPStan cache directory
56 |         run: mkdir -p build/phpstan
57 | 
58 |       - name: Cache PHPStan results
59 |         uses: actions/cache@v4
60 |         with:
61 |           path: build/phpstan
62 |           key: ${{ runner.os }}-phpstan-${{ github.sha }}
63 |           restore-keys: ${{ runner.os }}-phpstan-
64 | 
65 |       - name: Install dependencies
66 |         run: |
67 |           if [ -f composer.lock ]; then
68 |             composer install --no-progress --no-interaction --prefer-dist --optimize-autoloader
69 |           else
70 |             composer update --no-progress --no-interaction --prefer-dist --optimize-autoloader
71 |           fi
72 | 
73 |       - name: Run static analysis
74 |         run: vendor/bin/phpstan analyze
75 | 


--------------------------------------------------------------------------------
/.github/workflows/rector.yml:
--------------------------------------------------------------------------------
 1 | name: Rector
 2 | 
 3 | on:
 4 |   pull_request:
 5 |     branches:
 6 |       - develop
 7 |     paths:
 8 |       - '**.php'
 9 |       - 'composer.*'
10 |       - 'rector.php'
11 |       - '.github/workflows/rector.yml'
12 |   push:
13 |     branches:
14 |       - develop
15 |     paths:
16 |       - '**.php'
17 |       - 'composer.*'
18 |       - 'rector.php'
19 |       - '.github/workflows/rector.yml'
20 | 
21 | jobs:
22 |   build:
23 |     name: PHP ${{ matrix.php-versions }} Rector Analysis
24 |     runs-on: ubuntu-latest
25 |     if: "!contains(github.event.head_commit.message, '[ci skip]')"
26 |     strategy:
27 |       fail-fast: false
28 |       matrix:
29 |         php-versions: ['7.4', '8.0', '8.1']
30 | 
31 |     steps:
32 |       - name: Checkout
33 |         uses: actions/checkout@v4
34 | 
35 |       - name: Set up PHP
36 |         uses: shivammathur/setup-php@v2
37 |         with:
38 |           php-version: ${{ matrix.php-versions }}
39 |           tools: phpstan
40 |           extensions: intl, json, mbstring, xml
41 |           coverage: none
42 |         env:
43 |           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
44 | 
45 |       - name: Get composer cache directory
46 |         run: echo "COMPOSER_CACHE_FILES_DIR=$(composer config cache-files-dir)" >> $GITHUB_ENV
47 | 
48 |       - name: Cache composer dependencies
49 |         uses: actions/cache@v4
50 |         with:
51 |           path: ${{ env.COMPOSER_CACHE_FILES_DIR }}
52 |           key: ${{ runner.os }}-composer-${{ hashFiles('**/composer.json') }}-${{ hashFiles('**/composer.lock') }}
53 |           restore-keys: ${{ runner.os }}-composer-
54 | 
55 |       - name: Install dependencies
56 |         run: |
57 |           if [ -f composer.lock ]; then
58 |             composer install --no-progress --no-interaction --prefer-dist --optimize-autoloader
59 |           else
60 |             composer update --no-progress --no-interaction --prefer-dist --optimize-autoloader
61 |           fi
62 | 
63 |       - name: Analyze for refactoring
64 |         run: |
65 |           composer global require --dev rector/rector:^1.0.0
66 |           rector process --dry-run --no-progress-bar
67 | 


--------------------------------------------------------------------------------
/.gitignore:
--------------------------------------------------------------------------------
1 | vendor/
2 | build/
3 | phpunit*.xml
4 | phpunit
5 | *.cache
6 | composer.lock
7 | .DS_Store
8 | .idea/
9 | site/


--------------------------------------------------------------------------------
/.php-cs-fixer.dist.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | declare(strict_types=1);
 4 | 
 5 | /**
 6 |  * This file is part of Shield OAuth.
 7 |  *
 8 |  * (c) Datamweb <pooya_parsa_dadashi@yahoo.com>
 9 |  *
10 |  * For the full copyright and license information, please view
11 |  * the LICENSE file that was distributed with this source code.
12 |  */
13 | 
14 | use CodeIgniter\CodingStandard\CodeIgniter4;
15 | use Nexus\CsConfig\Factory;
16 | use PhpCsFixer\Finder;
17 | 
18 | $finder = Finder::create()
19 |     ->files()
20 |     ->in([
21 |         __DIR__ . '/src/',
22 |         // __DIR__ . '/tests/',
23 |     ])
24 |     ->exclude('build')
25 |     ->append([
26 |         __FILE__,
27 |         __DIR__ . '/rector.php',
28 |     ]);
29 | 
30 | $overrides = [
31 |     'declare_strict_types' => true,
32 |     'void_return'          => true,
33 |     'modernize_strpos'     => false,
34 | ];
35 | 
36 | $options = [
37 |     'finder'    => $finder,
38 |     'cacheFile' => '.php-cs-fixer.cache',
39 | ];
40 | 
41 | return Factory::create(new CodeIgniter4(), $overrides, $options)->forLibrary(
42 |     'Shield OAuth',
43 |     'Datamweb',
44 |     'pooya_parsa_dadashi@yahoo.com'
45 | );
46 | 


--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
 1 | MIT License
 2 | 
 3 | Copyright (c) 2022-2023 Pooya Parsa Dadashi
 4 | 
 5 | Permission is hereby granted, free of charge, to any person obtaining a copy
 6 | of this software and associated documentation files (the "Software"), to deal
 7 | in the Software without restriction, including without limitation the rights
 8 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 9 | copies of the Software, and to permit persons to whom the Software is
10 | furnished to do so, subject to the following conditions:
11 | 
12 | The above copyright notice and this permission notice shall be included in all
13 | copies or substantial portions of the Software.
14 | 
15 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21 | SOFTWARE.
22 | 


--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
 1 | [Farsi](./README.fa-IR.md) | English
 2 | ##  Codeigniter Shield OAuth
 3 | [![PHPCSFixer](https://github.com/datamweb/shield-oauth/actions/workflows/phpcsfixer.yml/badge.svg)](https://github.com/datamweb/shield-oauth/actions/workflows/phpcsfixer.yml)
 4 | [![PHPStan](https://github.com/datamweb/shield-oauth/actions/workflows/phpstan.yml/badge.svg)](https://github.com/datamweb/shield-oauth/actions/workflows/phpstan.yml)
 5 | [![Rector](https://github.com/datamweb/shield-oauth/actions/workflows/rector.yml/badge.svg)](https://github.com/datamweb/shield-oauth/actions/workflows/rector.yml)
 6 | [![PHPCPD](https://github.com/datamweb/shield-oauth/actions/workflows/phpcpd.yml/badge.svg)](https://github.com/datamweb/shield-oauth/actions/workflows/phpcpd.yml)
 7 | 
 8 | 
 9 | <p align="center"><img src="https://github.com/datamweb/my-repository-files/blob/main/shield-oauth/image/shieldOAuthLogo.png" alt="Logo Shield OAuth"></p>
10 | 
11 | [![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)
12 | 
13 | 
14 | `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 ...
15 | 
16 | 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.
17 | 
18 | <p align="center"><img src="https://github.com/datamweb/my-repository-files/blob/main/shield-oauth/image/ShieldOAuthDemo.jpg" alt="Demo Shield OAuth"></p>
19 | 
20 | ## Requirements
21 | 
22 | - [Composer](https://getcomposer.org)
23 | - [Codeigniter](https://codeigniter4.github.io/CodeIgniter4/installation/installing_composer.html#installation) **v4.3.5** or later
24 | - [Codeigniter Shield](https://github.com/codeigniter4/shield)
25 | - [cURL Library](https://www.php.net/manual/en/book.curl.php) to be installed in your version of PHP
26 | 
27 | ## Shield OAuth Documentation
28 | 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/).
29 | 
30 | ## License
31 | This project is licensed under the MIT License - see the [LICENSE](/LICENSE) file for details.
32 | 
33 | ## Acknowledgements
34 | 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`:
35 | 
36 | <a href="https://github.com/datamweb/shield-oauth/graphs/contributors">
37 |   <img src="https://contrib.rocks/image?repo=datamweb/shield-oauth" alt="Contributors">
38 | </a>
39 | 


--------------------------------------------------------------------------------
/admin/pre-commit:
--------------------------------------------------------------------------------
 1 | #!/bin/sh
 2 | if [ "$FILES" != "" ]; then
 3 |     echo "Running PHP CS Fixer..."
 4 | 
 5 |     if [ -d /proc/cygdrive ]; then
 6 |         ./vendor/bin/php-cs-fixer fix --verbose --dry-run --diff
 7 |     else
 8 |         php ./vendor/bin/php-cs-fixer fix --verbose --dry-run --diff
 9 |     fi
10 | 
11 |     if [ $? != 0 ]; then
12 |         echo "Some files are not following the coding standards. Please fix them before commit (try 'composer style')."
13 |         exit 1
14 |     fi
15 | fi
16 | 
17 | exit $?
18 | 


--------------------------------------------------------------------------------
/admin/setup.sh:
--------------------------------------------------------------------------------
1 | #!/bin/sh
2 | 
3 | # Install a pre-commit hook that
4 | # automatically runs phpcs to fix styles
5 | cp admin/pre-commit .git/hooks/pre-commit
6 | chmod +x .git/hooks/pre-commit


--------------------------------------------------------------------------------
/composer.json:
--------------------------------------------------------------------------------
 1 | {
 2 |   "name": "datamweb/shield-oauth",
 3 |   "description": "OAuth for CodeIgniter Shield",
 4 |   "license": "MIT",
 5 |   "type": "library",
 6 |   "keywords": [
 7 |     "codeigniter4",
 8 |     "shield",
 9 |     "oauth",
10 |     "googleOauth",
11 |     "githubOauth",
12 |     "authentication",
13 |     "authorization"
14 |   ],
15 |   "authors": [
16 |     {
17 |       "name": "Pooya Parsa Dadashi",
18 |       "email": "pooya_parsa_dadashi@yahoo.com",
19 |       "role": "Developer"
20 |     }
21 |   ],
22 |   "homepage": "https://github.com/datamweb/shield-oauth",
23 |   "minimum-stability": "dev",
24 |   "prefer-stable": true,
25 |   "require": {
26 |     "php": "^7.4.3 || ^8.0 || ^8.1 || ^8.2",
27 |     "ext-curl": "*",
28 |     "codeigniter4/shield": "^1.0"
29 |   },
30 |   "require-dev": {
31 |     "codeigniter4/devkit": "^1.0",
32 |     "codeigniter4/framework": "^4.3.5",
33 |     "codeigniter4/shield": "^1.0",
34 |     "rector/rector": "1.2.10"
35 |   },
36 |   "autoload": {
37 |     "psr-4": {
38 |       "Datamweb\\ShieldOAuth\\": "src"
39 |     },
40 |     "exclude-from-classmap": [
41 |       "**/Database/Migrations/**"
42 |     ]
43 |   },
44 |   "autoload-dev": {
45 |     "psr-4": {
46 |       "Tests\\": "tests",
47 |       "Tests\\Support\\": "tests/_support"
48 |     }
49 |   },
50 |   "scripts": {
51 |     "post-update-cmd": [
52 |       "bash admin/setup.sh"
53 |     ],
54 |     "ci": [
55 |       "Composer\\Config::disableProcessTimeout",
56 |       "@cs"
57 |     ],
58 |     "cs": "php-cs-fixer fix --ansi --verbose --dry-run --diff",
59 |     "cs-fix": "php-cs-fixer fix --ansi --verbose --diff",
60 |     "style": "@cs-fix"
61 |   },
62 |   "config": {
63 |     "allow-plugins": {
64 |       "phpstan/extension-installer": true
65 |     }
66 |   },
67 |   "support": {
68 |     "forum": "https://github.com/datamweb/shield-oauth/discussions",
69 |     "source": "https://github.com/datamweb/shield-oauth",
70 |     "issues": "https://github.com/datamweb/shield-oauth/issues",
71 |     "docs": "https://www.shield-oauth.codeigniter4.ir"
72 |   }
73 | }
74 | 


--------------------------------------------------------------------------------
/docs/CNAME:
--------------------------------------------------------------------------------
1 | www.shield-oauth.codeigniter4.ir
2 | 


--------------------------------------------------------------------------------
/docs/add_other_oauth.md:
--------------------------------------------------------------------------------
  1 | # Adding New OAuth To Shield OAuth
  2 | 
  3 | Shield OAuth supports *Google OAuth* and *GitHub OAuth* out-of-the-box and also provides an easy way to connect any server that offers **OAuth** to it. This guide explains how to achieve this.
  4 | 
  5 | - [Adding New OAuth To Shield OAuth](#adding-new-oauth-to-shield-oauth)
  6 |   - [Setup Instruction](#setup-instruction)
  7 |     - [Command Setup](#command-setup)
  8 |     - [Manual Setup](#manual-setup)
  9 |   - [Available Methods](#available-methods)
 10 |   - [YahooOAuth Example Class](#yahoooauth-example-class)
 11 | 
 12 | ## Setup Instruction
 13 | 
 14 | ### Command Setup
 15 | 
 16 | 1. Run the following command. This command handles steps 1 - 3 of *Manual Setup*.
 17 | 
 18 | ```console
 19 | php spark make:oauth Example
 20 | ```
 21 | 
 22 | > **Note** The name of the new OAuth you want to create doesn't need to contain the `OAuth` suffix. The command will automatically add it to the class name for you.
 23 | 
 24 | This command will automatically generate new files *ExampleOAuth.php*, *ShieldOAuthLang.php* in the **app/Libraries/ShieldOAuth**, **app/Language/en** paths respectively and also update the *ShieldOAuthConfig.php* file in the **app/Config** path.
 25 | 
 26 | > **Note** The *ShieldOAuthConfig.php* file must be present in your **app/Config** path for this command to run successfully. So ensure that you have run the `make:oauthconfig` command first, as stated [here](install.md#set-keys).
 27 | 
 28 | 2. Configure the files.
 29 | 
 30 | ```php
 31 | // updated file - app/Config/ShieldOAuthConfig.php
 32 | <?php 
 33 | public array $oauthConfigs = [
 34 |     // ..
 35 |     'example' => [
 36 |         'client_id'     => 'Get this from the OAuth server',
 37 |         'client_secret' => 'Get this from the OAuth server',
 38 | 
 39 |         'allow_login'    => true,
 40 |         'allow_register' => true,
 41 |     ],
 42 | ];
 43 | 
 44 | ```
 45 | 
 46 | ```php
 47 | // new file - app/Libraries/ShieldOAuth/ExampleOAuth.php
 48 | <?php 
 49 | 
 50 | declare(strict_types=1);
 51 | 
 52 | namespace App\Libraries\ShieldOAuth;
 53 | 
 54 | use Datamweb\ShieldOAuth\Libraries\Basic\AbstractOAuth;
 55 | 
 56 | class ExampleOAuth extends AbstractOAuth 
 57 | {
 58 |     private static $API_CODE_URL = '';
 59 |     private static $API_TOKEN_URL = '';
 60 |     private static $API_USER_INFO_URL = '';
 61 |     private static $APPLICATION_NAME = 'ShieldOAuth';
 62 | 
 63 |     protected string $token;
 64 |     protected string $client_id;
 65 |     protected string $client_secret;
 66 |     protected string $callback_url;
 67 | 
 68 |     public function __construct(string $token = '')
 69 |     {
 70 |         // your code here
 71 |     }
 72 | 
 73 |     public function makeGoLink(string $state): string
 74 |     {
 75 |         // your code here
 76 |         return '';
 77 |     }
 78 | 
 79 |     public function fetchAccessTokenWithAuthCode(array $allGet): void
 80 |     {
 81 |         // your code here
 82 |     }
 83 | 
 84 |     public function fetchUserInfoWithToken(): object
 85 |     {
 86 |         // your code here
 87 |         return json_decode('');
 88 |     }
 89 | 
 90 |     public function setColumnsName(string $nameOfProcess, object $userInfo): array
 91 |     {
 92 |         // your code here
 93 |         return [];
 94 |     }
 95 | }
 96 | ```
 97 | 
 98 | > See [YahooOAuth](#yahoooauth-example-class) example for full code.
 99 | 
100 | ### Manual Setup
101 | 
102 | 1. Create a file *ExampleOAuth* in the **app/Libraries/ShieldOAuth** path with the following contents. The **OAuth** suffix is mandatory in creating each new class. For example, if you want to add Yahoo, you should create a file named **YahooOAuth**.
103 | 
104 | ```php
105 | <?php 
106 | 
107 | declare(strict_types=1);
108 | 
109 | namespace App\Libraries\ShieldOAuth;
110 | 
111 | use Datamweb\ShieldOAuth\Libraries\Basic\AbstractOAuth;
112 | 
113 | class ExampleOAuth extends AbstractOAuth 
114 | {
115 |     private static $API_CODE_URL = '';
116 |     private static $API_TOKEN_URL = '';
117 |     private static $API_USER_INFO_URL = '';
118 |     private static $APPLICATION_NAME = 'ShieldOAuth';
119 | 
120 |     protected string $token;
121 |     protected string $client_id;
122 |     protected string $client_secret;
123 |     protected string $callback_url;
124 | 
125 |     public function __construct(string $token = '')
126 |     {
127 |         // your code here
128 |     }
129 | 
130 |     public function makeGoLink(string $state): string
131 |     {
132 |         // your code here
133 |         return '';
134 |     }
135 | 
136 |     public function fetchAccessTokenWithAuthCode(array $allGet): void
137 |     {
138 |         // your code here
139 |     }
140 | 
141 |     public function fetchUserInfoWithToken(): object
142 |     {
143 |         // your code here
144 |         return json_decode('');
145 |     }
146 | 
147 |     public function setColumnsName(string $nameOfProcess, object $userInfo): array
148 |     {
149 |         // your code here
150 |         return [];
151 |     }
152 | }
153 | ```
154 | 
155 | > See [YahooOAuth](#yahoooauth-example-class) example for full code.
156 | 
157 | 2. **Config Setup** Add the new OAuth config keys to the **app/Config/ShieldOAuthConfig.php** file.
158 | 
159 | ```php
160 | <?php 
161 | public array $oauthConfigs = [
162 |     //...
163 |     'example' => [
164 |         'client_id'     => 'Get this from the OAuth server',
165 |         'client_secret' => 'Get this from the OAuth server',
166 | 
167 |         'allow_login'    => true,
168 |         'allow_register' => true,
169 |     ],
170 |     //...
171 | ];
172 | 
173 | ```
174 | 
175 | 3. **Language setup** Add the following values to the **app/Language/en/ShieldOAuthLang.php** file. Create the file if it doesn't exist.
176 | 
177 | ```php
178 | return [
179 |     // ...
180 |     'Example' => [
181 |         'not_allow' => 'Now you can\'t login or register with Example!',
182 |         'example'   => 'Example',
183 |     ],
184 |     // ...
185 | ];
186 | ```
187 | 
188 | 4. **Translations** Depending on the requirements of your application, you can translate the language file using the same keys, in as many languages as possible. See [CodeIgniter docs](https://codeigniter.com/user_guide/outgoing/localization.html#creating-language-files) for more information. Also note that the file name for each language must be **ShieldOAuthLang.php**.
189 | 
190 | ## Available Methods
191 | 
192 | Your new *OAuth* file/class has just one requirement. It must extend `Datamweb\ShieldOAuth\Libraries\Basic\AbstractOAuth`. The abstract class `AbstractOAuth` implement methods `makeGoLink($state)`, `fetchAccessTokenWithAuthCode($allGet)`, `fetchUserInfoWithToken()` and `setColumnsName(string $nameOfProcess, $userInfo)`, which should be built according to the documentation of each server.
193 | 
194 | The `AbstractOAuth` defines four methods for your usage:
195 | 
196 | 1. `makeGoLink($state)` In this method, you need to create a link to transfer the user to the new provider. The output of this method is a `string` in the form of URL. For example, regarding Yahoo, you can follow the instructions available [here](https://developer.yahoo.com/oauth2/guide/flows_authcode/#step-2-get-an-authorization-url-and-authorize-access) to create this link.
197 | 2. `fetchAccessTokenWithAuthCode($allGet)` In this method, you should try to get the value of `access_token` according to the code received from the previous method. The output of this method is of `void`. For Yahoo, you can see the description [here](https://developer.yahoo.com/oauth2/guide/flows_authcode/#step-4-exchange-authorization-code-for-access-token). Everything is ready, just replace.
198 | 3. `fetchUserInfoWithToken()` In this method, you try to receive user information (including first name, last name, email, etc) according to the token code set in the previous step.The output of this method is a `object` of user info(email, name, ...). See [here](https://developer.yahoo.com/oauth2/guide/OpenID2) for more details about Yahoo.
199 | 4. `setColumnsName(string $nameOfProcess, $userInfo)` In this method, you set the fields received from each service OAuth to be recorded in each column of the table.
200 | 
201 | ## YahooOAuth Example Class
202 | 
203 | ```php
204 | <?php
205 | 
206 | declare(strict_types=1);
207 | 
208 | namespace App\Libraries\ShieldOAuth;
209 | 
210 | use CodeIgniter\HTTP\CURLRequest;
211 | use Config\Services;
212 | use Datamweb\ShieldOAuth\Config\ShieldOAuthConfig;
213 | use Datamweb\ShieldOAuth\Libraries\Basic\AbstractOAuth;
214 | use Exception;
215 | 
216 | class YahooOAuth extends AbstractOAuth
217 | {
218 |     // https://developer.yahoo.com/oauth2/guide/flows_authcode/#refresh-token-label
219 |     private static string $API_CODE_URL      = 'https://api.login.yahoo.com/oauth2/request_auth';
220 |     private static string $API_TOKEN_URL     = 'https://api.login.yahoo.com/oauth2/get_token';
221 |     private static string $API_USER_INFO_URL = 'https://api.login.yahoo.com/openid/v1/userinfo';
222 |     private static string $APPLICATION_NAME  = 'ShieldOAuth';
223 | 
224 |     protected string $token;
225 |     protected CURLRequest $client;
226 |     protected ShieldOAuthConfig $config;
227 |     protected string $client_id;
228 |     protected string $client_secret;
229 |     protected string $callback_url;
230 | 
231 |     public function __construct(string $token = '')
232 |     {
233 |         $this->token  = $token;
234 |         $this->client = Services::curlrequest();
235 | 
236 |         $this->config        = config('ShieldOAuthConfig');
237 |         $this->callback_url  = base_url('oauth/' . $this->config->call_back_route);
238 |         $this->client_id     = env('ShieldOAuthConfig.yahoo.client_id', $this->config->oauthConfigs['yahoo']['client_id']);
239 |         $this->client_secret = env('ShieldOAuthConfig.yahoo.client_secret', $this->config->oauthConfigs['yahoo']['client_secret']);
240 |     }
241 | 
242 |     public function makeGoLink(string $state): string
243 |     {
244 |         $yahooURL= self::$API_CODE_URL."?response_type=code&client_id={$this->client_id}&redirect_uri={$this->callback_url}&state={$state}";
245 | 
246 |         return $yahooURL;
247 |     }
248 | 
249 |     public function fetchAccessTokenWithAuthCode(array $allGet): void
250 |     {
251 | 
252 |         $client = \Config\Services::curlrequest();
253 |         try {
254 |             //send request to API URL
255 |             $response = $client->request('POST', self::$API_TOKEN_URL, [
256 |                 'form_params' => [
257 |                         'client_id'     => $this->client_id ,
258 |                         'client_secret' => $this->client_secret ,
259 |                         'redirect_uri'  => $this->callback_url,
260 |                         'code'          => $allGet['code'],
261 |                         'grant_type'    => 'authorization_code'
262 |                 ],
263 |                 'http_errors' => false,
264 |             ]);
265 |           
266 |         } catch (Exception $e) {
267 |             die($e->getMessage());
268 |         }
269 | 
270 |          $token = json_decode($response->getBody())->access_token;
271 |          $this->setToken($token);
272 |     }
273 |   
274 |     protected function fetchUserInfoWithToken(): object
275 |     {
276 |         // send request to API URL
277 |         try {
278 |             $response = $this->client->request('GET', self::$API_USER_INFO_URL, [
279 |                 'headers' => [
280 |                     'Authorization' => 'Bearer ' . $this->getToken(),
281 |                 ],
282 |                 'http_errors' => false,
283 |             ]);
284 |         } catch (Exception $e) {
285 |             die($e->getMessage());
286 |         }
287 | 
288 |         return json_decode($response->getBody());
289 |     }
290 | 
291 |     protected function setColumnsName(string $nameOfProcess, object $userInfo): array
292 |     {
293 |         if($nameOfProcess === 'syncingUserInfo'){
294 |             $usersColumnsName = [
295 |                 $this->config->usersColumnsName['first_name'] => $userInfo->given_name,
296 |                 $this->config->usersColumnsName['last_name']  => $userInfo->family_name,
297 |                 $this->config->usersColumnsName['avatar']     => $userInfo->picture,
298 |             ];
299 |         }
300 | 
301 |         if($nameOfProcess === 'newUser'){
302 |             $usersColumnsName = [
303 |                 'username'                                    => $userInfo->nickname,
304 |                 'email'                                       => $userInfo->email,
305 |                 'password'                                    => random_string('crypto', 32),
306 |                 'active'                                      => $userInfo->email_verified,
307 |                 $this->config->usersColumnsName['first_name'] => $userInfo->given_name,
308 |                 $this->config->usersColumnsName['last_name']  => $userInfo->family_name,
309 |                 $this->config->usersColumnsName['avatar']     => $userInfo->picture,
310 |             ];
311 |         }
312 | 
313 |         return $usersColumnsName;
314 |     }
315 | }
316 | ```
317 | 


--------------------------------------------------------------------------------
/docs/get_keys.md:
--------------------------------------------------------------------------------
 1 | # How To Get Keys
 2 |   
 3 | 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.
 4 | 
 5 | - [How To Get Keys](#how-to-get-keys)
 6 | - [Explanation About Callback](#explanation-about-callback)
 7 | - [Get GitHub Keys](#get-github-keys)
 8 | - [Get Google Keys](#get-google-keys)
 9 | - [Get Yahoo Keys](#get-yahoo-keys)
10 | 
11 | 
12 | # Explanation About Callback
13 | 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.
14 | ```
15 | https://yourBaseUrl.com/oauth/call-back
16 | ```
17 | `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.
18 | 
19 | ```php
20 | public string $call_back_route = 'any-name-for-call-back';
21 | ```
22 | 
23 | Be careful that you must provide the same address for all services.
24 | 
25 | ```
26 | https://yourBaseUrl.com/oauth/any-name-for-call-back
27 | ```
28 | 
29 | # Get GitHub Keys
30 | 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.
31 | 
32 | # Get Google Keys
33 | 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).
34 | 
35 | # Get Yahoo Keys
36 | The guide to get the `client_id` & `client_secret` keys on Yahoo is [here](https://developer.yahoo.com/apps/create/).
37 | 


--------------------------------------------------------------------------------
/docs/index.md:
--------------------------------------------------------------------------------
 1 | # Shield OAuth Documentation
 2 | [![PHPCSFixer](https://github.com/datamweb/shield-oauth/actions/workflows/phpcsfixer.yml/badge.svg)](https://github.com/datamweb/shield-oauth/actions/workflows/phpcsfixer.yml)
 3 | [![PHPStan](https://github.com/datamweb/shield-oauth/actions/workflows/phpstan.yml/badge.svg)](https://github.com/datamweb/shield-oauth/actions/workflows/phpstan.yml)
 4 | [![Rector](https://github.com/datamweb/shield-oauth/actions/workflows/rector.yml/badge.svg)](https://github.com/datamweb/shield-oauth/actions/workflows/rector.yml)
 5 | [![PHPCPD](https://github.com/datamweb/shield-oauth/actions/workflows/phpcpd.yml/badge.svg)](https://github.com/datamweb/shield-oauth/actions/workflows/phpcpd.yml)
 6 | 
 7 | <p align="center"><img src="https://github.com/datamweb/my-repository-files/blob/main/shield-oauth/image/shieldOAuthLogo.png?raw=true" alt="Logo Shield OAuth"></p>
 8 | 
 9 | [![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)
10 | 
11 | 
12 | `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`! 
13 | more info see [How to add other services](add_other_oauth.md).
14 | 
15 | ## Links:
16 | 
17 | * [Installation Guide](install.md)
18 | * [How To Get Keys](get_keys.md)
19 | * [How to add other services](add_other_oauth.md)
20 | * [Quick Start](quickstart.md)
21 | 
22 | ## Acknowledgements
23 | 
24 | Every open-source project depends on it's contributors to be a success. The following users have
25 | contributed in one manner or another in making `Shield OAuth`:
26 | 
27 | <a href="https://github.com/datamweb/shield-oauth/graphs/contributors">
28 |   <img src="https://contrib.rocks/image?repo=datamweb/shield-oauth" alt="Contributors">
29 | </a>
30 | 


--------------------------------------------------------------------------------
/docs/install.md:
--------------------------------------------------------------------------------
  1 | # Installation
  2 | 
  3 | - [Installation](#installation)
  4 |   - [Requirements](#requirements)
  5 |   - [Composer Installation](#composer-installation)
  6 |   - [Add Required Columns](#add-required-columns)
  7 |   - [Cancel Filter For Shield OAuth Routes](#cancel-filter-for-shield-oauth-routes)
  8 |   - [Set keys](#set-keys)
  9 |   - [Adding all login button with OAuth in View](#adding-all-login-button-with-oauth-in-view)
 10 | 
 11 | These instructions assume that you have already installed the **CodeIgniter 4 app starter** and **Shield** as the basis for your new project, set up your `.env` file, and created a database that you can access via the Spark CLI script.
 12 | 
 13 | ## Requirements
 14 | 
 15 | - [Composer](https://getcomposer.org)
 16 | - [Codeigniter](https://codeigniter4.github.io/CodeIgniter4/installation/installing_composer.html#installation) **v4.3.5** or later
 17 | - [Codeigniter Shield](https://github.com/codeigniter4/shield)
 18 | - [cURL Library](https://www.php.net/manual/en/book.curl.php) to be installed in your version of PHP
 19 | 
 20 | ## Composer Installation
 21 | 
 22 | Installation is done through [Composer](https://getcomposer.org). The example assumes you have it installed globally.
 23 | If you have it installed as a phar, or otherwise you will need to adjust the way you call composer itself.
 24 | 
 25 | ```console
 26 | composer require datamweb/shield-oauth:dev-develop
 27 | ```
 28 | > **Note**
 29 | > You can manually install `Shield OAuth` by extracting the project file to path `app\ThirdParty\shield-oauth` and then adding 
 30 | > 
 31 | >```php     
 32 | > public $psr4 = [
 33 | >     // add this line
 34 | >     'Datamweb\ShieldOAuth' => APPPATH . 'ThirdParty/shield-oauth/src',
 35 | > ];
 36 | > ``` 
 37 | > to the `app/Config/Autoload.php` file, however we do not recommend this. Please use the Composer.
 38 | 
 39 | ## Add Required Columns
 40 | 
 41 | `Shield OAuth` needs to make some changes in Shield `users` Table. In general, you should have the following items in `users` Table.
 42 | 
 43 | ```console
 44 | Data of Table "users":
 45 | 
 46 | +----+----------+--------+-...-+------------+-----------+--------+
 47 | | id | username | status | ... | first_name | last_name | avatar |
 48 | +----+----------+--------+-...-+------------+-----------+--------+
 49 | ```
 50 | Therefore, you can add `first_name`, `last_name`, and `avatar` columns to table `users` by any method you want or run the migrations:
 51 | 
 52 | ```console
 53 | php spark migrate -n Datamweb\ShieldOAuth
 54 | ```
 55 | 
 56 | > **Note**
 57 | > By default, `Shield OAuth` uses columns named `first_name`, `last_name`, and `avatar`.
 58 | > 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:
 59 | 
 60 | ```php 
 61 | public array $usersColumnsName = [
 62 |     'first_name' => 'first_name',
 63 |     'last_name'  => 'last_name',
 64 |     'avatar'     => 'avatar',
 65 | ];
 66 | ```
 67 | 
 68 | ## Cancel Filter For Shield OAuth Routes
 69 | 
 70 | `Shield OAuth` adds multiple routes to your project. `oauth/call-back` and `oauth/(:any)`, so you should register them in the category of **not applying** the shield filter. For this, you can proceed as follows you need to add the following code in the `app/Config/Filters.php` file.
 71 | 
 72 | ```php
 73 | public $globals = [
 74 |     'before' => [
 75 |         // ...
 76 |         'session' => ['except' => ['login*', 'register', 'auth/a/*', 'oauth*']],
 77 |     ],
 78 |     // ...
 79 | ];
 80 | ```
 81 | 
 82 | ## Set keys 
 83 | 
 84 | Receive keys `client_id` and `client_secret` from each OAuth server.
 85 | 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`.
 86 | 
 87 | We suggest that you set the keys of each service in file **.env** instead of using **app/Config/ShieldOAuthConfig**. For example, you can proceed as follows.
 88 | 
 89 | ```env
 90 | ShieldOAuthConfig.google.client_id = Your google client_id key
 91 | ShieldOAuthConfig.google.client_secret = Your google client_secret key
 92 | ```
 93 | 
 94 | > **Note**
 95 | > By default, there is no file `app/Config/ShieldOAuthConfig`. It is strongly recommended to set the keys to `app/Config/ShieldOAuthConfig`. This behavior will make sure that there will be no problems for the settings you have made in case of update `Shield OAuth`. To create it, you can use the following command:
 96 | >
 97 | > ```console
 98 | > php spark make:oauthconfig
 99 | > ```
100 | 
101 | You can see [How To Get Keys](get_keys.md) for instructions on how to get the keys.
102 | 
103 | ```php
104 | public array $oauthConfigs = [
105 |     'github' => [
106 |             'client_id'     => '8441sgsgsgsgshfgjgykgub08b6',
107 |             'client_secret' => '2336fsdgdfgdfgdfghfdhfghdhdhdhdhd',
108 |             // ...
109 |     ],
110 |     'google' => [
111 |             'client_id'     => '95040vghjhjghjgjgj.apps.googleusercontent.com',
112 |             'client_secret' => 'fsdfsdfsgdgrdg',
113 |         // ...
114 |     ],
115 |     // and other services...
116 | ```
117 | 
118 | ## Adding all login button with OAuth in View
119 | The last step is to, You can create your own buttons in views, what is important is that the addresses should be as follows:
120 | ```html
121 | http://localhost:8080/oauth/google
122 | http://localhost:8080/oauth/github
123 | http://localhost:8080/oauth/yahoo
124 | <!-- and other OAuth !>
125 | ```
126 | 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.
127 | 
128 | ```html
129 | {{ShieldOAuthButtonForLoginPage}}
130 | ```
131 | 
132 | ```html
133 | {{ShieldOAuthButtonForRegisterPage}}
134 | ```
135 | Because we have used Bootstrap to make the dropdown button, you need to add the following items at the end of the views file.
136 | 
137 | ```php
138 | <?= $this->section('pageScripts') ?>
139 | <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>
140 | <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>
141 | <?= $this->endSection() ?>
142 | ```
143 | 
144 | > **Note**
145 | > When you create a new class in path `app/Libraries/ShieldOAuth/`, for example `YahooOAuth.php`, you will have a new link as below, this is done automatically and there is no need to add code and perform special instructions.
146 | >
147 | > ```html
148 | > http://localhost:8080/oauth/yahoo
149 | > ```
150 | 
151 | > **Warning**
152 | > The two views `vendor/codeigniter4/shield/src/Views/login.php` and `vendor/codeigniter4/shield/src/Views/register.php` are the main files of `Shield`, we have included them in order to make the **documentation understandable**, you should definitely use custom views.
153 | 


--------------------------------------------------------------------------------
/docs/quickstart.md:
--------------------------------------------------------------------------------
 1 | # Quick Installation
 2 | 
 3 | 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.
 4 | 
 5 | ### Step 1 : 
 6 | 
 7 | Installing the package by Composer :
 8 | ```console
 9 | composer require datamweb/shield-oauth:dev-develop
10 | ```
11 | 
12 | ### Step 2 :
13 | 
14 | Add `first_name`, `last_name`, and `avatar` columns to table `users` :
15 | 
16 | ```console
17 | php spark migrate -n Datamweb\ShieldOAuth
18 | ```
19 | 
20 | ### Step 3 : 
21 | 
22 |  - Add `{{ShieldOAuthButtonForLoginPage}}` to `vendor\codeigniter4\shield\src\Views\login.php`
23 |  - Add `{{ShieldOAuthButtonForRegisterPage}}` to `vendor\codeigniter4\shield\src\Views\register.php`
24 |  - Add
25 | ```php
26 | <?= $this->section('pageScripts') ?>
27 | <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>
28 | <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>
29 | <?= $this->endSection() ?>
30 | ```
31 |  to `vendor\codeigniter4\shield\src\Views\login.php` and `vendor\codeigniter4\shield\src\Views\register.php`.
32 |  
33 | ### Step 4 : 
34 | 
35 | Receive keys `client_id` and `client_secret` from each OAuth server. and setting them in file `app\Config\ShieldOAuthConfig.php`.
36 | 
37 | callBack address is `https://yourBaseURL.com/oauth/call-back`.
38 | ```php
39 | public array $oauthConfigs = [
40 |     'github' => [
41 |             'client_id'     => '8441sgsgsgsgshfgjgykgub08b6',
42 |             'client_secret' => '2336fsdgdfgdfgdfghfdhfghdhdhdhdhd',
43 |             // ...
44 |     ],
45 |     'google' => [
46 |             'client_id'     => '95040vghjhjghjgjgj.apps.googleusercontent.com',
47 |             'client_secret' => 'fsdfsdfsgdgrdg',
48 |         // ...
49 |     ],
50 |     // and other services...
51 | ```
52 | 
53 | > **Note**
54 | > By default, there is no file `app/Config/ShieldOAuthConfig.php`. It is strongly recommended to set the keys to `app/Config/ShieldOAuthConfig.php`. This behavior will make sure that there will be no problems for the settings you have made in case of update `Shield OAuth`. To create it, you can use the following command:
55 | >
56 | > ```console
57 | > php spark make:oauthconfig
58 | > ```
59 | 
60 | ### Step 5 : 
61 | 
62 | Cancel filter for `Shield OAuth` routes.
63 | ```php
64 | public $globals = [
65 |     'before' => [
66 |         // ...
67 |         'session' => ['except' => ['login*', 'register', 'auth/a/*', 'oauth*']],
68 |     ],
69 |     // ...
70 | ];
71 | ```
72 | 
73 | ### Step 6 :
74 | See `https://yourBaseURL.com/login` Or `https://yourBaseURL.com/register` Use and enjoy!
75 | 


--------------------------------------------------------------------------------
/mkdocs.yml:
--------------------------------------------------------------------------------
 1 | site_name: CodeIgniter Shield OAuth
 2 | site_description: Documentation for Shield OAuth
 3 | 
 4 | theme:
 5 |   name: material
 6 |   icon:
 7 |     repo: fontawesome/brands/github
 8 |   font:
 9 |     text: Raleway
10 |   palette:
11 |     primary: red
12 |     accent: red
13 |   features:
14 |     - navigation.sections
15 |     - content.code.copy
16 |     - navigation.footer
17 |     - search.suggest
18 |     - search.highlight
19 |     - content.action.edit
20 | extra:
21 |   homepage: https://codeigniter4.ir
22 |   generator: false
23 |   social:
24 |     - icon: fontawesome/brands/github
25 |       link: https://github.com/datamweb/shield-oauth
26 |       name: GitHub
27 | 
28 | repo_url: https://github.com/datamweb/shield-oauth
29 | edit_uri: edit/develop/docs/
30 | copyright: Copyright &copy; 2022-2023 Pooya Parsa Dadashi.
31 | 
32 | plugins:
33 |   - search
34 |   - git-revision-date-localized:
35 |       enable_creation_date: true
36 | 
37 | markdown_extensions:
38 |   - pymdownx.superfences
39 |   - pymdownx.highlight:
40 |       use_pygments: true
41 | 
42 | extra_css:
43 |   - https://cdn.jsdelivr.net/gh/highlightjs/cdn-release@11.6.0/build/styles/github.min.css
44 | 
45 | extra_javascript:
46 |   - https://cdn.jsdelivr.net/gh/highlightjs/cdn-release@11.6.0/build/highlight.min.js
47 | 
48 | nav:
49 |   - Home: index.md
50 |   - Links:
51 |     - Installation Guide: install.md
52 |     - How To Get Keys: get_keys.md
53 |     - How to add other services: add_other_oauth.md
54 |     - Quick Start: quickstart.md
55 | 


--------------------------------------------------------------------------------
/phpstan-baseline.php:
--------------------------------------------------------------------------------
  1 | <?php declare(strict_types = 1);
  2 | 
  3 | $ignoreErrors = [];
  4 | $ignoreErrors[] = [
  5 | 	'message' => '#^Method Datamweb\\\\ShieldOAuth\\\\Commands\\\\OAuthSetup\\:\\:copyAndReplace\\(\\) has parameter \\$replaces with no value type specified in iterable type array\\.$#',
  6 | 	'count' => 1,
  7 | 	'path' => __DIR__ . '/src/Commands/OAuthSetup.php',
  8 | ];
  9 | // $ignoreErrors[] = [
 10 | // 	'message' => '#^Property Datamweb\\\\ShieldOAuth\\\\Commands\\\\OAuthSetup\\:\\:\\$arguments type has no value type specified in iterable type array\\.$#',
 11 | // 	'count' => 1,
 12 | // 	'path' => __DIR__ . '/src/Commands/OAuthSetup.php',
 13 | // ];
 14 | $ignoreErrors[] = [
 15 | 	'message' => '#^Property Datamweb\\\\ShieldOAuth\\\\Commands\\\\OAuthSetup\\:\\:\\$distPath has no type specified\\.$#',
 16 | 	'count' => 1,
 17 | 	'path' => __DIR__ . '/src/Commands/OAuthSetup.php',
 18 | ];
 19 | $ignoreErrors[] = [
 20 | 	'message' => '#^Method Datamweb\\\\ShieldOAuth\\\\Config\\\\Registrar\\:\\:Generators\\(\\) return type has no value type specified in iterable type array\\.$#',
 21 | 	'count' => 1,
 22 | 	'path' => __DIR__ . '/src/Config/Registrar.php',
 23 | ];
 24 | $ignoreErrors[] = [
 25 | 	'message' => '#^Call to deprecated function random_string\\(\\)\\:
 26 | The type \'basic\', \'md5\', and \'sha1\' are deprecated\\. They are not cryptographically secure\\.$#',
 27 | 	'count' => 1,
 28 | 	'path' => __DIR__ . '/src/Controllers/OAuthController.php',
 29 | ];
 30 | $ignoreErrors[] = [
 31 | 	'message' => '#^Method Datamweb\\\\ShieldOAuth\\\\Controllers\\\\OAuthController\\:\\:checkExistenceUser\\(\\) has parameter \\$find with no value type specified in iterable type array\\.$#',
 32 | 	'count' => 1,
 33 | 	'path' => __DIR__ . '/src/Controllers/OAuthController.php',
 34 | ];
 35 | $ignoreErrors[] = [
 36 | 	'message' => '#^Method Datamweb\\\\ShieldOAuth\\\\Libraries\\\\Basic\\\\AbstractOAuth\\:\\:fetchAccessTokenWithAuthCode\\(\\) has parameter \\$allGet with no value type specified in iterable type array\\.$#',
 37 | 	'count' => 1,
 38 | 	'path' => __DIR__ . '/src/Libraries/Basic/AbstractOAuth.php',
 39 | ];
 40 | $ignoreErrors[] = [
 41 | 	'message' => '#^Method Datamweb\\\\ShieldOAuth\\\\Libraries\\\\Basic\\\\AbstractOAuth\\:\\:getColumnsName\\(\\) return type has no value type specified in iterable type array\\.$#',
 42 | 	'count' => 1,
 43 | 	'path' => __DIR__ . '/src/Libraries/Basic/AbstractOAuth.php',
 44 | ];
 45 | $ignoreErrors[] = [
 46 | 	'message' => '#^Method Datamweb\\\\ShieldOAuth\\\\Libraries\\\\Basic\\\\AbstractOAuth\\:\\:getUserInfo\\(\\) has parameter \\$allGet with no value type specified in iterable type array\\.$#',
 47 | 	'count' => 1,
 48 | 	'path' => __DIR__ . '/src/Libraries/Basic/AbstractOAuth.php',
 49 | ];
 50 | $ignoreErrors[] = [
 51 | 	'message' => '#^Method Datamweb\\\\ShieldOAuth\\\\Libraries\\\\Basic\\\\AbstractOAuth\\:\\:setColumnsName\\(\\) return type has no value type specified in iterable type array\\.$#',
 52 | 	'count' => 1,
 53 | 	'path' => __DIR__ . '/src/Libraries/Basic/AbstractOAuth.php',
 54 | ];
 55 | $ignoreErrors[] = [
 56 | 	'message' => '#^Call to deprecated function random_string\\(\\)\\:
 57 | The type \'basic\', \'md5\', and \'sha1\' are deprecated\\. They are not cryptographically secure\\.$#',
 58 | 	'count' => 1,
 59 | 	'path' => __DIR__ . '/src/Libraries/GithubOAuth.php',
 60 | ];
 61 | $ignoreErrors[] = [
 62 | 	'message' => '#^Method Datamweb\\\\ShieldOAuth\\\\Libraries\\\\GithubOAuth\\:\\:fetchAccessTokenWithAuthCode\\(\\) has parameter \\$allGet with no value type specified in iterable type array\\.$#',
 63 | 	'count' => 1,
 64 | 	'path' => __DIR__ . '/src/Libraries/GithubOAuth.php',
 65 | ];
 66 | $ignoreErrors[] = [
 67 | 	'message' => '#^Method Datamweb\\\\ShieldOAuth\\\\Libraries\\\\GithubOAuth\\:\\:setColumnsName\\(\\) has parameter \\$userInfo with no type specified\\.$#',
 68 | 	'count' => 1,
 69 | 	'path' => __DIR__ . '/src/Libraries/GithubOAuth.php',
 70 | ];
 71 | $ignoreErrors[] = [
 72 | 	'message' => '#^Method Datamweb\\\\ShieldOAuth\\\\Libraries\\\\GithubOAuth\\:\\:setColumnsName\\(\\) return type has no value type specified in iterable type array\\.$#',
 73 | 	'count' => 1,
 74 | 	'path' => __DIR__ . '/src/Libraries/GithubOAuth.php',
 75 | ];
 76 | // $ignoreErrors[] = [
 77 | // 	'message' => '#^Property Datamweb\\\\ShieldOAuth\\\\Libraries\\\\GithubOAuth\\:\\:\\$client has no type specified\\.$#',
 78 | // 	'count' => 1,
 79 | // 	'path' => __DIR__ . '/src/Libraries/GithubOAuth.php',
 80 | // ];
 81 | // $ignoreErrors[] = [
 82 | // 	'message' => '#^Property Datamweb\\\\ShieldOAuth\\\\Libraries\\\\GithubOAuth\\:\\:\\$config has no type specified\\.$#',
 83 | // 	'count' => 1,
 84 | // 	'path' => __DIR__ . '/src/Libraries/GithubOAuth.php',
 85 | // ];
 86 | // $ignoreErrors[] = [
 87 | // 	'message' => '#^Variable \\$usersColumnsName might not be defined\\.$#',
 88 | // 	'count' => 1,
 89 | // 	'path' => __DIR__ . '/src/Libraries/GithubOAuth.php',
 90 | // ];
 91 | $ignoreErrors[] = [
 92 | 	'message' => '#^Call to deprecated function random_string\\(\\)\\:
 93 | The type \'basic\', \'md5\', and \'sha1\' are deprecated\\. They are not cryptographically secure\\.$#',
 94 | 	'count' => 1,
 95 | 	'path' => __DIR__ . '/src/Libraries/GoogleOAuth.php',
 96 | ];
 97 | $ignoreErrors[] = [
 98 | 	'message' => '#^Method Datamweb\\\\ShieldOAuth\\\\Libraries\\\\GoogleOAuth\\:\\:fetchAccessTokenWithAuthCode\\(\\) has parameter \\$allGet with no value type specified in iterable type array\\.$#',
 99 | 	'count' => 1,
100 | 	'path' => __DIR__ . '/src/Libraries/GoogleOAuth.php',
101 | ];
102 | $ignoreErrors[] = [
103 | 	'message' => '#^Method Datamweb\\\\ShieldOAuth\\\\Libraries\\\\GoogleOAuth\\:\\:setColumnsName\\(\\) has parameter \\$userInfo with no type specified\\.$#',
104 | 	'count' => 1,
105 | 	'path' => __DIR__ . '/src/Libraries/GoogleOAuth.php',
106 | ];
107 | $ignoreErrors[] = [
108 | 	'message' => '#^Method Datamweb\\\\ShieldOAuth\\\\Libraries\\\\GoogleOAuth\\:\\:setColumnsName\\(\\) return type has no value type specified in iterable type array\\.$#',
109 | 	'count' => 1,
110 | 	'path' => __DIR__ . '/src/Libraries/GoogleOAuth.php',
111 | ];
112 | // $ignoreErrors[] = [
113 | // 	'message' => '#^Property Datamweb\\\\ShieldOAuth\\\\Libraries\\\\GoogleOAuth\\:\\:\\$client has no type specified\\.$#',
114 | // 	'count' => 1,
115 | // 	'path' => __DIR__ . '/src/Libraries/GoogleOAuth.php',
116 | // ];
117 | // $ignoreErrors[] = [
118 | // 	'message' => '#^Property Datamweb\\\\ShieldOAuth\\\\Libraries\\\\GoogleOAuth\\:\\:\\$config has no type specified\\.$#',
119 | // 	'count' => 1,
120 | // 	'path' => __DIR__ . '/src/Libraries/GoogleOAuth.php',
121 | // ];
122 | // $ignoreErrors[] = [
123 | // 	'message' => '#^Variable \\$usersColumnsName might not be defined\\.$#',
124 | // 	'count' => 1,
125 | // 	'path' => __DIR__ . '/src/Libraries/GoogleOAuth.php',
126 | // ];
127 | 
128 | $ignoreErrors[] = [
129 | 	'message' => '#^Function auth not found\\.$#',
130 | 	'count' => 3,
131 | 	'path' => __DIR__ . '/src/Controllers/OAuthController.php',
132 | ];
133 | $ignoreErrors[] = [
134 | 	'message' => '#^Function user_id not found\\.$#',
135 | 	'count' => 1,
136 | 	'path' => __DIR__ . '/src/Controllers/OAuthController.php',
137 | ];
138 | 
139 | return ['parameters' => ['ignoreErrors' => $ignoreErrors]];
140 | 


--------------------------------------------------------------------------------
/phpstan.neon.dist:
--------------------------------------------------------------------------------
 1 | includes:
 2 | 		- phpstan-baseline.php
 3 | parameters:
 4 | 		tmpDir: build/phpstan
 5 | 		level: 6
 6 | 		paths:
 7 | 				- src/
 8 | 		bootstrapFiles:
 9 | 				- vendor/codeigniter4/framework/system/Test/bootstrap.php
10 | 		excludePaths:
11 | 				- app/Views/*
12 | 		ignoreErrors:
13 | 		universalObjectCratesClasses:
14 | 				- CodeIgniter\Entity
15 | 				- CodeIgniter\Entity\Entity
16 | 				- Faker\Generator
17 | 		scanDirectories:
18 | 				- vendor/codeigniter4/framework/system/Helpers
19 | 				- vendor/codeigniter4/settings/src/Helpers
20 | 		dynamicConstantNames:
21 | 				- APP_NAMESPACE
22 | 				- CI_DEBUG
23 | 				- ENVIRONMENT
24 | 


--------------------------------------------------------------------------------
/rector.php:
--------------------------------------------------------------------------------
  1 | <?php
  2 | 
  3 | declare(strict_types=1);
  4 | 
  5 | /**
  6 |  * This file is part of Shield OAuth.
  7 |  *
  8 |  * (c) Datamweb <pooya_parsa_dadashi@yahoo.com>
  9 |  *
 10 |  * For the full copyright and license information, please view
 11 |  * the LICENSE file that was distributed with this source code.
 12 |  */
 13 | 
 14 | use Rector\CodeQuality\Rector\BooleanAnd\SimplifyEmptyArrayCheckRector;
 15 | use Rector\CodeQuality\Rector\Class_\CompleteDynamicPropertiesRector;
 16 | use Rector\CodeQuality\Rector\Expression\InlineIfToExplicitIfRector;
 17 | use Rector\CodeQuality\Rector\Foreach_\UnusedForeachValueToArrayKeysRector;
 18 | use Rector\CodeQuality\Rector\FuncCall\ChangeArrayPushToArrayAssignRector;
 19 | use Rector\CodeQuality\Rector\FuncCall\SimplifyRegexPatternRector;
 20 | use Rector\CodeQuality\Rector\FuncCall\SimplifyStrposLowerRector;
 21 | use Rector\CodeQuality\Rector\FunctionLike\SimplifyUselessVariableRector;
 22 | use Rector\CodeQuality\Rector\If_\CombineIfRector;
 23 | use Rector\CodeQuality\Rector\If_\ShortenElseIfRector;
 24 | use Rector\CodeQuality\Rector\If_\SimplifyIfElseToTernaryRector;
 25 | use Rector\CodeQuality\Rector\If_\SimplifyIfReturnBoolRector;
 26 | use Rector\CodeQuality\Rector\Ternary\UnnecessaryTernaryExpressionRector;
 27 | use Rector\CodingStyle\Rector\ClassMethod\FuncGetArgsToVariadicParamRector;
 28 | use Rector\CodingStyle\Rector\ClassMethod\MakeInheritedMethodVisibilitySameAsParentRector;
 29 | use Rector\CodingStyle\Rector\FuncCall\CountArrayToEmptyArrayComparisonRector;
 30 | use Rector\Config\RectorConfig;
 31 | use Rector\DeadCode\Rector\ClassMethod\RemoveUnusedPromotedPropertyRector;
 32 | use Rector\EarlyReturn\Rector\Foreach_\ChangeNestedForeachIfsToEarlyContinueRector;
 33 | use Rector\EarlyReturn\Rector\If_\ChangeIfElseValueAssignToEarlyReturnRector;
 34 | use Rector\EarlyReturn\Rector\If_\RemoveAlwaysElseRector;
 35 | use Rector\EarlyReturn\Rector\Return_\PreparedValueToEarlyReturnRector;
 36 | use Rector\Php55\Rector\String_\StringClassNameToClassConstantRector;
 37 | use Rector\Php73\Rector\FuncCall\JsonThrowOnErrorRector;
 38 | use Rector\Php73\Rector\FuncCall\StringifyStrNeedlesRector;
 39 | use Rector\PHPUnit\Set\PHPUnitSetList;
 40 | use Rector\Privatization\Rector\Property\PrivatizeFinalClassPropertyRector;
 41 | use Rector\Set\ValueObject\LevelSetList;
 42 | use Rector\Set\ValueObject\SetList;
 43 | use Rector\TypeDeclaration\Rector\Property\TypedPropertyFromAssignsRector;
 44 | use Rector\ValueObject\PhpVersion;
 45 | 
 46 | return static function (RectorConfig $rectorConfig): void {
 47 |     $rectorConfig->sets([
 48 |         SetList::DEAD_CODE,
 49 |         LevelSetList::UP_TO_PHP_74,
 50 |         PHPUnitSetList::PHPUNIT_CODE_QUALITY,
 51 |         PHPUnitSetList::PHPUNIT_100,
 52 |     ]);
 53 | 
 54 |     $rectorConfig->parallel();
 55 | 
 56 |     // The paths to refactor (can also be supplied with CLI arguments)
 57 |     $rectorConfig->paths([
 58 |         __DIR__ . '/src/',
 59 |         // __DIR__ . '/tests/',
 60 |     ]);
 61 | 
 62 |     // Include Composer's autoload - required for global execution, remove if running locally
 63 |     $rectorConfig->autoloadPaths([
 64 |         __DIR__ . '/vendor/autoload.php',
 65 |     ]);
 66 | 
 67 |     // Do you need to include constants, class aliases, or a custom autoloader?
 68 |     $rectorConfig->bootstrapFiles([
 69 |         realpath(getcwd()) . '/vendor/codeigniter4/framework/system/Test/bootstrap.php',
 70 |     ]);
 71 | 
 72 |     if (is_file(__DIR__ . '/phpstan.neon.dist')) {
 73 |         $rectorConfig->phpstanConfig(__DIR__ . '/phpstan.neon.dist');
 74 |     }
 75 | 
 76 |     // Set the target version for refactoring
 77 |     $rectorConfig->phpVersion(PhpVersion::PHP_74);
 78 | 
 79 |     // Auto-import fully qualified class names
 80 |     $rectorConfig->importNames();
 81 | 
 82 |     // Are there files or rules you need to skip?
 83 |     $rectorConfig->skip([
 84 |         __DIR__ . '/app/Views',
 85 | 
 86 |         JsonThrowOnErrorRector::class,
 87 |         StringifyStrNeedlesRector::class,
 88 | 
 89 |         // Note: requires php 8
 90 |         RemoveUnusedPromotedPropertyRector::class,
 91 | 
 92 |         // May load view files directly when detecting classes
 93 |         StringClassNameToClassConstantRector::class,
 94 | 
 95 |         TypedPropertyFromAssignsRector::class => [
 96 |             __DIR__ . '/src/Commands/OAuthSetup.php',
 97 |             __DIR__ . '/src/Commands/Generators/NewShieldOauthGenerator.php',
 98 |         ],
 99 |     ]);
100 | 
101 |     // auto import fully qualified class names
102 |     $rectorConfig->importNames();
103 | 
104 |     $rectorConfig->rule(SimplifyUselessVariableRector::class);
105 |     $rectorConfig->rule(RemoveAlwaysElseRector::class);
106 |     $rectorConfig->rule(CountArrayToEmptyArrayComparisonRector::class);
107 |     $rectorConfig->rule(ChangeNestedForeachIfsToEarlyContinueRector::class);
108 |     $rectorConfig->rule(ChangeIfElseValueAssignToEarlyReturnRector::class);
109 |     $rectorConfig->rule(SimplifyStrposLowerRector::class);
110 |     $rectorConfig->rule(CombineIfRector::class);
111 |     $rectorConfig->rule(SimplifyIfReturnBoolRector::class);
112 |     $rectorConfig->rule(InlineIfToExplicitIfRector::class);
113 |     $rectorConfig->rule(PreparedValueToEarlyReturnRector::class);
114 |     $rectorConfig->rule(ShortenElseIfRector::class);
115 |     $rectorConfig->rule(SimplifyIfElseToTernaryRector::class);
116 |     $rectorConfig->rule(UnusedForeachValueToArrayKeysRector::class);
117 |     $rectorConfig->rule(ChangeArrayPushToArrayAssignRector::class);
118 |     $rectorConfig->rule(UnnecessaryTernaryExpressionRector::class);
119 |     $rectorConfig->rule(SimplifyRegexPatternRector::class);
120 |     $rectorConfig->rule(FuncGetArgsToVariadicParamRector::class);
121 |     $rectorConfig->rule(MakeInheritedMethodVisibilitySameAsParentRector::class);
122 |     $rectorConfig->rule(SimplifyEmptyArrayCheckRector::class);
123 |     $rectorConfig
124 |         ->ruleWithConfiguration(TypedPropertyFromAssignsRector::class, [
125 |             /**
126 |              * The INLINE_PUBLIC value is default to false to avoid BC break, if you use for libraries and want to preserve BC break, you don't need to configure it, as it included in LevelSetList::UP_TO_PHP_74
127 |              * Set to true for projects that allow BC break
128 |              */
129 |             TypedPropertyFromAssignsRector::INLINE_PUBLIC => true,
130 |         ]);
131 |     $rectorConfig->rule(StringClassNameToClassConstantRector::class);
132 |     $rectorConfig->rule(PrivatizeFinalClassPropertyRector::class);
133 |     $rectorConfig->rule(CompleteDynamicPropertiesRector::class);
134 | };
135 | 


--------------------------------------------------------------------------------
/src/Commands/Generators/NewShieldOauthGenerator.php:
--------------------------------------------------------------------------------
  1 | <?php
  2 | 
  3 | declare(strict_types=1);
  4 | 
  5 | /**
  6 |  * This file is part of Shield OAuth.
  7 |  *
  8 |  * (c) Datamweb <pooya_parsa_dadashi@yahoo.com>
  9 |  *
 10 |  * For the full copyright and license information, please view
 11 |  * the LICENSE file that was distributed with this source code.
 12 |  */
 13 | 
 14 | namespace Datamweb\ShieldOAuth\Commands\Generators;
 15 | 
 16 | use CodeIgniter\CLI\BaseCommand;
 17 | use CodeIgniter\CLI\CLI;
 18 | use CodeIgniter\CLI\GeneratorTrait;
 19 | use CodeIgniter\Shield\Commands\Setup\ContentReplacer;
 20 | 
 21 | class NewShieldOauthGenerator extends BaseCommand
 22 | {
 23 |     use GeneratorTrait;
 24 | 
 25 |     /**
 26 |      * The Command's Group
 27 |      *
 28 |      * @var string
 29 |      */
 30 |     protected $group = 'ShieldOAuth';
 31 | 
 32 |     /**
 33 |      * The Command's Name
 34 |      *
 35 |      * @var string
 36 |      */
 37 |     protected $name = 'make:oauth';
 38 | 
 39 |     /**
 40 |      * The Command's Description
 41 |      *
 42 |      * @var string
 43 |      */
 44 |     protected $description = 'Adds new OAuth to Shield OAuth.';
 45 | 
 46 |     /**
 47 |      * The Command's Usage
 48 |      *
 49 |      * @var string
 50 |      */
 51 |     protected $usage = 'make:oauth [<name>] [options]';
 52 | 
 53 |     /**
 54 |      * The Command's Arguments
 55 |      *
 56 |      * @var array<string, string>
 57 |      */
 58 |     protected $arguments = [
 59 |         'name' => 'The name of the new OAuth without the `OAuth` suffix. The `OAuth` suffix will be automatically added for you.',
 60 |     ];
 61 | 
 62 |     /**
 63 |      * The Command's Options
 64 |      *
 65 |      * @var array<string, string>
 66 |      */
 67 |     protected $options = [
 68 |         '--force' => 'Force overwrite existing file.',
 69 |     ];
 70 | 
 71 |     /**
 72 |      * Path to the app folder
 73 |      */
 74 |     protected string $distPath = APPPATH;
 75 | 
 76 |     /**
 77 |      * The ContentReplacer class
 78 |      */
 79 |     protected ContentReplacer $replacer;
 80 | 
 81 |     /**
 82 |      * Actually execute a command.
 83 |      */
 84 |     public function run(array $params): int
 85 |     {
 86 |         // The name param is required
 87 |         if (empty($params[0])) {
 88 |             CLI::error('Please enter the name of the OAuth.', 'light_gray', 'red');
 89 | 
 90 |             return 1;
 91 |         }
 92 | 
 93 |         $this->replacer = new ContentReplacer();
 94 | 
 95 |         $this->component     = 'Library';
 96 |         $this->directory     = 'Libraries\ShieldOAuth';
 97 |         $this->template      = 'newoauth.tpl.php';
 98 |         $this->classNameLang = 'CLI.generator.className.library';
 99 |         $this->setHasClassName(false);
100 | 
101 |         // Disable the suffix option
102 |         $this->setEnabledSuffixing(false);
103 | 
104 |         // The proper class name should contain the `OAuth` suffix if it doesn't exist
105 |         $class = str_ireplace('oauth', 'OAuth', $params[0]);
106 |         if (strpos($class, 'OAuth') === false) {
107 |             $class .= 'OAuth';
108 |         }
109 | 
110 |         $params[0] = $class;
111 | 
112 |         // ShieldOAuthConfig file must be present
113 |         if ($this->updateConfig($class) !== 0) {
114 |             CLI::error('ShieldOAuthConfig.php does not exist. Please run `php spark make:oauthconfig` first.', 'light_gray', 'red');
115 | 
116 |             return 1;
117 |         }
118 | 
119 |         // Default language file is required
120 |         if ($this->createLang($class) !== 0) {
121 |             return 1;
122 |         }
123 | 
124 |         // @TODO execute() is deprecated in CI v4.3.0.
125 |         $this->execute($params); // @phpstan-ignore-line suppress deprecated error.
126 | 
127 |         return 0;
128 |     }
129 | 
130 |     /**
131 |      * Add new OAuth to ShieldOAuthConfig.
132 |      *
133 |      * @param string $className
134 |      */
135 |     private function updateConfig($className): int
136 |     {
137 |         // Check that the config file exists
138 |         $file = 'Config/ShieldOAuthConfig.php';
139 |         if (! is_file($this->distPath . $file)) {
140 |             return 1;
141 |         }
142 | 
143 |         // Create the new config items to be added
144 |         $oauthKey  = strtolower(str_replace('OAuth', '', $className));
145 |         $oauthName = ucfirst(str_replace('OAuth', '', $className));
146 |         $code      = "'{$oauthKey}' => [
147 |             'client_id' => 'Get it from {$oauthName}',
148 |             'client_secret' => 'Get it from {$oauthName}',
149 | 
150 |             'allow_login'    => true,
151 |             'allow_register' => true,
152 |         ],";
153 | 
154 |         // Setup the process of adding the code to the config file
155 |         $pattern = '/(' . preg_quote('public array $oauthConfigs = [', '/') . ')/u';
156 |         $replace = '$1' . "\n        " . $code;
157 | 
158 |         // Add the code
159 |         $this->add($file, $code, $pattern, $replace);
160 | 
161 |         return 0;
162 |     }
163 | 
164 |     /**
165 |      * Create or update language file for English (en).
166 |      * Other languages should be translated by the
167 |      * developer where necessary.
168 |      *
169 |      * @param string $className
170 |      */
171 |     private function createLang($className): int
172 |     {
173 |         // Set the Oauth key, name and actual content
174 |         $oauthKey     = strtolower(str_replace('OAuth', '', $className));
175 |         $oauthName    = ucfirst(str_replace('OAuth', '', $className));
176 |         $oauthContent = "'{$oauthName}' => [
177 |         'not_allow' => 'Now you can\\'t login or register with {$oauthName}!',
178 |         '{$oauthKey}' => '{$oauthName}',
179 |     ],";
180 |         // Update if file exists
181 |         $file = 'Language/en/ShieldOAuthLang.php';
182 |         $path = $this->distPath . $file;
183 |         if (is_file($this->distPath . $file)) {
184 |             // Code addition setup
185 |             $pattern = '/(' . preg_quote('return [', '/') . ')/u';
186 |             $replace = '$1' . "\n    " . $oauthContent;
187 | 
188 |             $this->add($file, $oauthContent, $pattern, $replace);
189 | 
190 |             return 0;
191 |         }
192 | 
193 |         // This is a new file, prepare the contents
194 |         $content = "<?php \n\n";
195 |         $content .= "return [\n";
196 |         $content .= "    {$oauthContent}\n";
197 |         $content .= "];\n";
198 |         $cleanPath = clean_path($path);
199 |         $directory = dirname($path);
200 |         if (! is_dir($directory)) {
201 |             mkdir($directory, 0777, true);
202 |         }
203 | 
204 |         if (write_file($path, $content)) {
205 |             CLI::write(CLI::color('  Created: ', 'green') . $cleanPath);
206 | 
207 |             return 0;
208 |         }
209 |         CLI::error("  Error creating {$cleanPath}.");
210 | 
211 |         return 1;
212 |     }
213 | 
214 |     /**
215 |      * @param string $code Code to add.
216 |      * @param string $file Relative file path like 'Controllers/BaseController.php'.
217 |      */
218 |     protected function add(string $file, string $code, string $pattern, string $replace): void
219 |     {
220 |         $path      = $this->distPath . $file;
221 |         $cleanPath = clean_path($path);
222 | 
223 |         $content = file_get_contents($path);
224 | 
225 |         $output = $this->replacer->add($content, $code, $pattern, $replace);
226 | 
227 |         if ($output === true) {
228 |             CLI::error("  Skipped {$cleanPath}. It has already been updated.");
229 | 
230 |             return;
231 |         }
232 |         if ($output === false) {
233 |             CLI::error("  Error checking {$cleanPath}.");
234 | 
235 |             return;
236 |         }
237 | 
238 |         if (write_file($path, $output)) {
239 |             CLI::write(CLI::color('  Updated: ', 'green') . $cleanPath);
240 |         } else {
241 |             CLI::error("  Error updating {$cleanPath}.");
242 |         }
243 |     }
244 | }
245 | 


--------------------------------------------------------------------------------
/src/Commands/Generators/Views/newoauth.tpl.php:
--------------------------------------------------------------------------------
 1 | <@php
 2 | 
 3 | declare(strict_types=1);
 4 | 
 5 | namespace {namespace};
 6 | 
 7 | use Datamweb\ShieldOAuth\Libraries\Basic\AbstractOAuth;
 8 | 
 9 | class {class} extends AbstractOAuth
10 | {
11 |     /** @var string $API_CODE_URL The API URL to get the Auth Code. */
12 |     private static $API_CODE_URL = '';
13 | 
14 |     /** @var string $API_TOKEN_URL The API URL to get the Auth token. */
15 |     private static $API_TOKEN_URL = '';
16 | 
17 |     /** @var string $API_USER_INFO_URL The API URL to get the user info. */
18 |     private static $API_USER_INFO_URL = '';
19 | 
20 |     /** @var string $APPLICATION_NAME The name of this application. */
21 |     private static $APPLICATION_NAME = 'ShieldOAuth';
22 | 
23 |     protected string $token;
24 |     protected string $client_id;
25 |     protected string $client_secret;
26 |     protected string $callback_url;
27 | 
28 |     /**
29 |      * Class construct
30 |      *
31 |      * @see https://github.com/datamweb/shield-oauth/blob/develop/docs/add_other_oauth.md#writing-class-yahoo-oauth
32 |      * @param string $token
33 |      */
34 |     public function __construct(string $token = '')
35 |     {
36 |         // Your code here
37 |     }
38 | 
39 |     /**
40 |      * Create a link to transfer the user to the new provider.
41 |      *
42 |      * @see https://github.com/datamweb/shield-oauth/blob/develop/docs/add_other_oauth.md#writing-class-yahoo-oauth
43 |      * @param string $state
44 |      * @return string
45 |      */
46 |     public function makeGoLink(string $state): string
47 |     {
48 |         // Your code here
49 |         return '';
50 |     }
51 | 
52 |     /**
53 |      * Try to get the value of `access_token` according to the code
54 |      * received from the `makeGoLink()` method.
55 |      *
56 |      * @see https://github.com/datamweb/shield-oauth/blob/develop/docs/add_other_oauth.md#writing-class-yahoo-oauth
57 |      * @param array $allGet
58 |      * @return void
59 |      */
60 |     public function fetchAccessTokenWithAuthCode(array $allGet): void
61 |     {
62 |         // Your code here
63 |     }
64 | 
65 |     /**
66 |      * Try to receive user information (including first name,
67 |      * last name, email, etc) according to the token code set
68 |      * in the previous step.
69 |      *
70 |      * @see https://github.com/datamweb/shield-oauth/blob/develop/docs/add_other_oauth.md#writing-class-yahoo-oauth
71 |      * @return object
72 |      */
73 |     public function fetchUserInfoWithToken(): object
74 |     {
75 |         // Your code here
76 |         return json_decode('');
77 |     }
78 | 
79 |     /**
80 |      * Set the fields received from each service OAuth to be recorded
81 |      * in each column of the table.
82 |      *
83 |      * @see https://github.com/datamweb/shield-oauth/blob/develop/docs/add_other_oauth.md#writing-class-yahoo-oauth
84 |      * @param string $nameOfProcess
85 |      * @param object $userInfo
86 |      * @return array
87 |      */
88 |     public function setColumnsName(string $nameOfProcess, object $userInfo): array
89 |     {
90 |         // Your code here
91 |         return [];
92 |     }
93 | }
94 | 


--------------------------------------------------------------------------------
/src/Commands/OAuthSetup.php:
--------------------------------------------------------------------------------
  1 | <?php
  2 | 
  3 | declare(strict_types=1);
  4 | 
  5 | /**
  6 |  * This file is part of Shield OAuth.
  7 |  *
  8 |  * (c) Datamweb <pooya_parsa_dadashi@yahoo.com>
  9 |  *
 10 |  * For the full copyright and license information, please view
 11 |  * the LICENSE file that was distributed with this source code.
 12 |  */
 13 | 
 14 | namespace Datamweb\ShieldOAuth\Commands;
 15 | 
 16 | use CodeIgniter\Shield\Commands\Setup;
 17 | use CodeIgniter\Shield\Commands\Setup\ContentReplacer;
 18 | 
 19 | class OAuthSetup extends Setup
 20 | {
 21 |     /**
 22 |      * The group the command is lumped under
 23 |      * when listing commands.
 24 |      *
 25 |      * @var string
 26 |      */
 27 |     protected $group = 'ShieldOAuth';
 28 | 
 29 |     /**
 30 |      * The Command's name
 31 |      *
 32 |      * @var string
 33 |      */
 34 |     protected $name = 'make:oauthconfig';
 35 | 
 36 |     /**
 37 |      * the Command's short description
 38 |      *
 39 |      * @var string
 40 |      */
 41 |     protected $description = 'Generate file ShieldOAuthConfig in path APPPATH\Config.';
 42 | 
 43 |     /**
 44 |      * the Command's usage
 45 |      *
 46 |      * @var string
 47 |      */
 48 |     protected $usage = 'make:oauthconfig';
 49 | 
 50 |     /**
 51 |      * the Command's Arguments
 52 |      *
 53 |      * @var array<string, string>
 54 |      */
 55 |     protected $arguments = [];
 56 | 
 57 |     /**
 58 |      * the Command's Options
 59 |      *
 60 |      * @var array<string, string>
 61 |      */
 62 |     protected $options = [
 63 |         '-f' => 'Force overwrite ALL existing files in destination.',
 64 |     ];
 65 | 
 66 |     /**
 67 |      * The path to `Datamweb\ShieldOAuth\` src directory.
 68 |      *
 69 |      * @var string
 70 |      */
 71 |     protected $sourcePath;
 72 | 
 73 |     protected $distPath = APPPATH;
 74 |     private ContentReplacer $replacer;
 75 | 
 76 |     /**
 77 |      * Displays the help for the spark cli script itself.
 78 |      */
 79 |     public function run(array $params): void
 80 |     {
 81 |         $this->replacer = new ContentReplacer();
 82 | 
 83 |         $this->sourcePath = __DIR__ . '/../';
 84 | 
 85 |         $file     = 'Config/ShieldOAuthConfig.php';
 86 |         $replaces = [
 87 |             'namespace Datamweb\ShieldOAuth\Config;' => 'namespace Config;',
 88 |             'use CodeIgniter\\Config\\BaseConfig;'   => 'use Datamweb\ShieldOAuth\Config\ShieldOAuthConfig as OAuthConfig;',
 89 |             'extends BaseConfig'                     => 'extends OAuthConfig',
 90 |         ];
 91 | 
 92 |         $this->copyAndReplace($file, $replaces);
 93 |     }
 94 | 
 95 |     /**
 96 |      * @param string $file     Relative file path like 'Config/ShieldOAuthConfig.php'.
 97 |      * @param array  $replaces [search => replace]
 98 |      */
 99 |     protected function copyAndReplace(string $file, array $replaces): void
100 |     {
101 |         $path = "{$this->sourcePath}/{$file}";
102 | 
103 |         $content = file_get_contents($path);
104 | 
105 |         $content = $this->replacer->replace($content, $replaces);
106 | 
107 |         $this->writeFile($file, $content);
108 |     }
109 | }
110 | 


--------------------------------------------------------------------------------
/src/Config/Registrar.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | declare(strict_types=1);
 4 | 
 5 | /**
 6 |  * This file is part of Shield OAuth.
 7 |  *
 8 |  * (c) Datamweb <pooya_parsa_dadashi@yahoo.com>
 9 |  *
10 |  * For the full copyright and license information, please view
11 |  * the LICENSE file that was distributed with this source code.
12 |  */
13 | 
14 | namespace Datamweb\ShieldOAuth\Config;
15 | 
16 | use Datamweb\ShieldOAuth\Views\Decorators\ShieldOAuth;
17 | 
18 | class Registrar
19 | {
20 |     /**
21 |      * --------------------------------------------------------------------------
22 |      * Shield OAuth Decorator
23 |      * --------------------------------------------------------------------------
24 |      * Register the ShieldOAuth decorator.
25 |      *
26 |      * @see https://codeigniter.com/user_guide/outgoing/view_decorators.html
27 |      *
28 |      * @return array<string, list<string>>
29 |      */
30 |     public static function View(): array
31 |     {
32 |         return [
33 |             'decorators' => [
34 |                 ShieldOAuth::class,
35 |             ],
36 |         ];
37 |     }
38 | 
39 |     /**
40 |      * Register the ShieldOAuth make:oauth generator template.
41 |      */
42 |     public static function Generators(): array
43 |     {
44 |         return [
45 |             'views' => [
46 |                 'make:oauth' => 'Datamweb\ShieldOAuth\Commands\Generators\Views\newoauth.tpl.php',
47 |             ],
48 |         ];
49 |     }
50 | }
51 | 


--------------------------------------------------------------------------------
/src/Config/Routes.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | declare(strict_types=1);
 4 | 
 5 | /**
 6 |  * This file is part of Shield OAuth.
 7 |  *
 8 |  * (c) Datamweb <pooya_parsa_dadashi@yahoo.com>
 9 |  *
10 |  * For the full copyright and license information, please view
11 |  * the LICENSE file that was distributed with this source code.
12 |  */
13 | 
14 | use CodeIgniter\Router\RouteCollection;
15 | use Datamweb\ShieldOAuth\Config\ShieldOAuthConfig;
16 | use Datamweb\ShieldOAuth\Libraries\Basic\ShieldOAuth;
17 | 
18 | /**
19 |  * @var RouteCollection $routes
20 |  */
21 | $routes->group('oauth', ['namespace' => '\Datamweb\ShieldOAuth\Controllers'], static function ($routes): void {
22 |     /** @var ShieldOAuth $shieldOAuthLib */
23 |     $shieldOAuthLib = service('ShieldOAuth');
24 | 
25 |     $routes->addPlaceholder('allOAuthList', $shieldOAuthLib->allOAuth());
26 |     $routes->get('(:allOAuthList)', 'OAuthController::redirectOAuth/$1');
27 | 
28 |     /** @var ShieldOAuthConfig $config */
29 |     $config = config('ShieldOAuthConfig');
30 | 
31 |     $routes->get($config->call_back_route, 'OAuthController::callBack');
32 | });
33 | 


--------------------------------------------------------------------------------
/src/Config/Services.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | declare(strict_types=1);
 4 | 
 5 | /**
 6 |  * This file is part of Shield OAuth.
 7 |  *
 8 |  * (c) Datamweb <pooya_parsa_dadashi@yahoo.com>
 9 |  *
10 |  * For the full copyright and license information, please view
11 |  * the LICENSE file that was distributed with this source code.
12 |  */
13 | 
14 | namespace Datamweb\ShieldOAuth\Config;
15 | 
16 | use CodeIgniter\Config\BaseService;
17 | use Datamweb\ShieldOAuth\Libraries\Basic\ShieldOAuth;
18 | 
19 | class Services extends BaseService
20 | {
21 |     /**
22 |      * -------------------------------------------------------
23 |      * Service Configuration file
24 |      * -------------------------------------------------------
25 |      * Create and share new class instances
26 |      *
27 |      * More Info @see https://codeigniter.com/user_guide/concepts/services.html
28 |      */
29 |     public static function ShieldOAuth(bool $getShared = true): ShieldOAuth
30 |     {
31 |         if ($getShared) {
32 |             return static::getSharedInstance('ShieldOAuth');
33 |         }
34 | 
35 |         return new ShieldOAuth();
36 |     }
37 | }
38 | 


--------------------------------------------------------------------------------
/src/Config/ShieldOAuthConfig.php:
--------------------------------------------------------------------------------
  1 | <?php
  2 | 
  3 | declare(strict_types=1);
  4 | 
  5 | /**
  6 |  * This file is part of Shield OAuth.
  7 |  *
  8 |  * (c) Datamweb <pooya_parsa_dadashi@yahoo.com>
  9 |  *
 10 |  * For the full copyright and license information, please view
 11 |  * the LICENSE file that was distributed with this source code.
 12 |  */
 13 | 
 14 | namespace Datamweb\ShieldOAuth\Config;
 15 | 
 16 | use CodeIgniter\Config\BaseConfig;
 17 | 
 18 | class ShieldOAuthConfig extends BaseConfig
 19 | {
 20 |     /**
 21 |      * --------------------------------------------------------------------------
 22 |      * OAuth Configs
 23 |      * --------------------------------------------------------------------------
 24 |      *
 25 |      * Set keys and active any OAuth
 26 |      *
 27 |      * Here you can set the keys received from any OAuth servers.
 28 |      * for more information on getting keys:
 29 |      *
 30 |      * @see https://github.com/datamweb/shield-oauth/blob/develop/docs/get_keys.md
 31 |      *
 32 |      * @var array<string, array<string, bool|string>>
 33 |      */
 34 |     public array $oauthConfigs = [
 35 |         'github' => [
 36 |             'client_id'     => 'Get it from GitHub',
 37 |             'client_secret' => 'Get it from GitHub',
 38 | 
 39 |             'allow_login'    => true,
 40 |             'allow_register' => true,
 41 |         ],
 42 |         'google' => [
 43 |             'client_id'     => 'Get it from Google',
 44 |             'client_secret' => 'Get it from Google',
 45 | 
 46 |             'allow_login'    => true,
 47 |             'allow_register' => true,
 48 |         ],
 49 |         // 'yahoo' => [
 50 |         //     'client_id'     => 'Get it from Yahoo',
 51 |         //     'client_secret' => 'Get it from Yahoo',
 52 | 
 53 |         //     'allow_login'    => true,
 54 |         //     'allow_register' => true,
 55 |         // ],
 56 |     ];
 57 | 
 58 |     /**
 59 |      * --------------------------------------------------------------------------
 60 |      * Users Columns Name
 61 |      * --------------------------------------------------------------------------
 62 |      * If you use different names for the columns in the users table, use the following settings.
 63 |      *
 64 |      * Data of Table "users":
 65 |      * +----+----------+--------+...+------------+-----------+--------+
 66 |      * | id | username | status |...| first_name | last_name | avatar |
 67 |      * +----+----------+--------+...+------------+-----------+--------+
 68 |      * In fact, you set in which column the information received from the OAuth services should be recorded.
 69 |      * For example, the first name received from OAuth should be recorded in column 'first_name' of the 'users' table shield.
 70 |      * NOTE :
 71 |      *       This is suitable for those who have already installed the shield and created their own columns.
 72 |      *       In this case, there is no need to execute `php spark migrate -n Datamweb\ShieldOAuth`.
 73 |      *       Just set the following values with your table columns.
 74 |      *
 75 |      * @var array<string, string>
 76 |      */
 77 |     public array $usersColumnsName = [
 78 |         'first_name' => 'first_name',
 79 |         'last_name'  => 'last_name',
 80 |         'avatar'     => 'avatar',
 81 |     ];
 82 | 
 83 |     /**
 84 |      * --------------------------------------------------------------------------
 85 |      * Syncing User Info
 86 |      * --------------------------------------------------------------------------
 87 |      * Turn ON/OFF user data update
 88 |      *
 89 |      * If the user is already registered, by default when trying to login, their
 90 |      * information will be synchronized. If you want to cancel it, set to false.
 91 |      */
 92 |     public bool $syncingUserInfo = true;
 93 | 
 94 |     /**
 95 |      * --------------------------------------------------------------------------
 96 |      * Call Back Route
 97 |      * --------------------------------------------------------------------------
 98 |      * Set your custom call-back name
 99 |      *
100 |      * When the user login with his profile, the OAuth server directs him to the following path.
101 |      * So change this value only when you need to customize it.
102 |      * By default, it returns to the following path:
103 |      *      http://localhost:8080/oauth/call-back
104 |      */
105 |     public string $call_back_route = 'call-back';
106 | }
107 | 


--------------------------------------------------------------------------------
/src/Controllers/OAuthController.php:
--------------------------------------------------------------------------------
  1 | <?php
  2 | 
  3 | declare(strict_types=1);
  4 | 
  5 | /**
  6 |  * This file is part of Shield OAuth.
  7 |  *
  8 |  * (c) Datamweb <pooya_parsa_dadashi@yahoo.com>
  9 |  *
 10 |  * For the full copyright and license information, please view
 11 |  * the LICENSE file that was distributed with this source code.
 12 |  */
 13 | 
 14 | namespace Datamweb\ShieldOAuth\Controllers;
 15 | 
 16 | use App\Controllers\BaseController;
 17 | use CodeIgniter\HTTP\RedirectResponse;
 18 | use CodeIgniter\Shield\Entities\User;
 19 | use CodeIgniter\Shield\Models\LoginModel;
 20 | use Datamweb\ShieldOAuth\Libraries\Basic\ControllersInterface;
 21 | 
 22 | class OAuthController extends BaseController implements ControllersInterface
 23 | {
 24 |     private const ACCESS_DENIED = 'access_denied';
 25 | 
 26 |     private ?User $userExist = null;
 27 | 
 28 |     public function redirectOAuth(string $oauthName): RedirectResponse
 29 |     {
 30 |         // if user login
 31 |         if (auth()->loggedIn()) {
 32 |             return redirect()->to(config('Auth')->loginRedirect());
 33 |         }
 34 | 
 35 |         if (setting('ShieldOAuthConfig.oauthConfigs')[$oauthName]['allow_login'] === false) {
 36 |             $errorText = 'ShieldOAuthLang.' . ucfirst($oauthName) . '.not_allow';
 37 | 
 38 |             return redirect()->to(config('Auth')->logoutRedirect())->with('error', lang($errorText));
 39 |         }
 40 | 
 41 |         session()->set('oauth_name', $oauthName);
 42 | 
 43 |         // Loading the class according to oauthName choices
 44 |         $oauthClass = service('ShieldOAuth')::setOAuth($oauthName);
 45 | 
 46 |         // Run anti forgery
 47 |         $state = $this->makeAntiForgeryKey();
 48 | 
 49 |         $redirectLink = $oauthClass->makeGoLink($state);
 50 | 
 51 |         return redirect()->to($redirectLink);
 52 |     }
 53 | 
 54 |     public function callBack(): RedirectResponse
 55 |     {
 56 |         // if user after callback request url
 57 |         if (! $oauth_name = session('oauth_name')) {
 58 |             return redirect()->to(config('Auth')->logoutRedirect())->with('error', lang('ShieldOAuthLang.Callback.oauth_class_not_set'));
 59 |         }
 60 |         $allGet = $this->request->getGet();
 61 | 
 62 |         // if permission is denied or was cancelled by user.
 63 |         if (isset($allGet['error']) && $allGet['error'] === self::ACCESS_DENIED) {
 64 |             $OAuth     = ucfirst($oauth_name);
 65 |             $oauthName = lang("ShieldOAuthLang.{$OAuth}.{$oauth_name}");
 66 | 
 67 |             return redirect()->to(config('Auth')->logoutRedirect())->with('error', lang('ShieldOAuthLang.Callback.access_denied', [$oauthName]));
 68 |         }
 69 | 
 70 |         // if api have error
 71 |         if (isset($allGet['error'])) {
 72 |             return redirect()->to(config('Auth')->logoutRedirect())->with('error', lang('ShieldOAuthLang.unknown'));
 73 |         }
 74 |         // Loading the class according to oauthName choices
 75 |         $oauthName  = session()->get('oauth_name');
 76 |         $oauthClass = service('ShieldOAuth')::setOAuth($oauthName);
 77 | 
 78 |         // check request is Forgery
 79 |         if ($this->checkAntiForgery($allGet['state']) === false) {
 80 |             return redirect()->to(config('Auth')->logoutRedirect())->with('error', lang('ShieldOAuthLang.Callback.anti_forgery'));
 81 |         }
 82 | 
 83 |         // Delete to prevent reuse
 84 |         session()->remove(['state', 'oauth_name']);
 85 | 
 86 |         $userInfo = $oauthClass->getUserInfo($allGet);
 87 | 
 88 |         $find = ['email' => $userInfo->email];
 89 | 
 90 |         if ($this->checkExistenceUser($find)) {
 91 |             $updateFields = $oauthClass->getColumnsName('syncingUserInfo', $userInfo);
 92 | 
 93 |             $userid = $this->syncingUserInfo($find, $updateFields);
 94 |         } else {
 95 |             // Check config setting first to see if it can register automatically or not
 96 |             if (setting('ShieldOAuthConfig.oauthConfigs')[$oauthName]['allow_register'] === false) {
 97 |                 return redirect()->to(config('Auth')->logoutRedirect())->with('error', lang('ShieldOAuthLang.Callback.account_not_found', [$userInfo->email]));
 98 |             }
 99 | 
100 |             helper('text');
101 |             $users = model('ShieldOAuthModel');
102 |             // new user
103 |             $entitiesUser = new User($oauthClass->getColumnsName('newUser', $userInfo));
104 | 
105 |             $users->save($entitiesUser);
106 |             $userid = $users->getInsertID();
107 |             // To get the complete user object with ID, we need to get from the database
108 |             $user = $users->findById($userid);
109 |             $users->save($user);
110 |             // Add to default group
111 |             $users->addToDefaultGroup($user);
112 |         }
113 | 
114 |         if ($this->userExist && $this->userExist->isBanned()) {
115 |             return redirect()->to(config('Auth')->logoutRedirect())->with('error', $this->userExist->getBanMessage() ?? lang('Auth.bannedUser'));
116 |         }
117 | 
118 |         auth()->loginById($userid);
119 |         $this->recordLoginAttempt($oauthName, $userInfo->email);
120 | 
121 |         if (auth()->loggedIn()) {
122 |             return redirect()->to(config('Auth')->loginRedirect());
123 |         }
124 | 
125 |         return redirect()->to(config('Auth')->logoutRedirect())->with('error', lang('ShieldOAuthLang.unknown'));
126 |     }
127 | 
128 |     private function makeAntiForgeryKey(): string
129 |     {
130 |         helper('text');
131 |         $state = random_string('crypto', 40);
132 | 
133 |         session()->set('state', $state);
134 | 
135 |         return $state;
136 |     }
137 | 
138 |     private function checkAntiForgery(string $state): bool
139 |     {
140 |         return $state === session()->get('state');
141 |     }
142 | 
143 |     private function checkExistenceUser(array $find = []): bool
144 |     {
145 |         $users = model('ShieldOAuthModel');
146 | 
147 |         $findUser = $users->findByCredentials($find);
148 | 
149 |         $this->userExist = $findUser;
150 | 
151 |         return $findUser !== null;
152 |     }
153 | 
154 |     /**
155 |      * Syncs user information based on provided fields.
156 |      *
157 |      * @param array<string, string>      $find         Array containing criteria to find the user
158 |      * @param array<string, string|null> $updateFields Fields to update for the user
159 |      *
160 |      * @return int The ID of the user whose information is synced
161 |      */
162 |     private function syncingUserInfo(array $find = [], array $updateFields = []): int
163 |     {
164 |         $users = model('ShieldOAuthModel');
165 |         $user  = $users->findByCredentials($find);
166 | 
167 |         if (setting('ShieldOAuthConfig.syncingUserInfo') === true) {
168 |             $user->fill($updateFields);
169 |         }
170 | 
171 |         $users->save($user);
172 | 
173 |         return $user->id;
174 |     }
175 | 
176 |     private function recordLoginAttempt(string $oauthName = '', string $identifier = ''): void
177 |     {
178 |         $loginModel = model(LoginModel::class);
179 | 
180 |         $loginModel->recordLoginAttempt(
181 |             $oauthName . '_oauth',
182 |             $identifier,
183 |             true,
184 |             $this->request->getIPAddress(),
185 |             (string) $this->request->getUserAgent(),
186 |             user_id(),
187 |         );
188 |     }
189 | }
190 | 


--------------------------------------------------------------------------------
/src/Database/Migrations/2022-10-20-182737_ShieldOAuth.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | declare(strict_types=1);
 4 | 
 5 | /**
 6 |  * This file is part of Shield OAuth.
 7 |  *
 8 |  * (c) Datamweb <pooya_parsa_dadashi@yahoo.com>
 9 |  *
10 |  * For the full copyright and license information, please view
11 |  * the LICENSE file that was distributed with this source code.
12 |  */
13 | 
14 | namespace Datamweb\ShieldOAuth\Database\Migrations;
15 | 
16 | use CodeIgniter\Database\Migration;
17 | use Datamweb\ShieldOAuth\Config\ShieldOAuthConfig;
18 | 
19 | class ShieldOAuth extends Migration
20 | {
21 |     private string $first_name;
22 |     private string $last_name;
23 |     private string $avatar;
24 | 
25 |     public function __construct()
26 |     {
27 |         parent::__construct();
28 | 
29 |         /** @var ShieldOAuthConfig $config */
30 |         $config           = config('ShieldOAuthConfig');
31 |         $this->first_name = $config->usersColumnsName['first_name'];
32 |         $this->last_name  = $config->usersColumnsName['last_name'];
33 |         $this->avatar     = $config->usersColumnsName['avatar'];
34 |     }
35 | 
36 |     public function up(): void
37 |     {
38 |         $fields = [
39 |             $this->first_name => [
40 |                 'type'       => 'VARCHAR',
41 |                 'constraint' => '100',
42 |                 'null'       => true,
43 |             ],
44 |             $this->last_name => [
45 |                 'type'       => 'VARCHAR',
46 |                 'constraint' => '100',
47 |                 'null'       => true,
48 |             ],
49 |             $this->avatar => [
50 |                 'type'       => 'VARCHAR',
51 |                 'constraint' => '1000',
52 |                 'null'       => true,
53 |             ],
54 |         ];
55 | 
56 |         $this->forge->addColumn('users', $fields);
57 |     }
58 | 
59 |     public function down(): void
60 |     {
61 |         $fields = [
62 |             $this->first_name,
63 |             $this->last_name,
64 |             $this->avatar,
65 |         ];
66 | 
67 |         $this->forge->dropColumn('users', $fields);
68 |     }
69 | }
70 | 


--------------------------------------------------------------------------------
/src/Language/en/ShieldOAuthLang.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | declare(strict_types=1);
 4 | 
 5 | /**
 6 |  * This file is part of Shield OAuth.
 7 |  *
 8 |  * (c) Datamweb <pooya_parsa_dadashi@yahoo.com>
 9 |  *
10 |  * For the full copyright and license information, please view
11 |  * the LICENSE file that was distributed with this source code.
12 |  */
13 | 
14 | // ShieldOAuthLang language file
15 | return [
16 |     // Errors List
17 |     'unknown'  => 'Unknown error!',
18 |     'Callback' => [
19 |         'oauth_class_not_set' => 'An error occurred, it seems that the OAuth Class is not set.',
20 |         'anti_forgery'        => 'Your request has been detected as fake. we are sorry!',
21 |         'account_not_found'   => 'There is no account registered with the email "{0}".',
22 |         'access_denied'       => 'Authentication cancelled! You declined {0} permissions.',
23 |     ],
24 | 
25 |     // ShieldOAuthButton in views
26 |     'other'       => 'Other',
27 |     'login_by'    => 'Login by : ',
28 |     'register_by' => 'Register by : ',
29 | 
30 |     // Errors List For all OAuth
31 |     'Github' => [
32 |         'github'    => 'GitHub',
33 |         'not_allow' => "Now you can't login or register with GitHub!",
34 |     ],
35 |     'Google' => [
36 |         'google'    => 'Google',
37 |         'not_allow' => "Now you can't login or register with Google!",
38 |     ],
39 |     // 'Yahoo' => [
40 |     //     'yahoo'     => 'Yahoo',
41 |     //     'not_allow' => "Now you can't login or register with Yahoo!",
42 | 
43 |     // ],
44 | ];
45 | 


--------------------------------------------------------------------------------
/src/Language/fa/ShieldOAuthLang.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | declare(strict_types=1);
 4 | 
 5 | /**
 6 |  * This file is part of Shield OAuth.
 7 |  *
 8 |  * (c) Datamweb <pooya_parsa_dadashi@yahoo.com>
 9 |  *
10 |  * For the full copyright and license information, please view
11 |  * the LICENSE file that was distributed with this source code.
12 |  */
13 | 
14 | // ShieldOAuthLang language file
15 | return [
16 |     // Errors List
17 |     'unknown'  => 'خطای ناشناخته!',
18 |     'Callback' => [
19 |         'oauth_class_not_set' => 'خطای رخ داد، به نظر میرسد کلاس OAuth مورد نظر به درستی تنظیم نشده است.',
20 |         'anti_forgery'        => 'متاسفانه، تلاش شما ، یک درخواست جعلی تشخیص داده شد.',
21 |         'account_not_found'   => 'هیچ حسابی با ایمیل "{0}" ثبت نشده است.',
22 |         'access_denied'       => 'تأیید اعتبار لغو شد! شما دسترسی‌های {0} را رد کردید.',
23 |     ],
24 | 
25 |     // ShieldOAuthButton in views
26 |     'other'       => 'سایر',
27 |     'login_by'    => 'ورود با : ',
28 |     'register_by' => 'ثبت نام با : ',
29 | 
30 |     // Errors List For all OAuth
31 |     'Github' => [
32 |         'github'    => 'گیت هاب',
33 |         'not_allow' => 'اکنون، امکان ورود و یا ثبت نام با گیت هاب وجود دارد!',
34 |     ],
35 |     'Google' => [
36 |         'google'    => 'گوگل',
37 |         'not_allow' => 'اکنون امکان ورود و یا ثبت نام با گوگل وجود ندارد.',
38 |     ],
39 |     // 'Yahoo' => [
40 |     //     'yahoo'     => 'یاهو',
41 |     //     'not_allow' => "اکنون امکان ورود و یا ثبت نام با یاهو وجود ندارد!",
42 |     // ],
43 | ];
44 | 


--------------------------------------------------------------------------------
/src/Language/fr/ShieldOAuthLang.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | declare(strict_types=1);
 4 | 
 5 | /**
 6 |  * This file is part of Shield OAuth.
 7 |  *
 8 |  * (c) Datamweb <pooya_parsa_dadashi@yahoo.com>
 9 |  *
10 |  * For the full copyright and license information, please view
11 |  * the LICENSE file that was distributed with this source code.
12 |  */
13 | 
14 | // ShieldOAuthLang language file
15 | return [
16 |     // Errors List
17 |     'unknown'  => 'Erreur inconnue!',
18 |     'Callback' => [
19 |         'oauth_class_not_set' => 'Une erreur s’est produite, il semble que la classe OAuth n’est pas définie.',
20 |         'anti_forgery'        => 'Votre demande a été détectée comme erronée. Nous sommes désolés!',
21 |         'account_not_found'   => 'Il n\'y a pas de compte enregistré avec l\'email "{0}".',
22 |         'access_denied'       => 'Authentification annulée ! Vous avez refusé les autorisations {0}.',
23 |     ],
24 | 
25 |     // ShieldOAuthButton in views
26 |     'other'       => 'Autre',
27 |     'login_by'    => 'Connectez-vous avec : ',
28 |     'register_by' => 'Inscrivez-vous avec : ',
29 | 
30 |     // Errors List For all OAuth
31 |     'Github' => [
32 |         'github'    => 'GitHub',
33 |         'not_allow' => 'Vous ne pouvez pas vous connecter ou vous inscrire avec GitHub maintenant!',
34 |     ],
35 |     'Google' => [
36 |         'google'    => 'Google',
37 |         'not_allow' => 'Vous ne pouvez pas vous connecter ou vous inscrire avec Google maintenant!',
38 |     ],
39 |     // 'Yahoo' => [
40 |     //     'yahoo'     => 'Yahoo',
41 |     //     'not_allow' => "Vous ne pouvez pas vous connecter ou vous inscrire avec Yahoo maintenant!",
42 | 
43 |     // ],
44 | ];
45 | 


--------------------------------------------------------------------------------
/src/Language/id/ShieldOAuthLang.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | declare(strict_types=1);
 4 | 
 5 | /**
 6 |  * This file is part of Shield OAuth.
 7 |  *
 8 |  * (c) Datamweb <pooya_parsa_dadashi@yahoo.com>
 9 |  *
10 |  * For the full copyright and license information, please view
11 |  * the LICENSE file that was distributed with this source code.
12 |  */
13 | 
14 | // ShieldOAuthLang language file
15 | return [
16 |     // Errors List
17 |     'unknown'  => 'Ups, kesalahan tidak terduga!',
18 |     'Callback' => [
19 |         'oauth_class_not_set' => 'Terjadi kesalahan, sepertinya class OAuth tidak terpasang.',
20 |         'anti_forgery'        => 'Maaf, permintaan Anda terdeteksi tidak valid!',
21 |         'account_not_found'   => 'Tidak ada akun yang terdaftar dengan email "{0}".',
22 |         'access_denied'       => 'Autentikasi dibatalkan! Anda menolak izin {0}.',
23 |     ],
24 | 
25 |     // ShieldOAuthButton in views
26 |     'other'       => 'Lainnya',
27 |     'login_by'    => 'Masuk dengan : ',
28 |     'register_by' => 'Registrasi dengan : ',
29 | 
30 |     // Errors List For all OAuth
31 |     'Github' => [
32 |         'github'    => 'GitHub',
33 |         'not_allow' => 'Sekarang Anda tidak bisa masuk atau mendaftar dengan GitHub!',
34 |     ],
35 |     'Google' => [
36 |         'google'    => 'Google',
37 |         'not_allow' => 'Sekarang Anda tidak bisa masuk atau mendaftar dengan Google!',
38 |     ],
39 |     // 'Yahoo' => [
40 |     //     'yahoo'     => 'Yahoo',
41 |     //     'not_allow' => 'Sekarang Anda tidak bisa masuk atau mendaftar dengan Yahoo!',
42 | 
43 |     // ],
44 | ];
45 | 


--------------------------------------------------------------------------------
/src/Language/pt-BR/ShieldOAuthLang.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | declare(strict_types=1);
 4 | 
 5 | /**
 6 |  * This file is part of Shield OAuth.
 7 |  *
 8 |  * (c) Datamweb <pooya_parsa_dadashi@yahoo.com>
 9 |  *
10 |  * For the full copyright and license information, please view
11 |  * the LICENSE file that was distributed with this source code.
12 |  */
13 | 
14 | // ShieldOAuthLang language file
15 | return [
16 |     // Errors List
17 |     'unknown'  => 'Erro desconhecido!',
18 |     'Callback' => [
19 |         'oauth_class_not_set' => 'Ocorreu um erro, parece que a classe OAuth não está configurada.',
20 |         'anti_forgery'        => 'Sua solicitação foi detectada como falsa. Pedimos desculpas!',
21 |         'account_not_found'   => 'Não há nenhuma conta registrada com o e-mail "{0}".',
22 |         'access_denied'       => 'Autenticação cancelada! Você recusou as permissões de {0}.',
23 |     ],
24 | 
25 |     // ShieldOAuthButton in views
26 |     'other'       => 'Outro',
27 |     'login_by'    => 'Entrar com: ',
28 |     'register_by' => 'Registrar com: ',
29 | 
30 |     // Errors List For all OAuth
31 |     'Github' => [
32 |         'github'    => 'GitHub',
33 |         'not_allow' => 'Agora você não pode entrar ou se registrar com o GitHub!',
34 |     ],
35 |     'Google' => [
36 |         'google'    => 'Google',
37 |         'not_allow' => 'Agora você não pode entrar ou se registrar com o Google!',
38 |     ],
39 |     // 'Yahoo' => [
40 |     //     'yahoo'     => 'Yahoo',
41 |     //     'not_allow' => 'Agora você não pode entrar ou se registrar com o Yahoo!',
42 | 
43 |     // ],
44 | ];
45 | 


--------------------------------------------------------------------------------
/src/Libraries/Basic/AbstractOAuth.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | declare(strict_types=1);
 4 | 
 5 | /**
 6 |  * This file is part of Shield OAuth.
 7 |  *
 8 |  * (c) Datamweb <pooya_parsa_dadashi@yahoo.com>
 9 |  *
10 |  * For the full copyright and license information, please view
11 |  * the LICENSE file that was distributed with this source code.
12 |  */
13 | 
14 | namespace Datamweb\ShieldOAuth\Libraries\Basic;
15 | 
16 | abstract class AbstractOAuth
17 | {
18 |     protected string $token;
19 | 
20 |     abstract public function makeGoLink(string $state): string;
21 | 
22 |     abstract protected function fetchAccessTokenWithAuthCode(array $allGet): void;
23 | 
24 |     abstract protected function fetchUserInfoWithToken(): object;
25 | 
26 |     abstract protected function setColumnsName(string $nameOfProcess, object $userInfo): array;
27 | 
28 |     protected function setToken(string $token): void
29 |     {
30 |         $this->token = $token;
31 |     }
32 | 
33 |     protected function getToken(): string
34 |     {
35 |         return $this->token;
36 |     }
37 | 
38 |     public function getUserInfo(array $allGet): object
39 |     {
40 |         $this->fetchAccessTokenWithAuthCode($allGet);
41 | 
42 |         return $this->fetchUserInfoWithToken();
43 |     }
44 | 
45 |     public function getColumnsName(string $nameOfProcess, object $userInfo): array
46 |     {
47 |         return $this->setColumnsName($nameOfProcess, $userInfo);
48 |     }
49 | }
50 | 


--------------------------------------------------------------------------------
/src/Libraries/Basic/ControllersInterface.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | declare(strict_types=1);
 4 | 
 5 | /**
 6 |  * This file is part of Shield OAuth.
 7 |  *
 8 |  * (c) Datamweb <pooya_parsa_dadashi@yahoo.com>
 9 |  *
10 |  * For the full copyright and license information, please view
11 |  * the LICENSE file that was distributed with this source code.
12 |  */
13 | 
14 | namespace Datamweb\ShieldOAuth\Libraries\Basic;
15 | 
16 | use CodeIgniter\HTTP\RedirectResponse;
17 | 
18 | interface ControllersInterface
19 | {
20 |     /**
21 |      * -------------------------------------------------------------------------------------------
22 |      * Users Redirected to Request Their OAuth Identity
23 |      * -------------------------------------------------------------------------------------------
24 |      *
25 |      * The user is redirected to the specified URL for login to any OAuth service with credentials.
26 |      * Each OAuth service provides how to create a link for validation based on its instructions.
27 |      * For example, Github is explained here.
28 |      *
29 |      * @see https://docs.github.com/en/developers/apps/building-oauth-apps/authorizing-oauth-apps#1-request-a-users-github-identity
30 |      */
31 |     public function redirectOAuth(string $oauthName): RedirectResponse;
32 | 
33 |     /**
34 |      * -------------------------------------------------------------------------------------------
35 |      * Call Back From Every OAuth Service
36 |      * -------------------------------------------------------------------------------------------
37 |      *
38 |      * User return after credentials are valid or invalid in each OAuth service
39 |      * If the user is valid in OAuth Service, the new user is registered or login if there is one in shield user table.
40 |      * Otherwise, error messages will be displayed.
41 |      */
42 |     public function callBack(): RedirectResponse;
43 | }
44 | 


--------------------------------------------------------------------------------
/src/Libraries/Basic/ShieldOAuth.php:
--------------------------------------------------------------------------------
  1 | <?php
  2 | 
  3 | declare(strict_types=1);
  4 | 
  5 | /**
  6 |  * This file is part of Shield OAuth.
  7 |  *
  8 |  * (c) Datamweb <pooya_parsa_dadashi@yahoo.com>
  9 |  *
 10 |  * For the full copyright and license information, please view
 11 |  * the LICENSE file that was distributed with this source code.
 12 |  */
 13 | 
 14 | namespace Datamweb\ShieldOAuth\Libraries\Basic;
 15 | 
 16 | use CodeIgniter\Config\Factories;
 17 | use CodeIgniter\Files\FileCollection;
 18 | use Config\Autoload;
 19 | 
 20 | class ShieldOAuth
 21 | {
 22 |     /**
 23 |      * --------------------------------------------------------------------
 24 |      * Set OAuth
 25 |      * --------------------------------------------------------------------
 26 |      * This function creating instances of OAuth class chosen by the user
 27 |      *
 28 |      * This function has the ability to identify classes in two Paths:
 29 |      *
 30 |      *  - \App\Libraries\ShieldOAuth\       for load any OAuth custom class created by the user
 31 |      *  - \Datamweb\ShieldOAuth\Libraries\  for load GithubOAuth or GoogleOAuth class
 32 |      */
 33 |     public static function setOAuth(string $serviceName): object
 34 |     {
 35 |         $serviceName = ucfirst($serviceName);
 36 |         $className   = '\Datamweb\ShieldOAuth\Libraries\\' . $serviceName . 'OAuth';
 37 | 
 38 |         // For detect custom OAuth
 39 |         if (file_exists(APPPATH . 'Libraries/ShieldOAuth' . DIRECTORY_SEPARATOR . $serviceName . 'OAuth.php')) {
 40 |             $className = '\App\Libraries\ShieldOAuth\\' . $serviceName . 'OAuth';
 41 |         }
 42 | 
 43 |         return Factories::loadOAuth($className); // @phpstan-ignore-line
 44 |     }
 45 | 
 46 |     /**
 47 |      * --------------------------------------------------------------------
 48 |      * Names of all supported OAuth services
 49 |      * --------------------------------------------------------------------
 50 |      * List of all the OAuth services
 51 |      *
 52 |      * Identifies all OAuth classes and generates a string according to the file name of the classes as follows.
 53 |      * e.g. 'github|google|yahoo' ...
 54 |      */
 55 |     public function allOAuth(): string
 56 |     {
 57 |         $files = new FileCollection();
 58 | 
 59 |         /** @var Autoload $autoload */
 60 |         $autoload = new Autoload();
 61 | 
 62 |         // Checking if it is installed manually
 63 |         if (array_key_exists('Datamweb\ShieldOAuth', $autoload->psr4)) {
 64 |             // Adds all Libraries files
 65 |             $files = $files->add(APPPATH . 'ThirdParty/shield-oauth/src/Libraries', false);
 66 |         } else {
 67 |             // Adds all Libraries files if install via composer
 68 |             $files = $files->add(__DIR__ . '/..', false);
 69 |         }
 70 |         // For to detect custom OAuth
 71 |         if (is_dir(APPPATH . 'Libraries/ShieldOAuth')) {
 72 |             $files = $files->add(APPPATH . 'Libraries/ShieldOAuth', false);
 73 |         }
 74 |         // show only all *OAuth.php files
 75 |         $files = $files->retainPattern('*OAuth.php');
 76 | 
 77 |         $allOAuth = '';
 78 | 
 79 |         foreach ($files as $file) {
 80 |             // make string github|google and ... from class name
 81 |             $allOAuth .= strtolower(str_replace('OAuth.php', '|', $file->getBasename()));
 82 |         }
 83 | 
 84 |         return mb_substr($allOAuth, 0, -1);
 85 |     }
 86 | 
 87 |     /**
 88 |      * --------------------------------------------------------------------
 89 |      * Names of all Custom OAuth
 90 |      * --------------------------------------------------------------------
 91 |      * List of all just CustomOAuth services
 92 |      *
 93 |      * Returns array of all Custom OAuth classes file name
 94 |      * e.g. ['yahoo']
 95 |      *
 96 |      * @return array<int, string>
 97 |      */
 98 |     private function otherOAuth()
 99 |     {
100 |         $pieces = explode('|', $this->allOAuth());
101 | 
102 |         return array_diff($pieces, ['github', 'google']);
103 |     }
104 | 
105 |     /**
106 |      * --------------------------------------------------------------------
107 |      * Make OAuth Button
108 |      * --------------------------------------------------------------------
109 |      * Creates OAuth buttons based on existing OAuth classes
110 |      *
111 |      * Group a series of buttons together on a single line by bootstrap 5.0
112 |      *
113 |      * @see https://getbootstrap.com/docs/5.0/components/button-group/#nesting
114 |      * @see https://getbootstrap.com/docs/5.0/components/button-group/#basic-example
115 |      */
116 |     public function makeOAuthButton(string $forPage = 'login'): string
117 |     {
118 |         $active_by = lang('ShieldOAuthLang.login_by');
119 |         if ($forPage === 'register') {
120 |             $active_by = lang('ShieldOAuthLang.register_by');
121 |         }
122 | 
123 |         $Button = "<hr>
124 |         <div class='text-center'>
125 |                  <div class='btn-group' role='group' aria-label='Button group with nested dropdown'>
126 |                  <a href='#' class='btn btn-primary active' aria-current='page'>" . $active_by . '</a>';
127 | 
128 |         $Button .= '<a href=' . base_url('oauth/google') . " class='btn btn-outline-secondary' aria-current='page'>" . lang('ShieldOAuthLang.Google.google') . '</a>';
129 |         $Button .= '<a href=' . base_url('oauth/github') . " class='btn btn-outline-secondary' aria-current='page'>" . lang('ShieldOAuthLang.Github.github') . '</a>';
130 |         if ($this->otherOAuth() !== []) {
131 |             $Button .= "<div class='btn-group' role='group'>
132 |                             <button type='button' class='btn btn-outline-secondary dropdown-toggle' data-bs-toggle='dropdown' aria-expanded='false'>"
133 |                             . lang('ShieldOAuthLang.other') . "
134 |                             </button>
135 |                             <ul class='dropdown-menu'>";
136 | 
137 |             foreach ($this->otherOAuth() as $oauthName) {
138 |                 $OAuthName = ucfirst($oauthName);
139 |                 $Button .= "<li><a class='dropdown-item' href=" . base_url("oauth/{$oauthName}") . '>' . lang("ShieldOAuthLang.{$OAuthName}.{$oauthName}") . '</a></li>';
140 |             }
141 |             $Button .= '</ul></div>';
142 |         }
143 | 
144 |         return $Button . '
145 |         </div>
146 |         </div>';
147 |     }
148 | }
149 | 


--------------------------------------------------------------------------------
/src/Libraries/GithubOAuth.php:
--------------------------------------------------------------------------------
  1 | <?php
  2 | 
  3 | declare(strict_types=1);
  4 | 
  5 | /**
  6 |  * This file is part of Shield OAuth.
  7 |  *
  8 |  * (c) Datamweb <pooya_parsa_dadashi@yahoo.com>
  9 |  *
 10 |  * For the full copyright and license information, please view
 11 |  * the LICENSE file that was distributed with this source code.
 12 |  */
 13 | 
 14 | namespace Datamweb\ShieldOAuth\Libraries;
 15 | 
 16 | use CodeIgniter\HTTP\CURLRequest;
 17 | use Config\Services;
 18 | use Datamweb\ShieldOAuth\Config\ShieldOAuthConfig;
 19 | use Datamweb\ShieldOAuth\Libraries\Basic\AbstractOAuth;
 20 | use Exception;
 21 | 
 22 | class GithubOAuth extends AbstractOAuth
 23 | {
 24 |     public static string $API_CODE_URL        = 'https://github.com/login/oauth/authorize';
 25 |     public static string $API_TOKEN_URL       = 'https://github.com/login/oauth/access_token';
 26 |     public static string $API_USER_INFO_URL   = 'https://api.github.com/user';         // The /user API returns the user's publicly visible data or null for those that are not set
 27 |     public static string $API_USER_EMAILS_URL = 'https://api.github.com/user/emails';  // The /user/emails API returns all email addresses for the user, including those that are not set public
 28 |     private static string $APPLICATION_NAME   = 'ShieldOAuth';
 29 |     protected string $token;
 30 |     protected CURLRequest $client;
 31 |     protected ShieldOAuthConfig $config;
 32 |     protected string $client_id;
 33 |     protected string $client_secret;
 34 |     protected string $callback_url;
 35 | 
 36 |     public function __construct(string $token = '')
 37 |     {
 38 |         $this->token  = $token;
 39 |         $this->client = Services::curlrequest();
 40 | 
 41 |         $this->config        = config('ShieldOAuthConfig');
 42 |         $this->callback_url  = base_url('oauth/' . $this->config->call_back_route);
 43 |         $this->client_id     = env('ShieldOAuthConfig.github.client_id', $this->config->oauthConfigs['github']['client_id']);
 44 |         $this->client_secret = env('ShieldOAuthConfig.github.client_secret', $this->config->oauthConfigs['github']['client_secret']);
 45 |     }
 46 | 
 47 |     public function makeGoLink(string $state): string
 48 |     {
 49 |         return $redirectUrl = self::$API_CODE_URL . "?client_id={$this->client_id}&redirect_uri={$this->callback_url}&scope=user%3Aemail&response_type=code&state={$state}";
 50 |     }
 51 | 
 52 |     protected function fetchAccessTokenWithAuthCode(array $allGet): void
 53 |     {
 54 |         try {
 55 |             // send request to API URL
 56 |             $response = $this->client->request('POST', self::$API_TOKEN_URL, [
 57 |                 'form_params' => [
 58 |                     'client_id'     => $this->client_id,
 59 |                     'client_secret' => $this->client_secret,
 60 |                     'code'          => $allGet['code'],
 61 |                     'redirect_uri'  => $this->callback_url,
 62 |                     'grant_type'    => 'authorization_code',
 63 |                 ],
 64 |                 'headers' => [
 65 |                     'User-Agent' => self::$APPLICATION_NAME . '/1.0',
 66 |                     'Accept'     => 'application/json',
 67 |                 ],
 68 |             ]);
 69 |         } catch (Exception $e) {
 70 |             exit($e->getMessage());
 71 |         }
 72 | 
 73 |         $token = json_decode($response->getBody())->access_token;
 74 |         $this->setToken($token);
 75 |     }
 76 | 
 77 |     protected function fetchUserInfoWithToken(): object
 78 |     {
 79 |         // send request to API URL
 80 |         try {
 81 |             $response = $this->client->request('GET', self::$API_USER_INFO_URL, [
 82 |                 'headers' => [
 83 |                     'User-Agent'    => self::$APPLICATION_NAME . '/1.0',
 84 |                     'Accept'        => 'application/vnd.github+json',
 85 |                     'Authorization' => 'Bearer ' . $this->getToken(),
 86 |                 ],
 87 |                 'http_errors' => false,
 88 |             ]);
 89 |         } catch (Exception $e) {
 90 |             exit($e->getMessage());
 91 |         }
 92 | 
 93 |         $userInfo = json_decode($response->getBody(), false);
 94 | 
 95 |         // the email address is mandatory
 96 |         if (empty($userInfo->email)) {
 97 |             $userInfo->email = $this->getUserPrimaryEmail($this->fetchUserEmailsWithToken());
 98 |         }
 99 | 
100 |         return $userInfo;
101 |     }
102 | 
103 |     /**
104 |      * @return list<object>
105 |      */
106 |     protected function fetchUserEmailsWithToken(): array
107 |     {
108 |         // send request to API URL
109 |         try {
110 |             $response = $this->client->request('GET', self::$API_USER_EMAILS_URL, [
111 |                 'headers' => [
112 |                     'User-Agent'    => self::$APPLICATION_NAME . '/1.0',
113 |                     'Accept'        => 'application/vnd.github+json',
114 |                     'Authorization' => 'Bearer ' . $this->getToken(),
115 |                 ],
116 |                 'http_errors' => false,
117 |             ]);
118 |         } catch (Exception $e) {
119 |             exit($e->getMessage());
120 |         }
121 | 
122 |         return json_decode($response->getBody(), false);
123 |     }
124 | 
125 |     /**
126 |      * @param list<object> $emailAddresses
127 |      */
128 |     protected function getUserPrimaryEmail(array $emailAddresses): string
129 |     {
130 |         // try to get the one marked as primary, otherwise grab the first one
131 |         if (! empty($emailAddresses)) {
132 |             $primaryEmail = array_filter($emailAddresses, static fn ($eMail) => $eMail->primary);
133 |             $userEmail    = ! empty($primaryEmail) ? array_shift($primaryEmail)->email : array_shift($emailAddresses)->email;
134 |         }
135 | 
136 |         return $userEmail ?? '';
137 |     }
138 | 
139 |     protected function setColumnsName(string $nameOfProcess, $userInfo): array
140 |     {
141 |         if ($nameOfProcess === 'syncingUserInfo') {
142 |             return [
143 |                 $this->config->usersColumnsName['first_name'] => $userInfo->name,
144 |                 $this->config->usersColumnsName['last_name']  => $userInfo->name,
145 |                 $this->config->usersColumnsName['avatar']     => $userInfo->avatar_url,
146 |             ];
147 |         }
148 | 
149 |         if ($nameOfProcess === 'newUser') {
150 |             return [
151 |                 'username'                                    => $userInfo->login,
152 |                 'email'                                       => $userInfo->email,
153 |                 'password'                                    => random_string('crypto', 32),
154 |                 'active'                                      => true,
155 |                 $this->config->usersColumnsName['first_name'] => $userInfo->name,
156 |                 $this->config->usersColumnsName['last_name']  => $userInfo->name,
157 |                 $this->config->usersColumnsName['avatar']     => $userInfo->avatar_url,
158 |             ];
159 |         }
160 | 
161 |         return [];
162 |     }
163 | }
164 | 


--------------------------------------------------------------------------------
/src/Libraries/GoogleOAuth.php:
--------------------------------------------------------------------------------
  1 | <?php
  2 | 
  3 | declare(strict_types=1);
  4 | 
  5 | /**
  6 |  * This file is part of Shield OAuth.
  7 |  *
  8 |  * (c) Datamweb <pooya_parsa_dadashi@yahoo.com>
  9 |  *
 10 |  * For the full copyright and license information, please view
 11 |  * the LICENSE file that was distributed with this source code.
 12 |  */
 13 | 
 14 | namespace Datamweb\ShieldOAuth\Libraries;
 15 | 
 16 | use CodeIgniter\HTTP\CURLRequest;
 17 | use Config\Services;
 18 | use Datamweb\ShieldOAuth\Config\ShieldOAuthConfig;
 19 | use Datamweb\ShieldOAuth\Libraries\Basic\AbstractOAuth;
 20 | use Exception;
 21 | 
 22 | class GoogleOAuth extends AbstractOAuth
 23 | {
 24 |     private static string $API_CODE_URL      = 'https://accounts.google.com/o/oauth2/v2/auth';
 25 |     private static string $API_TOKEN_URL     = 'https://oauth2.googleapis.com/token';
 26 |     private static string $API_USER_INFO_URL = 'https://www.googleapis.com/oauth2/v3/userinfo';
 27 |     private static string $APPLICATION_NAME  = 'ShieldOAuth';
 28 |     protected string $token;
 29 |     protected CURLRequest $client;
 30 |     protected ShieldOAuthConfig $config;
 31 |     protected string $client_id;
 32 |     protected string $client_secret;
 33 |     protected string $callback_url;
 34 | 
 35 |     public function __construct(string $token = '')
 36 |     {
 37 |         $this->token  = $token;
 38 |         $this->client = Services::curlrequest();
 39 | 
 40 |         $this->config        = config('ShieldOAuthConfig');
 41 |         $this->callback_url  = base_url('oauth/' . $this->config->call_back_route);
 42 |         $this->client_id     = env('ShieldOAuthConfig.google.client_id', $this->config->oauthConfigs['google']['client_id']);
 43 |         $this->client_secret = env('ShieldOAuthConfig.google.client_secret', $this->config->oauthConfigs['google']['client_secret']);
 44 |     }
 45 | 
 46 |     public function makeGoLink(string $state): string
 47 |     {
 48 |         return self::$API_CODE_URL . "?response_type=code&client_id={$this->client_id}&scope=openid%20email%20profile&redirect_uri={$this->callback_url}&state={$state}";
 49 |     }
 50 | 
 51 |     protected function fetchAccessTokenWithAuthCode(array $allGet): void
 52 |     {
 53 |         try {
 54 |             // send request to API URL
 55 |             $response = $this->client->request('POST', self::$API_TOKEN_URL, [
 56 |                 'form_params' => [
 57 |                     'client_id'     => $this->client_id,
 58 |                     'client_secret' => $this->client_secret,
 59 |                     'code'          => $allGet['code'],
 60 |                     'redirect_uri'  => $this->callback_url,
 61 |                     'grant_type'    => 'authorization_code',
 62 |                 ],
 63 |                 'headers' => [
 64 |                     'User-Agent' => self::$APPLICATION_NAME . '/1.0',
 65 |                     'Accept'     => 'application/json',
 66 |                 ],
 67 |             ]);
 68 |         } catch (Exception $e) {
 69 |             exit($e->getMessage());
 70 |         }
 71 | 
 72 |         $token = json_decode($response->getBody())->access_token;
 73 |         $this->setToken($token);
 74 |     }
 75 | 
 76 |     protected function fetchUserInfoWithToken(): object
 77 |     {
 78 |         // send request to API URL
 79 |         try {
 80 |             $response = $this->client->request('POST', self::$API_USER_INFO_URL, [
 81 |                 'headers' => [
 82 |                     'Accept'        => 'application/json',
 83 |                     'User-Agent'    => self::$APPLICATION_NAME . '/1.0',
 84 |                     'Authorization' => 'Bearer ' . $this->getToken(),
 85 |                 ],
 86 |                 'http_errors' => false,
 87 |             ]);
 88 |         } catch (Exception $e) {
 89 |             exit($e->getMessage());
 90 |         }
 91 | 
 92 |         return json_decode($response->getBody());
 93 |     }
 94 | 
 95 |     protected function setColumnsName(string $nameOfProcess, $userInfo): array
 96 |     {
 97 |         if ($nameOfProcess === 'syncingUserInfo') {
 98 |             return [
 99 |                 $this->config->usersColumnsName['first_name'] => $userInfo->name,
100 |                 $this->config->usersColumnsName['last_name']  => $userInfo->family_name ?? null,
101 |                 $this->config->usersColumnsName['avatar']     => $userInfo->picture,
102 |             ];
103 |         }
104 | 
105 |         if ($nameOfProcess === 'newUser') {
106 |             return [
107 |                 // users tbl                                    // OAuth
108 |                 'username'                                    => $userInfo->email,
109 |                 'email'                                       => $userInfo->email,
110 |                 'password'                                    => random_string('crypto', 32),
111 |                 'active'                                      => $userInfo->email_verified,
112 |                 $this->config->usersColumnsName['first_name'] => $userInfo->given_name,
113 |                 $this->config->usersColumnsName['last_name']  => $userInfo->family_name ?? null,
114 |                 $this->config->usersColumnsName['avatar']     => $userInfo->picture,
115 |             ];
116 |         }
117 | 
118 |         return [];
119 |     }
120 | }
121 | 


--------------------------------------------------------------------------------
/src/Models/ShieldOAuthModel.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | declare(strict_types=1);
 4 | 
 5 | /**
 6 |  * This file is part of Shield OAuth.
 7 |  *
 8 |  * (c) Datamweb <pooya_parsa_dadashi@yahoo.com>
 9 |  *
10 |  * For the full copyright and license information, please view
11 |  * the LICENSE file that was distributed with this source code.
12 |  */
13 | 
14 | namespace Datamweb\ShieldOAuth\Models;
15 | 
16 | use CodeIgniter\Shield\Models\UserModel;
17 | use Datamweb\ShieldOAuth\Config\ShieldOAuthConfig;
18 | 
19 | class ShieldOAuthModel extends UserModel
20 | {
21 |     protected function initialize(): void
22 |     {
23 |         parent::initialize();
24 | 
25 |         /** @var ShieldOAuthConfig $config */
26 |         $config = config('ShieldOAuthConfig');
27 | 
28 |         // Merge properties with parent
29 |         $this->allowedFields = array_merge($this->allowedFields, [
30 |             $config->usersColumnsName['first_name'],
31 |             $config->usersColumnsName['last_name'],
32 |             $config->usersColumnsName['avatar'],
33 |         ]);
34 |     }
35 | }
36 | 


--------------------------------------------------------------------------------
/src/Views/Decorators/ShieldOAuth.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | declare(strict_types=1);
 4 | 
 5 | /**
 6 |  * This file is part of Shield OAuth.
 7 |  *
 8 |  * (c) Datamweb <pooya_parsa_dadashi@yahoo.com>
 9 |  *
10 |  * For the full copyright and license information, please view
11 |  * the LICENSE file that was distributed with this source code.
12 |  */
13 | 
14 | namespace Datamweb\ShieldOAuth\Views\Decorators;
15 | 
16 | use CodeIgniter\View\ViewDecoratorInterface;
17 | 
18 | class ShieldOAuth implements ViewDecoratorInterface
19 | {
20 |     public static function decorate(string $html): string
21 |     {
22 |         $shieldOAuthSnippets = [
23 |             '{{ShieldOAuthButtonForLoginPage}}'    => service('ShieldOAuth')->makeOAuthButton('login'),
24 |             '{{ShieldOAuthButtonForRegisterPage}}' => service('ShieldOAuth')->makeOAuthButton('register'),
25 |         ];
26 | 
27 |         return strtr($html, $shieldOAuthSnippets);
28 |     }
29 | }
30 | 


--------------------------------------------------------------------------------