Começando com Zend_Auth

Transcrição

1 Começando com Zend_Auth por Rob Allen, Versão do documento Copyright 2007 Traduzido por Ricardo Felipe Klein, blog.klein.inf.br Este tutorial tem a intenção de dar uma introdução básica do uso do Zend_Auth. Está construido dentro de outro tutorial, Getting Started with Zend Framework ou Começando com o Zend Framework que pode ser encontrado em Existe também uma versão traduzida deste tutorial lá, o link para ele é NOTA: Este tutorial foi testado nas versões e do Zend Framework. Há uma grande chance de que ele funcione em versões mais novas. Nota do Tradutor: Testado na versão 1.0.2, funciona. Antes de Começarmos A implementação de autenticação que nós iremos fazer neste tutorial usa Sessões do PHP. Tenha certeza de que o diretório setado no seu arquivo php.ini (session.save_path) tem permissão de escrita para o web server, caso contrário você recebera uma exception(erro). Autenticação Para o propósito deste tutorial, autenticação é o processo de logar alguém em uma aplicação web. Nós vamos modificar o programa de lista de CD's criado no tutorial Começando com Zend Framework para exigir o log in antes de dar acesso à qualquer parte da aplicação. O que precisamos fazer é: Criar uma tabela no banco de dados para os usuários e inserir um usuário nela. Criar um form de login. Criar um controller contendo os Actions para logging e log out. Alterar o rodapé (footer.phtml) para possibilitar o log out. Certificar-se de que o usuário está logado antes de deixar que ele acesse a aplicação. A tabela de Usuários A primeira coisa que precisamos é a tabela de usuários. Ela não precisa ser complicada e pode parecer com isso: Fieldname Type Null? Notes id Integer No Primary key, Autoincrement username Varchar(50) No Unique key password Varchar(50) No real_name Varchar(100) No Caso utilize o MySQL, o comando SQL para criar a tabela é: CREATE TABLE users ( id int(11) NOT NULL auto_increment, username varchar(50) NOT NULL, password varchar(50) NOT NULL, real_name varchar(100) NOT NULL, PRIMARY KEY (id), UNIQUE KEY username (username) ); Nós ainda precisamos de um usuário para que consiga fazer o log in: INSERT INTO users (id, username, password, real_name) VALUES (1, 'rob', 'rob', 'Rob Allen'); Page 1 of 7

2 Rode estes comandos em algum cliente MySQL como o phpmyadmin ou via linha de comando no cliente modo texto do MySQL. (é óbvio, você deve arrumar um usuário e senha melhores!) Mudanças no Bootstrap A fim de manter-se informado do fato de o usuário estar logado, nós vamos usar a sessão. O Zend Framework fornece o Zend_Session_Namespace que provém uma interface orientada à objetos para a sessão. As mudanças para o index.php são: zf-tutorial/index.php: Zend_Loader::loadClass('Zend_Db_Table'); Zend_Loader::loadClass('Zend_Debug'); Zend_Loader::loadClass('Zend_Auth'); e // load configuration.. // setup database $db = Zend_Db::factory($config->db->adapter, $config->db->config->toarray()); Zend_Db_Table::setDefaultAdapter($db); Zend_Registry::set('db', $db); // setup controller $frontcontroller = Zend_Controller_Front::getInstance(); O temos que fazer agora aqui é certificar que nós tenhamos carregado a classe Zend_Auth e registradoo adapter do banco de dados com o Zend_Registry. Nós armazenamos isto no registry pois vamos precisar dele para a autenticação mais tarde. O controller de autenticação (Auth Controller) Nós precisamos de um controller que irá conter os Actions de login e logout. Faz sentido o chamarmos de AuthController. Vamos iniciá-lo com os conceitos básicos do IndexController: zf-tutorial/application/controllers/authcontroller.php: <?php function init() $this->initview(); $this->view->baseurl = $this->_request->getbaseurl(); function indexaction() Nós criamos init() então o view será inicializado e baseurl será atribuido à ele. Nós ainda criamos a função indexaction() que é exigida pelo Zend_Controller_Action. Nós não precisamos do indexaction(), já que vamos Page 2 of 7

