Cifrado César

Índice

• 1. Preámbulo
• 2. Resumen del proyecto
• 3. Objetivos de aprendizaje
• 4. Consideraciones generales
• 5. Criterios de aceptación mínimos del proyecto
• 6. Hacker Edition
• 7. Pistas, tips y lecturas complementarias

---

1. Preámbulo

Cifrar significa codificar. El cifrado César es uno de los primeros métodos de cifrado conocidos. El emperador romano Julio César lo usaba para enviar órdenes secretas a sus generales en los campos de batalla.

El cifrado césar es una de las técnicas más simples para cifrar un mensaje. Es un tipo de cifrado por sustitución, es decir que cada letra del texto original es reemplazada por otra que se encuentra un número fijo de posiciones (desplazamiento) más adelante en el mismo alfabeto.

Por ejemplo, si usamos un desplazamiento (offset) de 3 posiciones:

• La letra A se cifra como D.
• La palabra CASA se cifra como FDVD.
• Alfabeto sin cifrar: A B C D E F G H I J K L M N O P Q R S T U V W X Y Z
• Alfabeto cifrado: D E F G H I J K L M N O P Q R S T U V W X Y Z A B C

En la actualidad, todos los cifrados de sustitución simple se descifran con mucha facilidad y, aunque en la práctica no ofrecen mucha seguridad en la comunicación por sí mismos; el cifrado César sí puede formar parte de sistemas más complejos de codificación, como el cifrado Vigenère, e incluso tiene aplicación en el sistema ROT13.

2. Resumen del proyecto

¿Qué tengo que hacer exactamente? En este proyecto crearás la primera aplicación web del bootcamp. Servirá para que el usuario pueda cifrar y descifrar un texto indicando un desplazamiento específico de caracteres (offset).

La temática es libre. Tú debes pensar en qué situaciones de la vida real se necesitaría cifrar un mensaje y pensar en cómo debe ser esa experiencia de uso (qué pantallas, explicaciones, mensajes, colores, ¿marca?) etc. Algunas ideas de ejemplo:

• Crear claves seguras para el email.
• Encriptar/cifrar una tarjeta de crédito.
• Herramienta de mensajería interna de una organización de derechos humanos en una zona de conflicto.
• Mensajería secreta para parejas.

3. Objetivos de aprendizaje

El objetivo principal de aprendizaje es adquirir experiencia desarrollando aplicaciones web (WebApp) que interactúen con el usuario a través del navegador y la lógica, utilizando HTML5, CCS3 y JavaScript como herramientas.

Reflexiona y luego marca los objetivos que has llegado a entender y aplicar en tu proyecto.

UX

• Diseñar la aplicación pensando y entendiendo al usuario.
• Crear prototipos para obtener feedback e iterar.
• Aplicar los principios de diseño visual (contraste, alineación, jerarquía).

HTML y CSS

• Uso correcto de HTML semántico.
• Uso de selectores de CSS.
• Construir tu aplicación respetando el diseño realizado (maquetación).

DOM

• Uso de selectores del DOM.
• Manejo de eventos del DOM.
• Manipulación dinámica del DOM.

Javascript

• Manipulación de strings.
• Uso de condicionales (if-else | switch).
• Uso de bucles (for | do-while).
• Uso de funciones (parámetros | argumentos | valor de retorno).
• Declaración correcta de variables (const & let).

Testing

• Testeo de tus funciones.

Git y GitHub

• Comandos de git (add | commit | pull | status | push).
• Manejo de repositorios de GitHub (clone | fork | gh-pages).

Buenas prácticas de desarrollo

• Uso de identificadores descriptivos (Nomenclatura | Semántica).
• Uso de linter para seguir buenas prácticas (ESLINT).

4. Consideraciones generales

• Este proyecto se debe resolver de manera individual.
• El proyecto será entregado subiendo tu código a GitHub (commit/push) y la interfaz será desplegada usando GitHub pages. Si no sabes lo que es GitHub, no te preocupes, lo aprenderás durante este proyecto.
• Tiempo para completarlo: Toma como referencia 2 semanas. Trabaja durante el primer Sprint (una semana) y al final, trata de fijar un estimado de cuándo lo terminarás.

5. Criterios de aceptación mínimos del proyecto

