Git Product home page Git Product logo

osmo-auth's Introduction

Osmo Auth

Authentication for PHP 8. Secure and easy.

Total Downloads Latest Stable Version License

Requirements

  • PHP 8.0+ (php 8)
  • PDO (PHP Data Objects) extension (pdo)
  • MySQL 5.6+ or MariaDB 5.5.23+ or PostgreSQL 9.5.10+

Installation

  1. Include the library via Composer:

    $ composer require osmo/auth
    
  2. Include the Composer autoloader:

    require __DIR__ . '/vendor/autoload.php';
  3. Set up a database and create the required tables:

Usage

Connect to database

The three required data are the name of the database, the username and password. If your table is not named users, please specify it in array or use the setTable method.

$con = new Osmo\Database([
    'username' => 'root',
    'database' => 'system',
    'password' => 'password'
  //'table'    => 'users_system' 
]);
//Default value {users}
//$con->setTable('users_table');

Create and configure a new instance

To configure the instance, you must pass two parameters, $connection and an array[] with the two fields in the database to be validated.

$auth = new Osmo\Auth($con, ['email', 'password']);

Config login

In case the data is incorrect. The make() function will return a redirect to the same path where the $_POST method was executed.

if ($auth->isPost()) {
    $auth->make($auth->inputEmailAddress(), $auth->input('password'), 'md5');
}

Methods to verify passwords

  • md5
  • sha1
  • crypt
  • password_verify (default verification)
$auth->make($auth->input('email'), $auth->input('password'), 'crypt');

To use the password_verify() method, leave the third parameter blank.

$auth->make($auth->input('email'), $auth->input('password'));

Redirect on successful login

To redirect user, you need pass the callback function:

$auth->make($auth->inputEmailAddress(), $auth->input('password'), 'md5', function (){
    Osmo\Response::redirect('/');
});

Verify user login

You can check if a user is logged in, with the following function:

if(Osmo\SessionManager::auth()) {
    //
}

Clean user session

To clean up the sessions, you need to run the following function:

Osmo\SessionManager::destroy();

osmo-auth's People

Contributors

mateoagudelo avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.