fluidphp/user-auth-api-helper

FluidPhp framework user authentication API

v1.0.5-stable 2023-09-12 21:46 UTC

Requires

• php: 5.4.0 - 7.4
• fluidphp/emailmanager-helper: ^1.0.0
• fluidphp/fluidphp: ^2.0.0
• fluidphp/logger-helper: ^1.0.0
• fluidphp/translator-helper: ^1.0.0
• fluidphp/validator-helper: ^1.0.0
• mnsami/composer-custom-directory-installer: 2.0.*
• phpmailer/phpmailer: ^6.7
• rmccue/requests: ^2.0

GPL-2.0-or-later

• Carlo Pietrobattista

• php framework

README

This is a helper for fluidphp framework, to authenticate users on your website or backend panel

Installation

1 - Add the package to your composer.json to install the helpers

"require": 
{
	"mnsami/composer-custom-directory-installer": "2.0.*" ,
	"fluidphp/user-auth-api-helper": "^1.0.0"
} ,
"extra": 
{
	"installer-paths": 
	{
		"./vendor/fluidphp/helpers/Translator": ["fluidphp/translator-helper"] ,
		"./vendor/fluidphp/helpers/Validator": ["fluidphp/validator-helper"],
		"./vendor/fluidphp/helpers/Logger": ["fluidphp/logger-helper"],
		"./vendor/fluidphp/helpers/EmailManager": ["fluidphp/emailmanager-helper"],
		"./vendor/fluidphp/helpers/UserAuthApi": ["fluidphp/user-auth-api-helper"]
	}
}

2 - Create "user-auth-api.php" config file in app/config folder and copy the code from "user-auth-api.config.sample.php"

3 - Create "logger.php" file in app/config folder and add your configuration if not present already

return
[
	'develop'	=>
	[
		'connection'	=>	'default' ,
		'table'		=>	'log'
	] ,
	'prod'	=>
	[
		'connection'	=>	'default' ,
		'table'		=>	'log'
	]
];

4 - Configure "auth.php" in app/config to add the api user model

'model'	=>	'\helpers\UserAuthApi\models\Users',	

5- Move email-templates folder in app/views

Usage

Using protected pages filter

Add the filter "_user-auth-api.check_login" to all the routes that require access to authenticated users

Using the api wrapper

The api wrapper is a convenient way to make the calls from js directly, as it can set the session variables directly.
To call the api wrapper u can use any request library

$app = \App::option('app');
try
{
	$request = Requests::post($app['url'] . $app['env'] . '/wrapper/reset-password/', [], ['username' => 'some_user_name']);
	return $request->body;
}
catch (\Throwable $e)
{
	return '{"error": 1, "message": "' . $e->getMessage() . '", "code": ' . $e->getCode(). '}';
}

Keep in mind that calling the api directly will not allow session variables to be set.

Calling the authentication api directly

The API should be only called directly within the localhost environment.
To call the authentication api u can use any request library

$app = \App::option('app');
try
{
	$request = Requests::put($app['url'] . $app['env'] . '/account/asutologin/'. $code . '/');
	return $request->body;
}
catch (\Throwable $e)
{
	return '{"error": 1, "message": "' . $e->getMessage() . '", "code": ' . $e->getCode(). '}';
}

Endpoints

Wrapper

Register

• {(http|https)}://{main_doman}/{app_path}/wrapper/register/

  • method: post
  • description: registers a new user to the database
  • params: see config/validator.php

Login

• {(http|https)}://{main_doman}/{app_path}/wrapper/login/

  • method: post
  • description: tries to log user in
  • params: username, password
  • return data: user data

Logout

• {(http|https)}://{main_doman}/{app_path}/wrapper/logout/

  • method: put
  • description: removes user session data and autologin cookie

Forgot Password

• {(http|https)}://{main_doman}/{app_path}/wrapper/forgot-pass/

  • method: post
  • description: send an email with a link to reset password
  • params: username

AutoLogin

• {(http|https)}://{main_doman}/{app_path}/wrapper/auto-login/{code}/

  • method: put
  • description: tries to log in with existing login_token
  • params: see config/validator.php
  • return data: returns user data

Verify Account

• {(http|https)}://{main_doman}/{app_path}/wrapper/verify/{verificationCode}/

  • method: put
  • description: tries to verify a user account

Change Password

• {(http|https)}://{main_doman}/{app_path}/wrapper/change-password/{resetLink}/

  • method: post
  • description: change user password
  • params: see config/validator.php

API

The API should be only called directly within the localhost environment, therefor it is not able to set session variables.

Register

• {(http|https)}://{USER_AUTH_APP_URL}/{app_path}/account/register/

  • method: post
  • description: registers a new user to the database
  • params: see config/validator.php

Login

• {(http|https)}://{USER_AUTH_APP_URL}/{app_path}/account/login/

  • method: post
  • description: tries to log user in
  • params: username, password
  • return data: user data

Logout

• {(http|https)}://{USER_AUTH_APP_URL}/{app_path}/account/logout/{code}/

  • method: put
  • description: removes user session data and autologin cookie

Forgot Password

• {(http|https)}://{USER_AUTH_APP_URL}/{app_path}/account/forgot-password/

  • description: send an email with a link to reset password
  • params: username

AutoLogin

• {(http|https)}://{USER_AUTH_APP_URL}/{app_path}/account/auto-login/{code}/

  • method: put
  • description: tries to log in with existing login_token
  • params: see config/validator.php
  • return data: returns user data

Verify Account

• {(http|https)}://{USER_AUTH_APP_URL}/{app_path}/account/verify/{verificationCode}/

  • method: put
  • description: tries to verify a user account

Change Password

• {(http|https)}://{USER_AUTH_APP_URL}/{app_path}/account/change-password/{resetLink}/

  • method: post
  • description: change user password
  • params: see config/validator.php