Usa este alfabeto simple (solamente mayúsculas y sin ñ).

• A B C D E F G H I J K L M N O P Q R S T U V W X Y Z

La interfaz debe permitir al usuario:

• Elegir un desplazamiento (offset) indicando cuántas posiciones queremos que el cifrado desplace cada caracter.
• Insertar un mensaje (texto) que queremos cifrar.
• Ver el resultado del mensaje cifrado.
• Insertar un mensaje (texto) a descifrar.
• Ver el resultado del mensaje descifrado.

Scripts / Archivos

UX (Diseño de experiencia de usuario)

Antes de iniciar a codear, debes entender el problema que quieres solucionar y cómo tu aplicación lo soluciona.

• Trabaja tu primer prototipo con papel y lápiz (blanco y negro).
• Luego valida esta solución con una compañera (pedir feedback).
• Toma lo aprendido al momento de validar tu primer prototipo y desarrolla un nuevo prototipo usando alguna herramienta para diseño de prototipos (Balsamiq, Figma, Google Slides, etc.) Estos puntos los presentarás en el README.md.

README.md:

Debe contener lo siguiente:

• Un título con el nombre de tu proyecto. *Título del Proyecto: PawsCause
• Un resumen de 1 o 2 líneas de qué se trata tu proyecto. *Es una aplicación web que genera un código particular para aquellos que al realizar una aportación eligen un cupón en específico. Se utilizará la cantidad aportada como offset para codificar la descripcion del cupón electo. Después éste podrá ser decodificado en las tiendas y así ver la descripción del cupón.
• La imagen final de tu proyecto.
• Investigación UX:
  1. Explicar quiénes son los usuarios y los objetivos en relación con el producto. *Los usuarios serían aquellos que requieran de cifrar los códigos que eligen sus usuarios para proporcionarles un código personal, así como los usuarios de estos. Tal código podrá ser mostrado en tienda o ingresarse al comprar en línea para que a través de descifrar el mismo la empresa (en la que el usuario desea comprar) acceda a la descripción del cupón obtenido por la persona.
  2. Explicar cómo el producto soluciona los problemas/necesidades de dichos usuarios. *Ambos, tanto las empresas que brindan los cupones como aquellos que los obtienen requieren estar ciertos de que el cupon que proporcionan/obtienen no podrá ser replicado facilmente por otros usuarios (voluntariamente). Por ello la app cifrará (utilizando como offset la cantidad aportada por el usuario) tanto la descripción del cupón como una palabra clave que se le solicitará al usuario para personalizar su cupón.
  3. Luego colocarás la foto de tu primer prototipo en papel.    
  4. Agregar un resumen del feedback recibido indicando las mejoras a realizar. *Mis compañeras me comentaron que era necesario simplificar la interfaz puesto que no era lo suficientemente intuitiva como para que el usuario navegara a través de la misma sin confundirse o no saber para qué servían algunos botones y secciones. También me comentaron que por la cantidad de pantallas era posible que no alcanzara a terminar el proyecto en tiempo.
  5. Imagen del prototipo final.

Visualmente (HTML5 y CSS3)

Deberás maquetar de forma exacta el prototipo final que hiciste en balsamiq utilizando HTML5 y CSS3. En este momento elegirás los colores, tipo de fuente, etc a usar.

A continuación describimos los archivos que utilizarás:

src/index.html:

En este archivo va el contenido que se mostrará al usuario (esqueleto HTML). Encontrarás 3 etiquetas iniciales, las cuales si deseas puedes borrar y empezar de cero:

• <header>: encabezado de tu proyecto.
• <main>: contenido principal de tu proyecto.
• <footer>: pie de página de tu proyecto.

src/style.css:

Este archivo debe contener las reglas de estilo. Queremos que escribas tus propias reglas, por eso NO está permitido el uso de frameworks de CSS3 (Bootstrap, materialize, etc).

Funcionalmente (JavaScript - pruebas unitarias)

• La lógica del proyecto debe estar implementada completamente en JavaScript.
• En este proyecto NO está permitido usar librerías o frameworks, sólo vanilla JavaScript.
• No se debe utilizar la pseudo-variable this.

Vas a tener 2 archivos JavaScript separando responsabilidades, a continuación indicamos qué harás en cada archivo:

