Grupo Autenticación (2014-15)

De Wiki de EGC
Saltar a: navegación, buscar

Definición

Un subsistema de AGORA@US para autenticar usuarios y controlar quién puede votar y quién ya ha votado para evitar multiples votos de la misma persona. Este sistema tiene que ofrecer una api clara y sencilla para que otras partes del sistema puedan usarlo. Un sistema básico podría ser uno basado en un censo cerrado usando como identificador el correo electrónico. El sistema de autenticación tiene que ofrecer métodos para:

  • Realizar una prueba de verificación de identidad
  • Autenticar usuarios
  • Registrar usuarios

Miembros

Interfaz del sistema

El sistema de autenticación se encargará de realizar la autenticación del usuario antes de que este acceda al resto de la aplicación. Para que quede constancia de su estado como autenticado, se almacenarán en su navegador 2 cookies:

  • Una con identificador "user", en la que se almacenará el nombre de usuario autenticado.
  • Una con identificador "token", en la que se almacenará un token generado a partir de su nombre de usuario y contraseña.

Siempre que se desee comprobar que el usuario accediendo a una funcionalidad está correctamente autenticado, se debe comprobar que el token almacenado en la cookie es el correcto. Para ello se ofrecen métodos en la API descrita a continuación:

API

Las peticiones tendrán el siguiente formato, siendo todas de tipo GET: 

   http://[host]/auth/api/[recurso]?param1=value1&param2=value2...

[host] hace referencia al host en el que se encuentre el sistema (localhost)

[recurso] hace referencia al nombre del recurso de la API.

Están disponibles los siguientes:

Recurso Descripción Parámetros Respuesta Ejemplo de respuesta
getUser Obtiene un usuario del sistema, incluyendo sus datos. Este método solo puede ser usado por subsistemas locales (acceso mediante localhost).
  • user: nombre del usuario
 JSON con la lista de usuarios. Cada usuario incluye los campos "username", "password" y "email", "genre" y "autonomous_community". 
   {
       "username" : "johndoe",
       "password" : "foo_bar",
       "email" : "mail@example.com",
       "genre" : "Masculino",
       "autonomous_community" : "Madrid"
   }
checkToken Comprueba si un token es válido. Para ello, se obtiene el usuario correspondiente al token (indicado al comienzo del token), se genera el token del usuario y se comprueba si es igual que el pasado como parámetro.
  • token: token a validar.
 JSON con el campo "valid" indicando la validez del token (true/false). 
   {
       "valid"=true
   }
checkTokenUser Comprueba si un token es válido para un usuario. Para ello, se obtiene el usuario pasado como parámetro, se genera el token del usuario y se comprueba si es igual que el pasado como parámetro.
  • user: nombre del usuario cuyo token se va a comprobar.
  • token: token a validar.
 JSON con el campo "valid" indicando la validez del token (true/false). 
   {
       "valid"=true
   }

Si en una petición no se pasan unos parámetros correctos (métodos que no existen o falta de parámetros necesarios) se devolverá un error de código 400 con el siguiente mensaje: 

   Bad Request. This method doesn't exist or the necessary paramenters weren't provided

Instalación del subsistema

Se está trabajando en una máquina virtual que disponga de las 3 plataformas usadas por los equipos: XAMPP, Django y Spring MVC.

Mientras tanto, para la instalación del sistema los pasos a seguir son los siguientes:

  1. Instalar XAMPP con los módulos Apache y MySQL (que vienen instalados por defecto). La instalación es trivial en Windows, Linux y OS X. Se puede obtener aquí.
  2. Borrar el contenido de la carpeta de proyectos. Habitualmente es C:/xampp/hdtocs.
  3. Introducir en la carpeta de proyectos una carpeta auth con el contenido de la carpeta auth que se encuentra en el repositorio compartido.
  4. Si se van a instalar otros subsistemas en la misma máquina, saltar este paso: Con Apache y MySQL activados (en el Control Panel de XAMPP) entrar en localhost/phpmyadmin y crear un usuario llamado 'usuario' con la contraseña 'password'. Crear una base de datos con el nombre 'egcdb' y dar todos los privilegios al usuario creado anteriormente.
  5. Suponiendo que ya se encuentre en la base de datos un usuario llamado 'usuario', con una contraseña 'password', no será necesario (ni posible) iniciar MySQL desde XAMPP.

Subsistemas relacionados

  • Cabina de votación: Deberá comprobar que sus usuarios estén logueados en la aplicación.
  • Creación/administración de votaciones: Deberá comprobar que sus usuarios estén logueados en la aplicación.
  • Deliberaciones: Deberá comprobar que sus usuarios estén logueados en la aplicación.

Repositorio de código

Actualmente, el repositorio en el que se encuentra nuestro código es el repositorio compartido con los demas subsistemas. Una versión estable se puede encontrar en la carpeta auth de la rama master, y una versión más actualizada en la misma carpeta, en la rama auth. El resto de ramas auth_* son ramas de desarrollo.

Antes de que existiera un repositorio común, usamos este repositorio repositorio del Grupo de Autenticación.

Gestión de la comunicación

Toda la comunicación se lleva a cabo presencialmente en horario de clase, y de forma remota mediante el uso de herramientas de mensajería instantánea (Telegram).

El diario de grupo se mantiene en esta wiki, y las actas se van publicando como páginas individuales dentro del diario de grupo.

Iteraciones

Son susceptibles de entrar en esta categoría aquellos trabajos en clase que tengan un entregable. Para ver las actas de otros entregables, ver el diario de grupo.

Diario de grupo

Hojas de tiempo

Debido a que la hoja de tiempos del grupo empezaba a tener una longitud casi mayor que el resto del diario del grupo, hemos decidido pasarla a una página independiente. La hoja de tiempos está aquí: Hoja de tiempos

Actas

Obtenido de «https://1984.lsi.us.es/wiki-egc/index.php?title=Grupo_Autenticación_(2014-15)&oldid=2216»