<?php
/**
 * This source file is part of the open source project
 * ExpressionEngine (https://expressionengine.com)
 *
 * @link      https://expressionengine.com/
 * @copyright Copyright (c) 2003-2022, Packet Tide, LLC (https://www.packettide.com)
 * @license   https://expressionengine.com/license Licensed under Apache License, Version 2.0
 */

/**
 * CSRF backend storage interface
 */
interface Csrf_storage_backend
{
    /**
     * Get the token expiration time
     *
     * @return int The token expiration in seconds
     */
    public function get_expiration();

    /**
     * Store a new token for the user
     *
     * @param $token String New token to store
     * @return void
     */
    public function store_token($token);

    /**
     * Delete the user's current token
     *
     * @return void
     */
    public function delete_token();

    /**
     * Fetch the user's token
     *
     * @return string Current user token
     */
    public function fetch_token();
}
