Overview

Packages

  • Auth
    • Ads
    • Ldap
    • Xoops
  • Autotasks
  • Config
    • Category
    • Item
    • Option
  • Core
    • Filesystem
    • Filters
    • Logger
    • Mail
    • Message
    • Password
    • Security
    • StopSpammer
    • Template
    • Textsanitizer
    • VersionChecker
  • Data
    • Avatar
    • Comment
  • Database
    • Connection
    • Criteria
    • Legacy
    • MySQL
    • PDO
    • Updater
  • Feeds
    • RSS
  • File
  • Form
    • Base
    • Elements
  • ICMS
    • IPF
      • View
  • Image
    • Category
  • Ipf
    • Category
    • Controller
    • Export
    • form
    • Keyhighlighter
    • Member
    • Object
    • Permission
    • richfile
    • Tree
    • urllink
    • View
  • kernel
    • Set
  • Member
    • Group
    • GroupMembership
    • GroupPermission
    • User
  • Messaging
  • Module
  • None
  • Notification
  • Page
  • Plugins
    • Editor
  • Preload
    • Libraries
  • Privmessage
  • Session
  • SmartObject
  • View
    • Block
    • Breadcrumb
    • PageNav
    • PrinterFriendly
    • Template
    • Templates
    • Theme
    • Tree

Classes

  • icms_core_Password
  • Overview
  • Package
  • Class

Class icms_core_Password

Password generation and validation

Final
Package: Core\Password
Category: ICMS
Copyright: (c) 2007-2010 The ImpressCMS Project - www.impresscms.org
License: GNU General Public License (GPL)
Author: vaughan montgomery (vaughan@impresscms.org)
Author: ImpressCMS Project
Located at core/Password.php
Methods summary
public
# __construct( )

Constructor for the Password class

Constructor for the Password class

public static object
# getInstance( )

Access the only instance of this class

Access the only instance of this class

Returns

object
public static string
# createSalt( string $slength = 64 )

This Function creates a unique random Salt Key for use with password encryptions It can also be used to generate a random AlphaNumeric key sequence of any given length.

This Function creates a unique random Salt Key for use with password encryptions It can also be used to generate a random AlphaNumeric key sequence of any given length.

Parameters

$slength
The length of the key to produce

Returns

string
returns the generated random key.

Copyright

(c) 2007-2008 The ImpressCMS Project - www.impresscms.org

Since

1.1
public string
# createCryptoKey( string $slength = 64 )

This Function creates a unique Crypto Generated Key for use with password encryptions This functions falls back to standard function createSalt() if PHP < 5.3

This Function creates a unique Crypto Generated Key for use with password encryptions This functions falls back to standard function createSalt() if PHP < 5.3

Parameters

$slength
The length of the key to produce

Returns

string
returns the generated random key.

Copyright

(c) 2007-2008 The ImpressCMS Project - www.impresscms.org

Since

1.3.3
public boolean
# passExpired( string $uname = '' )

This Public Function checks whether a users password has been expired

This Public Function checks whether a users password has been expired

Parameters

$uname
The username of the account to be checked

Returns

boolean
returns true if password is expired, false if password is not expired.

Copyright

(c) 2007-2008 The ImpressCMS Project - www.impresscms.org

Since

1.1
public string
# getUserSalt( string $uname = '' )

This Public Function returns the User Salt key belonging to username.

This Public Function returns the User Salt key belonging to username.

Parameters

$uname
Username to find User Salt key for.

Returns

string

returns the Salt key of the user.

To be removed in future versions

Copyright

(c) 2007-2008 The ImpressCMS Project - www.impresscms.org

Since

1.1
public string
# getUserEncType( string $uname = '' )

This Public Function returns the User Encryption Type belonging to username.

This Public Function returns the User Encryption Type belonging to username.

Parameters

$uname
Username to find Encryption Type for.

Returns

string

returns the Encryption Type of the user.

to be removed in future versions

Copyright

(c) 2007-2008 The ImpressCMS Project - www.impresscms.org

Since

1.1
public Hash
# encryptPass( string $pass )

This Public Function is used to Encrypt User Passwords

This Public Function is used to Encrypt User Passwords

Parameters

$pass
plaintext password to be encrypted

Returns

Hash
of users password.

Copyright

(c) 2007-2008 The ImpressCMS Project - www.impresscms.org

Since

1.1
public mixed
# verifyPass( string $pass = '', string $uname = '' )

This Public Function verifies if the users password is correct.

This Public Function verifies if the users password is correct.

Parameters

$pass
$uname Username to verify.
$uname
$pass Password to verify.

Returns

mixed
returns Hash if correct, returns false if incorrect.

Copyright

(c) 2007-2008 The ImpressCMS Project - www.impresscms.org

Since

1.3.3
API documentation generated by ApiGen