src/cipher.js:

Acá escribirás las 2 funciones necesarias para el usuario pueda cifrar o descifrar. Para esto debes implementar el objeto cipher, el cual ya se encuentra exportado en el objeto global (window). Este objeto (cipher) contiene dos métodos:

• cipher.encode(offset, string): offset es el número de posiciones que queremos mover a la derecha en el alfabeto y string el mensaje (texto) que queremos cifrar.
• cipher.decode(offset, string): offset es el número de posiciones que queremos mover a la izquierda en el alfabeto y string el mensaje (texto) que queremos descifrar.

src/index.js:

Acá escribirás todo el código que tenga que ver con la interacción del DOM (seleccionar, actualizar y manipular elementos del DOM y eventos). Es decir, en este archivo deberás invocar a cipher.encode(offset, string) y cipher.decode(offset, string) según sea necesario para actualizar el resultado en la pantalla(UI).

test/cipher.spec.js:

En este archivo tendrás que completar las pruebas unitarias de las funciones cipher.encode(offset, string) y cipher.decode(offset, string) implementadas en cipher.js utilizando Jest. Tus pruebas unitarias deben dar un 70% en coverage (cobertura), statements (sentencias), functions (funciones) y lines (líneas); y un mínimo del 50% de branches (ramas).

6. Hacker edition

Las secciones llamadas Hacker Edition son opcionales. Si terminaste con todo lo anterior y te queda tiempo, intenta completarlas. Así podrás profundizar y/o ejercitar más sobre los objetivos de aprendizaje del proyecto.

La descripción general de este proyecto no menciona qué pasaría con las letras minúsculas y otros caracteres (como espacios, puntuación, ñ, ...). El boilerplate incluye algunos tests (comentados en principio) que puedes usar como punto de partida para implementar el soporte para estos casos.

Tampoco se menciona qué pasaría si el offset fuera negativo. Como parte del hacker edition te invitamos a explorar también esta caso por tu cuenta.

7. Pistas, tips y lecturas complementarias

Primeros pasos

1. Antes que nada, asegúrate de tener un 📝 editor de texto en condiciones, algo como Atom o Code.
2. Para ejecutar los comandos a continuación necesitarás una 🐚 UNIX Shell, que es un programita que interpreta líneas de comando (command-line interpreter) así como tener git instalado. Si usas un sistema operativo "UNIX-like", como GNU/Linux o MacOS, ya tienes una shell (terminal) instalada por defecto (y probablemente git también). Si usas Windows puedes usar Git bash, aunque recomendaría que consideres probar 🐧 GNU/Linux.
3. Haz tu propio 🍴 fork del repo de tu cohort, tus coaches te compartirán un link a un repo y te darán acceso de lectura en ese repo.
4. ⬇️ Clona tu fork a tu computadora (copia local).
5. 📦 Instala las dependencias del proyecto con el comando npm install. Esto asume que has instalado Node.js (que incluye npm).
6. Si todo ha ido bien, deberías poder ejecutar las 🚥 pruebas unitarias (unit tests) con el comando npm test.
7. Para ver la interfaz de tu programa en el navegador, usa el comando npm start para arrancar el servidor web y dirígete a http://localhost:5000 en tu navegador.
8. A codear se ha dicho! 🚀

Recursos y temas relacionados

A continuación un video de Michelle que te lleva a través de la fórmula matemática del Cifrado César y un par de cosas más que debes saber para resolver este proyecto. ¡Escúchala con detenimiento y sigue sus consejos! :)

https://www.youtube.com/watch?v=f0zL6Ot9y_w

Diseño de experiencia de usuario (User Experience Design):

• Ideación
• Prototipado (sketching)
• Testeo e Iteración

Desarrollo Front-end:

• Valores
• Tipos
• Variables
• Control de flujo
• Tests unitarios
• Aprende más sobre charCodeAt()
• Aprende más sobre String.fromCharCode()
• Aprende más sobre ASCII
• Documentación de NPM

Herramientas:

• GitHub y GitHub Pages.

Organización del Trabajo:

• Metodologías Ágiles
• Scrum en menos de 2 minutos
• Scrum en Detalle. No esperamos que hagas todo eso desde este proyecto. Iremos profundizando poco a poco a lo largo del -bootcamp.