Skip to main content

Acerca del generador de expresiones regulares para patrones personalizados

Puedes definir tus propios patrones personalizados para ampliar las capacidades de secret scanning generando una o más expresiones regulares para cada patrón, mediante el generador de expresiones regulares.

¿Quién puede utilizar esta característica?

Secret scanning alerts for partners runs automatically on public repositories and public npm packages to notify service providers about leaked secrets on GitHub.

Secret scanning alerts for users are available for user-owned public repositories for free. Organizations using GitHub Enterprise Cloud with a license for GitHub Advanced Security can also enable secret scanning alerts for users on their private and internal repositories. Additionally, secret scanning alerts for users are available and in beta on user-owned repositories for GitHub Enterprise Cloud with Enterprise Managed Users. For more information, see "About secret scanning" and "About GitHub Advanced Security."

For information about how you can try GitHub Advanced Security for free, see "Setting up a trial of GitHub Advanced Security."

Nota: El generador de expresiones regulares está en versión beta. La funcionalidad y la documentación están sujetas a cambios.

Acerca de generador de expresiones regulares

Secret scanning explora repositorios en busca de un conjunto predefinido de secretos de nuestro programa de socios, así como patrones personalizados definidos por el usuario. Los patrones personalizados se formatean como expresiones regulares.

Las expresiones regulares no son fáciles de escribir. El generador de expresiones regulares te permite definir tus patrones personalizados sin tener conocimientos de expresiones regulares. En la página de patrones personalizados existente, puedes iniciar una experiencia de IA generativa en la que escribes una descripción de texto del patrón que te gustaría detectar, incluyes cadenas de ejemplo opcionales que deberían detectarse y obtienes a cambio expresiones regulares coincidentes.

Procesamiento de entradas

Los usuarios escriben una descripción de texto de lo que les gustaría detectar y ejemplos opcionales de cadenas que deberían detectarse.

Generación de respuestas y formato de salida

El generador de expresiones regulares usa GPT-3.5-Turbo y la API GitHub Copilot para generar expresiones regulares que coincidan con los datos de entrada.

El modelo devuelve hasta tres expresiones regulares para revisar. Puedes hacer clic en la expresión regular para obtener una descripción en lenguaje llano de la expresión regular generada por la IA.

Algunos resultados pueden coincidir bastante, y otros pueden no encontrar todos los casos del secreto que el patrón pretende detectar. También es posible que el generador de expresiones regulares produzca resultados no válidos o inapropiados.

Al hacer clic en Usar resultado en una expresión regular, la expresión y los ejemplos introducidos se copiarán en el formulario principal de patrones personalizados. Desde allí, puedes realizar una prueba del patrón para ver cómo funciona en tu repositorio u organización. Para más información sobre cómo definir un patrón personalizado para tu repositorio u organización, consulta "Definición de patrones personalizados para el examen de secretos."

Mejora del rendimiento para generador de expresiones regulares

Para mejorar el rendimiento y abordar algunas de las limitaciones de generador de expresiones regulares, hay varias medidas que puedes adoptar. Para más información sobre las limitaciones del generador de expresiones regulares, consulta "Limitaciones de generador de expresiones regulares".

Usa como una herramienta , no como un reemplazo

Aunque es una potente herramienta para crear patrones personalizados sin tener que escribir expresiones regulares, es importante usarla como herramienta y no como reemplazo de la entrada manual de datos. Se debe validar cuidadosamente el rendimiento de los resultados mediante la realización de una ejecución en seco a través de su organización o repositorio. Se recomienda ejecutar el patrón en un repositorio (o repositorios) que sean representativos de los repositorios de la organización. En algunos casos, puede resultar beneficioso modificar una expresión regular generada para que se ajuste mejor a tus necesidades. En última instancia, la responsabilidad de los patrones personalizados que decidas usar recae sobre ti.

Envío de comentarios

El se encuentra actualmente en fase beta. Si encuentras algún problema o limitación con el , te recomendamos que envíes tus comentarios a través del botón Enviar comentarios en la parte superior del generador, en la interfaz de usuario. Esto puede ayudar a los desarrolladores a mejorar la herramienta y abordar cualquier problema o limitación.

Limitaciones del

En función de factores como la descripción de la entrada y los ejemplos, puede experimentar diferentes niveles de rendimiento al usar . Tiene que ser muy específico con su descripción y proporcionar diferentes tipos de ejemplos de tokens que coincidan con su patrón, para asegurarse de que la expresión regular abarca todos los patrones que quiere que secret scanning busque.

Además, el modelo que usa el se entrenó con contenido en lenguaje natural escrito mayormente en inglés. Como resultado, es posible que notes un rendimiento diferente cuando proporciones al generador entradas en lenguaje natural en idiomas distintos del inglés.

Nota: solo es adecuado para crear expresiones regulares para detectar patrones estructurados.

Pasos siguientes

Información adicional