Merge pull request #106 from cupcakearmy/2.4.0

2.4.0

.nvmrc

@@ -1 +1 @@
-v18.16
+v20.9.0

CHANGELOG.md

@@ -5,6 +5,13 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [2.4.0] - 2023-11-01
+
+### Changed
+
+- Removed HTML sanitation, display the original message as string
+- Links are now displayed under the note in a separate section
+
 ## [2.3.1] - 2023-06-23
 
 ### Added

Dockerfile

@@ -8,12 +8,9 @@ RUN pnpm run build
 
 
 # BACKEND
-FROM rust:1.69-alpine as backend
+FROM rust:1.73-alpine as backend
 WORKDIR /tmp
 RUN apk add libc-dev openssl-dev alpine-sdk
-COPY ./packages/backend/Cargo.* ./
-ENV CARGO_REGISTRIES_CRATES_IO_PROTOCOL=sparse
-RUN cargo fetch
 COPY ./packages/backend ./
 RUN cargo build --release
 

README.md

@@ -14,7 +14,7 @@
 <a href=""><img src="./.github/lokalise.png" height="50">
 <br/><br/>
 
-EN | [简体中文](README_zh-CN.md)
+EN | [简体中文](README_zh-CN.md) | [ES](README_ES.md) 
 
 ## About?
 

README_ES.md

