Dsao_Hash Klassenreferenz

Repräsentiert einen Hash. Mehr ...

Klassendiagramm für Dsao_Hash:

Aufstellung aller Elemente

Öffentliche Methoden
	__toString ()
	Wandelt Hash in String um.
	compareTo (Dsao_Hash $hash)
	Hash-Vergleich.
	getAlgorithm ()
	Gibt dem verwendeten Algorithmus zurück.
	getHash ($length=0)
	Gibt den aktuellen Hash, gekürzt oder ungekürzt, zurück.
	getLength ($trueLength=false)
	Länge des Hashes, bzw.
	isReadOnly ($throw=false)
	Gibt zurück, ob Objekt schreibgeschützt ist.
	setAlgorithm ($algorithm)
	Festsetzung des Verschluesselungsalgorithmus.
	setHash ($hash=null, $fromText=false)
	Legt den Hash fest.
	setLength ($length=0)
	Setzt Länge, auf die der Hash bei der Rückgabe gekürzt werden soll.
	setReadOnly ($readOnly=true)
	Setzt den Hash auf schreibgeschützt.
Öffentliche, statische Methoden
static	factory ($hash=null, $length=0)
	Erstellt einen neuen Hash.
static	fromText ($text=null, $length=0)
	Klartextentgegenname und Hashbildung.
Geschützte Methoden
	__construct ($hash=null, $length=0, $algorithm=null)
	Hash-Konstrukt.
	_generateHash ($text=null)
	Generiert einen (zufälligen) Hash.
Geschützte, statische Methoden
static	_isHashInstalled ()
	Prüft, ob Funktion hash() verfügbar ist.
Geschützte Attribute
	$_algorithm = 'md5'
	string, Benutzter Algorithmus
	$_hash = null
	string, Hash
	$_length = 0
	int, Laenge, auf die der Hash bei Rueckgabe gekürzt werden soll, bei 0 wird er nicht gekürzt
	$_readOnly = false
	bool, ob Objekt schreibgeschützt ist
Statische geschützte Attribute
static	$_hashInstalled = true
	bool, ob PHP mit Hash-Unterstützung kompiliert wurde

---

Ausführliche Beschreibung

Repräsentiert einen Hash.

Autor:

DSAo-Md

http://www.gnu.org/licenses/gpl-3.0.html GNU Public License

Version:

SVN: $Id: Hash.php 519 2009-09-13 15:51:26Z saviola777 $

Definiert in Zeile 9 der Datei Hash.php.

---

Beschreibung der Konstruktoren und Destruktoren

Dsao_Hash::__construct	(	$	hash = null,
		$	length = 0,
		$	algorithm = null
	)			[protected]

Hash-Konstrukt.

Parameter:

	$hash	string, Hash
	$length	int, Länge, auf die gekürzt werden soll
	$algorithm	string, Algorithmus

Rückgabe:

void

Definiert in Zeile 45 der Datei Hash.php.

Benutzt Dsao_Registry::get(), setAlgorithm(), setHash() und setLength().

  {
    // Falls kein Algorithmus übergeben wurde, Standardalgorithmus wählen
    if (null === $algorithm)
    {
      $algorithm = Dsao_Registry::get('config')->encryption->hashAlgorithm;
    }

    // Werte setzen
    $this->setAlgorithm($algorithm);
    $this->setHash($hash);
    $this->setLength($length);
  }

---

Dokumentation der Elementfunktionen

Dsao_Hash::__toString

(

)

Wandelt Hash in String um.

Rückgabe:

string Hash

Erneute Implementation in Dsao_Hash_Password.

Definiert in Zeile 64 der Datei Hash.php.

Benutzt getHash().

  {
    return $this->getHash();
  }

Dsao_Hash::_generateHash

(

$

text = null

)

[protected]

Generiert einen (zufälligen) Hash.

Parameter:

$text

string, Text, aus dem Hash erzeugt werden soll

Rückgabe:

void

Definiert in Zeile 75 der Datei Hash.php.

Benutzt _isHashInstalled().

Wird benutzt von Dsao_Hash_Password::_generatePassword() und setHash().

  {
    $text = (null === $text ? uniqid(mt_rand(), true) : $text);

    $this->_hash = (self::_isHashInstalled() ?
      hash($this->_algorithm, $text) :
        call_user_func($this->_algorithm, $text));
  }

