Init v2, rewrite

settings/settings.go

@@ -0,0 +1,148 @@
+package github_recon_settings
+
+import (
+	"fmt"
+	"os"
+	"strings"
+
+	flag "github.com/spf13/pflag"
+
+	"context"
+
+	"github.com/charmbracelet/log"
+	"github.com/google/go-github/v72/github"
+)
+
+type TargetType string
+
+const (
+	TargetUsername TargetType = "Username"
+	TargetEmail    TargetType = "Email"
+)
+
+type Settings struct {
+	Token         string
+	Target        string
+	TargetType    TargetType
+	ShowSource    bool
+	Refresh       bool
+	MaxRepoSize   int
+	ExcludedRepos []string
+	JsonOutput    string
+	Silent        bool
+	DeepScan      bool
+	MaxDistance   int
+	HideAvatar    bool
+
+	// Internal
+	Client *github.Client
+	Logger *log.Logger
+	Ctx    context.Context
+}
+
+func GetSettings() (settings Settings) {
+	//// Flag settings
+	flag.Usage = func() {
+		fmt.Fprintf(os.Stderr, "Usage of %s:\n", os.Args[0])
+		fmt.Fprintf(os.Stderr, "github-recon [flags] <target username or email>\n")
+		fmt.Fprintf(os.Stderr, "\n")
+		fmt.Fprintf(os.Stderr, "Flags:\n")
+		flag.PrintDefaults()
+	}
+
+	flag.CommandLine.SetNormalizeFunc(wordSepNormalizeFunc)
+	flag.CommandLine.SortFlags = false
+
+	//// Flags
+	flag.StringVarP(&settings.Token, "token", "t", "null", "Github personal access token (e.g. ghp_aaa...). Can also be set via GITHUB_RECON_TOKEN environment variable. You also need to set the token in $HOME/.config/github-recon/env file if you want to use this tool without passing the token every time.")
+
+	// DeepScan
+	flag.BoolVarP(&settings.DeepScan, "deepscan", "d", false, "Enable deep scan (clone repos, regex search, analyse licenses, etc.)")
+	flag.IntVar(
+		&settings.MaxRepoSize,
+		"max-size",
+		150,
+		"Limit the size of repositories to scan (in MB) (only for deep scan)",
+	)
+	flag.StringSliceVarP(
+		&settings.ExcludedRepos,
+		"exclude-repo",
+		"e",
+		[]string{},
+		"Exclude repos from deep scan (comma-separated list, only for deep scan)",
+	)
+	flag.BoolVarP(
+		&settings.Refresh,
+		"refresh",
+		"r",
+		false,
+		"Refresh the cache (only for deep scan)",
+	)
+	flag.BoolVarP(
+		&settings.ShowSource,
+		"show-source",
+		"s",
+		false,
+		"Show where the information (authors, emails, etc) were found (only for deep scan)",
+	)
+	flag.IntVarP(
+		&settings.MaxDistance,
+		"max-distance",
+		"m",
+		20,
+		"Maximum Levenshtein distance for matching usernames & emails (only for deep scan)",
+	)
+
+	flag.BoolVarP(&settings.Silent, "silent", "S", false, "Suppress all non-essential output")
+	flag.BoolVarP(&settings.HideAvatar, "hide-avatar", "h", false, "Hide the avatar in the output")
+	flag.StringVarP(&settings.JsonOutput, "json", "j", "", "Write results to specified JSON file")
+
+	//// Parse
+	flag.Parse()
+
+	//// Setup
+	settings.Client = github.NewClient(nil)
+	settings.Logger = log.NewWithOptions(os.Stderr, log.Options{
+		ReportCaller:    false,
+		ReportTimestamp: false,
+	})
+	settings.Ctx = context.Background()
+
+	//// Tail
+	nonFlagArgs := flag.Args()
+	if len(nonFlagArgs) > 1 {
+		settings.Logger.Error("Please provide only one target (username or email)")
+		flag.Usage()
+		os.Exit(1)
+	} else if len(nonFlagArgs) < 1 {
+		settings.Logger.Error("Please provide a target (username or email)")
+		flag.Usage()
+		os.Exit(1)
+	}
+
+	settings.Target = flag.Arg(0)
+	settings.Target = strings.TrimPrefix(settings.Target, "@") // Remove the @ of the username
+
+	if strings.Contains(settings.Target, " ") {
+		settings.Logger.Fatal("Target cannot contain spaces")
+	}
+
+	if strings.Contains(settings.Target, "@") {
+		settings.TargetType = TargetEmail
+	} else {
+		settings.TargetType = TargetUsername
+	}
+
+	// If token is not set via flag, get it from env
+	if settings.Token == "null" {
+		settings.Token = getToken()
+	}
+
+	if settings.Token == "null" {
+		settings.Logger.Warn("No Github token provided. You might hit the rate limit. Check the help menu for more information.")
+	} else {
+		settings.Client = settings.Client.WithAuthToken(settings.Token)
+	}
+
+	return
+}

settings/utils.go

@@ -0,0 +1,39 @@
+package github_recon_settings
+
+import (
+	"os"
+	"path/filepath"
+	"strings"
+
+	"github.com/joho/godotenv"
+	flag "github.com/spf13/pflag"
+)
+
+func getToken() string {
+	token := os.Getenv("GITHUB_RECON_TOKEN")
+	if token != "" {
+		return token
+	}
+
+	// Check the $HOME/.config/github-recon/env file for this variable
+	homedir, err := os.UserHomeDir()
+	if err != nil {
+		return "null"
+	}
+	godotenv.Load(filepath.Join(homedir, ".config/github-recon/env"))
+	token = os.Getenv("GITHUB_RECON_TOKEN")
+	if token != "" {
+		return token
+	}
+
+	return "null"
+}
+
+func wordSepNormalizeFunc(f *flag.FlagSet, name string) flag.NormalizedName {
+	from := []string{".", "_"}
+	to := "-"
+	for _, sep := range from {
+		name = strings.ReplaceAll(name, sep, to)
+	}
+	return flag.NormalizedName(name)
+}