SproutCMS

class Auth

Provides user authentication functions for the admin

• File: /sprout/Helpers/Auth.php
• Namespace: Sprout\Helpers

Extending this class

<?php
/**
* New class description goes here
* 
* @author Your Name, 2024-11-25
**/
class NewClassName extends Auth {
    
    /**
    * Check a password hash against an entered password
    **/
    public function doPasswordCheck (string $known_hash, int $algorithm, string $salt, string $user_string) {
        // Method code goes here
    }
    
    /**
    * Return the algorithm for new accounts.
    * Existing accounts will be re-crypted into this algorithm upon next login.
    **/
    public function defaultAlgorithm () {
        // Method code goes here
    }
    
    /**
    * Return a hashed password, password algorithm, and salt, for inserting into the database
    **/
    public function hashPassword (string $password, int $algorithm) {
        // Method code goes here
    }
    
    /**
    * Checks if a given password algorithm is available
    **/
    public function checkAlgorithm (int $algorithm) {
        // Method code goes here
    }
    
}
?>