PHPackages                             virgantara/unida-apps-support - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [Utility & Helpers](/categories/utility)
4. /
5. virgantara/unida-apps-support

ActiveLibrary[Utility & Helpers](/categories/utility)

virgantara/unida-apps-support
=============================

A collection of UNIDA Gontor Apps Components.

v1.0.7(1mo ago)03MITPHPPHP >=7.4

Since Dec 18Pushed 1mo ago1 watchersCompare

[ Source](https://github.com/virgantara/Unida-Apps-Support)[ Packagist](https://packagist.org/packages/virgantara/unida-apps-support)[ RSS](/packages/virgantara-unida-apps-support/feed)WikiDiscussions master Synced today

READMEChangelog (1)Dependencies (6)Versions (8)Used By (0)

🚀 UNIDA Apps Support Components for Yii2
========================================

[](#-unida-apps-support-components-for-yii2)

[![License](https://camo.githubusercontent.com/b8cadaa967891081f8f165695470689986c028821dd8a040132f6e661795dc0d/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f6c6963656e73652d4d49542d626c7565)](https://camo.githubusercontent.com/b8cadaa967891081f8f165695470689986c028821dd8a040132f6e661795dc0d/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f6c6963656e73652d4d49542d626c7565)[![PHP](https://camo.githubusercontent.com/61ac6fd08d26de053c71a00c885c7d3d924ae0babf4d146e509dd73ddd6521cc/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f7068702d2533453d372e342d627269676874677265656e)](https://camo.githubusercontent.com/61ac6fd08d26de053c71a00c885c7d3d924ae0babf4d146e509dd73ddd6521cc/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f7068702d2533453d372e342d627269676874677265656e)[![Yii2](https://camo.githubusercontent.com/d731221643b09f3e00a769a836a95aa2b2fedb3d9d6811af0b56d2f936acb955/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f636f6d70617469626c652d596969322d626c7565)](https://camo.githubusercontent.com/d731221643b09f3e00a769a836a95aa2b2fedb3d9d6811af0b56d2f936acb955/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f636f6d70617469626c652d596969322d626c7565)

A reusable Yii2 component package for UNIDA Gontor applications. This package provides helper components for OAuth2 authentication, token handling, user session integration, and application jump support between UNIDA apps.

---

📦 Features
----------

[](#-features)

- OAuth2 Authorization Code integration
- Access token and refresh token management
- User info retrieval from SSO server
- Allowed application list retrieval
- Secure app-to-app jump support
- Yii2 component-based integration

---

⚠️ Security Notice
------------------

[](#️-security-notice)

This package must use OAuth2 Authorization Code Flow for authentication and app jumping.

Do **not** send `access_token` or `refresh_token` through URL query parameters.

Bad example:

```
https://app.example.com/callback?access_token=xxx&refresh_token=yyy

```

Recommended flow:

```
Source App
  ↓
Target App /site/start-sso
  ↓
SSO /oauth/authorize
  ↓
Target App /site/auth-callback?code=xxx&state=yyy
  ↓
Target App exchanges code for token

```

---

📋 Requirements
--------------

[](#-requirements)

- PHP >= 7.4
- Yii2 Framework
- Composer
- OAuth2 SSO server

---

⚙️ Installation
---------------

[](#️-installation)

### 1. Add Repository to `composer.json`

[](#1-add-repository-to-composerjson)

```
{
    "repositories": [
        {
            "type": "vcs",
            "url": "https://github.com/virgantara/Unida-Apps-Support.git"
        }
    ]
}
```

### 2. Add Package Requirement

[](#2-add-package-requirement)

For development branch:

```
{
    "require": {
        "virgantara/unida-apps-support": "dev-master"
    }
}
```

For stable release tag:

```
{
    "require": {
        "virgantara/unida-apps-support": "^1.0"
    }
}
```

Then run:

```
composer update -vvv
```

Or install directly:

```
composer require virgantara/unida-apps-support:^1.0
```

---

🔧 OAuth Configuration
---------------------

[](#-oauth-configuration)

Add this configuration to `params.php` or `params-local.php`.

```
return [
    'oauth' => [
        'client_id' => 'your-client-id',
        'client_secret' => 'your-client-secret',
        'baseurl' => 'https://your-sso-server.com',
        'redirectUri' => 'https://your-app.com/site/auth-callback',
        'scope' => 'read write',
    ],
];
```

Example:

```
return [
    'oauth' => [
        'client_id' => 'elitabmas',
        'client_secret' => 'your-secret',
        'baseurl' => 'https://sso.unida.gontor.ac.id',
        'redirectUri' => 'https://elitabmas.unida.gontor.ac.id/site/auth-callback',
        'scope' => 'read write',
    ],
];
```

---

🧩 Yii2 Component Configuration
------------------------------

[](#-yii2-component-configuration)

Open `config/web.php`, then add the components below.

```
'components' => [
    // Other components...

    'tokenService' => [
        'class' => 'virgantara\components\TokenService',
    ],

    'aplikasi' => [
        'class' => 'virgantara\components\AplikasiAuth',
        'baseurl' => $params['oauth']['baseurl'],
    ],

    'tokenManager' => [
        'class' => 'virgantara\components\TokenManager',
    ],

    'oauth2' => [
        'class' => 'virgantara\components\OAuth2Client',
        'tokenValidationUrl' => $params['oauth']['baseurl'],
        'tokenRefreshUrl' => $params['oauth']['baseurl'],
        'client_id' => $params['oauth']['client_id'],
        'client_secret' => $params['oauth']['client_secret'],
    ],
],
```

---

🔐 Start SSO Login
-----------------

[](#-start-sso-login)

Add this action to your `SiteController`.

```
public function actionStartSso()
{
    $session = Yii::$app->session;

    if (!$session->isActive) {
        $session->open();
    }

    $state = Yii::$app->security->generateRandomString(40);
    $session->set('oauth_state', $state);

    $params = [
        'client_id' => Yii::$app->params['oauth']['client_id'],
        'redirect_uri' => Yii::$app->params['oauth']['redirectUri'],
        'response_type' => 'code',
        'scope' => Yii::$app->params['oauth']['scope'] ?? 'read write',
        'state' => $state,
    ];

    $authUrl = rtrim(Yii::$app->params['oauth']['baseurl'], '/')
        . '/oauth/authorize?'
        . http_build_query($params);

    return $this->redirect($authUrl);
}
```

---

🔁 OAuth Callback
----------------

[](#-oauth-callback)

Add this callback action to your `SiteController`.

```
public function actionAuthCallback()
{
    try {
        $session = Yii::$app->session;

        if (!$session->isActive) {
            $session->open();
        }

        $sessionState = $session->get('oauth_state');
        $receivedState = Yii::$app->request->get('state');

        if (empty($sessionState) || empty($receivedState) || $sessionState !== $receivedState) {
            throw new \yii\web\BadRequestHttpException('Invalid OAuth state.');
        }

        $authCode = Yii::$app->request->get('code');

        if (empty($authCode)) {
            throw new \yii\web\BadRequestHttpException('Authorization code not received.');
        }

        $response = Yii::$app->tokenManager->fetchAccessTokenWithAuthCode($authCode);

        if (empty($response['access_token'])) {
            throw new \yii\web\UnauthorizedHttpException('Failed to get access token.');
        }

        $accessToken = $response['access_token'];
        $refreshToken = $response['refresh_token'] ?? null;

        $userinfo = Yii::$app->tokenManager->getUserinfo($accessToken);

        if (empty($userinfo) || empty($userinfo['email'])) {
            throw new \yii\web\UnauthorizedHttpException('Failed to get user info.');
        }

        $session->set('access_token', $accessToken);

        if (!empty($refreshToken)) {
            $session->set('refresh_token', $refreshToken);
        }

        /*
         * TODO:
         * Implement local user login here.
         *
         * Example:
         * - Find local user by email
         * - Create user if allowed
         * - Login using Yii::$app->user->login($identity)
         */

        return $this->redirect(['site/index']);
    } catch (\Throwable $e) {
        return $this->handleException($e);
    }
}
```

Add the exception handler:

```
protected function handleException($e)
{
    Yii::error($e->getMessage(), __METHOD__);
    Yii::$app->session->setFlash('danger', $e->getMessage());

    return $this->redirect(['site/index']);
}
```

---

🧭 App-to-App Jump
-----------------

[](#-app-to-app-jump)

This package supports Google-like app jumping.

Example:

```
SIAKAD → ELITABMAS
E-KHIDMAH → MOODLE
MOODLE → SIAKAD

```

The source app should only open the target app login endpoint:

```
https://target-app.unida.gontor.ac.id/site/start-sso

```

The target app will then start its own OAuth2 flow.

Correct flow:

```
User is logged in to SIAKAD
  ↓
User clicks ELITABMAS
  ↓
Browser opens ELITABMAS /site/start-sso
  ↓
ELITABMAS redirects to SSO /oauth/authorize
  ↓
SSO detects active SSO session
  ↓
SSO redirects back to ELITABMAS callback with authorization code
  ↓
ELITABMAS exchanges code for token
  ↓
User is logged in to ELITABMAS

```

The source application must not generate OAuth state for the target application.

---

📱 Allowed Apps List
-------------------

[](#-allowed-apps-list)

You can render allowed applications from SSO using:

```
$apps = Yii::$app->aplikasi->getRenderedAllowedAppsList();
```

Example usage in layout or menu:

```
use yii\widgets\Menu;

echo Menu::widget([
    'items' => Yii::$app->aplikasi->getRenderedAllowedAppsList(),
    'encodeLabels' => false,
]);
```

The SSO `/app/list` endpoint should return data like this:

```
[
    {
        "app_id": 1,
        "client_id": "siakad",
        "app_name": "SIAKAD",
        "base_url": "https://siakad.unida.gontor.ac.id",
        "jump_callback": "/site/start-sso"
    },
    {
        "app_id": 2,
        "client_id": "elitabmas",
        "app_name": "ELITABMAS",
        "base_url": "https://elitabmas.unida.gontor.ac.id",
        "jump_callback": "/site/start-sso"
    }
]
```

Or preferably:

```
[
    {
        "app_id": 2,
        "client_id": "elitabmas",
        "app_name": "ELITABMAS",
        "start_sso_url": "https://elitabmas.unida.gontor.ac.id/site/start-sso"
    }
]
```

---

🚪 Logout
--------

[](#-logout)

Recommended logout flow:

```
Application logout
  ↓
Clear local Yii2 session
  ↓
Redirect to SSO logout endpoint
  ↓
SSO clears global SSO session
  ↓
Redirect back to application logout callback

```

Example:

```
public function actionLogout()
{
    Yii::$app->user->logout();

    Yii::$app->session->remove('access_token');
    Yii::$app->session->remove('refresh_token');

    $logoutUrl = rtrim(Yii::$app->params['oauth']['baseurl'], '/')
        . '/oauth/logout?'
        . http_build_query([
            'client_id' => Yii::$app->params['oauth']['client_id'],
        ]);

    return $this->redirect($logoutUrl);
}
```

---

🏷️ Release Tag Procedure
------------------------

[](#️-release-tag-procedure)

Use semantic versioning for releases.

Format:

```
MAJOR.MINOR.PATCH

```

Examples:

```
v1.0.0
v1.0.1
v1.1.0
v2.0.0

```

### 1. Check Current Branch

[](#1-check-current-branch)

```
git branch
```

Switch to `master` or `main` branch:

```
git checkout master
```

or:

```
git checkout main
```

### 2. Pull Latest Changes

[](#2-pull-latest-changes)

```
git pull origin master
```

or:

```
git pull origin main
```

### 3. Check Git Status

[](#3-check-git-status)

```
git status
```

Make sure there are no uncommitted changes.

### 4. Commit Changes

[](#4-commit-changes)

```
git add .
git commit -m "Prepare release v1.0.0"
```

Skip this step if all changes have already been committed.

### 5. Create Git Tag

[](#5-create-git-tag)

```
git tag -a v1.0.0 -m "Release v1.0.0"
```

### 6. Push Commit and Tag

[](#6-push-commit-and-tag)

If using `master`:

```
git push origin master
git push origin v1.0.0
```

If using `main`:

```
git push origin main
git push origin v1.0.0
```

Or push all tags:

```
git push origin --tags
```

### 7. Verify Tag

[](#7-verify-tag)

```
git tag
```

Or check remote tags:

```
git ls-remote --tags origin
```

---

📦 Using a Release Tag in Yii2 App
---------------------------------

[](#-using-a-release-tag-in-yii2-app)

After creating a release tag, update the Yii2 app `composer.json`.

```
{
    "require": {
        "virgantara/unida-apps-support": "^1.0"
    }
}
```

Then run:

```
composer update virgantara/unida-apps-support -vvv
```

For a specific version:

```
{
    "require": {
        "virgantara/unida-apps-support": "1.0.0"
    }
}
```

Then:

```
composer update virgantara/unida-apps-support -vvv
```

---

🔄 Updating Release Version
--------------------------

[](#-updating-release-version)

For bug fixes:

```
git tag -a v1.0.1 -m "Release v1.0.1"
git push origin v1.0.1
```

For new backward-compatible features:

```
git tag -a v1.1.0 -m "Release v1.1.0"
git push origin v1.1.0
```

For breaking changes:

```
git tag -a v2.0.0 -m "Release v2.0.0"
git push origin v2.0.0
```

---

🧹 Removing a Wrong Tag
----------------------

[](#-removing-a-wrong-tag)

Remove local tag:

```
git tag -d v1.0.0
```

Remove remote tag:

```
git push origin --delete v1.0.0
```

Create the corrected tag again:

```
git tag -a v1.0.0 -m "Release v1.0.0"
git push origin v1.0.0
```

---

🧪 Testing Package Installation Locally
--------------------------------------

[](#-testing-package-installation-locally)

In a Yii2 application:

```
composer clear-cache
composer update virgantara/unida-apps-support -vvv
```

Check installed version:

```
composer show virgantara/unida-apps-support
```

---

📁 Suggested Package Structure
-----------------------------

[](#-suggested-package-structure)

```
Unida-Apps-Support/
├── composer.json
├── README.md
├── src/
│   └── components/
│       ├── AplikasiAuth.php
│       ├── OAuth2Client.php
│       ├── TokenManager.php
│       └── TokenService.php
└── LICENSE

```

---

🧾 Example Package `composer.json`
---------------------------------

[](#-example-package-composerjson)

```
{
    "name": "virgantara/unida-apps-support",
    "description": "Support components for Yii2 UNIDA Gontor applications",
    "type": "yii2-extension",
    "license": "MIT",
    "authors": [
        {
            "name": "Oddy Virgantara Putra",
            "email": "your-email@example.com"
        }
    ],
    "require": {
        "php": ">=7.4",
        "yiisoft/yii2": "~2.0.0",
        "yiisoft/yii2-httpclient": "*",
        "firebase/php-jwt": "^6.0"
    },
    "autoload": {
        "psr-4": {
            "virgantara\\": "src/"
        }
    }
}
```

If your component files are placed directly under:

```
components/

```

then use:

```
{
    "autoload": {
        "psr-4": {
            "virgantara\\": ""
        }
    }
}
```

---

✅ Recommended Release Checklist
-------------------------------

[](#-recommended-release-checklist)

Before creating a new tag:

- Code is committed
- `composer.json` is valid
- Namespace matches PSR-4 autoload
- README is updated
- No token is exposed through URL
- OAuth callback uses authorization code
- App jump uses target app `/site/start-sso`
- Version tag is created
- Tag is pushed to GitHub
- Yii2 app can install the tagged version

---

📄 License
---------

[](#-license)

This package is open-sourced under the MIT license.

###  Health Score

38

—

LowBetter than 83% of packages

Maintenance93

Actively maintained with recent releases

Popularity3

Limited adoption so far

Community7

Small or concentrated contributor base

Maturity43

Maturing project, gaining track record

 Bus Factor1

Top contributor holds 100% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Every ~88 days

Recently: every ~133 days

Total

7

Last Release

33d ago

### Community

Maintainers

![](https://avatars.githubusercontent.com/u/832277?v=4)[Oddy Virgantara Putra](/maintainers/virgantara)[@virgantara](https://github.com/virgantara)

---

Top Contributors

[![virgantara](https://avatars.githubusercontent.com/u/832277?v=4)](https://github.com/virgantara "virgantara (25 commits)")

---

Tags

componentsyii2UNIDA GontorGontor

### Embed Badge

![Health badge](/badges/virgantara-unida-apps-support/health.svg)

```
[![Health](https://phpackages.com/badges/virgantara-unida-apps-support/health.svg)](https://phpackages.com/packages/virgantara-unida-apps-support)
```

###  Alternatives

[craftcms/cms

Craft CMS

3.6k3.6M3.1k](/packages/craftcms-cms)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)