Index | Nette Security API

A

AuthenticationException — Class in namespace Nette\Security: Authentication exception.
Authenticator — Class in namespace Nette\Security: Performs authentication.
Authenticator::authenticate() — Method in class Authenticator: Performs an authentication.
Authorizator — Class in namespace Nette\Security: Checks whether a given role has access to a given resource.
IIdentity::array() — Method in class IIdentity
Permission::addRole() — Method in class Permission: Adds a Role to the list. The most recently added parent takes precedence over parents that were previously added.
Permission::addResource() — Method in class Permission: Adds a Resource to the list.
Permission::allow() — Method in class Permission: Allows one or more Roles access to [certain $privileges upon] the specified Resource(s).
SimpleAuthenticator::authenticate() — Method in class SimpleAuthenticator: Authenticates against the in-memory list of users (case-insensitive username).
$ User#authenticatedRole — Property in class User: default role for authenticated user without own identity

B

SecurityExtension::beforeCompile() — Method in class SecurityExtension

C

CookieIdentity — Class in namespace Nette\Bridges\SecurityHttp: Identity used by CookieStorage
CookieStorage — Class in namespace Nette\Bridges\SecurityHttp: Cookie storage for Nette\Security\User object.
CookieStorage::clearAuthentication() — Method in class CookieStorage: Removes authenticated state from storage.
SessionStorage::clearAuthentication() — Method in class SessionStorage: Removes authenticated state from storage.
UserStorage::clearAuthentication() — Method in class UserStorage: Removes authenticated state from storage.

D

Permission::deny() — Method in class Permission: Denies one or more Roles access to [certain $privileges upon] the specified Resource(s).
$ SimpleIdentity#data — Property in class SimpleIdentity

G

SecurityExtension::getConfigSchema() — Method in class SecurityExtension
CookieIdentity::getId() — Method in class CookieIdentity: Returns the ID of user.
CookieIdentity::getRoles() — Method in class CookieIdentity
CookieIdentity::getData() — Method in class CookieIdentity
CookieStorage::getState() — Method in class CookieStorage: Returns user authenticated state, identity and logout reason.
SessionStorage::getState() — Method in class SessionStorage: Returns user authenticated state, identity and logout reason.
SessionStorage::getNamespace() — Method in class SessionStorage: Returns current namespace.
UserPanel::getTab() — Method in class UserPanel: Renders tab.
UserPanel::getPanel() — Method in class UserPanel: Renders panel.
IIdentity::getId() — Method in class IIdentity: Returns the ID of user.
IIdentity::getRoles() — Method in class IIdentity: Returns a list of roles that the user is a member of.
IdentityHandler::getGuestIdentity() — Method in class IdentityHandler: Returns the identity for an anonymous (not logged-in) user, or null if none.
Permission::getRoles() — Method in class Permission: Returns all Roles.
Permission::getRoleParents() — Method in class Permission: Returns existing Role's parents ordered by ascending priority.
Permission::getResources() — Method in class Permission: Returns all Resources.
Permission::getQueriedRole() — Method in class Permission: Returns the role currently being queried. Used by assertion callbacks.
Permission::getQueriedResource() — Method in class Permission: Returns the resource currently being queried. Used by assertion callbacks.
Resource::getResourceId() — Method in class Resource: Returns a string identifier of the Resource.
Role::getRoleId() — Method in class Role: Returns a string identifier of the Role.
SimpleIdentity::getId() — Method in class SimpleIdentity: Returns the ID of user.
SimpleIdentity::getRoles() — Method in class SimpleIdentity: Returns a list of roles that the user is a member of.
SimpleIdentity::getData() — Method in class SimpleIdentity: Returns user data.
$ User#guestRole — Property in class User: role for an unauthenticated user, unless a guest identity provides its own roles
User::getStorage() — Method in class User
User::getIdentity() — Method in class User: Returns the user identity. When not logged in, this is the retained identity (unless $persistIdentity is disabled) or a guest identity if the authenticator provides one; null otherwise.
User::getId() — Method in class User: Returns the ID of the identity returned by getIdentity(), so it may be the retained or guest identity's ID even when not logged in; null if there is no identity.
User::getAuthenticator() — Method in class User: Returns authentication handler.
User::getAuthenticatorIfExists() — Method in class User: Returns authentication handler, or null if none is set.
User::getLogoutReason() — Method in class User: Returns the logout reason: LogoutManual or LogoutInactivity, or null if not applicable.
User::getRoles() — Method in class User: Returns effective roles derived from the login state, not from the (possibly retained) identity.
User::getAuthorizator() — Method in class User: Returns current authorization handler.
User::getAuthorizatorIfExists() — Method in class User: Returns authorization handler, or null if none is set.
UserStorage::getState() — Method in class UserStorage: Returns user authenticated state, identity and logout reason.

