Autenticación¶

action¶

action (string $action = ':controller/:action')

Si estas usando ACOs como parte de tu estructura ACL, puedes obtener la ruta al nodo del ACO que está enlazado a un par controlador/acción particular.

$acoNode = $this->Auth->action('users/delete');

Si no le pasas valores, utilizará el par controlador/acción actual (el que se está ejecutando).

allow¶

Si tienes acciones en tu controlador que no necesitas que se autentiquen contra ellas (como una acción de registro de usuarios), puedes agregar métodos que debe ignorar AuthComponent. El siguiente ejemplo muestra como permitir una acción llamada “register”.

function beforeFilter() {
    ...
    $this->Auth->allow('register');
}

Si deseas permitir que múltiples acciones no usen autenticación, las pasas como parámetros al método allow():

function beforeFilter() {
    ...
    $this->Auth->allow('foo', 'bar', 'baz');
}

Atajo: también puedes permitir todas las acciones en un controlador usando “*”.

function beforeFilter() {
    ...
    $this->Auth->allow('*');
}

Si estás usando requestAction en tu layout o en tus elementos, deberías permitir esas acciones para poder abrir la página de login correctamente.

El componente auth supone que tus nombres de acciones siguen las convenciones y usan guiones bajos.

deny¶

Habrá algunas veces que quieras eliminar acciones de la lista de acciones permitidas (añadidas usando $this->Auth->allow()). He aquí un ejemplo:

function beforeFilter() {
    $this->Auth->authorize = 'controller';
    $this->Auth->allow('delete');
}

function isAuthorized() {
    if ($this->Auth->user('role') != 'admin') {
        $this->Auth->deny('delete');
    }

    ...
}

hashPasswords¶

hashPasswords ($data)

Este método verifica si $data contiene los campos nombre de usuario(username) y contraseña(password), tal y como está especificado en la variable $fields indexados por el nombre del modelo especificado en $userModel. Si el array $data contiene el nombre de usuario y la contraseña, realiza el hash del campo contraseña en el array y devuelve el array $data con el mismo formato. Esta función debe ser usada antes de realizar llamadas de inserción o actualización de los datos del usuario cuando afecta al campo contraseña.

$data['User']['username'] = '[email protected]';
$data['User']['password'] = 'changeme';
$hashedPasswords = $this->Auth->hashPasswords($data);
pr($hashedPasswords);
/* devuelve:
Array
(
    [User] => Array
    (
        [username] => [email protected]
        [password] => 8ed3b7e8ced419a679a7df93eff22fae
    )
)

*/

En el campo $hashedPasswords[“User”][“password”] ahora debería ser realizado el “hash” usando el método password del componente.

Si tu controlador usa el compoente Auth y los datos recibidos por POST contienen los campos explicados arriba, automáticamente realizará el hash al campo contraseña usando esta función.

mapActions¶

Si estás utilizando Acl en modo CRUD, tal vez desees asignar ciertas acciones no predeterminadas a cada parte de CRUD.

$this->Auth->mapActions(
    array(
        'create' => array('ciertaAccion'),
        'read' => array('ciertaAccion', 'ciertaAccion2'),
        'update' => array('ciertaAccion'),
        'delete' => array('ciertaAccion')
    )
);

login¶

login($data = null)

Si estás haciendo algún tipo de login basada en Ajax, puedes usar este método para identificar manualmente a alguien en el sistema. Si no pasas ningún valor para $data, automáticamente usará los datos enviados mediante POST al controlador.

Por ejemplo, en una aplicación tal vez desees asignar a un usuario una contraseña y autoidentificarlo en el sistema tras el registro. En un ejemplo muy simplificado:

Vista:

echo $form->create('User',array('action'=>'registrar'));
echo $form->input('username');
echo $form->end('Regístrame');

Controlador:

