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

package/README.md

@@ -6,40 +6,41 @@
   <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
 
-### Desde yarn
+- ✅ **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 and copy to clipboard.
+- ✅ **Multi-language support (i18n)**: English and Spanish.
+- ✅ **Secure Key Management** with validation and clear error messages.
+- ✅ **Encrypted Data** in database with unique IV and Auth Tag.
+- ✅ **Nested Components support** at any depth.
+
+### Installation
 
 ```bash
+npm install @growy/strapi-plugin-encrypted-field
+# or
 yarn add @growy/strapi-plugin-encrypted-field
 ```
 
-## Configuración
+### Configuration
 
-### 1. Habilitar el plugin
+#### 1. Enable the plugin
 
-Crea o edita `config/plugins.js` o `config/plugins.ts`:
+Create or edit `config/plugins.js` or `config/plugins.ts`:
 
 ```javascript
 module.exports = {
@@ -49,199 +50,111 @@ module.exports = {
 };
 ```
 
-### 2. Configurar la clave de cifrado (REQUERIDO)
+#### 2. Configure Encryption Key (REQUIRED)
 
-#### Opción A: Variable de entorno (recomendado)
-
-Agrega a tu `.env`:
+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).
-
-⚠️ **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
-
-### 3. Rebuild del admin
-
-```bash
-npm run build
-npm run develop
-```
-
-## Requisitos
-
-- **Strapi**: v5.0.0 o superior
-- **Node.js**: 18.x - 22.x
-- **npm**: 6.0.0 o superior
-
-## Validación de datos
+### Usage
 
-El plugin soporta validación antes del cifrado:
+1. Go to **Content-Type Builder**.
+2. Select a collection or create a new one.
+3. Click on **"Add another field"**.
+4. Select **"Encrypted Text"** (look for the 🔒 icon).
+5. Values are hidden by default in the Admin Panel but can be revealed or copied using the inline buttons.
 
-### Configurar validación regex
-
-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
-
-**Ejemplo**: Para validar formato de API key:
-```regex
-^sk-[a-zA-Z0-9]{32}$
-```
-
-Si el valor no cumple con el patrón, se lanzará un error antes de cifrar.
-
-## Uso
-
-### 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
+## Versión en Español
 
-### 2. Usar el campo
+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 campo funciona como un campo de texto normal con características de seguridad adicionales:
+### Características
 
-- **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
+- ✅ **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 y copiar al portapapeles.
+- ✅ **Soporte multi-idioma (i18n)**: Inglés y Español.
+- ✅ **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.
+- ✅ **Soporte para componentes anidados** a cualquier profundidad.
 
-### 3. Uso por API
+### Instalación
 
 ```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"
-    }
-  }'
-
-# Leer (devuelve descifrado)
-curl -X GET http://localhost:1337/api/usuarios/1
-# Response: { "nombre": "Juan", "apiKey": "mi-clave-secreta-123" }
+npm install @growy/strapi-plugin-encrypted-field
+# o
+yarn add @growy/strapi-plugin-encrypted-field
 ```
 
-## Ejemplo de uso
+### Configuración
 
-### Colección "Usuario" con API Key cifrada
+#### 1. Habilitar el plugin
 
-**Schema:**
-```json
-{
-  "nombre": "string",
-  "email": "email",
-  "apiKey": "plugin::encrypted-field.encrypted-text"
-}
-```
-
-**En la BD:**
-```
-apiKey: "a1b2c3d4e5f6....:f9e8d7c6b5a4....:9f8e7d6c5b4a3..."
-```
+Edita `config/plugins.js`:
 
-**En el panel y API:**
-```
-apiKey: "sk-1234567890abcdef"
+```javascript
+module.exports = {
+  'encrypted-field': {
+    enabled: true,
+  },
+};
 ```
 
-## Seguridad y arquitectura
-
-### Especificaciones técnicas
+#### 2. Configurar la clave (REQUERIDO)
 
-- **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)
+Agrega a tu `.env`:
 
-### Características de seguridad
+```bash
+ENCRYPTION_KEY=tu_clave_de_64_caracteres_hexadecimales_aqui
+```
 
-- ✅ **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
+### Uso
 
-### Mejores prácticas
+1. Ve a **Content-Type Builder**.
+2. Selecciona una colección.
+3. Click en **"Add another field"**.
+4. Selecciona **"Texto Cifrado"** (icono 🔒).
+5. Los valores están ocultos por defecto en el panel pero pueden mostrarse o copiarse con los botones integrados.
 
-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
+### Seguridad y Especificaciones
 
-## Casos de uso
+- **Algoritmo**: AES-256-GCM.
+- **IV (Initialization Vector)**: 96 bits generado aleatoriamente por operación.
+- **Auth Tag**: 128 bits para verificación de integridad.
+- **Formato almacenado**: `iv:authTag:encryptedData`.
 
-- 🔑 API Keys de terceros
-- 🔐 Tokens de acceso
-- 🔒 Secretos de webhooks
-- 💳 Información sensible
-- 📧 Credenciales SMTP
-- 🔑 Contraseñas de aplicaciones
+### Limitaciones
 
-## Limitaciones conocidas
+- ❌ **Búsqueda**: No se puede buscar por campos cifrados.
+- ❌ **Ordenamiento**: No se puede ordenar por campos cifrados.
+- ❌ **Filtros**: No se pueden aplicar filtros directos sobre datos cifrados.
 
-- ❌ **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.1",
   "description": "Campo personalizado de texto cifrado para Strapi",
   "strapi": {
     "name": "encrypted-field",