Download the PHP package equidna/caronte-client without Composer

WARNING UPRGRADE FROM 1.1 TO 1.2 MAY BRAKE YOUR APPLICATION DUE TO NAMESPACE CHANGE FOR FACADE Equidna\Caronte to Caronte

Caronte is a JWT token based authentication system written in PHP using the Laravel Framework.

This package provides all the necesary tools to handle user authentication and permission validation for a new Laravel application.

Installation

To install the package simpy call:

After installation is complete you must run:

to create te default caronte-roles.php file in your config path.

If you plan to use the UPDATE_USER feature and/or the CaronteUserHelper you need to have the apropriate tables on your database. You can create those tables using the provided migrations by using the command:

There are other files you may want to publish to fully customize your installation

Views

Publishes views used by the package to the /resources/views/vendor/caronte folder

• base: Base layout for all views
• login: Default login page using email and password
• 2fa-login: Email 2FA based login page
• password-recover-request: Form with email field to request a resset validation token
• password-recover: Form to input new password after password resset is requested and validated
• messages: Frame to show errors and sucess messages

Migrations

Two migrations are provided to generate the bare miminum structure for the CaronteUserHelper

• User
• UserMetadata

Assets

Publish everything

Configuration

.env

Caronte uses environment variables to configure itself, these are the options that you can configure on your .env file.

caronte-roles.php

This file conatins an asociative array where keys are the name of the role used in the PermissionHelper::hasRoles() function and ValidateRoles middleware, and the value the description.

Changes on this file must be notified to the Caronte authentication server via de following command:

Routes

Middleware

ValidateSession

Main Class: Equidna\Caronte\Http\Middleware\ValidateSession

Alias: Caronte.ValidateSession

Validates that the user is authenticated with a valid JWT token and has any permission associated with the CARONTE_APP_ID provided in configuration

Token is automatically renewed during the validation process if it has expired, in this case the new token will be available on a response header named _newtoken

ValidateRoles

Main Class: Equidna\Caronte\Http\Middleware\ValidateRoles

Alias: Caronte.ValidateRoles

Parameters: a comma separated list or array of permissions to validate

Validates that the user has any of the provided roles. root role is allways added to the list, therefore a user with the root role will allways be considered valid.

Helpers

This package provides helper classes for simplifying some common actions with users, all methods are designed to be called statically

Equidna\Caronte\Helpers\CaronteUserHelper

• getUserName(string $uri_user):string Returns the name of the user with the asociated URI

• getUserEmail(string $uri_user):string Returns the email of the user with the asociated URI

• getUserMetadata(string $uri_user, string $key):string Returns metadata valuie for the provided key and uri_user

Equidna\Caronte\Helpers\PermissionHelper

• hasApplication():bool Validates if current user has any role asociated with the CARONTE_APP_ID

• hasRoles(mixed $roles):bool Validates if the current user has any of the provided roles $roles can be provided as a comma separated list of values or an array root role is always added to the list therefore an user with the root role will allways return true.

Facades

Equidna\Caronte

• getToken():Plain Returns a Lcobucci\JWT\Token\Plain representing the token in use

• getUser():stdClass|null Returns a stdClass representing the user for whom the token was isued or null if any error was found while decoding

• getRouteUser():string Returns the {uri_user} part of the route or an empty string of no {uri_user} is found on the route

• saveToken(string $token_str):void @param $tokenstring stores the provided token string on the tokens folder of the server and saves the file id on a cookie named caronte_token*

• clearToken():void Clears the _carontetoken cookie and deletes the asociated file storing the user token

• setTokenWasExchanged():void Raises a flag indicating that the token had expired and was exchanged during the validation process

• tokenWasExchanged():bool Return true if the token was exchanged during the validation process

• echo(string $message):string Returns the provided message

Commands

• caronte:notify-client-configuration: Updates aplication roles on Caronte server based on information provided in caronte-roles.php configuration file.