The highest tagged major version is v4.

rules

package

v3.21.0 Latest Latest Go to latest Published: Jul 4, 2025 License: Apache-2.0 Imports: 8 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/checkmarx/2ms

Links

Open Source Insights

Documentation ¶

Index ¶

Constants
func AuthenticatedURL() *config.Rule
func Clojars() *config.Rule
func FilterRules(selectedList, ignoreList, specialList []string) *[]Rule
func GenericCredential() *config.Rule
func GetDefaultRules() *[]Rule
func GitHubApp() *config.Rule
func HardcodedPassword() *config.Rule
func PlaidAccessID() *config.Rule
func PrivateKey() *config.Rule
func VaultServiceToken() *config.Rule
type Rule
type RuleCategory
type ScoreParameters

Constants ¶

View Source

const TagAccessId = "access-id"

View Source

const TagAccessKey = "access-key"

View Source

const TagAccessToken = "access-token"

View Source

const TagApiKey = "api-key"

View Source

const TagApiToken = "api-token"

View Source

const TagClientId = "client-id"

View Source

const TagClientSecret = "client-secret"

View Source

const TagEncryptionKey = "encryption-key"

View Source

const TagPassword = "password"

View Source

const TagPrivateKey = "private-key"

View Source

const TagPublicKey = "public-key"

View Source

const TagPublicSecret = "public-secret"

View Source

const TagRefreshToken = "refresh-token"

View Source

const TagRegistrationToken = "registration-token"

View Source

const TagSecretKey = "secret-key"

View Source

const TagSensitiveUrl = "sensitive-url"

View Source

const TagTriggerToken = "trigger-token"

View Source

const TagUploadToken = "upload-token"

View Source

const TagWebhook = "webhook"

Variables ¶

This section is empty.

Functions ¶

func AuthenticatedURL ¶

func AuthenticatedURL() *config.Rule

func Clojars ¶

func Clojars() *config.Rule

func FilterRules ¶

func FilterRules(selectedList, ignoreList, specialList []string) *[]Rule

func GenericCredential ¶

func GenericCredential() *config.Rule

func GetDefaultRules ¶ added in v3.20.1

func GetDefaultRules() *[]Rule

func GitHubApp ¶

func GitHubApp() *config.Rule

func HardcodedPassword ¶

func HardcodedPassword() *config.Rule

func PlaidAccessID ¶

func PlaidAccessID() *config.Rule

Using this local version because gitleaks has entropy as 3.5, which causes issues on this rule's validation

func PrivateKey ¶

func PrivateKey() *config.Rule

func VaultServiceToken ¶

func VaultServiceToken() *config.Rule

Using this local version because newer versions of gitleaks have an entropy value, which was set as too high It's here as prevention in case a newer version of gitleaks starts getting used and causes issues on this rule If gitleaks is updated on 2ms and the new version of this rule has entropy, set it to 3.0

Types ¶

type Rule ¶

type Rule struct {
	Rule            config.Rule
	Tags            []string
	ScoreParameters ScoreParameters
}

type RuleCategory ¶

type RuleCategory string

const (
	CategoryAuthenticationAndAuthorization RuleCategory = "Authentication and Authorization"
	CategoryCryptocurrencyExchange         RuleCategory = "Cryptocurrency Exchange"
	CategoryFinancialServices              RuleCategory = "Financial Services"
	CategoryPaymentProcessing              RuleCategory = "Payment Processing"
	CategorySecurity                       RuleCategory = "Security"
	CategoryAPIAccess                      RuleCategory = "API Access"
	CategoryCICD                           RuleCategory = "CI/CD"
	CategoryCloudPlatform                  RuleCategory = "Cloud Platform"
	CategoryDatabaseAsAService             RuleCategory = "Database as a Service"
	CategoryDevelopmentPlatform            RuleCategory = "Development Platform"
	CategoryEmailDeliveryService           RuleCategory = "Email Delivery Service"
	CategoryInfrastructureAsCode           RuleCategory = "Infrastructure as Code (IaC)"
	CategoryPackageManagement              RuleCategory = "Package Management"
	CategorySourceCodeManagement           RuleCategory = "Source Code Management"
	CategoryWebHostingAndDeployment        RuleCategory = "Web Hosting and Deployment"
	CategoryBackgroundProcessingService    RuleCategory = "Background Processing Service"
	CategoryCDN                            RuleCategory = "CDN (Content Delivery Network)"
	CategoryContentManagementSystem        RuleCategory = "Content Management System (CMS)"
	CategoryCustomerSupport                RuleCategory = "Customer Support"
	CategoryDataAnalytics                  RuleCategory = "Data Analytics"
	CategoryFileStorageAndSharing          RuleCategory = "File Storage and Sharing"
	CategoryIoTPlatform                    RuleCategory = "IoT platform"
	CategoryMappingAndLocationServices     RuleCategory = "Mapping and Location Services"
	CategoryNetworking                     RuleCategory = "Networking"
	CategoryPhotoSharing                   RuleCategory = "Photo Sharing"
	CategorySaaS                           RuleCategory = "SaaS"
	CategoryShipping                       RuleCategory = "Shipping"
	CategorySoftwareDevelopment            RuleCategory = "Software Development"
	CategoryAIAndMachineLearning           RuleCategory = "AI and Machine Learning"
	CategoryApplicationMonitoring          RuleCategory = "Application Monitoring"
	CategoryECommercePlatform              RuleCategory = "E-commerce Platform"
	CategoryMarketingAutomation            RuleCategory = "Marketing Automation"
	CategoryNewsAndMedia                   RuleCategory = "News and Media"
	CategoryOnlineSurveyPlatform           RuleCategory = "Online Survey Platform"
	CategoryProjectManagement              RuleCategory = "Project Management"
	CategorySearchService                  RuleCategory = "Search Service"
	CategorySocialMedia                    RuleCategory = "Social Media"
	CategoryGeneralOrUnknown               RuleCategory = "general or unknown"
)

type ScoreParameters ¶

type ScoreParameters struct {
	Category RuleCategory
	RuleType uint8
}

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL