db

package

v0.0.0-...-6fcdc86 Latest Latest Go to latest Published: Jul 12, 2021 License: MIT Imports: 20 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

This section is empty.

View Source

var ErrExists = errors.New("already exists")

View Source

var ErrNotFound = errors.New("not found")

func ValidateUsername(username string) bool

type Action rune

const (
	Read  Action = 'R'
	Write Action = 'W'
)

type Handle struct {
	GetCertificate func(*tls.ClientHelloInfo) (*tls.Certificate, error)
	// contains filtered or unexported fields
}

func Open(dir string) (*Handle, error)

func (db *Handle) RTxn() *RTxn

func (db *Handle) Txn() *Txn

type Policy struct {
	Verb   Verb
	Action Action
	Name   string
	Users  []string
	Paths  []string
}

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

func (tx *RTxn) Complete()

func (tx *RTxn) FetchAllPolicies() []Policy

func (tx *RTxn) FetchAllUsers() []User

func (tx *RTxn) FindUser(username string) (user User, found bool)

func (tx *RTxn) GetPolicies(path string, username string, action Action) []Policy

func (tx *RTxn) NumUsers() int

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

func (tx *Txn) AddUser(u *User) error

func (tx *Txn) Complete()

func (tx *Txn) DeleteAccessPolicy(name string) error

func (tx *Txn) DeleteUser(username string) error

func (tx *Txn) FindUser(username string) (user User, found bool)

func (tx *Txn) NumUsers() int

func (tx *Txn) PutAccessPolicy(p *Policy) error

func (tx *Txn) UpdateUser(username string, f func(u *User)) error

type User struct {
	Username string
	Password []byte
	Chroot   string
	Admin    bool
}

type Verb string

const (
	Allow Verb = "ALLOW"
	Deny  Verb = "DENY"
)