StrikeOne Docs

GitHub Actions

Introducción

Un test puede ser realizado de manera externa autenticando una cuenta de StrikeOne Admin desde GitHub Actions y después llamando al orquestrador de tests con los parámetros apropiados. El ejemplo de más abajo muestra una manera de ejecutar tests desde un Job de GitHub Actions.

Ejecución Remota de un Test

Introducción

Para ejecutar un test, usted requiere de un token de autorización. Usted puede generar un API Token desde el apartado de Integraciones de su perfil de StrikeOne Admin. El token de autorización permitirá realizar llamadas subsecuentes a otros endpoints.

Después, se debe llamar al orquestrador de tests. Esta request POST requiere un body que incluya el campo externalData que contenga los campos testName, parsedDomainId, parsedScanId y tool. Ambas IDs parseadas para el dominio y el escaneo se pueden obtener directamente yendo a la pestaña de Dominios y de Escaneos de un activo.

Los siguientes valores son válidos para el campo tool:

  • openvas
  • owasp_zap
  • dep_check
  • nuclei
  • gitleaks

IMPORTANTE

Algunas herramientas requieren, o aceptan, más argumentos para su ejecución. La lista es la siguiente:

  • OWASP Dependency Check (dep_check) y GitLeaks (gitleaks) requieren un objeto toolData adicional que sea includo además de externalData. Este objeto contendrá el campo projectUrl (la URL del repositorio, incluyendo el usuario y el token), projectName (el nombre del repositorio) y projectRepo (la rama a clonar, si se está usando curl el campo es opcional).

  • Nuclei (nuclei) acepta un objeto toolData adicional que sea incluido además de externalData. Este objeto puede contener el campo templates que corresponde a un string con la lista de templates a utilizar por Nuclei. Este campo es concatenado al argumento -nts para ser utilizado por Nuclei al ejecutarse.

Si el test fue creado con éxito, /api/vm/tests/external/execute retornará un código 200.

Requisitos

El workflow de ejemplo hace uso de HTTP Request Action.

Ejemplo de Job de GitHub Actions

  execute_so_test:
    name: Execute StrikeOne Test
    runs-on: self-hosted

    steps:
      - name: StrikeOne Test Execution
        id: strikeone_test_execution
        uses: fjogeleit/http-request-action@v1
        with:
          url: "https://assessment.strikeone.io/api/vm/tests/external/execute"
          method: "POST"
          customHeaders: '{"Content-Type": "application/json"}'
          bearerToken: ${{ secrets.SO_API_TOKEN }}
          data: '{"externalData": { "parsedDomainId": "192079240", "parsedScanId": "192079369", "tool": "owasp_zap", "testName": "Test iniciado desde GitHub Actions" } }'
      - name: Show Response
        run: |
          echo ${{ steps.strikeone_test_execution.outputs.response }}
Last Updated: