sqlite

Documentation

Index

• Constants
• type DB
  • func Open(dsn string) (*DB, error)
  • func (db *DB) DeleteUser(email string) error
  • func (db *DB) LoadData(filter SQLFilter) ([]scan.IPInfo, error)
  • func (db *DB) LoadGroups() ([]string, error)
  • func (db *DB) LoadJobSubmission() (scan.Submission, error)
  • func (db *DB) LoadJobs(filter SQLFilter) ([]scan.Job, error)
  • func (db *DB) LoadSubmission(filter SQLFilter) (scan.Submission, error)
  • func (db *DB) LoadTraceroute(dest string) (string, error)
  • func (db *DB) LoadTracerouteIPs() (map[string]struct{}, error)
  • func (db *DB) LoadUsers() ([]string, error)
  • func (db *DB) ResultData(ip, fs, ls string) (scan.Data, error)
  • func (db *DB) SaveAudit(ts time.Time, user, event, info string) error
  • func (db *DB) SaveData(results []scan.Result, now time.Time) (int64, error)
  • func (db *DB) SaveJob(cidr, ports, proto, user string) (int64, error)
  • func (db *DB) SaveSubmission(host string, job *int64, now time.Time) error
  • func (db *DB) SaveTraceroute(dest, trace string) error
  • func (db *DB) SaveUser(email string) error
  • func (db *DB) UpdateJob(id string, count int64) error
  • func (db *DB) UserExists(email string) (bool, error)
• type SQLFilter
  • func (f SQLFilter) String() string

Constants

const DefaultDBFile = "scan.db"

DefaultDBFile is the default SQLite database file name.

Types

type DB

type DB struct {
	*sql.DB
}

DB is the database.

func Open

func Open(dsn string) (*DB, error)

Open creates a new SQLite database object.

func (*DB) DeleteUser

func (db *DB) DeleteUser(email string) error

DeleteUser deletes a user.

func (*DB) LoadData

func (db *DB) LoadData(filter SQLFilter) ([]scan.IPInfo, error)

LoadData loads all data for displaying in the browser.

func (*DB) LoadGroups

func (db *DB) LoadGroups() ([]string, error)

func (*DB) LoadJobSubmission

func (db *DB) LoadJobSubmission() (scan.Submission, error)

LoadJobSubmission retrieves the stored submissions associated with a job.

func (*DB) LoadJobs

func (db *DB) LoadJobs(filter SQLFilter) ([]scan.Job, error)

LoadJobs retrives the stored jobs.

func (*DB) LoadSubmission

func (db *DB) LoadSubmission(filter SQLFilter) (scan.Submission, error)

LoadSubmission retrieves the stored submissions.

func (*DB) LoadTraceroute

func (db *DB) LoadTraceroute(dest string) (string, error)

LoadTraceroute retrieves a traceroute.

func (*DB) LoadTracerouteIPs

func (db *DB) LoadTracerouteIPs() (map[string]struct{}, error)

LoadTracerouteIPs retrieves the stored traceroutes.

func (*DB) LoadUsers

func (db *DB) LoadUsers() ([]string, error)

LoadUsers retrieves all users.

func (*DB) ResultData

func (db *DB) ResultData(ip, fs, ls string) (scan.Data, error)

ResultData retrieves stored results. Each argument is optional and allows searching by IP address, first seen and last seen.

func (*DB) SaveAudit

func (db *DB) SaveAudit(ts time.Time, user, event, info string) error

func (*DB) SaveData

func (db *DB) SaveData(results []scan.Result, now time.Time) (int64, error)

SaveData saves the results posted.

func (*DB) SaveJob

func (db *DB) SaveJob(cidr, ports, proto, user string) (int64, error)

SaveJob stores a new custom scan job request.

func (*DB) SaveSubmission

func (db *DB) SaveSubmission(host string, job *int64, now time.Time) error

SaveSubmission stores when and which host just submitted data.

func (*DB) SaveTraceroute

func (db *DB) SaveTraceroute(dest, trace string) error

func (*DB) SaveUser

func (db *DB) SaveUser(email string) error

SaveUser stores a new user.

func (*DB) UpdateJob

func (db *DB) UpdateJob(id string, count int64) error

UpdateJob updates the given job to mark the number of ports found.

func (*DB) UserExists

func (db *DB) UserExists(email string) (bool, error)

type SQLFilter

type SQLFilter struct {
	Where  []string
	Values []interface{}
}

SQLFilter is for constructing data filters ("WHERE" clauses) in a SQL statement

func (SQLFilter) String

func (f SQLFilter) String() string

String constructs a SQL WHERE clause.