Fix golint issue

Author: nodauf

src/adfs/struct.go

@@ -7,6 +7,7 @@ import (
 
 var log *logger.Logger
 
+// Options for owa module
 type Options struct {
 	Domain string
 	utils.BaseOptions

src/adfs/utils.go

@@ -12,7 +12,10 @@ import (
 	"strings"
 )
 
+// FIND_ADFS_URL is the URL used to find the URL of an ADFS instance based on company hostname
 var FIND_ADFS_URL = "https://login.microsoftonline.com/getuserrealm.srf?login=%s"
+
+// ADFS_URL is the endpoint to authenticate on
 var ADFS_URL = "https://%s/adfs/ls/idpinitiatedsignon.aspx?client-request-id=%s&pullStatus=0"
 
 func (options *Options) brute(username, password string) bool {

src/azure/struct.go

@@ -4,6 +4,7 @@ import (
 	"GoMapEnum/src/utils"
 )
 
+// Options for Azure module
 type Options struct {
 	utils.BaseOptions
 }

src/azure/userEnum.go

@@ -13,7 +13,7 @@ import (
 	"time"
 )
 
-// Data of the request which will be sent to authenticate
+// BASE_XML is the data of the request which will be sent to authenticate
 var BASE_XML = `<?xml version="1.0" encoding="UTF-8"?>
 <s:Envelope xmlns:s="http://www.w3.org/2003/05/soap-envelope" xmlns:a="http://www.w3.org/2005/08/addressing" xmlns:u="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd">
   <s:Header>
@@ -47,6 +47,8 @@ var BASE_XML = `<?xml version="1.0" encoding="UTF-8"?>
   </s:Body>
 </s:Envelope>
 `
+
+// AZURE_URL is the url to authenticate on
 var AZURE_URL = "https://autologon.microsoftazuread-sso.com/%s/winauth/trust/2005/usernamemixed?client-request-id=%s"
 
 var log *logger.Logger

src/cmd/brute/bruteSpray.go

@@ -34,7 +34,7 @@ var proxy func(*http.Request) (*url.URL, error)
 
 var proxyString string
 
-// bruteSprayCmd represents the bruteSpray command
+// BruteSprayCmd represents the bruteSpray command
 var BruteSprayCmd = &cobra.Command{
 	Use:   "bruteSpray",
 	Short: "Spray a password or bruteforce a user's password",

src/cmd/enum/userenum.go

@@ -21,7 +21,7 @@ var proxy func(*http.Request) (*url.URL, error)
 
 var proxyString string
 
-// userenumCmd represents the userenum command
+// UserenumCmd represents the userenum command
 var UserenumCmd = &cobra.Command{
 	Use:   "userenum",
 	Short: "User enumeration",

src/cmd/gather/gather.go

@@ -35,7 +35,7 @@ var users []string
 var output string
 var proxyString string
 
-// gatherCmd represents the gather command
+// GatherCmd represents the gather command
 var GatherCmd = &cobra.Command{
 	Use:   "gather",
 	Short: "Retrieve a list of email address based on the company name",

src/cmd/gather/searchEngine.go

@@ -17,12 +17,12 @@ package gather
 
 import (
 	"GoMapEnum/src/logger"
-	"GoMapEnum/src/searchEngine"
+	searchengine "GoMapEnum/src/searchEngine"
 
 	"github.com/spf13/cobra"
 )
 
-var searchEngineOptions searchEngine.Options
+var searchEngineOptions searchengine.Options
 
 // o365Cmd represents the o365 command
 var searchEngineCmd = &cobra.Command{

src/linkedin/gather.go

@@ -5,10 +5,10 @@ import (
 	"strings"
 )
 
-// URL to search for companies
+// LINKEDIN_LIST_COMPANY is the URL to search for companies
 var LINKEDIN_LIST_COMPANY = "https://www.linkedin.com/voyager/api/voyagerSearchDashTypeahead?decorationId=com.linkedin.voyager.dash.deco.search.typeahead.GlobalTypeaheadCollection-27&q=globalTypeahead&query=%s"
 
-// URL to search for people
+// LINKEDIN_LIST_PEOPLE is the URL to search for people
 var LINKEDIN_LIST_PEOPLE = "https://www.linkedin.com/voyager/api/search/dash/clusters?decorationId=com.linkedin.voyager.dash.deco.search.SearchClusterCollection-126&origin=COMPANY_PAGE_CANNED_SEARCH&q=all&query=(flagshipSearchIntent:SEARCH_SRP,queryParameters:(currentCompany:List(%d),resultType:List(PEOPLE)),includeFiltersInResponse:false)&start=%d"
 
 // Gather return a list of all users belongins to the specified company (or multiple companies if the search return more than one)

src/linkedin/struct.go

@@ -7,6 +7,7 @@ import (
 
 var log *logger.Logger
 
+// Options for o365 module
 type Options struct {
 	Format     string
 	ExactMatch bool

src/logger/logger.go

@@ -6,6 +6,7 @@ import (
 	"github.com/fatih/color"
 )
 
+// Level is a type representing the logging level
 type Level int
 
 const (
@@ -17,13 +18,15 @@ const (
 	DebugLevel
 )
 
+// Logger is the options for the logging module
 type Logger struct {
 	Level  Level
 	Module string
 	Target string
 	Type   string
 }
 
+// New create a Logger object for the specified arguments
 func New(kind, module, target string) *Logger {
 	log := &Logger{}
 	// If not set during the init of logger

src/o365/struct.go

@@ -5,6 +5,7 @@ import (
 	"encoding/xml"
 )
 
+// Options for o365 module
 type Options struct {
 	Mode             string
 	LockoutThreshold int

src/o365/userEnum.go

@@ -6,7 +6,7 @@ import (
 	"sync"
 )
 
-// UserEnum: Return a valid list of users according the provided options
+// UserEnum return a valid list of users according the provided options
 func (options *Options) UserEnum() []string {
 	mux := &sync.Mutex{}
 	options.Users = utils.GetStringOrFile(options.Users)
@@ -25,9 +25,9 @@ func (options *Options) UserEnum() []string {
 				if !options.validTenant(domain) {
 					options.Log.Error("Tenant " + domain + " is not valid")
 					return
-				} else {
-					options.Log.Verbose("Tenant " + domain + " is valid")
 				}
+				options.Log.Verbose("Tenant " + domain + " is valid")
+
 				switch options.Mode {
 				case "office":
 					if options.enumOffice(email) {

src/o365/utils.go

@@ -13,9 +13,16 @@ import (
 	"strings"
 )
 
+// OFFICE_URL is used to get parameter for office user enumeration
 var OFFICE_URL = "https://www.office.com"
+
+// MICROSOFT_ONLINE_URL is the URL to performed user enumeration
 var MICROSOFT_ONLINE_URL = "https://login.microsoftonline.com/common/GetCredentialType?mkt=en-US"
+
+// VALIDATE_TENANT_URL is the url to validate if a tenant exist or not
 var VALIDATE_TENANT_URL = "https://login.microsoftonline.com/getuserrealm.srf?login=user@%s&xml=1"
+
+// OAUTH2_URL is the URL to authenticate with oauth2 method
 var OAUTH2_URL = "https://login.microsoft.com/common/oauth2/token"
 
 // enumOffice return a bool if the user exist or not

src/owa/brute.go

@@ -10,6 +10,7 @@ import (
 	"time"
 )
 
+// Brute will bruteforce or spray passwords on the specified users.
 func (options *Options) Brute() {
 	log = options.Log
 	var emailList []string

src/owa/struct.go

@@ -8,6 +8,7 @@ import (
 
 var log *logger.Logger
 
+// Options for owa module
 type Options struct {
 	tr *http.Transport
 	utils.BaseOptions

src/owa/userEnum.go

@@ -10,7 +10,7 @@ import (
 	"time"
 )
 
-// UserEnum: Return a valid list of users according the provided options
+// UserEnum return a valid list of users according the provided options
 func (options *Options) UserEnum() []string {
 	log = options.Log
 

src/searchEngine/gather.go

@@ -1,4 +1,4 @@
-package searchEngine
+package searchengine
 
 import (
 	"GoMapEnum/src/utils"
@@ -7,15 +7,17 @@ import (
 	"strings"
 )
 
+// SEARCH_ENGINE contains url for search on Google and Bing
 var SEARCH_ENGINE = map[string]string{"google": `https://www.google.com/search?q=site:linkedin.com/in+"%s"&num=100&start=%d`,
 	"bing": `http://www.bing.com/search?q=site:linkedin.com/in+"%s"&first=%d`}
 
-// Regex to extract title from search engine's results
+// REGEX_TITLE is the regex to extract title from search engine's results
 var REGEX_TITLE = `<h[23](.*?")?>(.*?)<\/h[23]>`
 
-// Regex to extract field from the title
+// REGEX_LINKEDIN is the regex to extract field from the title
 var REGEX_LINKEDIN = `<h[23](.*?")?>(?P<FirstName>.*?) (?P<LastName>.*?) [-–] (?P<Title>.*?) [-–] (?P<Company>.*?)(\| LinkedIn)(.*?)<\/h[23]>`
 
+// Gather will search a company name and returned the list of people in specified format
 func (options *Options) Gather() []string {
 	var output []string
 	log = options.Log

src/searchEngine/struct.go

@@ -1,4 +1,4 @@
-package searchEngine
+package searchengine
 
 import (
 	"GoMapEnum/src/logger"
@@ -7,6 +7,7 @@ import (
 
 var log *logger.Logger
 
+// Options for searchengine module
 type Options struct {
 	Format     string
 	ExactMatch bool

src/teams/struct.go

@@ -7,6 +7,7 @@ import (
 
 var log *logger.Logger
 
+// Options for teams module
 type Options struct {
 	Email  string
 	Token  string

src/teams/utils.go

@@ -13,8 +13,8 @@ import (
 // getPresence request the Teams API to get additional details about the user with its mri
 func (options *Options) getPresence(mri, bearer string, log *logger.Logger) (string, string, string) {
 
-	var json_data = []byte(`[{"mri":"` + mri + `"}]`)
-	req, _ := http.NewRequest("POST", URL_PRESENCE_TEAMS, bytes.NewBuffer(json_data))
+	var jsonData = []byte(`[{"mri":"` + mri + `"}]`)
+	req, _ := http.NewRequest("POST", URL_PRESENCE_TEAMS, bytes.NewBuffer(jsonData))
 	req.Header.Add("Authorization", bearer)
 	req.Header.Add("x-ms-client-version", CLIENT_VERSION)
 	req.Header.Set("Content-Type", "application/json")

src/utils/struct.go

@@ -22,4 +22,5 @@ type BaseOptions struct {
 	Proxy            func(*http.Request) (*url.URL, error)
 }
 
+// ErrLockout is the error to returned when an account is locked
 var ErrLockout = errors.New("account is locked")

src/utils/utils.go

@@ -84,8 +84,8 @@ func GetUserAgent() string {
 	return userAgents[rand.Intn(len(userAgents))]
 }
 
-// Credits: https://stackoverflow.com/a/46202939/7245054
 // ReSubMatchMap will applied a regex with named capture and return a map
+// Credits: https://stackoverflow.com/a/46202939/7245054
 func ReSubMatchMap(r *regexp.Regexp, str string) map[string]string {
 	matches := r.FindAllStringSubmatch(str, -1)