@@ -0,0 +1,200 @@
+<p align="center">
+  <img src="./design/Github.png" alt="logo">
+</p>
+
+<a href="https://discord.gg/nuby6RnxZt">
+  <img alt="discord" src="https://img.shields.io/discord/252403122348097536?style=for-the-badge" />
+  <img alt="docker pulls" src="https://img.shields.io/docker/pulls/cupcakearmy/cryptgeon?style=for-the-badge" />
+  <img alt="Docker image size badge" src="https://img.shields.io/docker/image-size/cupcakearmy/cryptgeon?style=for-the-badge" />
+  <img alt="Latest version" src="https://img.shields.io/github/v/release/cupcakearmy/cryptgeon?style=for-the-badge" />
+</a>
+
+<br/><br/>
+<a href="https://www.producthunt.com/posts/cryptgeon?utm_source=badge-featured&utm_medium=badge&utm_souce=badge-cryptgeon" target="_blank"><img src="https://api.producthunt.com/widgets/embed-image/v1/featured.svg?post_id=295189&theme=light" alt="Cryptgeon - Securely share self-destructing notes | Product Hunt" height="50" /></a>
+<a href=""><img src="./.github/lokalise.png" height="50">
+<br/><br/>
+
+[EN](README.md) | [简体中文](README_zh-CN.md) | ES
+
+## Acerca de
+
+_cryptgeon_ es un servicio seguro y de código abierto para compartir notas o archivos inspirado en [_PrivNote_](https://privnote.com).
+Incluye un servidor, una página web y una interfaz de línea de comandos (CLI, por sus siglas en inglés).
+
+> 🌍 Si quieres traducir este proyecto no dudes en ponerte en contacto conmigo.
+>
+> Gracias a [Lokalise](https://lokalise.com/) por darnos acceso gratis a su plataforma.
+
+## Demo
+
+### Web
+
+Prueba la demo y experimenta por ti mismo [cryptgeon.org](https://cryptgeon.org)
+
+### CLI
+
+```
+npx cryptgeon send text "Esto es una nota secreta"
+```
+
+Puedes revisar la documentación sobre el CLI en este [readme](./packages/cli/README.md).
+
+## Características
+
+- enviar texto o archivos
+- el servidor no puede desencriptar el contenido debido a que la encriptación se hace del lado del cliente
+- restriccion de vistas o de tiempo
+- en memoria, sin persistencia
+- compatibilidad obligatoria con el modo oscuro
+
+## ¿Cómo funciona?
+
+Se genera una <code>id (256bit)</code> y una <code>llave 256(bit)</code> para cada nota. La
+<code>id</code>
+se usa para guardar y recuperar la nota. Después la nota es encriptada con la <code>llave</code> y con aes en modo gcm del lado del cliente y por último se envía al servidor. La información es almacenada en memoria y nunca persiste en el disco. El servidor nunca ve la llave de encriptación por lo que no puede desencriptar el contenido de las notas aunque lo intentara.
+
+## Capturas de pantalla
+
+![screenshot](./design/Screens.png)
+
+## Variables de entorno
+
+| Variable           | Default          | Descripción                                                                                                                                                                                                   |
+| ------------------ | ---------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `REDIS`            | `redis://redis/` | Redis URL a la que conectarse. [Según el formato](https://docs.rs/redis/latest/redis/#connection-parameters)                                                                                                     |
+| `SIZE_LIMIT`       | `1 KiB`          | Tamaño máximo. Valores aceptados según la [unidad byte](https://docs.rs/byte-unit/). <br> `512 MiB` es el máximo permitido. <br> El frontend mostrará ese número, incluyendo el ~35% de sobrecarga de codificación. |
+| `MAX_VIEWS`        | `100`            | Número máximo de vistas.                                                                                                                                                                                      |
+| `MAX_EXPIRATION`   | `360`            | Tiempo máximo de expiración en minutos.                                                                                                                                                                                |
+| `ALLOW_ADVANCED`   | `true`           | Permitir configuración personalizada. Si se establece en `false` todas las notas serán de una sola vista.                                                                                                                                |
+| `ID_LENGTH`        | `32`             | Establece el tamaño en bytes de la `id` de la nota. Por defecto es de `32` bytes. Esto es util para reducir el tamaño del link. _Esta configuración no afecta el nivel de encriptación_.                                             |
+| `VERBOSITY`        | `warn`           | Nivel de verbosidad del backend. [Posibles valores](https://docs.rs/env_logger/latest/env_logger/#enabling-logging): `error`, `warn`, `info`, `debug`, `trace`                                             |
+| `THEME_IMAGE`      | `""`             | Imagen personalizada para reemplazar el logo. Debe ser accesible públicamente.                                                                                                                                               |
+| `THEME_TEXT`       | `""`             | Texto personalizado para reemplazar la descripción bajo el logo.                                                                                                                                                      |
+| `THEME_PAGE_TITLE` | `""`             | Texto personalizado para el título                                                                                                                                                                                    |
+| `THEME_FAVICON`    | `""`             | Url personalizada para el favicon. Debe ser accesible públicamente.                                                                                                                                                        |
+
+## Despliegue
+
+> ℹ️ Se requiere `https` de lo contrario el navegador no soportará las funciones de encriptacón.
+
+> ℹ️ Hay un endpoint para verificar el estado, lo encontramos en `/api/health/`. Regresa un código 200 o 503.
+
+### Docker
+
+Docker es la manera más fácil. Aquí encontramos [la imágen oficial](https://hub.docker.com/r/cupcakearmy/cryptgeon).
+
+```yaml
+# docker-compose.yml
+
+version: '3.8'
+
+services:
+  redis:
+    image: redis:7-alpine
+    # Set a size limit. See link below on how to customise.
+    # https://redis.io/docs/manual/eviction/
+    # command: redis-server --maxmemory 1gb --maxmemory-policy allkeys-lru
+
+  app:
+    image: cupcakearmy/cryptgeon:latest
+    depends_on:
+      - redis
+    environment:
+      # Size limit for a single note.
+      SIZE_LIMIT: 4 MiB
+    ports:
+      - 80:8000
+
+    # Optional health checks
+    # healthcheck:
+    #   test: ["CMD", "curl", "--fail", "http://127.0.0.1:8000/api/live/"]
+    #   interval: 1m
+    #   timeout: 3s
+    #   retries: 2
+    #   start_period: 5s
+```
+
+### NGINX Proxy
+
+Ver la carpeta de [ejemplo/nginx](https://github.com/cupcakearmy/cryptgeon/tree/main/examples/nginx). Hay un ejemplo con un proxy simple y otro con https. Es necesario que especifiques el nombre del servidor y los certificados.
+
+### Traefik 2
+
+Ver la carpeta de [ejemplo/traefik](https://github.com/cupcakearmy/cryptgeon/tree/main/examples/traefik).
+
+### Scratch
+
+Ver la carpeta de [ejemplo/scratch](https://github.com/cupcakearmy/cryptgeon/tree/main/examples/scratch). Ahí encontrarás una guía de cómo configurar el servidor e instalar cryptgeon desde cero.
+
+### Synology
+
+Hay una [guía](https://mariushosting.com/how-to-install-cryptgeon-on-your-synology-nas/) (en inglés) que puedes seguir.
+
+### Guías en Youtube
+
+- En inglés, por [Webnestify](https://www.youtube.com/watch?v=XAyD42I7wyI)
+- En inglés, por [DB Tech](https://www.youtube.com/watch?v=S0jx7wpOfNM) [Previous Video](https://www.youtube.com/watch?v=JhpIatD06vE)
+- En alemán, por [ApfelCast](https://www.youtube.com/watch?v=84ZMbE9AkHg)
+
+## Desarrollo
+
+**Requisitos**
+
+- `pnpm`: `>=6`
+- `node`: `>=18`
+- `rust`: edition `2021`
+
+**Instalación**
+
+```bash
+pnpm install
+
+# También necesitas cargo-watch, si no lo tienes instalado.
+# https://lib.rs/crates/cargo-watch
+cargo install cargo-watch
+```
+
+**Ejecutar**
+
+Asegurate de que docker se esté ejecutando.
+
+```bash
+pnpm run dev
+```
+
+Ejecutando `pnpm run dev` en la carpeta raíz iniciará lo siguiente:
+
+- redis docker container
+- rust backend
+- client
+- cli
+
+Puedes ver la app en [localhost:1234](http://localhost:1234).
+
+> Existe una colección de Postman con algunas peticiones de ejemplo [disponible en el repo](./Cryptgeon.postman_collection.json)
+
+### Tests
+
+Los tests son end-to-end tests escritos con Playwright.
+
+```sh
+pnpm run test:prepare
+
+# Usa el script test o test:local. La versión local solo corre en el navegador para acelerar el desarrollo.
+pnpm run test:local
+```
+
+## Seguridad
+
+Por favor dirigite a la sección de seguridad [aquí](./SECURITY.md).
+
+---
+
+_Atribuciones_
+
+- Datos del Test:
+  - Texto para los tests [Nietzsche Ipsum](https://nietzsche-ipsum.com/)
+  - [AES Paper](https://www.cs.miami.edu/home/burt/learning/Csc688.012/rijndael/rijndael_doc_V2.pdf)
+  - [Unsplash Imágenes](https://unsplash.com/)
+- Animación de carga por [Nikhil Krishnan](https://codepen.io/nikhil8krishnan/pen/rVoXJa)
+- Iconos hechos por <a href="https://www.freepik.com" title="Freepik">freepik</a> de <a href="https://www.flaticon.com/" title="Flaticon">www.flaticon.com</a>

README_zh-CN.md

@@ -14,7 +14,7 @@
 <a href=""><img src="./.github/lokalise.png" height="50">
 <br/>
 
-[EN](README.md) | 简体中文
+[EN](README.md) | 简体中文 | [ES](README_ES.md) 
 
 ## 关于本项目
 

package.json

@@ -1,5 +1,5 @@
 {
-  "packageManager": "pnpm@8.6.3",
+  "packageManager": "pnpm@8.10.1",
   "scripts": {
     "dev:docker": "docker-compose -f docker-compose.dev.yaml up redis",
     "dev:packages": "pnpm --parallel run dev",
@@ -13,8 +13,8 @@
     "build": "pnpm run --recursive --filter=!@cryptgeon/backend build"
   },
   "devDependencies": {
-    "@playwright/test": "^1.33.0",
-    "@types/node": "^20.1.3",
+    "@playwright/test": "^1.39.0",
+    "@types/node": "^20.8.10",
     "npm-run-all": "^4.1.5",
     "shelljs": "^0.8.5"
   }

packages/backend/Cargo.toml

@@ -1,8 +1,9 @@
 [package]
 name = "cryptgeon"
-version = "2.3.1"
+version = "2.4.0"
 authors = ["cupcakearmy <hi@nicco.io>"]
 edition = "2021"
+rust-version = "1.73"
 
 [[bin]]
 name = "cryptgeon"

packages/cli/package.json

@@ -1,5 +1,5 @@
 {
-  "version": "2.3.1",
+  "version": "2.4.0",
   "name": "cryptgeon",
   "repository": {
     "type": "git",
@@ -26,18 +26,18 @@
     "dist"
   ],
   "devDependencies": {
-    "@commander-js/extra-typings": "^10.0.3",
+    "@commander-js/extra-typings": "^11.1.0",
     "@cryptgeon/shared": "workspace:*",
-    "@types/inquirer": "^9.0.3",
-    "@types/mime": "^3.0.1",
-    "@types/node": "^20.1.3",
-    "commander": "^10.0.1",
-    "esbuild": "^0.17.19",
-    "inquirer": "^9.2.2",
+    "@types/inquirer": "^9.0.6",
+    "@types/mime": "^3.0.3",
+    "@types/node": "^20.8.10",
+    "commander": "^11.1.0",
+    "esbuild": "^0.19.5",
+    "inquirer": "^9.2.11",
     "mime": "^3.0.0",
     "occulto": "^2.0.1",
     "pkg": "^5.8.1",
-    "pretty-bytes": "^6.1.0",
-    "typescript": "^5.0.4"
+    "pretty-bytes": "^6.1.1",
+    "typescript": "^5.2.2"
   }
 }

packages/frontend/locales/de.json

@@ -47,7 +47,8 @@
 		"explanation": "Klicken Sie unten, um die Notiz anzuzeigen und zu löschen, wenn der Zähler sein Limit erreicht hat",
 		"show_note": "Notiz anzeigen",
 		"warning_will_not_see_again": "haben Sie <b>keine</b> Gelegenheit, die Notiz noch einmal zu sehen.",
-		"download_all": "alle herunterladen"
+		"download_all": "alle herunterladen",
+		"links_found": "Links in der Notiz:"
 	},
 	"file_upload": {
 		"selected_files": "Ausgewählte Dateien",

packages/frontend/locales/en.json

@@ -47,7 +47,8 @@
 		"explanation": "click below to show and delete the note if the counter has reached it's limit",
 		"show_note": "show note",
 		"warning_will_not_see_again": "you will <b>not</b> get the chance to see the note again.",
-		"download_all": "download all"
+		"download_all": "download all",
+		"links_found": "links found inside the note:"
 	},
 	"file_upload": {
 		"selected_files": "Selected Files",

packages/frontend/locales/es.json

@@ -23,7 +23,7 @@
 		"intro": "Envía fácilmente notas o archivos <i>totalmente encriptados</i> y seguros con un solo clic. Solo tienes que crear una nota y compartir el enlace.",
 		"explanation": "la nota expirará y se destruirá después de {type}.",
 		"new_note": "nueva nota",
-		"new_note_notice": "<b>disponibilidad:</b><br />no se garantiza que la nota se almacene, ya que todo se guarda en la memoria RAM, si se llena se eliminarán las notas más antiguas.<br />(probablemente estará bien, sólo está advertido.)",
+		"new_note_notice": "<b>disponibilidad:</b><br />no se garantiza que la nota se almacene, ya que todo se guarda en la memoria RAM, si se llena se eliminarán las notas más antiguas.<br />(probablemente estará bien, solo está advertido.)",
 		"errors": {
 			"note_to_big": "no se pudo crear la nota. la nota es demasiado grande",
 			"note_error": "No se ha podido crear la nota. Por favor, inténtelo de nuevo.",
@@ -34,7 +34,7 @@
 			"note_created": "nota creada."
 		},
 		"advanced": {
-			"explanation": "Por defecto, se utiliza una contraseña generada de forma segura para cada nota. No obstante, también puede elegir su propia contraseña, que no se incluye en el enlace.",
+			"explanation": "Por defecto, se utiliza una contraseña generada de forma segura para cada nota. No obstante, también puede elegir su propia contraseña, la cual no se incluye en el enlace.",
 			"custom_password": "contraseña personalizada"
 		}
 	},
@@ -47,7 +47,8 @@
 		"explanation": "pulse abajo para mostrar y borrar la nota si el contador ha llegado a su límite",
 		"show_note": "mostrar nota",
 		"warning_will_not_see_again": "<b>no</b> tendrás la oportunidad de volver a ver la nota.",
-		"download_all": "descargar todo"
+		"download_all": "descargar todo",
+		"links_found": "enlaces que se encuentran dentro de la nota:"
 	},
 	"file_upload": {
 		"selected_files": "Archivos seleccionados",

packages/frontend/locales/fr.json

@@ -47,7 +47,8 @@
 		"explanation": "Cliquez ci-dessous pour afficher et supprimer la note si le compteur a atteint sa limite.",
 		"show_note": "note de présentation",
 		"warning_will_not_see_again": "vous <b>n'aurez pas</b> la chance de revoir la note.",
-		"download_all": "télécharger tout"
+		"download_all": "télécharger tout",
+		"links_found": "liens trouvés à l’intérieur de la note :"
 	},
 	"file_upload": {
 		"selected_files": "Fichiers sélectionnés",

packages/frontend/locales/it.json

@@ -47,7 +47,8 @@
 		"explanation": "clicca sotto per mostrare e cancellare la nota se il contatore ha raggiunto il suo limite",
 		"show_note": "mostra la nota",
 		"warning_will_not_see_again": "<b>non</b> avrete la possibilità di rivedere la nota.",
-		"download_all": "scarica tutti"
+		"download_all": "scarica tutti",
+		"links_found": "link presenti all'interno della nota:"
 	},
 	"file_upload": {
 		"selected_files": "File selezionati",

packages/frontend/locales/ja.json

@@ -47,7 +47,8 @@
 		"explanation": "カウンターが上限に達した場合、ノートの表示と削除を行うには、以下をクリックします。",
 		"show_note": "メモを表示",
 		"warning_will_not_see_again": "あなた <b>できません</b> このノートをもう一度見る",
-		"download_all": "すべてダウンロード"
+		"download_all": "すべてダウンロード",
+		"links_found": "メモ内にあるリンク:"
 	},
 	"file_upload": {
 		"selected_files": "選択したファイル",

packages/frontend/locales/ru.json

@@ -47,7 +47,8 @@
 		"explanation": "щелкните ниже, чтобы показать и удалить примечание, если счетчик достиг предела",
 		"show_note": "показать заметку",
 		"warning_will_not_see_again": "вы <b>не сможете</b> больше просмотреть заметку.",
-		"download_all": "скачать всё"
+		"download_all": "скачать всё",
+		"links_found": "ссылки внутри заметки:"
 	},
 	"file_upload": {
 		"selected_files": "Выбранные файлы",

packages/frontend/locales/zh.json

@@ -47,7 +47,8 @@
 		"explanation": "点击下方按钮即可查看密信，阅后即焚。",
 		"show_note": "查看密信",
 		"warning_will_not_see_again": "你将<b>无法</b>再次查看该密信，请尽快复制到粘贴板。",
-		"download_all": "下载全部"
+		"download_all": "下载全部",
+		"links_found": "注释中找到的链接："
 	},
 	"file_upload": {
 		"selected_files": "已选中的文件",

packages/frontend/package.json

@@ -13,29 +13,27 @@
 	},
 	"type": "module",
 	"devDependencies": {
-		"@lokalise/node-api": "^9.8.0",
-		"@sveltejs/adapter-static": "^2.0.2",
-		"@sveltejs/kit": "^1.16.3",
-		"@types/dompurify": "^3.0.2",
-		"@types/file-saver": "^2.0.5",
-		"@zerodevx/svelte-toast": "^0.9.3",
+		"@lokalise/node-api": "^12.0.0",
+		"@sveltejs/adapter-static": "^2.0.3",
+		"@sveltejs/kit": "^1.27.2",
+		"@types/file-saver": "^2.0.6",
+		"@zerodevx/svelte-toast": "^0.9.5",
 		"adm-zip": "^0.5.10",
-		"dotenv": "^16.0.3",
-		"svelte": "^3.59.1",
-		"svelte-check": "^3.3.2",
-		"svelte-intl-precompile": "^0.12.1",
-		"tslib": "^2.5.0",
-		"typescript": "^5.0.4",
-		"vite": "^4.3.5"
+		"dotenv": "^16.3.1",
+		"svelte": "^4.2.2",
+		"svelte-check": "^3.5.2",
+		"svelte-intl-precompile": "^0.12.3",
+		"tslib": "^2.6.2",
+		"typescript": "^5.2.2",
+		"vite": "^4.5.0"
 	},
 	"dependencies": {
 		"@cryptgeon/shared": "workspace:*",
-		"@fontsource/fira-mono": "^4.5.10",
+		"@fontsource/fira-mono": "^5.0.8",
 		"copy-to-clipboard": "^3.3.3",
-		"dompurify": "^3.0.3",
 		"file-saver": "^2.0.5",
 		"occulto": "^2.0.1",
-		"pretty-bytes": "^6.1.0",
+		"pretty-bytes": "^6.1.1",
 		"qrious": "^4.0.2"
 	}
 }

packages/frontend/src/lib/ui/ShowNote.svelte

@@ -3,7 +3,6 @@
 </script>
 
 <script lang="ts">
-	import DOMPurify from 'dompurify'
 	import { saveAs } from 'file-saver'
 	import prettyBytes from 'pretty-bytes'
 	import { t } from 'svelte-intl-precompile'
@@ -34,22 +33,29 @@
 		saveAs(f)
 	}
 
-	function contentWithLinks(content: string): string {
-		const replaced = content.replace(
-			RE_URL,
-			(url) => `<a href="${url}" rel="noreferrer">${url}</a>`
-		)
-		return DOMPurify.sanitize(replaced, { USE_PROFILES: { html: true } })
-	}
+	$: links = typeof note.contents === 'string' ? note.contents.match(RE_URL) : []
 </script>
 
 <p class="error-text">{@html $t('show.warning_will_not_see_again')}</p>
 <div data-testid="result">
 	{#if note.meta.type === 'text'}
 		<div class="note">
-			{@html contentWithLinks(note.contents)}
+			{note.contents}
 		</div>
 		<Button on:click={() => copy(note.contents)}>{$t('common.copy_clipboard')}</Button>
+
+		{#if links && links.length}
+			<div class="links">
+				{$t('show.links_found')}
+				<ul>
+					{#each links as link}
+						<li>
+							<a href={link} target="_blank" rel="noopener noreferrer">{link}</a>
+						</li>
+					{/each}
+				</ul>
+			</div>
+		{/if}
 	{:else}
 		{#each files as file}
 			<div class="note file">
@@ -92,4 +98,20 @@
 	.note.file small {
 		padding-left: 1rem;
 	}
+
+	.links {
+		margin-top: 2rem;
+	}
+	.links ul {
+		margin: 0;
+		padding: 0;
+		margin-top: 0.5rem;
+		padding-left: 1rem;
+		list-style: square;
+	}
+
+	.links ul li {
+		margin-bottom: 0.5rem;
+		word-wrap: break-word;
+	}
 </style>

packages/frontend/src/lib/views/Create.svelte

@@ -1,5 +1,5 @@
 <script lang="ts">
-	import { AES, Hex, Bytes } from 'occulto'
+	import { AES, Hex } from 'occulto'
 	import { t } from 'svelte-intl-precompile'
 	import { blur } from 'svelte/transition'
 
@@ -14,7 +14,7 @@
 	import Switch from '$lib/ui/Switch.svelte'
 	import TextArea from '$lib/ui/TextArea.svelte'
 	import type { FileDTO, Note } from '@cryptgeon/shared'
-	import { Adapters, create, PayloadToLargeError } from '@cryptgeon/shared'
+	import { Adapters, PayloadToLargeError, create } from '@cryptgeon/shared'
 
 	let note: Note = {
 		contents: '',
@@ -149,7 +149,7 @@
 			</p>
 
 			{#if advanced}
-				<div transition:blur={{ duration: 250 }}>
+				<div transition:blur|global={{ duration: 250 }}>
 					<hr />
 					<AdvancedParameters bind:note bind:timeExpiration bind:customPassword />
 				</div>

packages/shared/package.json

@@ -14,7 +14,7 @@
     "build": "tsc"
   },
   "devDependencies": {
-    "typescript": "^5.0.4"
+    "typescript": "^5.2.2"
   },
   "dependencies": {
     "occulto": "^2.0.1"