Esta guía describe cómo integrar New Relic Gestión de vulnerabilidades con Snyk Webhooks. Los webhooks en Snyk son una característica beta que solo está disponible para clientes Business o Enterprise de Snyk. Como característica beta, la API y la estructura de Webhook pueden cambiar sin previo aviso, por lo tanto, tenga discreción al utilizar Webhooks para la automatización de sus procesos de seguridad.
Si bien haremos todo lo posible para mantenernos sincronizados con los cambios en Snyk Webhooks, si nota que no estamos sincronizados, háganoslo saber.
Después de completar estos pasos, verá las nuevas vulnerabilidades detectadas por Snyk en su cuenta New Relic en tiempo real y podrá crear un panel de análisis de los problemas recién detectados.
Para obtener más información, consulte la documentación oficial de Snyk.
Requisitos previos
Un token API de Snyk
New Relic
Debes ser administrador de una organización de Snyk para configurar Webhooks a través de API
Configuración del webhook
Para configurar su webhook, siga los siguientes pasos:
Obtenga su token API de Snyk
En la UI usuario de Snyk, en el menú de usuario, haga clic en Account settings y copie su clave de token API de Snyk. Lea más en la documentación oficial de Snyk.
Clave de licencia New Relic License - Insert
Seleccione un License - Insert en su cuenta New Relic o cree una nueva.
Importante
Además de sus claves Snyk y New Relic, debe generar un secreto de firma aleatorio. Snyk lo requiere, pero New Relic no lo utiliza al recibir datos.
Compilar ID de organizaciones de Snyk
Obtenga una lista de los ID de organizaciones de Snyk a los que tiene acceso ejecutando el siguiente comando:
$curl -H "content-type: application/json" \>-H "authorization: token YOUR_SNYK_API_TOKEN" \>"https://api.snyk.io/api/v1/orgs" | jq -r '.orgs[] | "\(.id)\t\(.name)"'Importante
Para ejecutar este comando, necesita instalar jq, un procesador JSON de línea de comando.
Cree un webhook en cada organización de Snyk
Debe configurar un webhook por separado para cada organización de Snyk.
Ejecute el siguiente comando para crear un webhook que se publicará en el procesador de ingesta de seguridad en New Relic cada vez que se pruebe un proyecto. Esto se envía a través del tipo de evento project_snapshot .
$curl -X POST -H "content-type: application/json" \>-H "authorization: token <SNYK_API_TOKEN>" \>--data '{"url": $ "https://security-ingest-processor.service.newrelic.com/v1/security/webhooks/snyk?Api-Key=YOUR_NEW_RELIC_LICENSE_KEY",$ "secret": "YOUR_SIGNING_SECRET"}' \>"https://api.snyk.io/api/v1/org/<SNYK_ORG_ID>/webhooks"Probar una conexión de webhook
El siguiente comando devuelve una matriz de resultados con un ID de webhook y una URL para cada webhook configurado en la organización:
$curl -H "content-type: application/json" \>-H "authorization: token YOUR_SNYK_API_TOKEN" \>"https://api.snyk.io/api/v1/org/YOUR_SNYK_ORG_ID/webhooks"Para probar un webhook, copie el ID del webhook que desea probar y ejecute el siguiente comando:
$curl -X POST --data "" -H "content-type: application/json" \>-H "authorization: token YOUR_SNYK_API_TOKEN" \>"https://api.snyk.io/api/v1/org/YOUR_SNYK_ORG_ID/webhooks/YOUR_WEBHOOK_ID/ping"El comando devolverá OK si ha configurado el webhook correctamente.
Probar un webhook manualmente
Es posible que deba activar un escaneo manual de un proyecto dentro de Snyk para que los datos fluyan hacia New Relic. Puede hacerlo a través de la CLI o API de Snyk, o desde la UI de Snyk, haciendo clic en Retest now en un objetivo de escaneo dentro de un proyecto.
Consulte la documentación oficial de Snyk sobre cómo ejecutar pruebas manuales.
Haga clic en Retest now en un objetivo de escaneo dentro de un proyecto.
Verifique que sus datos de Snyk se envíen a New Relic
Verifique iniciar sesión en New Relic para verificar que los hallazgos de Snyk de su prueba manual se entregaron correctamente ingresando logtype:security para filtrar por evento de seguridad.
Vaya a
one.newrelic.com > All capabilities > Logs
.
En la barra de búsqueda, ingrese
logtype:securityy haga clic enQuery logs
.
one.newrelic.com > All capabilities > Logs
El Snyk Webhook transporta solo los retornos New Issues y Removed Issues que ocurren con cada prueba. New Relic analizará solo el New Issues. Si la prueba manual no revela ningún problema nuevo, no verá ningún registro de seguridad nuevo en New Relic. En este caso, verá un mensaje de inicio de sesión en New Relic para el transporte exitoso del webhook del siguiente modo:
SnykWebhook scan reported 879 byte payload with 0 events (0 unique issue ids) from '' errors=noVer datos de Snyk en New Relic
Una vez que haya configurado uno o más eventos de webhook, podrá ver los resultados del webhook de Snyk que se envía a nuestro extremo de ingesta de seguridad en New Relic.
Consulte las 3 formas que puede utilizar para identificar los datos de Snyk en New Relic:
Visualización de datos en Gestión de vulnerabilidades
Puede encontrar esta página en one.newrelic.com > All capabilities > Vulnerability Management.
Esta vista le brinda una vista panorámica de todas las vulnerabilidades de su software, incluidos los datos que se han consumido desde la integración de Snyk. Utilice las distintas pestañas para identificar y clasificar vulnerabilidades.
one.newrelic.com > All capabilities > Vulnerability Management.
Consultando evento de vulnerabilidades
Cuando se procesan los eventos Snyk, se almacenan en la tabla Vulnerability . Para consultar esta tabla y ver los datos sin procesar, haga lo siguiente:
Vaya a one.newrelic.com > All capabilities > Query your data.
Ingrese la siguiente consulta:
FROM Vulnerability SELECT * where source = 'Snyk' since 7 days agoone.newrelic.com > All capabilities > Query your data
Dashboard Snyk
Puede instalar el dashboard Snyk prediseñado desde el mercado de observabilidad instantánea de New Relic.
Este dashboard ofrece otra vista de los datos de vulnerabilidades y puede usar el widget de gráfico para crear sus propias vistas dashboard a partir de sus datos de integración de Snyk.
Instale el dashboardSnyk de observabilidad instantánea.