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

package/README.md

@@ -22,9 +22,8 @@ Official **Growy AI** plugin for Strapi that provide a custom encrypted text fie
 - ✅ **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.
+- ✅ **Native Strapi v5 UI** with visibility controls, redimensionable inputs 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.
 
@@ -39,9 +38,7 @@ yarn add @growy/strapi-plugin-encrypted-field
 ### Configuration
 
 #### 1. Enable the plugin
-
-Create or edit `config/plugins.js` or `config/plugins.ts`:
-
+Edit `config/plugins.js` or `config/plugins.ts`:
 ```javascript
 module.exports = {
   'encrypted-field': {
@@ -51,25 +48,43 @@ module.exports = {
 ```
 
 #### 2. Configure Encryption Key (REQUIRED)
-
 Add to your `.env`:
-
 ```bash
 ENCRYPTION_KEY=your_64_character_hex_key_here
 ```
 
-Generate a secure key:
+**Generate a secure key:**
 ```bash
 node -e "console.log(require('crypto').randomBytes(32).toString('hex'))"
 ```
 
-### Usage
+⚠️ **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.
+
+### Usage & Validation
 
-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.
+#### 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
+# 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" } }
+```
 
 ---
 
@@ -83,9 +98,8 @@ Plugin oficial de **Growy AI** para Strapi que proporciona un campo personalizad
 - ✅ **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.
+- ✅ **UI Nativa Strapi v5** con controles de visibilidad, inputs redimensionables 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.
 
@@ -100,9 +114,7 @@ yarn add @growy/strapi-plugin-encrypted-field
 ### Configuración
 
 #### 1. Habilitar el plugin
-
 Edita `config/plugins.js`:
-
 ```javascript
 module.exports = {
   'encrypted-field': {
@@ -112,44 +124,58 @@ module.exports = {
 ```
 
 #### 2. Configurar la clave (REQUERIDO)
-
 Agrega a tu `.env`:
-
 ```bash
 ENCRYPTION_KEY=tu_clave_de_64_caracteres_hexadecimales_aqui
 ```
 
-### Uso
+⚠️ **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.
+
+### Uso y Validación
 
-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.
+#### 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}$`.
 
-### Seguridad y Especificaciones
+#### 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": {"apiKey": "mi-clave-secreta-123"}}'
+
+# Leer (devuelve descifrado)
+curl -X GET http://localhost:1337/api/usuarios/1
+# Response: { "apiKey": "mi-clave-secreta-123" }
+```
 
-- **Algoritmo**: AES-256-GCM.
+### Especificaciones Técnicas
+
+- **Algoritmo**: AES-256-GCM (Grado militar).
 - **IV (Initialization Vector)**: 96 bits generado aleatoriamente por operación.
-- **Auth Tag**: 128 bits para verificación de integridad.
+- **Integridad**: Auth Tag de 128 bits para detectar manipulaciones.
 - **Formato almacenado**: `iv:authTag:encryptedData`.
 
-### Limitaciones
+### Limitaciones Conocidas
 
-- ❌ **Búsqueda**: No se puede buscar por campos cifrados.
+- ❌ **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 sobre datos cifrados.
+- ❌ **Filtros**: No se pueden aplicar filtros directos en la consulta a la BD.
 
 ---
 
 ## License / Licencia
-
 MIT © 2025 Growy AI
 
 ## Credits / Créditos
-
 **Growy AI** - Soluciones de IA y automatización empresarial
-
 **Main Author / Autor principal**: Zahir El isaac
 
 ---

package/package.json

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