@growy/strapi-plugin-encrypted-field 2.3.0 → 2.3.2

package/README.md

@@ -6,41 +6,39 @@
   <img src="https://img.shields.io/badge/Strapi-v5-blueviolet" alt="Strapi v5" />
 </div>
 
-Plugin oficial de **Growy AI** para Strapi que proporciona un campo personalizado de texto cifrado con AES-256-GCM. Protege información sensible directamente en tu base de datos con cifrado transparente y validación robusta.
+---
 
+### [English](#english-version) | [Español](#versión-en-español)
 
-- ✅ **Campo personalizado** "Texto Cifrado" en el Content-Type Builder
-- ✅ **Cifrado automático** AES-256-GCM al guardar
-- ✅ **Descifrado transparente** al leer (panel y API)
-- ✅ **Validación backend** con soporte para regex y restricciones
-- ✅ **UI mejorada** con controles de visibilidad y copiar al portapapeles
-- ✅ **Valores ocultos** por defecto con opción de mostrar/ocultar
-- ✅ **Notificaciones** de confirmación al copiar valores
-- ✅ **Gestión de claves robusta** con validación y mensajes de error claros
-- ✅ **Datos cifrados** en base de datos con IV único y Auth Tag
-- ✅ **Reutilizable** en cualquier colección o componente
-- ✅ **Soporte completo** para componentes anidados y estructuras complejas
+---
 
-## Instalación
+## English Version
 
-### Desde npm
+Official **Growy AI** plugin for Strapi that provide a custom encrypted text field using AES-256-GCM. Protect sensitive information directly in your database with transparent encryption and robust validation.
 
-```bash
-npm install @growy/strapi-plugin-encrypted-field
-```
+### Features
+
+- ✅ **Custom Field** "Encrypted Text" in the Content-Type Builder.
+- ✅ **Automatic Encryption** AES-256-GCM when saving.
+- ✅ **Transparent Decryption** when reading (Admin panel and API).
+- ✅ **Backend Validation** with regex support and length constraints.
+- ✅ **Native Strapi v5 UI** with visibility controls, redimensionable inputs and copy to clipboard.
+- ✅ **Multi-language support (i18n)**: English and Spanish.
+- ✅ **Encrypted Data** in database with unique IV and Auth Tag.
+- ✅ **Nested Components support** at any depth.
 
-### Desde yarn
+### Installation
 
 ```bash
+npm install @growy/strapi-plugin-encrypted-field
+# or
 yarn add @growy/strapi-plugin-encrypted-field
 ```
 
-## Configuración
-
-### 1. Habilitar el plugin
-
-Crea o edita `config/plugins.js` o `config/plugins.ts`:
+### Configuration
 
+#### 1. Enable the plugin
+Edit `config/plugins.js` or `config/plugins.ts`:
 ```javascript
 module.exports = {
   'encrypted-field': {
@@ -49,199 +47,140 @@ module.exports = {
 };
 ```
 
-### 2. Configurar la clave de cifrado (REQUERIDO)
-
-#### Opción A: Variable de entorno (recomendado)
-
-Agrega a tu `.env`:
-
+#### 2. Configure Encryption Key (REQUIRED)
+Add to your `.env`:
 ```bash
-ENCRYPTION_KEY=tu_clave_de_64_caracteres_hexadecimales_aqui
+ENCRYPTION_KEY=your_64_character_hex_key_here
 ```
 
-#### Opción B: Archivo de configuración
-
-Edita `config/plugins.js`:
-
-```javascript
-module.exports = ({ env }) => ({
-  'encrypted-field': {
-    enabled: true,
-    config: {
-      encryptionKey: env('ENCRYPTION_KEY'),
-    },
-  },
-});
-```
-
-#### Generar clave segura
-
+**Generate a secure key:**
 ```bash
 node -e "console.log(require('crypto').randomBytes(32).toString('hex'))"
 ```
 
-Esto generará una clave de 64 caracteres hexadecimales (32 bytes).
+⚠️ **CRITICAL - Key Management**:
+- **Store the key safely** (Secrets manager, encrypted env vars).
+- **Never** include it in version control.
+- **If you lose the key**, you will NOT be able to decrypt existing data.
+- **Use the same key** across all environments sharing the same database.
 
-⚠️ **CRÍTICO - Gestión de claves**:
-- **Guarda la clave de forma segura** (gestor de secretos, variables de entorno cifradas)
-- **Nunca** la incluyas en el control de versiones
-- **Si pierdes la clave**, no podrás descifrar los datos existentes
-- **Usa la misma clave** en todos los entornos que compartan la misma base de datos
-- **Para producción**, considera usar servicios como AWS Secrets Manager, HashiCorp Vault o similar
+### Usage & Validation
 
-### 3. Rebuild del admin
+#### Data Validation
+The plugin supports validation before encryption:
+1. In Content-Type Builder, select the encrypted field.
+2. Go to **"Advanced Settings"**.
+3. In **"RegEx pattern"**, enter your regular expression.
+**Example**: To validate an API key format: `^sk-[a-zA-Z0-9]{32}$`.
 