3 usar apenas loginaction() e logoutaction(), então nós apenas redirecionamos novamente para a raiz caso alguém tente acessar auth/index. Logging In Para logar na aplicação precisamos de um form, o action do login irá funcionar de forma semelhante aos forms do IndexController. O template do form ficará em views/scripts/auth/login.phtml e o código estará em AuthController::loginAction(). O form é bem simples, precisando apenas de dois campos: username e password: zf-tutorial/application/views/scripts/auth/login.phtml: <?php echo $this->render('header.phtml');?> <h1><?php echo $this->escape($this->title);?></h1> <?php if(!empty($this->message)) :?> <div id="message"> <?php echo $this->escape($this->message);?> <?php endif;?> <form action="<?php echo $this->baseurl?>/auth/login" method="post"> <div> <label for="username">usuário</label> <input type="text" name="username" value=""/> <div> <label for="password">senha</label> <input type="password" name="password" value=""/> <div id="formbutton"> <input type="submit" name="login" value="login" /> </form> <?php echo $this->render('footer.phtml');?> O template mostra através do render() os templates header.phtml e footer.phtml no topo e rodapé como no outro tutorial. Note que mostramos a mensagem apenas se $this->message não estiver vazia. Isto é usado ao usuário se ele falhou no login. O resto do template é o form de login. Agora já temos o form, precisamos criar o Action no Controller para rodá-lo. Adicionamos isto no AuthController.php: zf-tutorial/application/controllers/authcontroller.php: function loginaction() $this->view->message = ''; $this->view->title = "Log in"; Inicialmente tudo o que precisamos é setar o título ($this->view->title) e a mensagem ($this-view->message) e então aparecerá o form. Se você navegar através de você devera ver o form de login. O que será feito após o form ser enviado (submit)? Para isto, nós utilizamos o mesmo truque do add e edit forms do IndexController e fazer o processo se o metodo _request for post. Mude o loginaction() que nós já criamos: Page 3 of 7

4 zf-tutorial/application/controllers/authcontroller.php: function loginaction() $this->view->message = ''; if ($this->_request->ispost()) // pega as informações do usuário Zend_Loader::loadClass('Zend_Filter_StripTags'); $f = new Zend_Filter_StripTags(); $username = $f->filter($this->_request->getpost('username')); $password = $f->filter($this->_request->getpost('password')); if (empty($username)) $this->view->message = 'Por favor informe o usuário.'; else // configura o adapter Zend_Auth para uma tabela do BD Zend_Loader::loadClass('Zend_Auth_Adapter_DbTable'); $db = Zend_Registry::get('db'); $authadapter = new Zend_Auth_Adapter_DbTable($db); $authadapter->settablename('users'); $authadapter->setidentitycolumn('username'); $authadapter->setcredentialcolumn('password'); // Seta as credenciais para a autenticação $authadapter->setidentity($username); $authadapter->setcredential($password); // Faça a autenticação $auth = Zend_Auth::getInstance(); $result = $auth->authenticate($authadapter); if ($result->isvalid()) // success: store database row to auth's storage // system. (Not the password though!) $data = $authadapter->getresultrowobject(null, 'password'); $auth->getstorage()->write($data); else // failure: clear database row from session $this->view->message = 'Login failed.'; $this->view->title = "Log in"; Um monte de coisa está acontecendo aqui, então vamos passar por isso: // pegando as informações do usuário Zend_Loader::loadClass('Zend_Filter_StripTags'); $f = new Zend_Filter_StripTags(); $username = $f->filter($this->_request->getpost('username')); $password = $f->filter($this->_request->getpost('password')); if (empty($username)) $this->view->message = 'Por favor informe o usuário.'; else Como de costume nós setamos um filtro para extrair o username e a password das informações do POST. Note que nós usamos a função getpost() ele vai lidar com o isset() checando e retornando uma string vazia se o campo não existir no array POST. Se o username estiver vazio, então não á nada para tentar a autenticação(e o Zend_Auth irá te devolver uma exception (erro) se tentar!), então nós checamos se o username está vazio e informamos o usuário disto em seguida. Page 4 of 7

