Por qué importan los patrones personalizados

Si bien AI Diff Review viene con patrones integrados para secretos comunes, tu base de código puede usar formatos personalizados que no están cubiertos por los valores predeterminados. Crear patrones de redacción personalizados asegura que todos tus secretos estén protegidos, independientemente de su formato.

Entender el formato de patrones

Los patrones de redacción usan expresiones regulares (regex), dándote capacidades de coincidencia poderosas. Un buen patrón debería:

  • Coincidir con tu formato de secreto con precisión
  • No coincidir con valores no secretos (evitar falsos positivos)
  • Ser lo suficientemente específico para capturar variaciones
  • No ser demasiado amplio (evitar redactar demasiado)

Ejemplos de patrones comunes

Claves API con prefijos

API_KEY\s*[:=]\s*['"]?[A-Za-z0-9]{32,}['"]?

Coincide con claves API en varios formatos de asignación con claves de 32+ caracteres.

Tokens JWT

eyJ[A-Za-z0-9_-]{20,}\.[A-Za-z0-9_-]{20,}\.[A-Za-z0-9_-]{20,}

Coincide con tokens JWT (tres partes codificadas en base64 separadas por puntos).

Cadenas de conexión a base de datos

(?:jdbc:|mongodb\+srv://|postgresql://)[^\s'"]+

Coincide con varias cadenas de conexión a base de datos.

Tokens OAuth

oauth[_-]?token\s*[:=]\s*['"]?[A-Za-z0-9_-]{20,}['"]?

Coincide con tokens OAuth en varios formatos.

Crear patrones personalizados

Para agregar un patrón personalizado:

  1. Ve a Configuración → Herramientas → AI Diff Review
  2. Navega a la sección Redacción de secretos
  3. Haz clic en "Agregar patrón"
  4. Ingresa tu patrón regex
  5. El patrón se valida inmediatamente
  6. Los patrones inválidos muestran un mensaje de error

Validación de patrones

AI Diff Review valida patrones cuando los agregas o editas:

  • La sintaxis regex inválida se detecta inmediatamente
  • Los mensajes de error explican qué está mal
  • No puedes guardar patrones inválidos
  • Esto previene frustración por patrones rotos

Gestión de patrones

Ver patrones

Puedes ver todos los patrones (integrados y personalizados) en la configuración. Los patrones integrados están marcados y no se pueden eliminar, pero puedes deshabilitarlos si es necesario.

Editar patrones

Los patrones personalizados se pueden editar en cualquier momento. Haz clic en un patrón para modificarlo, y la validación ocurre inmediatamente.

Eliminar patrones

Puedes eliminar patrones personalizados que ya no necesites. Los patrones integrados no se pueden eliminar pero se pueden deshabilitar.

Reordenar patrones

Los patrones se aplican en orden, por lo que el reordenamiento importa. Los patrones más específicos deben venir antes de los generales para asegurar coincidencia correcta.

Importar y exportar

Puedes exportar tu conjunto de patrones a un archivo de texto (un regex por línea) e importarlo en otras máquinas. Esto es útil para:

  • Compartir patrones con miembros del equipo
  • Respaldar tu configuración
  • Usar los mismos patrones entre proyectos
  • Controlar la versión de tus patrones

Probar patrones

Después de crear un patrón, pruébalo:

  1. Crea un commit de prueba con secretos de ejemplo
  2. Ejecuta un análisis
  3. Verifica que los secretos se redacten correctamente
  4. Verifica que no haya falsos positivos (no secretos siendo redactados)
  5. Ajusta el patrón si es necesario

Mejores prácticas

Comenzar específico

Crea patrones específicos primero, luego agrega más generales si es necesario. Los patrones específicos tienen menos probabilidad de causar falsos positivos.

Probar a fondo

Prueba patrones con ejemplos reales de tu base de código para asegurar que funcionen correctamente.

Documentar patrones

Considera documentar qué coincide cada patrón personalizado, especialmente si tien muchos patrones.

Revisar regularmente

Revisa periódicamente tus patrones para asegurar que sigan siendo relevantes y no causen problemas.

El orden importa

Coloca patrones más específicos antes de los generales. La primera coincidencia gana, por lo que el orden afecta lo que se redacta.

Errores comunes

Demasiado amplio

Evita patrones que coincidan con demasiado. Por ejemplo, no redactes todas las cadenas—sé específico sobre qué constituye un secreto.

Demasiado estrecho

Asegúrate de que los patrones capturen variaciones. Si tus secretos pueden aparecer en diferentes formatos, tenlo en cuenta.

No probar

Siempre prueba patrones antes de confiar en ellos. Un patrón que parece correcto podría no funcionar como se espera.

Conclusión

Los patrones de redacción de secretos personalizados te permiten proteger tus formatos de secretos específicos, asegurando protección integral para tu base de código. Al entender regex y seguir mejores prácticas, puedes crear patrones efectivos que mantengan tus secretos seguros.

Recuerda probar patrones, ordenarlos correctamente y revisarlos regularmente. Con una gestión adecuada de patrones, puedes mantener una seguridad fuerte mientras usas revisión de código con IA.

¿Listo para personalizar tu protección? Instala AI Diff Review y comienza a crear patrones de redacción personalizados para tu base de código.