+#### API Usage
+The API returns decrypted values automatically for authorized requests.
 ```bash
-npm run build
-npm run develop
+# Create an entry
+curl -X POST http://localhost:1337/api/users \
+  -H "Content-Type: application/json" \
+  -d '{"data": {"apiKey": "my-secret-token"}}'
+
+# Read (returns decrypted)
+curl -X GET http://localhost:1337/api/users/1
+# Response: { "data": { "apiKey": "my-secret-token" } }
 ```
 
-## Requisitos
+---
 
-- **Strapi**: v5.0.0 o superior
-- **Node.js**: 18.x - 22.x
-- **npm**: 6.0.0 o superior
+## Versión en Español
 
-## Validación de datos
+Plugin oficial de **Growy AI** para Strapi que proporciona un campo personalizado de texto cifrado con AES-256-GCM. Protege información sensible directamente en tu base de datos con cifrado transparente y validación robusta.
 
-El plugin soporta validación antes del cifrado:
+### Características
 
-### Configurar validación regex
+- ✅ **Campo personalizado** "Texto Cifrado" en el Content-Type Builder.
+- ✅ **Cifrado automático** AES-256-GCM al guardar.
+- ✅ **Descifrado transparente** al leer (panel y API).
+- ✅ **Validación backend** con soporte para regex y restricciones.
+- ✅ **UI Nativa Strapi v5** con controles de visibilidad, inputs redimensionables y copiar al portapapeles.
+- ✅ **Soporte multi-idioma (i18n)**: Inglés y Español.
+- ✅ **Datos cifrados** en base de datos con IV único y Auth Tag.
+- ✅ **Soporte para componentes anidados** a cualquier profundidad.
 
-1. En el Content-Type Builder, selecciona el campo cifrado
-2. Ve a la pestaña **"Advanced Settings"**
-3. En **"RegEx pattern"**, ingresa tu expresión regular
-4. Guarda los cambios
+### Instalación
 
-**Ejemplo**: Para validar formato de API key:
-```regex
-^sk-[a-zA-Z0-9]{32}$
+```bash
+npm install @growy/strapi-plugin-encrypted-field
+# o
+yarn add @growy/strapi-plugin-encrypted-field
 ```
 
-Si el valor no cumple con el patrón, se lanzará un error antes de cifrar.
-
-## Uso
+### Configuración
 
-### 1. Agregar campo cifrado a una colección
-
-1. Ve a **Content-Type Builder**
-2. Selecciona una colección o crea una nueva
-3. Click en **"Add another field"**
-4. Busca **"Texto Cifrado"** (con icono 🔒)
-5. Configura el nombre del campo
-6. Guarda y reinicia Strapi
+#### 1. Habilitar el plugin
+Edita `config/plugins.js`:
+```javascript
+module.exports = {
+  'encrypted-field': {
+    enabled: true,
+  },
+};
+```
 
-### 2. Usar el campo
+#### 2. Configurar la clave (REQUERIDO)
+Agrega a tu `.env`:
+```bash
+ENCRYPTION_KEY=tu_clave_de_64_caracteres_hexadecimales_aqui
+```
 
-El campo funciona como un campo de texto normal con características de seguridad adicionales:
+⚠️ **CRÍTICO - Gestión de claves**:
+- **Guarda la clave de forma segura** (gestor de secretos, variables de entorno cifradas).
+- **Nunca** la incluyas en el control de versiones.
+- **Si pierdes la clave**, NO podrás descifrar los datos existentes.
 
-- **En el panel**: Escribe texto normalmente
-- **Valores ocultos**: Los valores se muestran como `***` por defecto
-- **Botón ojo**: Alterna entre mostrar/ocultar el valor
-- **Botón copiar**: Copia el valor al portapapeles con notificación de confirmación
-- **Placeholder personalizable**: Configura un placeholder desde las opciones del campo
-- **Al guardar**: Se cifra automáticamente
-- **Al leer**: Se descifra automáticamente
-- **En la BD**: Se guarda cifrado con formato `iv:authTag:encrypted`
-- **En componentes**: Funciona igual en componentes anidados de cualquier profundidad
+### Uso y Validación
 
-### 3. Uso por API
+#### Validación de datos
+El plugin soporta validación antes del cifrado:
+1. En el Content-Type Builder, selecciona el campo cifrado.
+2. Ve a la pestaña **"Advanced Settings"**.
+3. En **"RegEx pattern"**, ingresa tu expresión regular.
+**Ejemplo**: Para validar formato de API key: `^sk-[a-zA-Z0-9]{32}$`.
 
+#### Uso por API
+La API devuelve los valores descifrados automáticamente.
 ```bash
 # Crear con campo cifrado
 curl -X POST http://localhost:1337/api/usuarios \
   -H "Content-Type: application/json" \
