tlucas/liteauth

phpliteauth

Small authentication library for PHP, using SQLite as a database backend, _(*1)

Installation

composer require tlucas/liteauth

In the project file (e.g. project.php) you wish to use it in make sure you have, _(*2)

require_once('vendor/autoload.php');

Then initialise the authentication object with:, _(*3)

$auth = new liteAuth\liteAuth('path/to/my/auth_database.db');

(Of course, you can call the object anything, but for the rest of this readme, we will assume you called it $auth), _(*4)

Basic usage

User creation

The very first thing you will have to do, before logging in to liteAuth, is, of course, create a user., _(*5)

This is done using:, _(*6)

$auth->newUser($user, $pass, $email, $fname, $sname, $admin);

Only the $user and $pass parameters are required, the rest are optional., _(*7)

So, to give an example:, _(*8)

$auth->newUser('John', 'superstrongpassword');

We now have a user called John in the database, with the password superstrongpassword., _(*9)

(If newUser() is successful it returns the new user's id , otherwise, it returns False), _(*10)

(The other fields should be self-explanatory, with the posssible expception of the $admin. This is simply a True/False field, it has no special meaning within liteAuth, so you are free to use it however you will!), _(*11)

From a form

There is also included a helper method registerFromPost(), to allow for easy registration form creation., _(*12)

Place it at the target of a form, and it will look for the relevant post variables, to register a new user., _(*13)

For example, you might have a file register.php containing, _(*14)

$auth->registerFromPost();

And another file signup.html:, _(*15)

<form action="register.php" method="post">
<input type="text" name="user" placeholder="Username"><br>
<input type="text" name="fname" placeholder="First name"><br>
<input type="text" name="sname" placeholder="Surname"><br>
<input type="email" name="email" placeholder="Email Address"><br>
<input type="password" name="pass" placeholder="Password"><br>
<input type="password" name="pass2" placeholder="Password"><br>
<input type="checkbox" name="admin"> Admin?<br>
<input type="submit" value="Register">
</form>

The register.php will take the data from signup.html and create a new user corresponding to the input., _(*16)

BE CAREFUL: Anyone with access to the script calling registerFromPost() will be able to create a new user. Make sure this is only accessible by people who should have this authority!, _(*17)

One example would be to require an admin user to be logged in:, _(*18)

register.php:, _(*19)

if($auth->user->admin)
    $auth->registerFromPost();

Logging in

Logging in is very similar to creating a user, you have the login() method you can call:, _(*20)

$auth->login($user, $pass);

After which, if the password correctly matches the user, it will return True and populate $auth->user, _(*21)

The following properties are available on the user object, once logged in:, _(*22)

$auth->user->user       // User's username
$auth->user->first_name     // User's first name, if set
$auth->user->surname        // User's surname, if set
$auth->user->email      // User's email address, if set
$auth->user->admin      // If the user is set as an admin

There is also the special method, _(*23)

$auth->name()

Which returns either the user's human name (ie. 'Firstname surname' or 'Firstname'), or falls back to username., _(*24)

From a form

Just like with registration, there is a helper method for logging in from a form:, _(*25)

$auth->loginFromPost();

If you put that in, for example, login.php, the form at loginform.html:, _(*26)

<form action="login.php" method="post">
<input type="text" name="user" placeholder="Username"><br>
<input type="password" name="pass" placeholder="Password"><br>
<input type="submit" value="Login">
</form>

Will pass the appropriate values to sign in., _(*27)

Modifying a user

To modify an existing user, you can edit any of the accessible properties, listed above, for example, _(*28)

$auth->user->first_name = 'Stephen';

And then call, _(*29)

$auth->user->save();

And it will update the current user's first name to Stephen in the database., _(*30)

Other methods

$auth->countUsers();

Returns a count of users that exist in the database, _(*31)

$auth->existUsers();

Returns False if no users exist (This is useful to allow for 'first run' setup procedures), _(*32)