IntroducciónZend_Auth
provee una
API
para
autenticación e incluye adaptadores concretos de autenticación para
escenarios de casos
de uso común.
Zend_Auth
es concerniente sólo con
autenticación
y no con
autorización
. Autenticación es vagamente
definido como: determinar si una entidad realmente es lo que
pretende
ser (o sea, identificación), basandose en un grupo de credenciales.
Autorización, el
proceso de decidir si se permite a una entidad: acceso
a, o el realizar operaciones en, otras
entidades esta fuera del alcance
de
Zend_Auth
. Para más información sobre
autorización y control de acceso con Zend Framework, por favor
vea
Zend_Acl
.
La clase
Zend_Auth
implementa el patrón
Singleton - sólo una instancia de la clase está disponible - a
través de su método estático
getInstance()
. Esto significa que usar el operador
new
y
la keyword
clone
no va a funcionar con la
clase
Zend_Auth
: use
Zend_Auth::getInstance()
en su lugar.
Adaptadores
Un adaptador
Zend_Auth
es usado para
autenticar en contra de un tipo particular de servicio de
autenticación,
como
LDAP
,
RDBMS
, o almacenamiento basado en
ficheros. Diferentes adaptadores pueden tener opciones y
compotamientos muy diferentes, pero algunas cosas básicas son
comunes entre los
adaptadores de autenticación. Por ejemplo, aceptar
credenciales de autenticación
(incluyendo una identidad supuesta),
realizar consultas ante el servicio de
autenticación, y regresar
resultados, son comunes para los adaptadores
Zend_Auth
.
Cada clase adaptadora
Zend_Auth
implementa
Zend_Auth_Adapter_Interface
. Esta
interface define un metodo,
authenticate()
, que la clase adaptadora debe implementar para realizar una
peticion de autenticación.
Cada clase adaptadora debe ser preparada
antes de llamar a
authenticate()
. Esta
preparación del adaptador incluye la creación de credenciales (p.ej.
nombre de
usuario y contraseña) y la definición de valores para
opciones de configuración
especificos del adaptador, como valores de
coneccion a base de datos para un adaptador de
tabla de base de
datos.
El siguente ejemplo es un adaptador de autenticación que requiere
que un nombre de
usuario y contraseña sean especificados para la
autenticación. Otros detalles, como la
forma de realizar peticiones
al servicio de autenticación, han sido omitídos por
brevedad:
Como se ha indicado en su docblock,
authenticate()
debe regresar una
instancia de
Zend_Auth_Result
(o de una clase
derivada de
Zend_Auth_Result
). Si por alguna
razón es imposible realizar una petición de autenticación,
authenticate()
debería arrojar una
excepción que se derive de
Zend_Auth_Adapter_Exception
.
Resultados
Los adaptadores
Zend_Auth
regresan una instancia de
Zend_Auth_Result
con
authenticate()
para representar el
resultado de un intento de autenticación. Los adaptadores llenan el
objeto
Zend_Auth_Result
en cuanto se
construye, así que los siguientes cuatro métodos proveen un grupo
básico de
operaciones "frente al usuario" que son comunes a los
resultados de adaptadores
Zend_Auth:
isValid()
- regresa true si y
solo si el resultado representa un intento de
autenticación exitoso
getCode()
- regresa una
constante identificadora
Zend_Auth_Result
para
determinar el tipo de fallo en la autenticación o si ha
sido exitosa.
Este puede ser usado en situaciones cuando
el desarrollador desea distinguir
entre varios tipos de
resultados de autenticación. Esto permite a los
desarrolladores, por ejemplo, mantener estadísticas
detalladas de los
resultados de autenticación. Otro uso
de esta característica es: proporcionar
al usuario
mensajes específicos detallados por razones de
usabilidad, aunque
los desarrolladores son exhortados a
considerar el riesgo de proporcionar
tales detalles a
los usuarios, en vez de un mensaje general de fallo en
la
autenticación. Para más información, vea las
siguientes notas:
getIdentity()
- regresa la
identidad del intento de autenticación
getMessages()
- regresa un
arreglo de mensajes pertinentes a un fallido intento de
autenticación
El desarrollador podría desear ramificar basado en el tipo de
resultado de la
autenticación a fin de realizar operaciones mas
específicas. Algunas operaciones que los
desarrolladores podrían
encontrar útiles son: bloquear cuentas despues de varios intentos
fallidos de ingresar una contraseña, marcar una dirección IP despues
de que ha intentado
muchas identidades no existentes, y porporcionar
al usuario mensajes especificos
resultados de la autenticación. Los
siguientes codigos de resultado están disponibles:
El siguiente ejemplo ilustra como un desarrollador podría
ramificar basado en el código
resultado:
_auth->authenticate($adapter);
switch ($result->getCode()) {
case Zend_Auth_Result::FAILURE_IDENTITY_NOT_FOUND:
/** realiza algo para identidad inexistente **/
break;
case Zend_Auth_Result::FAILURE_CREDENTIAL_INVALID:
/** realiza algo para credencial invalida **/
break;
case Zend_Auth_Result::SUCCESS:
/** realiza algo para autenticación exitosa **/
break;
default:
/** realiza algo para otras fallas **/
break;
}
]]>Persistencia de IdentidadAutenticar una petición que incluye credenciales de autenticación
es util por sí mismo,
pero también es importante el soportar
mantener la identidad autenticada sin tener que
presentar las
credenciales de autenticación con cada petición.
HTTP
es un protocolo sin estado, sin embargo, se han desarrollado
técnicas como las cookies y
sesiones a fin de facilitar mantener el
estado a través de multiples peticiones en
aplicaciones web del lado
del servidor.
Persistencia por Defecto en la Sesión PHP
Por defecto,
Zend_Auth
provee
almacenamiento persistente de la identidad desde un intento de
autenticación
exitoso usando la sesión
PHP
. En un intento de
autenticación exitoso,
end_Auth::authenticate()
almacena la
identidad del resultado de autenticación en almacenamiento
persistente. A
menos que se configure diferente,
Zend_Auth
usa una clase de
almacenamiento llamada
Zend_Auth_Storage_Session
, la cual,
a su vez usa
Zend_Session
. Una clase diferente podría ser utilizada mediante
proveer un objeto que implemente
Zend_Auth_Storage_Interface
a
Zend_Auth::setStorage()
Si el automático almacenamiento persistente de la
identidad no es apropiado para
un caso en particular,
entonces los desarrolladores podrían dejar de usar la
clase
Zend_Auth
al mismo tiempo,
utilizando en su lugar una clase adaptadora directamente.
Modifying the Session NamespaceZend_Auth_Storage_Session
usa un
espacionombre (namespace) de sesión 'Zend_Auth'. Este
espacio-nombre podría
ser OVERRIDDEN al pasar un valor
diferente al contructor de
Zend_Auth_Storage_Session
, y
este valor es pasado internamente al constructor de
Zend_Session_Namespace
. Esto
debería ocurrir antes de que se intente la autenticación, ya
que
Zend_Auth::authenticate()
realiza
el almacenamiento automático de la identidad.
setStorage(new Zend_Auth_Storage_Session('unEspacionombre'));
/**
* @todo Set up the auth adapter, $authAdapter
*/
// Autenticar, almacenando el resultado, y persistiendo la identidad en
// suceso
$result = $auth->authenticate($authAdapter);
]]>Implementando Almacenamiento Personalizado
En ocaciones los desarrolladores podrían necesitar usar un
diferente comportamiento
de persistencia de identidad que el
provisto por
Zend_Auth_Storage_Session
.
Para esos casos los desarrolladores podrían simplemente
implementar
Zend_Auth_Storage_Interface
y
suplir una instancia de la clase a
Zend_Auth::setStorage()
.
Usando una Clase de Almacenamiento Personalizada
Para poder utilizar una clase de almacenamiento
persistente de identidad
diferente a
Zend_Auth_Storage_Session
, el
desarrollador implementa
Zend_Auth_Storage_Interface
:
A fin de poder usar esta clase de almacenamiento
personalizada,
Zend_Auth::setStorage()
es
invocada antes de intentar una petición de autenticación:
setStorage(new MyStorage());
/**
* @por hacer Configurar el adaptador de autenticación, $authAdapter
*/
// Autenticar, almacenando el resultado, y persistiendo la identidad
// si hay exito
$result = Zend_Auth::getInstance()->authenticate($authAdapter);
]]>Uso
Hay dos formas provistas de usar adaptadores
Zend_Auth
:
indirectamente, a través de
Zend_Auth::authenticate()
directamente, a través del metodo
authenticate()
del
adaptador
El siguiente ejemplo ilustra como usar el adaptador
:Zend_Auth
: indirectamente, a través del
uso de la clase
Zend_Auth
:
authenticate($authAdapter);
if (!$result->isValid()) {
// Fautenticación fallida: imprime el por que
foreach ($result->getMessages() as $message) {
echo "$message\n";
}
} else {
// Autenticación exitosa, la identidad ($username) es almacenada
// en la sesión
// $result->getIdentity() === $auth->getIdentity()
// $result->getIdentity() === $username
}
]]>Una vez que la autenticación ha sido intentada en una petición,
como en el ejemplo
anterior, es fácil verificar si existe una
identidad autenticada exitosamente:
hasIdentity()) {
// Existe la identidad; obtenla
$identity = $auth->getIdentity();
}
]]>
Para remover una identidad del almacenamiento persistente,
simplemente usa el metodo
clearIdentity()
method. Comunmente esto sería usado para implementar una operación
"cerrar sesión" en la
aplicación:
clearIdentity();
]]>
Cuando el uso automático de almacenamiento persistente es
inapropiado para un caso en
particular, el desarrollador podría
simplemente omitir el uso de la clase
Zend_Auth
, usando una clase adaptadora
directamente. El uso directo de una clase adaptadora
implica
configurar y preparar un objeto adaptador y despues llamar a su
metodo
authenticate()
. Los detalles
específicos del adaptador son discutidos en la documentación de cada
adaptador. El siguiente ejemplo utiliza directamente
MyAuthAdapter
:
authenticate();
if (!$result->isValid()) {
// Autenticación fallida, imprime el porque
foreach ($result->getMessages() as $message) {
echo "$message\n";
}
} else {
// Autenticación exitosa
// $result->getIdentity() === $username
}
]]>