audit

Documentation

Overview

Package audit contains the password-strength auditing implementation. It reads all decrypted passwords and applies different heuristics and external password strength checks to determine the quality of the password (i.e. the first line of the secret - only!).

Index

• Variables
• func Single(ctx context.Context, password string)
• type Auditor
  • func New(ctx context.Context, s secretGetter) *Auditor
  • func (a *Auditor) Batch(ctx context.Context, secrets []string) (*Report, error)
• type Finding
• type Report
  • func (r *Report) PrintResults(ctx context.Context) error
  • func (r *Report) RenderCSV(w io.Writer) error
  • func (r *Report) RenderHTML(w io.Writer) error
• type ReportBuilder
  • func (r *ReportBuilder) AddFinding(secret, finding, message, severity string)
  • func (r *ReportBuilder) AddPassword(name, pw string)
  • func (r *ReportBuilder) Finalize() *Report
  • func (r *ReportBuilder) SetAge(name string, age time.Duration)
• type SecretReport

Variables

var DefaultExpiration = time.Hour * 24 * 365

DefaultExpiration is the default expiration time for secrets.

Functions

func Single

func Single(ctx context.Context, password string)

Single runs a password strength audit on a single password.

Types

type Auditor

type Auditor struct {
	// contains filtered or unexported fields
}

func New

func New(ctx context.Context, s secretGetter) *Auditor

func (*Auditor) Batch

func (a *Auditor) Batch(ctx context.Context, secrets []string) (*Report, error)

Batch runs a password strength audit on multiple secrets. Expiration is in days.

type Finding

type Finding struct {
	Severity string
	Message  string
}

type Report

type Report struct {
	Secrets  map[string]SecretReport
	Template string
	Duration time.Duration
}

func (*Report) PrintResults

func (r *Report) PrintResults(ctx context.Context) error

func (*Report) RenderCSV

func (r *Report) RenderCSV(w io.Writer) error

func (*Report) RenderHTML

func (r *Report) RenderHTML(w io.Writer) error

type ReportBuilder

type ReportBuilder struct {
	sync.Mutex
	// contains filtered or unexported fields
}

func (*ReportBuilder) AddFinding

func (r *ReportBuilder) AddFinding(secret, finding, message, severity string)

func (*ReportBuilder) AddPassword

func (r *ReportBuilder) AddPassword(name, pw string)

func (*ReportBuilder) Finalize

func (r *ReportBuilder) Finalize() *Report

Finalize computes the duplicates.

func (*ReportBuilder) SetAge

func (r *ReportBuilder) SetAge(name string, age time.Duration)

type SecretReport

type SecretReport struct {
	Name     string
	Findings map[string]Finding
	Age      time.Duration
}