mirror of
https://github.com/projectdiscovery/nuclei.git
synced 2025-12-18 14:25:25 +00:00
442fc0f060
* fix(reporting): Markdown and Jira exporter fixes * removed the code duplication between the Markdown and Jira exporter * markdown requires at least 3 dashes in the cells to separate headers from contents in a table * fixed the Jira link creation in the description * Jira requires at least 4 dashes for a horizontal line * added tests * Jira doesn't use dashed separators between table headers and contents * fix(reporting): Markdown and Jira exporter fixes * satisfying the linter * minor syntax changes --------- Co-authored-by: Mzack9999 <mzack9999@protonmail.com>
100 lines
3.1 KiB
Go
100 lines
3.1 KiB
Go
package github
|
|
|
|
import (
|
|
"context"
|
|
"fmt"
|
|
"net/http"
|
|
"net/url"
|
|
"strings"
|
|
|
|
"github.com/google/go-github/github"
|
|
"github.com/pkg/errors"
|
|
"golang.org/x/oauth2"
|
|
|
|
"github.com/projectdiscovery/nuclei/v2/pkg/output"
|
|
"github.com/projectdiscovery/nuclei/v2/pkg/reporting/exporters/markdown/util"
|
|
"github.com/projectdiscovery/nuclei/v2/pkg/reporting/format"
|
|
"github.com/projectdiscovery/nuclei/v2/pkg/types"
|
|
"github.com/projectdiscovery/retryablehttp-go"
|
|
)
|
|
|
|
// Integration is a client for an issue tracker integration
|
|
type Integration struct {
|
|
client *github.Client
|
|
options *Options
|
|
}
|
|
|
|
// Options contains the configuration options for GitHub issue tracker client
|
|
type Options struct {
|
|
// BaseURL (optional) is the self-hosted GitHub application url
|
|
BaseURL string `yaml:"base-url" validate:"omitempty,url"`
|
|
// Username is the username of the GitHub user
|
|
Username string `yaml:"username" validate:"required"`
|
|
// Owner is the owner name of the repository for issues.
|
|
Owner string `yaml:"owner" validate:"required"`
|
|
// Token is the token for GitHub account.
|
|
Token string `yaml:"token" validate:"required"`
|
|
// ProjectName is the name of the repository.
|
|
ProjectName string `yaml:"project-name" validate:"required"`
|
|
// IssueLabel (optional) is the label of the created issue type
|
|
IssueLabel string `yaml:"issue-label"`
|
|
// SeverityAsLabel (optional) sends the severity as the label of the created
|
|
// issue.
|
|
SeverityAsLabel bool `yaml:"severity-as-label"`
|
|
|
|
HttpClient *retryablehttp.Client `yaml:"-"`
|
|
}
|
|
|
|
// New creates a new issue tracker integration client based on options.
|
|
func New(options *Options) (*Integration, error) {
|
|
ctx := context.Background()
|
|
ts := oauth2.StaticTokenSource(
|
|
&oauth2.Token{AccessToken: options.Token},
|
|
)
|
|
tc := oauth2.NewClient(ctx, ts)
|
|
|
|
// patch transport to support proxy - only http
|
|
// TODO: investigate if it's possible to reuse existing retryablehttp
|
|
if types.ProxyURL != "" {
|
|
if proxyURL, err := url.Parse(types.ProxyURL); err == nil {
|
|
tc.Transport.(*http.Transport).Proxy = http.ProxyURL(proxyURL)
|
|
}
|
|
}
|
|
|
|
client := github.NewClient(tc)
|
|
if options.BaseURL != "" {
|
|
parsed, err := url.Parse(options.BaseURL)
|
|
if err != nil {
|
|
return nil, errors.Wrap(err, "could not parse custom baseurl")
|
|
}
|
|
if !strings.HasSuffix(parsed.Path, "/") {
|
|
parsed.Path += "/"
|
|
}
|
|
client.BaseURL = parsed
|
|
}
|
|
return &Integration{client: client, options: options}, nil
|
|
}
|
|
|
|
// CreateIssue creates an issue in the tracker
|
|
func (i *Integration) CreateIssue(event *output.ResultEvent) error {
|
|
summary := format.Summary(event)
|
|
description := format.CreateReportDescription(event, util.MarkdownFormatter{})
|
|
labels := []string{}
|
|
severityLabel := fmt.Sprintf("Severity: %s", event.Info.SeverityHolder.Severity.String())
|
|
if i.options.SeverityAsLabel && severityLabel != "" {
|
|
labels = append(labels, severityLabel)
|
|
}
|
|
if label := i.options.IssueLabel; label != "" {
|
|
labels = append(labels, label)
|
|
}
|
|
|
|
req := &github.IssueRequest{
|
|
Title: &summary,
|
|
Body: &description,
|
|
Labels: &labels,
|
|
Assignees: &[]string{i.options.Username},
|
|
}
|
|
_, _, err := i.client.Issues.Create(context.Background(), i.options.Owner, i.options.ProjectName, req)
|
|
return err
|
|
}
|