static Dsao_Hash::_isHashInstalled

(

)

[static, protected]

Prüft, ob Funktion hash() verfügbar ist.

Rückgabe:

bool, Ob hash() vorhanden ist

Definiert in Zeile 89 der Datei Hash.php.

Wird benutzt von _generateHash().

  {
    if (null === self::$_hashInstalled)
    {
      self::$_hashInstalled = (function_exists('hash') ? true : false);
    }

    return self::$_hashInstalled;
  }

Dsao_Hash::compareTo

(

Dsao_Hash $

hash

)

Hash-Vergleich.

Vergleicht den Hash mit einem anderen, wobei der fremde Hash mindestens genauso lang sein muss, aber länger sein darf (überstehendes wird abgeschnitten). Dies ist z.B. nützlich, wenn in der Datenbank nicht genügend Platz für einen SHA1-Hash ist, somit also z.B. nur die ersten 20 Zeichen gespeichert werden. Dann werden einfach nur die ersten 20 Zeichen des zu prüfenden Hashes verglichen

Parameter:

$hash

Dsao_Hash, Zu vergleichender Hash

Rückgabe:

bool Ob Hashes 'gleich' oder nicht

Definiert in Zeile 112 der Datei Hash.php.

Benutzt getHash().

  {
    return ($this->getHash() == $hash->getHash($this->getLength()));
  }

static Dsao_Hash::factory	(	$	hash = null,
		$	length = 0
	)			[static]

Erstellt einen neuen Hash.

Parameter:

	$hash	string, Hash
	$length	int, Länge des Hashes

Rückgabe:

Dsao_Hash, Hash-Objekt

Erneute Implementation in Dsao_Hash_Password.

Definiert in Zeile 124 der Datei Hash.php.

Wird benutzt von Dsao_Uri_Http::setToken().

  {
    return new self($hash, $length);
  }

static Dsao_Hash::fromText	(	$	text = null,
		$	length = 0
	)			[static]

Klartextentgegenname und Hashbildung.

Nimmt Klartext entgegen und bildet daraus den Hash. Der Klartext wird nicht gespeichert.

Parameter:

	$text	string, Klartext
	$length	int, Länge des Hashes (!)

Rückgabe:

Dsao_Hash, Hash

Definiert in Zeile 139 der Datei Hash.php.

Wird benutzt von Dsao_Model_User_Profile::_editPassword().

  {
    // Hash erstellen
    $hash = new self(null, $length);

    // Hash generieren und setzen
    $hash->_generateHash($text);

    return $hash;
  }

Dsao_Hash::getAlgorithm

(

)

Gibt dem verwendeten Algorithmus zurück.

Rückgabe:

string Algorithmus

Definiert in Zeile 155 der Datei Hash.php.

  {
    return $this->_algorithm;
  }

Dsao_Hash::getHash

(

$

length = 0

)

Gibt den aktuellen Hash, gekürzt oder ungekürzt, zurück.

Parameter:

$length

int, Länge, auf die gekürzt werden soll; null = Wert aus Klasse, 0 = vollständiger Hash

Rückgabe:

string, Hash

Definiert in Zeile 167 der Datei Hash.php.

Wird benutzt von __toString(), Dsao_Hash_User::_findRow(), compareTo() und Dsao_Hash_User::insert().

  {
    // Falls ganzer String zurückgegeben werden soll, oder in Klasse keine
    // Länge definiert wurde
    if (0 === $length || (!$length && !$this->_length))
    {
      return $this->_hash;
    }
    // Falls keine Länge definiert wurde, die aus Klasse nehmen
    else if (!$length)
    {
      $length = $this->_length;
    }

    // Gekürzten Hash zurückgeben
    return substr($this->_hash, 0, $length);
  }

Dsao_Hash::getLength

(

$

trueLength = false

)

Länge des Hashes, bzw.

Länge, auf den er gekürzt werden soll, zurück geben.

Parameter:

$trueLength

bool, Ob wahre Länge des Hashes zurück gegeben werden soll

Rückgabe:

int, Länge des Hashes

