Download the PHP package gcgov/framework-service-auth-oauth-server without Composer
On this page you can find all versions of the php package gcgov/framework-service-auth-oauth-server. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download gcgov/framework-service-auth-oauth-server
More information about gcgov/framework-service-auth-oauth-server
Files in gcgov/framework-service-auth-oauth-server
Package framework-service-auth-oauth-server
Short Description Plugin enables a full fledged oauth server generating access and refresh tokens. Authentication can be provided as username/password or via third party Oauth providers.
License MIT
Informations about the package framework-service-auth-oauth-server
Oauth Server Service
Service to extend gcgov/framework
Primary purpose
- Implement a full Oauth service for authenticating to app. Provides functionality to authenticate users via third party Oauth providers or username/password database.
Impact to application
- Router:
- Adds routes:
- Adds route
/.well-known/jwks.json
- provides endpoint to enable front end validation of tokens generated by the app - Adds route
/.well-known/openid-configuration
- provides public oauth configuration endpoint - Adds route
/auth/fileToken
- create a short lived access token that can be used in the url for supported routes - Adds route
/auth/out
- kills refresh token for user and removes any session and cookie data - Adds route
/auth/authorize
- GET and POST for authenticating user and generating access and refresh tokens - Adds route
/auth/hybridauth/{provider}
- Return endpoint for third party Oauth providers
- Adds route
- Adds authentication guard:
- All routes in application with
authentication=true
must pass this guard. Checks the HTTP Authorization header, or url parameterfileAccessToken
for routes withallowShort
.
- All routes in application with
- Adds routes:
Installation:
- Require using Composer https://packagist.org/packages/gcgov/framework-service-auth-oauth-server
- Add namespace
\gcgov\framework\services\authoauth
to\app\app->registerFrameworkServiceNamespaces()
Configuration
Allowed Users
By default, users attempting to sign in who not already present in the user database collection will be prevented from
signing in. To enable sign in for any user who passes the third party Oauth provider authentication, set
config variable blockNewUsers=false
. When blockNewUsers=false
, any user successfully authenticated by the third
party Oauth provider will be automatically added to the database user config
New User Default Roles
When blockNewUsers=false
, new users will be automatically added to the user database collection. To set the default
roles that a new user should be assigned at creation, provide the roles to the setBlockNewUsers
method.
All versions of framework-service-auth-oauth-server with dependencies
hybridauth/hybridauth Version ^3.10
lcobucci/jwt Version ^4.0
lcobucci/clock Version ^2.0
andrewsauder/json-deserialize Version ^2.5
robthree/twofactorauth Version ^3.0
bacon/bacon-qr-code Version ^3.0
ext-mongodb Version *
ext-imagick Version *