PHPackages                             univicosa/laravel-openid-client - 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. [Authentication & Authorization](/categories/authentication)
4. /
5. univicosa/laravel-openid-client

ActiveLibrary[Authentication & Authorization](/categories/authentication)

univicosa/laravel-openid-client
===============================

OpenId client for the Univiçosa authenticated projects.

1.0.13(3y ago)1050141MITPHPPHP >=7.0.0CI failing

Since Aug 9Pushed 9mo ago1 watchersCompare

[ Source](https://github.com/univicosa/laravel-openid-client)[ Packagist](https://packagist.org/packages/univicosa/laravel-openid-client)[ RSS](/packages/univicosa-laravel-openid-client/feed)WikiDiscussions master Synced 1w ago

READMEChangelog (10)Dependencies (3)Versions (33)Used By (1)

Univiçosa Laravel OpenId Client
===============================

[](#univiçosa-laravel-openid-client)

`univicosa/laravel-openid-client` is a Laravel package which created to integrate the Oauth server to ours Laravel project's that requires authentication.

Install
-------

[](#install)

Installation using composer:

```
composer require univicosa/laravel-openid-client

```

For Laravel versions < 5.5 add the service provider in `config/app.php`:

```
Modules\OpenId\Providers\OpenIdServiceProvider::class

```

To personalize the config, publish the package's configuration file by running:

```
php artisan vendor:publish --tag=openid-config

```

The file `config/openid.php` will be generated.

### Oauth `public key`

[](#oauth-public-key)

Your system need the `oauth public key` to connect and communicate with the Oauth Server.So you need to copy the public key file to `storage` folder of your project.

### Redirecting to *Login*

[](#redirecting-to-login)

In the file `app\Exceptions\Handler.php` find or overwrite the `unauthenticated` method and change the redirect route to:

```
protected function unauthenticated($request, AuthenticationException $exception) : \Illuminate\Http\RedirectResponse
{
     if ($request->expectsJson()) {
         return response()->json(['error' => 'Unauthenticated.'], 401);
     }

     if (env('APP_ENV') === 'local') {
         return redirect()->guest(route('login'));
     }

     return redirect()->guest(config('openid.server') . '/login?continue=' . $request->url());
}
```

### .env File

[](#env-file)

Set a variable called `SESSION_LIFETIME` in the `.env` file and define it to the time in minutes you want to keep the logged session. The max time of the Oauth Server keeps the session is 240 minutes (4 hours).

```
#### APP CONFIG ####
APP_URL=url-project (https://domain.com)

#### CACHE CONFIG ####
BROADCAST_DRIVER=log
CACHE_DRIVER=redis
SESSION_DRIVER=file
SESSION_LIFETIME=240
QUEUE_DRIVER=sync

REDIS_HOST=127.0.0.1
REDIS_PASSWORD=null
REDIS_PORT=6379

#### OAUTH OPENID ####
AUTH_SERVER=https://oauth.univicosa.com.br or https://devauth.univicosa.com.br
CLIENT_ID=you-client-id
CLIENT_SECRET=your-secret-code
```

### Change Kernel.php

[](#change-kernelphp)

In file *app/Http/Kernel.php*\* change the attribute $routeMiddleware

```
protected $routeMiddleware = [
   'auth' => \Illuminate\Auth\Middleware\Authenticate::class // CHANGE THIS
];
```

### For change the *Guard*

[](#for-change-the-guard)

change the file `config\auth.php` to:

```
'guards' => [
    'web' => [
        'driver' => 'openid',
        'provider' => NULL,
    ],
    /*
     * ...
     */
]
```

*Facades*
---------

[](#facades)

The client methods are available under the facade **\\OpenId**.

The authentication methods like the verifier `\Auth::check()` are available under the Facade **\\Illuminate\\Support\\Facades\\Auth**;

The facade **\\Oauth2** provides all helpers needed to get and post data from the Oauth Server.

### \\Ouath2 methods available

[](#ouath2-methods-available)

```
@method \Oauth2::getSystems(): array
@api GET '/api/{version}/system'

@return array With Systems available in Oauth Server
```

```
@method \Oauth2::getSystemRoles(): array
@api GET '/api/{version}/system/roles'

@return array With System givable roles
```

```
@method \Oauth2::getSystemPermissions(): array
@api GET '/api/{version}/system/permissions'

@return array With System givable permissions
```

```
@method \Oauth2::getUser(): array
@api GET '/api/{version}/user'

@return array With logged user data
```

```
@method \Oauth2::getUserProfiles(): array
@api GET '/api/{version}/profile'

@return array With logged user profiles
```

```
@method \Oauth2::getUserByCpf(string $cpf): array
@api POST '/api/{version}/user/cpf'

@return array With the data of user owner of document given
```

```
@method \Oauth2::getUsersByCpf(array $cpf): array
@api POST '/api/{version}/user/search/cpf'

@return array With the data of user owner of document given: limit array size to 100 items
```

```
@method \Oauth2::searchUserByName(string $name): array
@api POST '/api/{version}/user/name'

@return array With the data of users owner of document given
```

```
@method \Oauth2::searchUserByRegistry(string $registry): array
@api POST '/api/{version}/user/registry'

@return array With the data of users owner of registry given
```

```
@method \Oauth2::getUserSystems(): array
@api GET '/api/{version}/user/systems'

@return array With the systems that the user is allowed to access
```

```
@method \Oauth2::getUserPermissions(): array
@api GET '/api/{version}/user/permissions'

@return array With the roles that the logged user has in the request owner
```

```
@method \Oauth2::getGenders(): array
@api GET '/api/{version}/profile/genders'

@return array With th data of all genders available for select on the Oauth Server
```

```
@method \Oauth2::setUserPermission(string $cpf, string $role, string $expires_at = ''): array
@api POST '/api/{version}/user/permission'

@return array with the response of Post action
```

```
@method \Oauth2::isAddressFilled(): array
@api GET '/api/{version}/address/filled'

@return array With the Boolean response if the user address data is populated on the Oauth Server
```

```
@method \Oauth2::getStates(): array
@api GET '/api/{version}/address/states'

@return array With the data of all Brazilian states present on the Oauth Server
```

```
@method \Oauth2::getCities(string $state): array
@api GET '/api/{version}/address/cities/{state}'

@return array With the data of all Brazilian cities according to the state given present on the Oauth Server
```

```
@method \Oauth2::setAddress(array $data): array
@api POST '/api/{version}/address'

@return array with the response of Post action
```

```
@method \Oauth2::setProfile(array $data): array
@api POST '/api/{version}/profile'

@return array with the response of Post action
```

```
@method \Oauth2::setUsername(array $data): array
@api POST '/api/{version}/user/update/username'

@return array with the response of Post action
```

```
@method \Oauth2::getUsersType(string $type): array
@api POST '/api/{version}/profile/users/type'

@return array With all user data available for a type selected on the Oauth server
```

```
@method \Oauth2::setUsersType(array $data): array
@api POST '/api/{version}/profile/create/usertype'

@return array with the response of Post action
```

```
@method \Oauth2::removeAllTypesFromUser(array $data): array
@api POST '/api/{version}/profile/remove/usertype'

@return array with the response of Post action
```

*View components*
-----------------

[](#view-components)

`@openidComponents`:

For load the user's logged menu, the fast access with the users permissions and render the Login Button in case you have not authenticated page, just call the Blade directive under your header component.

`@login('route.name')`:

The login directive will call the route you pass or return the oauth path formated with the continue parameter to the required route.

*Redirecting routes*
--------------------

[](#redirecting-routes)

The dynamic route from Oauth system can redirect the user back to the source using the `?continue` url parameter.

The following example will be redirect back to the source after the user executes the actions needed in the Oauth Service page:

```
config('openid.server') . '{ouath_service_page}?' . http_build_query(['continue' => {route_to_redirect_back}])
```

###  Health Score

40

—

FairBetter than 88% of packages

Maintenance40

Moderate activity, may be stable

Popularity23

Limited adoption so far

Community15

Small or concentrated contributor base

Maturity69

Established project with proven stability

 Bus Factor1

Top contributor holds 54.5% 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 ~67 days

Recently: every ~181 days

Total

32

Last Release

1110d ago

Major Versions

0.7.4 → 1.0.02018-06-07

PHP version history (2 changes)0.6PHP >=5.6.4

1.0.0PHP >=7.0.0

### Community

Maintainers

![](https://www.gravatar.com/avatar/c760aa601ba6b0885956cc9ff477324753099137b502cbf81810167d1df4b3ff?d=identicon)[univicosa](/maintainers/univicosa)

---

Top Contributors

[![webmaster-uni](https://avatars.githubusercontent.com/u/36699488?v=4)](https://github.com/webmaster-uni "webmaster-uni (18 commits)")[![viniciofm](https://avatars.githubusercontent.com/u/19212108?v=4)](https://github.com/viniciofm "viniciofm (13 commits)")[![joaomsfreis](https://avatars.githubusercontent.com/u/40475388?v=4)](https://github.com/joaomsfreis "joaomsfreis (2 commits)")

---

Tags

laravellaravel-passportlaravel-socialiteoauth-serveropenidsso

### Embed Badge

![Health badge](/badges/univicosa-laravel-openid-client/health.svg)

```
[![Health](https://phpackages.com/badges/univicosa-laravel-openid-client/health.svg)](https://phpackages.com/packages/univicosa-laravel-openid-client)
```

###  Alternatives

[jeremy379/laravel-openid-connect

OpenID Connect support to the PHP League's OAuth2 Server. Compatible with Laravel Passport.

55342.3k2](/packages/jeremy379-laravel-openid-connect)[simplesamlphp/simplesamlphp-module-oidc

A SimpleSAMLphp module adding support for the OpenID Connect protocol

5016.9k1](/packages/simplesamlphp-simplesamlphp-module-oidc)

PHPackages © 2026

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