-
Notifications
You must be signed in to change notification settings - Fork 4.7k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add security hub summary API (#18872)
include WithCVE, WithArtifact option Signed-off-by: stonezdj <daojunz@vmware.com>
- Loading branch information
Showing
16 changed files
with
1,101 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,138 @@ | ||
| // Copyright Project Harbor Authors | ||
| // | ||
| // Licensed under the Apache License, Version 2.0 (the "License"); | ||
| // you may not use this file except in compliance with the License. | ||
| // You may obtain a copy of the License at | ||
| // | ||
| // http://www.apache.org/licenses/LICENSE-2.0 | ||
| // | ||
| // Unless required by applicable law or agreed to in writing, software | ||
| // distributed under the License is distributed on an "AS IS" BASIS, | ||
| // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| // See the License for the specific language governing permissions and | ||
| // limitations under the License. | ||
|
|
||
| package securityhub | ||
|
|
||
| import ( | ||
| "context" | ||
|
|
||
| "github.com/goharbor/harbor/src/lib/q" | ||
| "github.com/goharbor/harbor/src/pkg" | ||
| "github.com/goharbor/harbor/src/pkg/artifact" | ||
| "github.com/goharbor/harbor/src/pkg/scan/scanner" | ||
| "github.com/goharbor/harbor/src/pkg/securityhub" | ||
| secHubModel "github.com/goharbor/harbor/src/pkg/securityhub/model" | ||
| ) | ||
|
|
||
| // Ctl is the global controller for security hub | ||
| var Ctl = NewController() | ||
|
|
||
| // Options define the option to query summary info | ||
| type Options struct { | ||
| WithCVE bool | ||
| WithArtifact bool | ||
| } | ||
|
|
||
| // Option define the func to build options | ||
| type Option func(*Options) | ||
|
|
||
| func newOptions(options ...Option) *Options { | ||
| opts := &Options{} | ||
| for _, f := range options { | ||
| f(opts) | ||
| } | ||
| return opts | ||
| } | ||
|
|
||
| // WithCVE enable CVE info in summary | ||
| func WithCVE(enable bool) Option { | ||
| return func(o *Options) { | ||
| o.WithCVE = enable | ||
| } | ||
| } | ||
|
|
||
| // WithArtifact enable artifact info in summary | ||
| func WithArtifact(enable bool) Option { | ||
| return func(o *Options) { | ||
| o.WithArtifact = enable | ||
| } | ||
| } | ||
|
|
||
| // Controller controller of security hub | ||
| type Controller interface { | ||
| // SecuritySummary returns the security summary of the specified project. | ||
| SecuritySummary(ctx context.Context, projectID int64, options ...Option) (*secHubModel.Summary, error) | ||
| } | ||
|
|
||
| type controller struct { | ||
| artifactMgr artifact.Manager | ||
| scannerMgr scanner.Manager | ||
| secHubMgr securityhub.Manager | ||
| } | ||
|
|
||
| // NewController ... | ||
| func NewController() Controller { | ||
| return &controller{ | ||
| artifactMgr: pkg.ArtifactMgr, | ||
| scannerMgr: scanner.New(), | ||
| secHubMgr: securityhub.Mgr, | ||
| } | ||
| } | ||
|
|
||
| func (c *controller) SecuritySummary(ctx context.Context, projectID int64, options ...Option) (*secHubModel.Summary, error) { | ||
| opts := newOptions(options...) | ||
| scannerUUID, err := c.defaultScannerUUID(ctx) | ||
| if err != nil { | ||
| return nil, err | ||
| } | ||
| sum, err := c.secHubMgr.Summary(ctx, scannerUUID, projectID, nil) | ||
| if err != nil { | ||
| return nil, err | ||
| } | ||
| sum.TotalArtifactCnt, err = c.totalArtifactCount(ctx, projectID) | ||
| if err != nil { | ||
| return nil, err | ||
| } | ||
| sum.ScannedCnt, err = c.secHubMgr.ScannedArtifactsCount(ctx, scannerUUID, projectID, nil) | ||
| if err != nil { | ||
| return nil, err | ||
| } | ||
| if opts.WithCVE { | ||
| sum.DangerousCVEs, err = c.secHubMgr.DangerousCVEs(ctx, scannerUUID, projectID, nil) | ||
| if err != nil { | ||
| return nil, err | ||
| } | ||
| } | ||
| if opts.WithArtifact { | ||
| sum.DangerousArtifacts, err = c.secHubMgr.DangerousArtifacts(ctx, scannerUUID, projectID, nil) | ||
| if err != nil { | ||
| return nil, err | ||
| } | ||
| } | ||
| return sum, nil | ||
| } | ||
|
|
||
| func (c *controller) scannedArtifactCount(ctx context.Context, projectID int64) (int64, error) { | ||
| scannerUUID, err := c.defaultScannerUUID(ctx) | ||
| if err != nil { | ||
| return 0, err | ||
| } | ||
| return c.secHubMgr.ScannedArtifactsCount(ctx, scannerUUID, projectID, nil) | ||
| } | ||
|
|
||
| func (c *controller) totalArtifactCount(ctx context.Context, projectID int64) (int64, error) { | ||
| if projectID == 0 { | ||
| return c.artifactMgr.Count(ctx, nil) | ||
| } | ||
| return c.artifactMgr.Count(ctx, q.New(q.KeyWords{"project_id": projectID})) | ||
| } | ||
|
|
||
| // defaultScannerUUID returns the default scanner uuid. | ||
| func (c *controller) defaultScannerUUID(ctx context.Context) (string, error) { | ||
| reg, err := c.scannerMgr.GetDefault(ctx) | ||
| if err != nil { | ||
| return "", err | ||
| } | ||
| return reg.UUID, nil | ||
| } |
Oops, something went wrong.