Definiert in Zeile 191 der Datei Hash.php.

  {
    // Falls wahre Länge zurück gegeben werden soll, oder Hash eh nicht gekürzt
    // werden sollte
    if ($trueLength || !$this->_length)
    {
      return strlen($this->_hash);
    }

    return $this->_length;
  }

Dsao_Hash::isReadOnly

(

$

throw = false

)

Gibt zurück, ob Objekt schreibgeschützt ist.

Parameter:

$throw

bool, Ob ggf. eine Exception geworfen werden soll

Rückgabe:

bool, ob Objekt schreibgeschützt ist

Definiert in Zeile 209 der Datei Hash.php.

Wird benutzt von Dsao_Hash_User::__set(), Dsao_Hash_User::hasDuplicates(), setAlgorithm(), setHash() und setLength().

  {
    if (true === $throw && true === $this->_readOnly)
    {
      throw new Dsao_Exception('dsao_hash_object_readonly');
    }

    return (bool) $this->_readOnly;
  }

Dsao_Hash::setAlgorithm

(

$

algorithm

)

Festsetzung des Verschluesselungsalgorithmus.

Legt einen Verschlüsselungsalgorithmus fest. Eine Änderung des Algorithmus bewirkt keine Änderung des Hashes, dieser muss erst neu generiert werden

Parameter:

$algorithm

string, Algorithmus

Rückgabe:

Dsao_Hash, fließendes Interface

Definiert in Zeile 228 der Datei Hash.php.

Benutzt isReadOnly().

Wird benutzt von __construct().

  {
    // Falls Objekt schreibgeschützt ist wird eine Exception geworfen
    $this->isReadOnly(true);

    // Falls Hash-Funktionen verfügbar
    if (self::_isHashInstalled())
    {
      // Algorithmus gültig?
      if (in_array($algorithm, hash_algos()))
      {
        $this->_algorithm = $algorithm;
      }
    }
    // Ansonsten schauen, ob Funktion selber vorhanden (md5(), sha1(), crc32()
    // usw.)
    else
    {
      if (function_exists($algorithm))
      {
        $this->_algorithm = $algorithm;
      }
    }

    return $this;
  }

Dsao_Hash::setHash	(	$	hash = null,
		$	fromText = false
	)

Legt den Hash fest.

Wird nichts übergeben, so wird ein neuer generiert. Durch den zweiten Parameter kann auch Klartext verschlüsselt werden.

Parameter:

	$hash	string, Hash
	$fromText	bool, ob Klartext übergeben wurde

Rückgabe:

Dsao_Hash Fließendes Interface

Definiert in Zeile 265 der Datei Hash.php.

Benutzt _generateHash() und isReadOnly().

Wird benutzt von __construct().

  {
    // Falls Objekt schreibgeschützt ist wird eine Exception geworfen
    $this->isReadOnly(true);

    // Falls kein Hash übergeben wurde, zufälligen generieren
    if (null === $hash || $fromText)
    {
      $this->_generateHash(($fromText ? $hash : null));
    }
    else
    {
      $this->_hash = $hash;
    }

    return $this;
  }

Dsao_Hash::setLength

(

$

length = 0

)

Setzt Länge, auf die der Hash bei der Rückgabe gekürzt werden soll.

Parameter:

$length

int, Länge; 0 = ungekürzt

Rückgabe:

Dsao_Hash Fließendes Interface

Definiert in Zeile 289 der Datei Hash.php.

Benutzt isReadOnly().

Wird benutzt von __construct().

  {
    // Falls Objekt schreibgeschützt ist wird eine Exception geworfen
    $this->isReadOnly(true);

    $this->_length = $length;

    return $this;
  }

Dsao_Hash::setReadOnly

(

$

readOnly = true

)

Setzt den Hash auf schreibgeschützt.

Parameter:

$readOnly

bool, schreibgeschützt

Rückgabe:

Dsao_Hash, fließendes Interface

Definiert in Zeile 305 der Datei Hash.php.

  {
    $this->_readOnly = (bool) $readOnly;

    return $this;
  }

---

Die Dokumentation für diese Klasse wurde erzeugt aufgrund der Datei:

• /var/www/devel.dsao.eu/library/Dsao/Hash.php