Amoclient
A Laravel 5 (and up) package for use with the amologin OpenID connect server.
Now using curio.codes!, (*1)
Installation
!! Please make sure your app is using https, to prevent unwanted exposure of token, secrets, etc., (*2)
To use amoclient in your project:, (*3)
-
In your laravel project run: composer require studiokaa/amoclient, (*4)
-
Set these keys in your .env file:, (*5)
AMO_CLIENT_IDAMO_CLIENT_SECRET-
AMO_API_LOG (optional)
-
Default:
no
- Set to
yes to make Amoclient log all usage of access_tokens and refresh_tokens to the default log-channel.
-
AMO_APP_FOR (optional)
-
Default:
teachers
- This key determines if students can login to your application.
- May be one of:
-
all: everyone can login, you may restrict access using guards or middleware.
-
teachers: a student will be completely blocked and no user will be created when they try to login.
-
AMO_USE_MIGRATION (optional)
-
Default:
yes
- Set to no if you want to use your own migration instead of the users migration this package provides
-
AMO_SSL_VERIFYPEER (optional)
-
Default:
yes
- Set to
no if you want to disable SSL verification. This is only recommended for during development and only on trusted networks.
-
Alter your User model and add the line: public $incrementing = false;, (*6)
-
(Recommended) Remove any default users-migration from your app, because Amoclient will conflict with it. Do not remove the user-model. If you want to keep using your own migration, in your .env file set: AMO_USE_MIGRATION=no, (*7)
-
Lastly, run php artisan migrate., (*8)
Usage
Logging in
Redirect your users to http://yoursite/amoclient/redirect, this will send your user to amologin for authentication., (*9)
You should have a named route that will serve your users with a button or direct redirect to /amoclient/redirect., (*10)
Example;, (*11)
Route::get('/login', function(){
return redirect('/amoclient/redirect');
})->name('login');
Catch the after-login redirect
After a succesfull login, Amoclient will redirect you to /amoclient/ready. You may define a route in your applications routes/web.php file to handle this., (*12)
Example;, (*13)
Route::get('/amoclient/ready', function(){
return redirect('/educations');
})
Logging out
Send your user to /amoclient/logout.
Please note: a real logout cannot be accomplished at this time. If you log-out of your app, but are still logged-in to the amologin-server, this will have no effect., (*14)
Laravel's make:auth
Don't use this in combination with Amoclient., (*15)
AmoAPI
Apart from being the central login-server, login.amo.rocks also exposes an api. Please note this api is currently undocumented, although there are options to explore the api:
* Refer to amologin's routes/api.php file.
* Play around at apitest.amo.rocks., (*16)
Amoclient API Interface
An example of calling the api through Amoclient;, (*17)
namespace App\Http\Controllers;
use \StudioKaa\Amoclient\Facades\AmoAPI;
class MyController extends Controller
{
//This method is protected by the auth-middleware
public function index()
{
$users = AmoAPI::get('users');
return view('users.index')->with(compact('users'));
}
}
Known 'bug': Currently the AmoAPI class doesn't check if the token expired but just refreshes it anytime you use it., (*18)
AmoAPI::get($endpoint)
- Performs an HTTP-request like
GET https://api.amo.rocks/$endpoint.
- This method relies on a user being authenticated through the amoclient first. Please do call this method only from routes and/or controllers protected by the auth middlware.
- Returns a Laravel-collection
Contributing
- Clone this repository to your device
- Inside the root of this repository run
composer install
- Create a test project in which you will use this package (Follow Usage instructions above)
- Add the package locally using the following additions to your composer.json:
json
"repositories": [
{
"type": "path",
"url": "../amoclient"
}
],
-
Note:
../amoclient should point to where you cloned this package
- Run
composer require "studiokaa/amoclient @dev" inside the test project
You can now test and modify this package. Changes will immediately be reflected in the test project., (*19)
Wallogit.com