H

Passwords::hash() — Method in class Passwords: Computes a password hash containing the algorithm ID, settings, salt, and the hash itself.
Permission::hasRole() — Method in class Permission: Checks whether the Role exists in the list.
Permission::hasResource() — Method in class Permission: Checks whether the Resource exists in the list.
User::hasAuthenticator() — Method in class User
User::hasAuthorizator() — Method in class User

I

Authorizator::isAllowed() — Method in class Authorizator: Performs a role-based authorization.
IAuthorizator — Class in namespace Nette\Security
IIdentity — Class in namespace Nette\Security: Represents the user of application.
IResource — Class in namespace Nette\Security
IRole — Class in namespace Nette\Security
Identity — Class in namespace Nette\Security
IdentityHandler — Class in namespace Nette\Security: Serializes and restores identity to/from persistent storage.
Permission::isAllowed() — Method in class Permission: Returns true if and only if the Role has access to [certain $privileges upon] the Resource.
$ SimpleIdentity#id — Property in class SimpleIdentity
$ User#identity — Property in class User
User::isLoggedIn() — Method in class User: Checks whether the user is authenticated.
User::isInRole() — Method in class User: Checks whether the user has the specified effective role.
User::isAllowed() — Method in class User: Checks whether the user has access to the given resource and privilege.

L

SecurityExtension::loadConfiguration() — Method in class SecurityExtension
$ User#loggedIn — Property in class User
User::login() — Method in class User: Authenticates the user. Accepts username and password, or an IIdentity directly.
User::logout() — Method in class User: Logs out the user from the current session. The identity is kept available afterwards, unless $clearIdentity is set or the $persistIdentity property is disabled.

N

Passwords::needsRehash() — Method in class Passwords: Checks whether the hash needs to be rehashed with the current algorithm and options.

O

$ User#onLoggedIn — Property in class User
$ User#onLoggedOut — Property in class User

P

Passwords — Class in namespace Nette\Security: Password hashing and verification.
Permission — Class in namespace Nette\Security: Access control list (ACL) functionality and privileges management.
$ User#persistIdentity — Property in class User: keep identity available (via getIdentity() and getId()) after logout or expiration; depends on the storage implementation

R

Permission::roleInheritsFrom() — Method in class Permission: Returns true if $role inherits from $inherit. If $onlyParents is true, then $role must inherit directly from $inherit.
Permission::removeRole() — Method in class Permission: Removes the Role from the list.
Permission::removeAllRoles() — Method in class Permission: Removes all Roles from the list.
Permission::resourceInheritsFrom() — Method in class Permission: Returns true if $resource inherits from $inherit. If $onlyParent is true, then $resource must inherit directly from $inherit.
Permission::removeResource() — Method in class Permission: Removes a Resource and all of its children.
Permission::removeAllResources() — Method in class Permission: Removes all Resources.
Permission::removeAllow() — Method in class Permission: Removes "allow" permissions from the list in the context of the given Roles, Resources, and privileges.
Permission::removeDeny() — Method in class Permission: Removes "deny" restrictions from the list in the context of the given Roles, Resources, and privileges.
Resource — Class in namespace Nette\Security: Represents a resource to which access is controlled.
Role — Class in namespace Nette\Security: Represents a role that can be granted access to resources.
$ SimpleIdentity#roles — Property in class SimpleIdentity
User::refreshStorage() — Method in class User: Discards the cached authentication state and identity, forcing a reload on next access.

