valkyriweb/wp-remote-auth

A composer package to be able to login / register on a remote endpoint and receive an authorization token which is then stored in a table and can be called and referenced by the application implementing the authToken class

v1.0.6.4 2024-04-14 17:19 UTC

Requires

• php: >=8.2
• composer-plugin-api: ^2.3.0
• guzzlehttp/guzzle: ^7.0

Requires (Dev)

• pestphp/pest: 2.x-dev

MIT

• Luke Anthony Seeber

README

This package provides a simple way to generate and validate authentication tokens using PHP, mainly used for my own projects, but thought it may be useful for other PHP developers out there, contributions welcome.

Current Version: 1.0.6.4

Installation

Install the latest version with

$ composer require valkyriweb/wp-remote-auth

Basic Usage

<?php
    
    use ValkyriWeb\WPRemoteAuth\WPRemoteAuth;
    use ValkyriWeb\WPRemoteAuth\WordPress\RegisterAjaxEndpoints;

    $token = new WPRemoteAuth();
    
    // Initialise the Class
    $args = [
        'wordpress' => true,
        'remote_login_url' => 'http://' . $baseUrl . '/api/login',
        'remote_register_url' => 'http://' . $baseUrl . '/api/register',
        'remote_logout_url' => 'http://' . $baseUrl . '/api/logout',
    ];
    
    $token->init($args);
    (new RegisterAjaxEndpoints())();
    
    // Generate a token using existing user and store it in the session / database
    $args = [
        'username' => 'test',
        'password' => 'test',
    ];
    
    $token->login($args);
    
    // Generate a token and store it in the session / database
    $args = [
        'name' => 'test',
        'email' => 'test',
        'password' => 'test',
    ];
    
    $token->register($args);
    
    $token->logout();
    
    // Save Token
    $token = $token->generate();
    $user_id = 'wordpress_user_id';
    
    $token->saveToken($token);
    
    // Check if token exists in DB
    // Returns True or False
    $token->checkTokenExists();
    
    // Generate a token
    // Returns a token
    $token->generate();
    
    // Validate a token
    $token->validate($token);

Testing

$ composer test

Changelog

Please see CHANGELOG for more information on what has changed recently.