Pre receive feature command (AST-89345) #1146
There are no files selected for viewing
This file contains hidden or 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 hidden or 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 hidden or 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 hidden or 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,51 @@ | ||
| package commands | ||
|
|
||
| import ( | ||
| "github.com/MakeNowJust/heredoc" | ||
| "github.com/checkmarx/ast-cli/internal/params" | ||
| "github.com/checkmarx/ast-cli/internal/wrappers" | ||
| "github.com/pkg/errors" | ||
| "github.com/spf13/cobra" | ||
| ) | ||
|
|
||
| // NewHooksCommand creates the hooks command with pre-commit subcommand | ||
|
|
||
| func NewHooksCommand(jwtWrapper wrappers.JWTWrapper) *cobra.Command { | ||
| hooksCmd := &cobra.Command{ | ||
| Use: "hooks", | ||
| Short: "Manage Git hooks", | ||
| Long: "The hooks command enables the ability to manage Git hooks for Checkmarx One.", | ||
| Example: heredoc.Doc( | ||
| ` | ||
| $ cx hooks pre-commit secrets-install-git-hook | ||
| $ cx hooks pre-commit secrets-scan | ||
| $ cx hooks pre-receive secrets-scan | ||
| `, | ||
| ), | ||
| Annotations: map[string]string{ | ||
| "command:doc": heredoc.Doc( | ||
| ` | ||
| https://checkmarx.com/resource/documents/en/xxxxx-xxxxx-hooks.html | ||
| `, | ||
| ), | ||
| }, | ||
| } | ||
|
|
||
| // Add pre-commit and pre-receive subcommand | ||
| hooksCmd.AddCommand(PreCommitCommand(jwtWrapper)) | ||
| hooksCmd.AddCommand(PreReceiveCommand(jwtWrapper)) | ||
|
|
||
| return hooksCmd | ||
| } | ||
|
|
||
| func validateLicense(jwtWrapper wrappers.JWTWrapper) error { | ||
|
|
||
| allowed, err := jwtWrapper.IsAllowedEngine(params.EnterpriseSecretsLabel) | ||
| if err != nil { | ||
| return errors.Wrapf(err, "Failed checking license") | ||
| } | ||
| if !allowed { | ||
| return errors.New("Error: License validation failed. Please verify your CxOne license includes Enterprise Secrets.") | ||
| } | ||
| return nil | ||
| } | ||
This file contains hidden or 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,49 @@ | ||
| package commands | ||
|
|
||
| import ( | ||
| prereceive "github.com/Checkmarx/secret-detection/pkg/hooks/pre-receive" | ||
| "github.com/MakeNowJust/heredoc" | ||
| "github.com/checkmarx/ast-cli/internal/wrappers" | ||
| "github.com/spf13/cobra" | ||
| ) | ||
|
|
||
| func PreReceiveCommand(jwtWrapper wrappers.JWTWrapper) *cobra.Command { | ||
| preReceiveCmd := &cobra.Command{ | ||
| Use: "pre-receive", | ||
| Short: "Manage pre-receive hooks and run secret detection scans", | ||
| Long: "The pre-receive command enables the ability to manage Git pre-receive hooks for secret detection.", | ||
| Example: heredoc.Doc( | ||
| ` | ||
| $ cx hooks pre-receive secrets-scan | ||
| `, | ||
| ), | ||
| } | ||
| preReceiveCmd.AddCommand(scanSecretsPreReceiveCommand(jwtWrapper)) | ||
|
|
||
| return preReceiveCmd | ||
| } | ||
|
|
||
| func scanSecretsPreReceiveCommand(jwtWrapper wrappers.JWTWrapper) *cobra.Command { | ||
| var configFile string | ||
| scanPrereceiveCmd := &cobra.Command{ | ||
| Use: "secrets-scan", | ||
| Short: "Scan commits for secret detection.", | ||
| Long: "Scan all commits about to enter the remote git repository for secret detection.", | ||
| Example: heredoc.Doc( | ||
| ` | ||
| $ cx hooks pre-receive secrets-scan | ||
| $ cx hooks pre-receive secrets-scan --config /path/to/config.yaml | ||
| `, | ||
| ), | ||
| PreRunE: func(cmd *cobra.Command, args []string) error { | ||
| return validateLicense(jwtWrapper) | ||
| }, | ||
| RunE: func(cmd *cobra.Command, args []string) error { | ||
| return prereceive.Scan(configFile) | ||
| }, | ||
| } | ||
|
|
||
| scanPrereceiveCmd.Flags().StringVarP(&configFile, "config", "c", "", "path to config.yaml file") | ||
|
|
||
| return scanPrereceiveCmd | ||
| } |
This file contains hidden or 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
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Will change this once module is release