S

SecurityExtension — Class in namespace Nette\Bridges\SecurityDI: Security extension for Nette DI.
CookieStorage::saveAuthentication() — Method in class CookieStorage: Saves authenticated identity to storage.
CookieStorage::setExpiration() — Method in class CookieStorage: Enables log out from the persistent storage after inactivity (like '20 minutes').
CookieStorage::setCookieParameters() — Method in class CookieStorage
SessionStorage — Class in namespace Nette\Bridges\SecurityHttp: Session storage for Nette\Security\User object.
SessionStorage::saveAuthentication() — Method in class SessionStorage: Saves authenticated identity to storage.
SessionStorage::setExpiration() — Method in class SessionStorage: Enables log out from the persistent storage after inactivity (like '20 minutes').
SessionStorage::setNamespace() — Method in class SessionStorage: Changes namespace; allows more users to share a session.
IdentityHandler::sleepIdentity() — Method in class IdentityHandler: Called before identity is written to storage. Typically replaces the full identity with a lightweight token.
Permission::setRule() — Method in class Permission: Performs operations on Access Control List rules.
SimpleAuthenticator — Class in namespace Nette\Security: Trivial implementation of Authenticator.
SimpleIdentity — Class in namespace Nette\Security: Default implementation of IIdentity.
SimpleIdentity::setId() — Method in class SimpleIdentity: Sets the ID of user.
SimpleIdentity::setRoles() — Method in class SimpleIdentity: Sets a list of roles that the user is a member of.
User::setAuthenticator() — Method in class User: Sets authentication handler.
User::setExpiration() — Method in class User: Enables log out after inactivity (like '20 minutes'). The identity is kept available afterwards, unless $clearIdentity is set or the $persistIdentity property is disabled.
User::setAuthorizator() — Method in class User: Sets authorization handler.
UserStorage::saveAuthentication() — Method in class UserStorage: Saves authenticated identity to storage.
UserStorage::setExpiration() — Method in class UserStorage: Enables log out from the persistent storage after inactivity (like '20 minutes').

U

UserPanel — Class in namespace Nette\Bridges\SecurityTracy: User panel for Debugger Bar.
User — Class in namespace Nette\Security: User authentication and authorization.
UserStorage — Class in namespace Nette\Security: Persistent storage for user authentication state and identity.

V

Passwords::verify() — Method in class Passwords: Checks whether the password matches the given hash.
SimpleAuthenticator::verifyPassword() — Method in class SimpleAuthenticator

W

IdentityHandler::wakeupIdentity() — Method in class IdentityHandler: Called after identity is read from storage. Typically refreshes roles or validates the token. Returns null to force logout.

_

SecurityExtension::__construct() — Method in class SecurityExtension
CookieIdentity::__construct() — Method in class CookieIdentity
CookieStorage::__construct() — Method in class CookieStorage
SessionStorage::__construct() — Method in class SessionStorage
UserPanel::__construct() — Method in class UserPanel
Passwords::__construct() — Method in class Passwords: Configures the hashing algorithm and its options.
SimpleAuthenticator::__construct() — Method in class SimpleAuthenticator
SimpleIdentity::__construct() — Method in class SimpleIdentity
SimpleIdentity::__set() — Method in class SimpleIdentity: Sets user data value.
SimpleIdentity::__get() — Method in class SimpleIdentity: Returns user data value.
SimpleIdentity::__isset() — Method in class SimpleIdentity
SimpleIdentity::__serialize() — Method in class SimpleIdentity
SimpleIdentity::__unserialize() — Method in class SimpleIdentity
User::__construct() — Method in class User