mleku
69e2c873d8
Some checks failed
Go / build-and-release (push) Has been cancelled
Replaced inline interface literals with dedicated, documented interface definitions in `pkg/interfaces/`. Introduced `TimeoutError`, `PolicyChecker`, and `Neo4jResultIterator` interfaces to clarify design, improve maintainability, and resolve potential circular dependencies. Updated config and constant usage rules for consistency. Incremented version to v0.31.11.
41 lines
1.4 KiB
Go
41 lines
1.4 KiB
Go
// Package acl is an interface for implementing arbitrary access control lists.
|
|
package acl
|
|
|
|
import (
|
|
"git.mleku.dev/mleku/nostr/encoders/event"
|
|
"next.orly.dev/pkg/interfaces/typer"
|
|
)
|
|
|
|
const (
|
|
None = "none"
|
|
// Read means read only
|
|
Read = "read"
|
|
// Write means read and write
|
|
Write = "write"
|
|
// Admin means read, write, import/export and arbitrary delete
|
|
Admin = "admin"
|
|
// Owner means read, write, import/export, arbitrary delete and wipe
|
|
Owner = "owner"
|
|
)
|
|
|
|
type I interface {
|
|
Configure(cfg ...any) (err error)
|
|
// GetAccessLevel returns the access level string for a given pubkey.
|
|
GetAccessLevel(pub []byte, address string) (level string)
|
|
// GetACLInfo returns the name and a description of the ACL, which should
|
|
// explain briefly how it works, and then a long text of documentation of
|
|
// the ACL's rules and configuration (in asciidoc or markdown).
|
|
GetACLInfo() (name, description, documentation string)
|
|
// Syncer is a worker thread that does things in the background like syncing
|
|
// with other relays on admin relay lists using subscriptions for all events
|
|
// that arrive elsewhere relevant to the ACL scheme.
|
|
Syncer()
|
|
typer.T
|
|
}
|
|
|
|
// PolicyChecker is an optional interface that ACL implementations can implement
|
|
// to provide custom event policy checking beyond basic access level checks.
|
|
type PolicyChecker interface {
|
|
CheckPolicy(ev *event.E) (allowed bool, err error)
|
|
}
|