5 // setup Zend_Auth adapter for a database table Zend_Loader::loadClass('Zend_Auth_Adapter_DbTable'); $db = Zend_Registry::get('db'); $authadapter = new Zend_Auth_Adapter_DbTable($db); $authadapter->settablename('users'); $authadapter->setidentitycolumn('username'); $authadapter->setcredentialcolumn('password'); O Zend_Auth usa um sistema de adapter para permitir que você utilize qualquer sistema para fazer a autenticação. Nós queremos usar uma tabela do banco de dados então usamos o Zend_Auth_Adapter_DbTable. Para usar o adapter, você informa os campos a se usar e os passa em uma conexão com o banco de dados. // Set the input credential values to authenticate against $authadapter->setidentity($username); $authadapter->setcredential($password); Nós precisamos informar ao adapter exatamente o usuário e a senha que o usuário informou no form. // do the authentication $auth = Zend_Auth::getInstance(); $result = $auth->authenticate($authadapter); Para fazer a autenticação nos chamamos a função authenticate() do Zend_Auth. Isto garante que os resultados da autenticação sejam armazenados automaticamente em uma sessão. if ($result->isvalid()) // success : store database row to auth's storage // system. (not the password though!) $data = $authadapter->getresultrowobject(null, 'password'); $auth->getstorage()->write($data); No caso de sucesso, nós armazenamos a linha inteira do banco de dados (exceto a senha!) no Zend_Auth singleton. Isto garante que consigamos pegar o nome do usuário para mostrar no rodapé. else // failure: clear database row from session $this->view->message = 'Login failed.'; No caso da autenticação falhar, nós setamos a mensagem, assim o usuário é informado do que está acontecendo. O processo de Autenticação/Login está completo agora. Logging out Logging out muito mais simples do que o login in, apenas precisamos informar ao Zend_Auth singleton para limpar as informações. Isto será feito em um novo action no AuthController, o logoutaction(). Então nós poderemos navegar para assim o usuário fará log outt: zf-tutorial/application/controllers/authcontroller.php: function logoutaction() Zend_Auth::getInstance()->clearIdentity(); Page 5 of 7

6 A função logoutaction() é tão simples, que não consigo pensar em nada para falar sobre ela! Nota do Tradutor: nem eu :-). Agora nós precisamos prover ao usuário um link para que ele consiga sair (log out) da aplicação. Faremos isto dentro do rodapé (footer.phtml). Nós vamos informar o usuário seu nome, assim ele pode saber se ele está logado corretamente. O nome dele está armazenado no atributo real_name da tabela de usuários no banco de dados, que agora está acessível na instância do Zend_Auth. A primeira coisa a se fazer é dar esta informação à view, que nós fazemos dentro da função init() do IndexController: zf-tutorial/application/controllers/indexcontroller.php: class IndexController extends Zend_Controller_Action function init() $this->initview(); Zend_Loader::loadClass('Album'); $this->view->baseurl = $this->_request->getbaseurl(); $this->view->user = Zend_Auth::getInstance()->getIdentity(); É conveniente que o Zend_Auth seja único, caso contrário nó teriamos armazenado esta informação no registry. Agora precisamos adicionar algum HTML ao rodaé(footer.phtml): zf-tutorial/application/views/scripts/footer.phtml: <?php if($this->user) :?> <p id="logged-in">logged in as <?php echo $this->escape($this->user->real_name);?>. <a href="<?php echo $this->baseurl?>/auth/logout">logout</a></p> <?php endif;?> </body> </html> Isto parece familiar e não há nenhum conceito novo aqui. Nós usamos escape() para certificar que o nome real (real_name) do usuário seja mostrado corretamente e usamos baseurl para setar o link para o lugar correto. Isto é tudo o que precisamos para o Logout. Protegendo os Actions O que falta é ter certeza de que nenhuma action seja acessivel caso você não tenha feito o login. Para fazer isso, nós precisamos adicionar algum código à função predispatch() no IndexController. zf-tutorial/application/controllers/indexcontroller.php: class IndexController extends Zend_Controller_Action function predispatch() $auth = Zend_Auth::getInstance(); if (!$auth->hasidentity()) $this->_redirect('auth/login'); Page 6 of 7

7 O predispatch() é chamado antes de qualquer action no controller. Nós coletamos a instância do Zend_Auth e então a função hasidentity() nos informa se o usuário está logado. Se não ele redireciona o usuário para o auth/login (loginaction() do AuthController). E isto é tudo! Conclusão Isto conclui nosso breve olhar sobre como integrar o Zend_Auth à uma aplicação MVC. Claro ue existe um monte de coisas a mais para se fazer com o Zend_Auth, e há várias maneiras de implementar um código que funcione, especialmente se você tiver vários controllers para proteger. Note que nós não olhamos em detalhes os níveis de autorização, que são cobertos pelo componente Zend_Acl. O Zend_Acl pode ser usado em conjunto com o Zend_Auth pra prover diferentes níveis de acesso para actions ou informação, mas isto é assunto para outro tutorial. Espero que você tenha achado interessante e informativo. Se você encontrou algo errado, por favor me mande um em rob@akrabat.com. Page 7 of 7