Overview

Namespaces

  • ModHelper
    • Exceptions

Classes

  • A
  • BitwiseFlag
  • Collection
  • Database
  • Editor
  • Hooks
  • Linktree
  • Menu
  • Nonce
  • Psr4AutoloaderClass
  • Verify

Traits

  • SingletonTrait
  • Overview
  • Namespace
  • Class

Class Nonce

Nonce, an anti CSRF token generation/checking class. Copyright (c) 2011 Thibaut Despoulain http://bkcore.com/blog/code/nocsrf-php-class.html

Namespace: ModHelper
Package: ModHelper
Copyright: Copyright (c) 2015 John Rayes
License: MIT
Version: 1.0
Located at Nonce.php
Methods summary
public
# __construct( string $key = null, integer $ttl = 900 )

Parameters

$key
The session and $origin key where to find the token.
$ttl
(Facultative) Makes the token expire after $this->ttl seconds. (null = never)
public boolean
# check( )

Check CSRF tokens match between session and $origin. Make sure you generated a token in the form before checking it.

Check CSRF tokens match between session and $origin. Make sure you generated a token in the form before checking it.

Returns

boolean
Returns FALSE if a CSRF attack is detected, TRUE otherwise.
public string
# getHash( )

Returns

string
public
# setKey( string $key )

Parameters

$key
public string
# getKey( )

Returns

string
public
# setTtl( integer $ttl )

Parameters

$ttl
public integer
# getTtl( )

Returns

integer
public string
# generate( )

CSRF token generator. After generating the token, put it inside a hidden form field named $this->key.

CSRF token generator. After generating the token, put it inside a hidden form field named $this->key.

Returns

string
The generated, base64 encoded token.
private string
# randomString( integer $length )

Generates a random string of given $length.

Generates a random string of given $length.

Parameters

$length
The string length.

Returns

string
The randomly generated string.
Properties summary
private string $hash
#
private string $key
#
private integer $ttl
# 900
API documentation generated by ApiGen