mirror of
https://github.com/projectdiscovery/nuclei.git
synced 2025-12-17 20:35:26 +00:00
110 lines
3.0 KiB
Go
110 lines
3.0 KiB
Go
package github
|
|
|
|
import (
|
|
"context"
|
|
"fmt"
|
|
"net/url"
|
|
"strings"
|
|
|
|
"golang.org/x/oauth2"
|
|
|
|
"github.com/google/go-github/github"
|
|
"github.com/pkg/errors"
|
|
|
|
"github.com/projectdiscovery/nuclei/v2/pkg/output"
|
|
"github.com/projectdiscovery/nuclei/v2/pkg/reporting/format"
|
|
)
|
|
|
|
// 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"`
|
|
// Username is the username of the github user
|
|
Username string `yaml:"username"`
|
|
// Owner (manadatory) is the owner name of the repository for issues.
|
|
Owner string `yaml:"owner"`
|
|
// Token is the token for github account.
|
|
Token string `yaml:"token"`
|
|
// ProjectName is the name of the repository.
|
|
ProjectName string `yaml:"project-name"`
|
|
// 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"`
|
|
}
|
|
|
|
// New creates a new issue tracker integration client based on options.
|
|
func New(options *Options) (*Integration, error) {
|
|
err := validateOptions(options)
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
ctx := context.Background()
|
|
ts := oauth2.StaticTokenSource(
|
|
&oauth2.Token{AccessToken: options.Token},
|
|
)
|
|
tc := oauth2.NewClient(ctx, ts)
|
|
|
|
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")
|
|
}
|
|
client.BaseURL = parsed
|
|
}
|
|
return &Integration{client: client, options: options}, nil
|
|
}
|
|
|
|
func validateOptions(options *Options) error {
|
|
errs := []string{}
|
|
if options.Username == "" {
|
|
errs = append(errs, "Username")
|
|
}
|
|
if options.Owner == "" {
|
|
errs = append(errs, "Owner")
|
|
}
|
|
if options.Token == "" {
|
|
errs = append(errs, "Token")
|
|
}
|
|
if options.ProjectName == "" {
|
|
errs = append(errs, "ProjectName")
|
|
}
|
|
|
|
if len(errs) > 0 {
|
|
return errors.New("Mandatory reporting configuration fields are missing: " + strings.Join(errs, ","))
|
|
}
|
|
|
|
return nil
|
|
}
|
|
|
|
// CreateIssue creates an issue in the tracker
|
|
func (i *Integration) CreateIssue(event *output.ResultEvent) error {
|
|
summary := format.Summary(event)
|
|
description := format.MarkdownDescription(event)
|
|
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
|
|
}
|