-  -d '{
-    "data": {
-      "nombre": "Juan",
-      "apiKey": "mi-clave-secreta-123"
-    }
-  }'
+  -d '{"data": {"apiKey": "mi-clave-secreta-123"}}'
 
 # Leer (devuelve descifrado)
 curl -X GET http://localhost:1337/api/usuarios/1
-# Response: { "nombre": "Juan", "apiKey": "mi-clave-secreta-123" }
+# Response: { "apiKey": "mi-clave-secreta-123" }
 ```
 
-## Ejemplo de uso
+### Especificaciones Técnicas
 
-### Colección "Usuario" con API Key cifrada
+- **Algoritmo**: AES-256-GCM (Grado militar).
+- **IV (Initialization Vector)**: 96 bits generado aleatoriamente por operación.
+- **Integridad**: Auth Tag de 128 bits para detectar manipulaciones.
+- **Formato almacenado**: `iv:authTag:encryptedData`.
 
-**Schema:**
-```json
-{
-  "nombre": "string",
-  "email": "email",
-  "apiKey": "plugin::encrypted-field.encrypted-text"
-}
-```
+### Limitaciones Conocidas
 
-**En la BD:**
-```
-apiKey: "a1b2c3d4e5f6....:f9e8d7c6b5a4....:9f8e7d6c5b4a3..."
-```
+- ❌ **Búsqueda**: No se puede buscar por campos cifrados debido al cifrado en BD.
+- ❌ **Ordenamiento**: No se puede ordenar por campos cifrados.
+- ❌ **Filtros**: No se pueden aplicar filtros directos en la consulta a la BD.
 
-**En el panel y API:**
-```
-apiKey: "sk-1234567890abcdef"
-```
-
-## Seguridad y arquitectura
-
-### Especificaciones técnicas
-
-- **Algoritmo**: AES-256-GCM (estándar NIST, grado militar)
-- **Tamaño de clave**: 256 bits (32 bytes, 64 caracteres hexadecimales)
-- **IV (Initialization Vector)**: 96 bits (12 bytes) generado aleatoriamente por operación
-- **Auth Tag**: 128 bits (16 bytes) para verificación de integridad
-- **Formato almacenado**: `iv:authTag:encryptedData` (todos en hexadecimal)
-
-### Características de seguridad
-
-- ✅ **Cifrado autenticado**: GCM proporciona confidencialidad e integridad
-- ✅ **IV único**: Cada operación de cifrado genera un IV aleatorio
-- ✅ **Resistencia a manipulación**: Auth Tag detecta cualquier modificación
-- ✅ **Validación de entrada**: Soporte para regex y restricciones personalizadas
-- ✅ **Manejo de errores seguro**: Logs controlados sin exponer datos sensibles
-
-### Mejores prácticas
-
-1. **Rotación de claves**: Planifica un proceso de rotación periódica
-2. **Separación de entornos**: Usa claves diferentes para dev/staging/prod
-3. **Auditoría**: Monitorea logs de errores de cifrado/descifrado
-4. **Backup de claves**: Mantén copias seguras de las claves en múltiples ubicaciones
-5. **Campos privados**: Marca campos sensibles como "privados" para excluirlos de la API pública
-
-## Casos de uso
-
-- 🔑 API Keys de terceros
-- 🔐 Tokens de acceso
-- 🔒 Secretos de webhooks
-- 💳 Información sensible
-- 📧 Credenciales SMTP
-- 🔑 Contraseñas de aplicaciones
-
-## Limitaciones conocidas
-
-- ❌ **Búsqueda**: No se puede buscar por campos cifrados (datos cifrados en BD)
-- ❌ **Ordenamiento**: No se puede ordenar por campos cifrados
-- ❌ **Filtros**: No se pueden aplicar filtros directos sobre campos cifrados
-- ⚠️ **Rendimiento**: El cifrado/descifrado añade overhead mínimo (~1-2ms por operación)
-- ⚠️ **Sincronización de claves**: Todos los entornos que compartan BD deben usar la misma clave
-
-## Licencia
+---
 
+## License / Licencia
 MIT © 2025 Growy AI
 
-## Desarrollado por
-
+## Credits / Créditos
 **Growy AI** - Soluciones de IA y automatización empresarial
-
-**Autor principal**: Zahir El isaac
+**Main Author / Autor principal**: Zahir El isaac
 
 ---
 
 <div align="center">
-  <p>Si este plugin te resulta útil, considera darle una ⭐ en GitHub</p>
-  <p>Hecho con ❤️ por el equipo de Growy AI</p>
+  <p>If this plugin is useful to you, consider giving it a ⭐ on GitHub / Si este plugin te resulta útil, considera darle una ⭐ en GitHub</p>
+  <p>Made with ❤️ by Growy AI Team</p>
 </div>

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@growy/strapi-plugin-encrypted-field",
-  "version": "2.3.0",
+  "version": "2.3.2",
   "description": "Campo personalizado de texto cifrado para Strapi",
   "strapi": {
     "name": "encrypted-field",