function registrar() {
    if(!empty($this->data)) {
        $this->User->create();
        $contrasena_asignada = "ConTr4senna";
        $this->data['User']['password'] = $contrasena_asignada;
        if($this->User->save($this->data)) {
            // enviar el email de registro conteniendo la contraseña al nuevo usuario
            $this->Auth->login($this->data);
            $this->redirect("inicio");
    }
}

Una cosa a remarcar es que has de redirigir manualmente al usuario tras el login ya que no se invoca loginRedirect().

$this->Auth->login($data) devuelve 1 tras un login exitoso, 0 en caso de fallo.

logout¶

Provee de una manera rápida de “deautenticar” a alguien y redirigirlo a donde necesite ir. Este método también es útil si deseas proporcionar un enlace “Cerrar sesión” dentro de una sección para usuarios registrados de tu aplicación.

Ejemplo:

$this->redirect($this->Auth->logout());

password¶

password (string $password)

Pásale una cadena de texto, y obtendrás la contraseña “hasheada”. Esta es una funcionalidad esencial si estás creando una pantala de registro de usuario donde los usuarios han de insertar sus contraseñas una segunda vez para confirmarlas. if ($this->data[“User”][“password”] == $this->Auth->password($this->data[“User”][“password2”])) { // Las contraseñas concuerdan, continuar procesando … } else { $this->flash(“Las contraseñas introducidas no concuerdan”, “users/registrar”); }

El componente Auth automáticamente aplicará el hash al campo contraseña (password) si también está presente el campo nombre de usuario (username) en los datos recibidos en la petición.

Cake añade tu cadena contraseña a un valor salt y después realiza el hash. La función de hash utilizada depende de la seleccionada por la clase utilidad del núcleo Security (sha1 por defecto). Puedes utilizar la función Security::setHash para cambiar el método para calcular el hash. El valor salt es el indicado en la configuración de tu aplicación definido en tu core.php.

user¶

user(string $key = null)

Este método proporciona información sobre el usuario actualmente identificado. La información es tomada de la sesión. Por ejemplo:

if ($this->Auth->user('rol') == 'admin') {
    $this->flash('Tienes acceso de administrador');
}

También puede ser usado para obtener todos los datos de sesión del usuario así:

$data['User'] = $this->Auth->user();

Si este método devuelve null es que el usuario no se ha identificado (logged in).

En la vista puedes utilizar el helper Session para obtener la información del usuario actualmente autenticado:

$session->read('Auth.User'); // devuelve el registro completo del usuario
$session->read('Auth.User.nombre') //devuelve el valor particular de un campo

La clave de la sesión puede ser diferente dependiendo de qué modelo se ha configurado para ser utilizado por Auth. P.e., si usas el modelo Cuenta en vez de User, entonces la clave de sesión sería Auth.Cuenta.

userModel¶

¿No deseas utilizar un modelo User contra el que autenticar? No hay problema. Simplemente cámbialo configurando este valor con el nombre del modelo que deseas usar.

<?php
    $this->Auth->userModel = 'Miembro';
?>

fields¶

Sobreescribe los campos de usuario y contraseña por defecto usados para la autenticación.

<?php
    $this->Auth->fields = array('username' => 'email', 'password' => 'passwd');
?>

userScope¶

Utiliza esto para añadir requisitos adicionales para que la autenticación sea exitosa.

<?php
    $this->Auth->userScope = array('User.activo' => true);
?>

loginAction¶

Puedes cambiar el login por defecto de /users/login para que sea cualquier acción a tu elección.

<?php
    $this->Auth->loginAction = array('admin' => false, 'controller' => 'miembros', 'action' => 'inicio_sesion');
?>

loginRedirect¶

El componente AuthComponent recuerda qué par controlador/acción estabas tratando de ejecutar antes de que pedirte que te autenticaras, almacenando el valor en Session bajo la clave Auth.redirect. Sin embargo, si este valor de la sesión no está definido (si vienes de la página de login de un enlace externo, por ejemplo), entonces el usuario será redirigido a la URL indicada en loginRedirect.

Ejemplo:

<?php
    $this->Auth->loginRedirect = array('controller' => 'miembros', 'action' => 'inicio');
?>

logoutRedirect¶

Puedes especificar a donde ira el usuario luego de “deautenticarse”, el inicio por defecto es la accion login

<?php
    $this->Auth->logoutRedirect = array(Configure::read('Routing.admin') => false, 'controller' => 'members', 'action' => 'logout');
?>

loginError¶

Cambia el mensaje de error por defecto que se mostrará, cuando el login no sea exitoso.

<?php
    $this->Auth->loginError = "No, you fool!  That's not the right password!";
?>

authError¶

Cambia el mensaje de error por defecto que será mostrado, cuando intenten acceder a un objeto o a una acción a la que no autorizada.

<?php
    $this->Auth->authError = "Sorry, you are lacking access.";
?>

autoRedirect¶

Normally, the AuthComponent will automatically redirect you as soon as it authenticates. Sometimes you want to do some more checking before you redirect users:

<?php
    function beforeFilter() {
        ...
        $this->Auth->autoRedirect = false;
    }

    ...

    function login() {
    //-- code inside this function will execute only when autoRedirect was set to false (i.e. in a beforeFilter).
        if ($this->Auth->user()) {
            if (!empty($this->data['User']['remember_me'])) {
                $cookie = array();
                $cookie['username'] = $this->data['User']['username'];
                $cookie['password'] = $this->data['User']['password'];
                $this->Cookie->write('Auth.User', $cookie, true, '+2 weeks');
                unset($this->data['User']['remember_me']);
            }
            $this->redirect($this->Auth->redirect());
        }
        if (empty($this->data)) {
            $cookie = $this->Cookie->read('Auth.User');
            if (!is_null($cookie)) {
                if ($this->Auth->login($cookie)) {
                    //  Clear auth message, just in case we use it.
                    $this->Session->del('Message.auth');
                    $this->redirect($this->Auth->redirect());
                }
            }
        }
    }
?>

The code in the login function will not execute unless you set $autoRedirect to false in a beforeFilter. The code present in the login function will only execute after authentication was attempted. This is the best place to determine whether or not a successful login occurred by the AuthComponent (should you desire to log the last successful login timestamp, etc.).

With autoRedirect set to false, you can also inject additional code such as keeping track of the last successful login timestamp

<?php
    function login() {
        if( !(empty($this->data)) && $this->Auth->user() ){
            $this->User->id = $this->Auth->user('id');
            $this->User->saveField('last_login', date('Y-m-d H:i:s') );
            $this->redirect($this->Auth->redirect());
        }
    }
?>

authorize¶

Normally, the AuthComponent will attempt to verify that the login credentials you’ve entered are accurate by comparing them to what’s been stored in your user model. However, there are times where you might want to do some additional work in determining proper credentials. By setting this variable to one of several different values, you can do different things. Here are some of the more common ones you might want to use.

<?php
    $this->Auth->authorize = 'controller';
?>

When authorize is set to “controller”, you’ll need to add a method called isAuthorized() to your controller. This method allows you to do some more authentication checks and then return either true or false.

<?php
    function isAuthorized() {
        if ($this->action == 'delete') {
            if ($this->Auth->user('role') == 'admin') {
                return true;
            }
        }
    if ($this->action == 'view') {
                return true;
        }
    ...
        return false;
    }
?>

Remember that this method will be checked after you have already passed the basic authentication check against the user model.

<?php
    $this->Auth->authorize = 'model';
?>

Don’t want to add anything to your controller and might be using ACO’s? You can get the AuthComponent to call a method in your user model called isAuthorized() to do the same sort of thing:

<?php
    class User extends AppModel {
        ...

        function isAuthorized($user, $controller, $action) {

            switch ($action) {
                case 'default':
                    return false;
                    break;
                case 'delete':
                    if ($user['User']['role'] == 'admin') {
                        return true;
                    }
                    break;
            }
        }
    }
?>

Lastly, you can use authorize with actions such as below

<?php
    $this->Auth->authorize = 'actions';
?>

By using actions, Auth will make use of ACL and check with AclComponent::check(). An isAuthorized function is not needed.

<?php
    $this->Auth->authorize = 'crud';
?>

By using crud, Auth will make use of ACL and check with AclComponent::check(). Actions should be mapped to CRUD (see mapActions).

sessionKey¶

Name of the session array key where the record of the current authed user is stored.

Defaults to «Auth», so if unspecified, the record is stored in «Auth.{$userModel name}».

<?php
    $this->Auth->sessionKey = 'Authorized';
?>

ajaxLogin¶

If you are doing Ajax or Javascript based requests that require authenticated sessions, set this variable to the name of a view element you would like to be rendered and returned when you have an invalid or expired session.

As with any part of CakePHP, be sure to take a look at AuthComponent class for a more in-depth look at the AuthComponent.

authenticate¶

This variable holds a reference to the object responsible for hashing passwords if it is necessary to change/override the default password hashing mechanism. See Changing the Encryption Type for more info.

actionPath¶

If using action-based access control, this defines how the paths to action ACO nodes is computed. If, for example, all controller nodes are nested under an ACO node named “Controllers”, $actionPath should be set to “Controllers/”.