From 58cf1f4c8e61e04929cb63c9205cc94577a8a03a Mon Sep 17 00:00:00 2001 From: Kota Kanbe Date: Mon, 24 Aug 2020 16:34:32 +0900 Subject: [PATCH] refactor(typo): fix typos (#1041) --- config/config.go | 10 +++++----- config/tomlloader.go | 8 ++++---- github/github.go | 2 +- go.mod | 6 +++--- go.sum | 12 ++++++------ libmanager/libManager.go | 2 +- models/cvecontents.go | 2 +- models/library.go | 4 ++-- models/scanresults.go | 8 ++++---- report/util.go | 8 ++++---- scan/debian.go | 4 ++-- scan/serverapi.go | 2 +- util/logutil.go | 2 +- util/util.go | 10 +++++----- 14 files changed, 40 insertions(+), 40 deletions(-) diff --git a/config/config.go b/config/config.go index 874db6b4..8299efb0 100644 --- a/config/config.go +++ b/config/config.go @@ -522,11 +522,11 @@ func (c *HipChatConf) Validate() (errs []error) { return } if len(c.Room) == 0 { - errs = append(errs, xerrors.New("hipcaht.room must not be empty")) + errs = append(errs, xerrors.New("hipchat.room must not be empty")) } if len(c.AuthToken) == 0 { - errs = append(errs, xerrors.New("hipcaht.AuthToken must not be empty")) + errs = append(errs, xerrors.New("hipchat.AuthToken must not be empty")) } _, err := valid.ValidateStruct(c) @@ -548,11 +548,11 @@ func (c *ChatWorkConf) Validate() (errs []error) { return } if len(c.Room) == 0 { - errs = append(errs, xerrors.New("chatworkcaht.room must not be empty")) + errs = append(errs, xerrors.New("chatWorkConf.room must not be empty")) } if len(c.APIToken) == 0 { - errs = append(errs, xerrors.New("chatworkcaht.ApiToken must not be empty")) + errs = append(errs, xerrors.New("chatWorkConf.ApiToken must not be empty")) } _, err := valid.ValidateStruct(c) @@ -1231,7 +1231,7 @@ const ( ) // GetServerName returns ServerName if this serverInfo is about host. -// If this serverInfo is abount a container, returns containerID@ServerName +// If this serverInfo is about a container, returns containerID@ServerName func (s ServerInfo) GetServerName() string { if len(s.Container.ContainerID) == 0 { return s.ServerName diff --git a/config/tomlloader.go b/config/tomlloader.go index 232aa966..5c30ae8f 100644 --- a/config/tomlloader.go +++ b/config/tomlloader.go @@ -116,7 +116,7 @@ func (c TOMLLoader) Load(pathToToml, keyPass string) error { case "offline": s.Mode.Set(Offline) default: - return xerrors.Errorf("scanMode: %s of %s is invalie. Specify -fast, -fast-root, -deep or offline", m, serverName) + return xerrors.Errorf("scanMode: %s of %s is invalid. Specify -fast, -fast-root, -deep or offline", m, serverName) } } if err := s.Mode.validate(); err != nil { @@ -208,14 +208,14 @@ func (c TOMLLoader) Load(pathToToml, keyPass string) error { for _, reg := range s.IgnorePkgsRegexp { _, err := regexp.Compile(reg) if err != nil { - return xerrors.Errorf("Faild to parse %s in %s. err: %w", reg, serverName, err) + return xerrors.Errorf("Failed to parse %s in %s. err: %w", reg, serverName, err) } } for contName, cont := range s.Containers { for _, reg := range cont.IgnorePkgsRegexp { _, err := regexp.Compile(reg) if err != nil { - return xerrors.Errorf("Faild to parse %s in %s@%s. err: %w", + return xerrors.Errorf("Failed to parse %s in %s@%s. err: %w", reg, contName, serverName, err) } } @@ -291,5 +291,5 @@ func toCpeURI(cpename string) (string, error) { } return naming.BindToURI(wfn), nil } - return "", xerrors.Errorf("Unknow CPE format: %s", cpename) + return "", xerrors.Errorf("Unknown CPE format: %s", cpename) } diff --git a/github/github.go b/github/github.go index 9ff2bb1a..3a03f60b 100644 --- a/github/github.go +++ b/github/github.go @@ -15,7 +15,7 @@ import ( "golang.org/x/oauth2" ) -// FillGitHubSecurityAlerts access to owner/repo on GitHub and fetch scurity alerts of the repository via GitHub API v4 GraphQL and then set to the given ScanResult. +// FillGitHubSecurityAlerts access to owner/repo on GitHub and fetch security alerts of the repository via GitHub API v4 GraphQL and then set to the given ScanResult. // https://help.github.com/articles/about-security-alerts-for-vulnerable-dependencies/ func FillGitHubSecurityAlerts(r *models.ScanResult, owner, repo, token string) (nCVEs int, err error) { src := oauth2.StaticTokenSource( diff --git a/go.mod b/go.mod index 1eddb0f1..09eea959 100644 --- a/go.mod +++ b/go.mod @@ -31,14 +31,14 @@ require ( github.com/knqyf263/go-deb-version v0.0.0-20190517075300-09fca494f03d github.com/knqyf263/go-rpm-version v0.0.0-20170716094938-74609b86c936 github.com/knqyf263/go-version v1.1.1 - github.com/knqyf263/gost v0.1.3 + github.com/knqyf263/gost v0.1.4 github.com/kotakanbe/go-cve-dictionary v0.5.0 github.com/kotakanbe/go-pingscanner v0.1.0 - github.com/kotakanbe/goval-dictionary v0.2.8 + github.com/kotakanbe/goval-dictionary v0.2.10 github.com/kotakanbe/logrus-prefixed-formatter v0.0.0-20180123152602-928f7356cb96 github.com/mgutz/ansi v0.0.0-20170206155736-9520e82c474b // indirect github.com/mitchellh/go-homedir v1.1.0 - github.com/mozqnet/go-exploitdb v0.0.0-20200612044106-ea30f49f0902 + github.com/mozqnet/go-exploitdb v0.1.0 github.com/nlopes/slack v0.6.0 github.com/nsf/termbox-go v0.0.0-20200418040025-38ba6e5628f1 // indirect github.com/olekukonko/tablewriter v0.0.4 diff --git a/go.sum b/go.sum index c875d81f..9be7c2ee 100644 --- a/go.sum +++ b/go.sum @@ -418,8 +418,8 @@ github.com/knqyf263/go-rpm-version v0.0.0-20170716094938-74609b86c936/go.mod h1: github.com/knqyf263/go-rpmdb v0.0.0-20190501070121-10a1c42a10dc/go.mod h1:MrSSvdMpTSymaQWk1yFr9sxFSyQmKMj6jkbvGrchBV8= github.com/knqyf263/go-version v1.1.1 h1:+MpcBC9b7rk5ihag8Y/FLG8get1H2GjniwKQ+9DxI2o= github.com/knqyf263/go-version v1.1.1/go.mod h1:0tBvHvOBSf5TqGNcY+/ih9o8qo3R16iZCpB9rP0D3VM= -github.com/knqyf263/gost v0.1.3 h1:jr0H56Vfvf23X319TGmIacpgR7PwmW8q5pjo4xLhOFY= -github.com/knqyf263/gost v0.1.3/go.mod h1:okRxldLs7RVZEjNVBOQEqKj93OU91TmULMnHWU6gJ1s= +github.com/knqyf263/gost v0.1.4 h1:X6HxOUozp/eSSzyLHb/C8/gkzWtRPHcJ8sLbKJ5mXu0= +github.com/knqyf263/gost v0.1.4/go.mod h1:okRxldLs7RVZEjNVBOQEqKj93OU91TmULMnHWU6gJ1s= github.com/knqyf263/nested v0.0.1/go.mod h1:zwhsIhMkBg90DTOJQvxPkKIypEHPYkgWHs4gybdlUmk= github.com/konsorten/go-windows-terminal-sequences v1.0.1/go.mod h1:T0+1ngSBFLxvqU3pZ+m/2kptfBszLMUkC4ZK/EgS/cQ= github.com/konsorten/go-windows-terminal-sequences v1.0.2/go.mod h1:T0+1ngSBFLxvqU3pZ+m/2kptfBszLMUkC4ZK/EgS/cQ= @@ -429,8 +429,8 @@ github.com/kotakanbe/go-cve-dictionary v0.5.0 h1:wai3ymaI0BFhcofW7ITOAAILm4CvsBn github.com/kotakanbe/go-cve-dictionary v0.5.0/go.mod h1:zgnFBROvdhyd30KU0yekNI0J1kQkjTMND8GqlL8y25k= github.com/kotakanbe/go-pingscanner v0.1.0 h1:VG4/9l0i8WeToXclj7bIGoAZAu7a07Z3qmQiIfU0gT0= github.com/kotakanbe/go-pingscanner v0.1.0/go.mod h1:/761QZzuZFcfN8h/1QuawUA+pKukp3qcNj5mxJCOiAk= -github.com/kotakanbe/goval-dictionary v0.2.8 h1:C2hAEA3HdsaJbSoWjyZjZFeBjBoF/CVLmZJxSrcpAkM= -github.com/kotakanbe/goval-dictionary v0.2.8/go.mod h1:OozI5ZbKWHIPcjYgOITYHRy+Vo6ZbksY1FU8aCwojK4= +github.com/kotakanbe/goval-dictionary v0.2.10 h1:ilzsGCwe74b+OsajFO+VbOW9IUxu5i3dYNWdl+8JZrw= +github.com/kotakanbe/goval-dictionary v0.2.10/go.mod h1:OozI5ZbKWHIPcjYgOITYHRy+Vo6ZbksY1FU8aCwojK4= github.com/kotakanbe/logrus-prefixed-formatter v0.0.0-20180123152602-928f7356cb96 h1:xNVK0mQJdQjw+QYeaMM4G6fvucWr8rTGGIhlPakx1wU= github.com/kotakanbe/logrus-prefixed-formatter v0.0.0-20180123152602-928f7356cb96/go.mod h1:ljq48H1V+0Vh0u7ucA3LjR4AfkAeCpxrf7LaaCk8Vmo= github.com/kr/fs v0.1.0/go.mod h1:FFnZGqtBN9Gxj7eW1uZ42v5BccTP0vu6NEaFoC2HwRg= @@ -514,8 +514,8 @@ github.com/modern-go/reflect2 v1.0.1/go.mod h1:bx2lNnkwVCuqBIxFjflWJWanXIb3Rllmb github.com/morikuni/aec v0.0.0-20170113033406-39771216ff4c/go.mod h1:BbKIizmSmc5MMPqRYbxO4ZU0S0+P200+tUnFx7PXmsc= github.com/morikuni/aec v1.0.0/go.mod h1:BbKIizmSmc5MMPqRYbxO4ZU0S0+P200+tUnFx7PXmsc= github.com/moul/http2curl v1.0.0/go.mod h1:8UbvGypXm98wA/IqH45anm5Y2Z6ep6O31QGOAZ3H0fQ= -github.com/mozqnet/go-exploitdb v0.0.0-20200612044106-ea30f49f0902 h1:JXh+QEZqWJ5SIWdm8WsztZqvaeLubj9IZ/vvir0jMEY= -github.com/mozqnet/go-exploitdb v0.0.0-20200612044106-ea30f49f0902/go.mod h1:TsEciLihBvN8yO9iCHBahCLxZff11NxbBO/xm8nVH9g= +github.com/mozqnet/go-exploitdb v0.1.0 h1:pZDwJQEn3TFsaH+N1B6pBoCmK95XKzCve63sZjXkGCY= +github.com/mozqnet/go-exploitdb v0.1.0/go.mod h1:8mbqC/rcubAo8AEQ2zwR90IkhsltyQg70zllgmvEpAw= github.com/munnerz/goautoneg v0.0.0-20120707110453-a547fc61f48d/go.mod h1:+n7T8mK8HuQTcFwEeznm/DIxMOiR9yIdICNftLE1DvQ= github.com/munnerz/goautoneg v0.0.0-20191010083416-a7dc8b61c822/go.mod h1:+n7T8mK8HuQTcFwEeznm/DIxMOiR9yIdICNftLE1DvQ= github.com/mwitkow/go-conntrack v0.0.0-20161129095857-cc309e4a2223/go.mod h1:qRWi+5nqEBWmkhHvq77mSJWrCKwh8bxhgT7d/eI7P4U= diff --git a/libmanager/libManager.go b/libmanager/libManager.go index f204d816..dc947ecf 100644 --- a/libmanager/libManager.go +++ b/libmanager/libManager.go @@ -17,7 +17,7 @@ import ( "github.com/future-architect/vuls/util" ) -// FillLibrary fills LibraryScanner informations +// FillLibrary fills LibraryScanner information func FillLibrary(r *models.ScanResult) (totalCnt int, err error) { if len(r.LibraryScanners) == 0 { return diff --git a/models/cvecontents.go b/models/cvecontents.go index 297c8e67..16db36ca 100644 --- a/models/cvecontents.go +++ b/models/cvecontents.go @@ -256,7 +256,7 @@ const ( // RedHatAPI is RedHat RedHatAPI CveContentType = "redhat_api" - // DebianSecurityTracker is Debian Secury tracker + // DebianSecurityTracker is Debian Security tracker DebianSecurityTracker CveContentType = "debian_security_tracker" // Debian is Debian diff --git a/models/library.go b/models/library.go index e36b19cd..aecf4501 100644 --- a/models/library.go +++ b/models/library.go @@ -42,7 +42,7 @@ type LibraryScanner struct { func (s LibraryScanner) Scan() ([]VulnInfo, error) { scanner, err := library.DriverFactory{}.NewDriver(filepath.Base(string(s.Path))) if err != nil { - return nil, xerrors.Errorf("Faild to new a library driver: %w", err) + return nil, xerrors.Errorf("Failed to new a library driver: %w", err) } var vulnerabilities = []VulnInfo{} for _, pkg := range s.Libs { @@ -71,7 +71,7 @@ func (s LibraryScanner) convertFanalToVuln(tvulns []types.DetectedVulnerability) for _, tvuln := range tvulns { vinfo, err := s.getVulnDetail(tvuln) if err != nil { - util.Log.Debugf("failed to getVulnDetail. err: %s, tvun: %#v", err, tvuln) + util.Log.Debugf("failed to getVulnDetail. err: %s, tvuln: %#v", err, tvuln) continue } vulns = append(vulns, vinfo) diff --git a/models/scanresults.go b/models/scanresults.go index baae1135..409439ee 100644 --- a/models/scanresults.go +++ b/models/scanresults.go @@ -216,7 +216,7 @@ func (r ScanResult) FilterIgnorePkgs() ScanResult { for _, pkgRegexp := range ignorePkgsRegexps { re, err := regexp.Compile(pkgRegexp) if err != nil { - util.Log.Errorf("Faild to parse %s. err: %+v", pkgRegexp, err) + util.Log.Errorf("Failed to parse %s. err: %+v", pkgRegexp, err) continue } else { regexps = append(regexps, re) @@ -339,8 +339,8 @@ func (r ScanResult) FormatServerName() (name string) { return } -// FormatTextReportHeadedr returns header of text report -func (r ScanResult) FormatTextReportHeadedr() string { +// FormatTextReportHeader returns header of text report +func (r ScanResult) FormatTextReportHeader() string { var buf bytes.Buffer for i := 0; i < len(r.ServerInfo()); i++ { buf.WriteString("=") @@ -400,7 +400,7 @@ func (r ScanResult) FormatMetasploitCveSummary() string { return fmt.Sprintf("%d modules", nMetasploitCve) } -// FormatAlertSummary returns a summary of XCERT alerts +// FormatAlertSummary returns a summary of CERT alerts func (r ScanResult) FormatAlertSummary() string { jaCnt := 0 enCnt := 0 diff --git a/report/util.go b/report/util.go index 6e7d9dd3..7b3d2bba 100644 --- a/report/util.go +++ b/report/util.go @@ -97,7 +97,7 @@ func formatOneLineSummary(rs ...models.ScanResult) string { } func formatList(r models.ScanResult) string { - header := r.FormatTextReportHeadedr() + header := r.FormatTextReportHeader() if len(r.Errors) != 0 { return fmt.Sprintf( "%s\nError: Use configtest subcommand or scan with --debug to view the details\n%s\n\n", @@ -171,7 +171,7 @@ No CVE-IDs are found in updatable packages. } func formatFullPlainText(r models.ScanResult) (lines string) { - header := r.FormatTextReportHeadedr() + header := r.FormatTextReportHeader() if len(r.Errors) != 0 { return fmt.Sprintf( "%s\nError: Use configtest subcommand or scan with --debug to view the details\n%s\n\n", @@ -500,9 +500,9 @@ func getDiffCves(previous, current models.ScanResult) models.VulnInfos { updated[v.CveID] = v util.Log.Debugf("updated: %s", v.CveID) - // TODO commented out beause a bug of diff logic when multiple oval defs found for a certain CVE-ID and same updated_at + // TODO commented out because a bug of diff logic when multiple oval defs found for a certain CVE-ID and same updated_at // if these OVAL defs have different affected packages, this logic detects as updated. - // This logic will be uncommented after integration with ghost https://github.com/knqyf263/gost + // This logic will be uncomented after integration with ghost https://github.com/knqyf263/gost // } else if isCveFixed(v, previous) { // updated[v.CveID] = v // util.Log.Debugf("fixed: %s", v.CveID) diff --git a/scan/debian.go b/scan/debian.go index f4eebb6b..3333c0e3 100644 --- a/scan/debian.go +++ b/scan/debian.go @@ -326,7 +326,7 @@ func (o *debian) rebootRequired() (bool, error) { case 1: return false, nil default: - return false, xerrors.Errorf("Failed to check reboot reauired: %s", r) + return false, xerrors.Errorf("Failed to check reboot required: %s", r) } } @@ -505,7 +505,7 @@ func (o *debian) ensureChangelogCache(current cache.Meta) (*cache.Meta, error) { if current.Distro.Family != cached.Distro.Family || current.Distro.Release != cached.Distro.Release { - o.log.Debugf("Need to refesh meta: %s", current.Name) + o.log.Debugf("Need to refresh meta: %s", current.Name) err = cache.DB.EnsureBuckets(current) if err != nil { return nil, xerrors.Errorf("Failed to ensure buckets. err: %s", err) diff --git a/scan/serverapi.go b/scan/serverapi.go index 160a8d9c..312034e4 100644 --- a/scan/serverapi.go +++ b/scan/serverapi.go @@ -599,7 +599,7 @@ func setupChangelogCache() error { needToSetupCache = true break case config.Ubuntu, config.Debian: - //TODO changelopg cache for RedHat, Oracle, Amazon, CentOS is not implemented yet. + //TODO changelog cache for RedHat, Oracle, Amazon, CentOS is not implemented yet. if s.getServerInfo().Mode.IsDeep() { needToSetupCache = true } diff --git a/util/logutil.go b/util/logutil.go index f56591c9..8336906f 100644 --- a/util/logutil.go +++ b/util/logutil.go @@ -15,7 +15,7 @@ import ( formatter "github.com/kotakanbe/logrus-prefixed-formatter" ) -// Log for localhsot +// Log for localhost var Log *logrus.Entry func init() { diff --git a/util/util.go b/util/util.go index 817dedeb..0025481b 100644 --- a/util/util.go +++ b/util/util.go @@ -42,11 +42,11 @@ func AppendIfMissing(slice []string, s string) []string { // URLPathJoin make URL func URLPathJoin(baseURL string, paths ...string) (string, error) { baseURL = strings.TrimSuffix(baseURL, "/") - trimedPaths := []string{} + trimmedPaths := []string{} for _, path := range paths { - trimed := strings.Trim(path, " /") - if len(trimed) != 0 { - trimedPaths = append(trimedPaths, trimed) + trimmed := strings.Trim(path, " /") + if len(trimmed) != 0 { + trimmedPaths = append(trimmedPaths, trimmed) } } var url *url.URL @@ -54,7 +54,7 @@ func URLPathJoin(baseURL string, paths ...string) (string, error) { if err != nil { return "", err } - url.Path += "/" + strings.Join(trimedPaths, "/") + url.Path += "/" + strings.Join(trimmedPaths, "/") return url.String(), nil }