Documentation
¶
Index ¶
- Constants
- func ParseLevel(levelStr string) (zerolog.Level, error)
- func RegisterStatusHook(hook ShortcutStatusFN)
- func SetGlobalHitWriter(writer *HitLevelWriter)
- func SetLogLevel(verbose bool)
- func ShortcutListeners(status ShortcutStatusFN)
- type HitEvent
- type HitLevelWriter
- type SecretType
- type ShortcutStatusFN
Constants ¶
View Source
const HitLevel zerolog.Level = zerolog.WarnLevel
HitLevel defines a custom log level for security finding hits. Implemented as WarnLevel but transformed to "hit" in output.
Variables ¶
This section is empty.
Functions ¶
func ParseLevel ¶
ParseLevel extends zerolog's ParseLevel to support "hit" level.
func RegisterStatusHook ¶
func RegisterStatusHook(hook ShortcutStatusFN)
func SetGlobalHitWriter ¶
func SetGlobalHitWriter(writer *HitLevelWriter)
SetGlobalHitWriter sets the global HitLevelWriter (for testing only).
func SetLogLevel ¶
func SetLogLevel(verbose bool)
func ShortcutListeners ¶
func ShortcutListeners(status ShortcutStatusFN)
Types ¶
type HitEvent ¶
type HitEvent struct {
// contains filtered or unexported fields
}
HitEvent wraps a zerolog.Event for hit-level logging with "level":"hit" output.
type HitLevelWriter ¶
type HitLevelWriter struct {
// contains filtered or unexported fields
}
HitLevelWriter wraps an io.Writer to transform logs with "level":"warn" to "level":"hit".
func NewHitLevelWriter ¶
func NewHitLevelWriter(out io.Writer) *HitLevelWriter
NewHitLevelWriter creates a new HitLevelWriter wrapping the given io.Writer.
func (*HitLevelWriter) SetOutput ¶
func (w *HitLevelWriter) SetOutput(out io.Writer)
type SecretType ¶
type SecretType string
SecretType defines the source type of a detected secret.
const ( // SecretTypeLog indicates a secret found in CI/CD logs. SecretTypeLog SecretType = "log" // SecretTypeArchive indicates a secret found in an archive/artifact. SecretTypeArchive SecretType = "archive" // NestedArchive indicates a secret found in a nested archive. SecretTypeNestedArchive SecretType = "nested-archive" // SecretTypeDotenv indicates a secret found in a dotenv file. SecretTypeDotenv SecretType = "dotenv" )
type ShortcutStatusFN ¶
func GetStatusHook ¶
func GetStatusHook() ShortcutStatusFN
Source Files
Click to show internal directories.
Click to hide internal directories.