Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

comqttauth

package module

Go to main page

Versions in this module

v0

v0.3.0

May 14, 2026

v0.2.1

May 14, 2026

v0.2.0

May 13, 2026

Changes in this version

+ var ErrInvalidRule = errors.New("comqttauth: invalid regex rule")

type Backend

+ DeleteRegexRule func(ctx context.Context, id string) error

+ GetRegexSeeded func(ctx context.Context) (bool, error)

+ PutRegexRule func(ctx context.Context, r RegexRule) (id string, err error)

+ RegexRules func(ctx context.Context) ([]RegexRule, error)

+ SetRegexSeeded func(ctx context.Context) error

+ type Hook struct

+ func (h *Hook) ID() string

+ func (h *Hook) Init(config any) error

+ func (h *Hook) OnACLCheck(cl *mqtt.Client, topic string, write bool) bool

+ func (h *Hook) Provides(b byte) bool

+ type HookOptions struct

+ Backend Backend

+ Logger *slog.Logger

+ type Permission int8

+ const PermissionAllow

+ const PermissionDeny

+ func ParsePermission(s string) (Permission, bool)

+ func (p Permission) String() string

+ type RegexRule struct

+ Action RuleAction

+ ID string

+ Order int

+ Permission Permission

+ SubjectKind SubjectKind

+ SubjectPattern string

+ TopicPatterns []string

+ type RuleAction int8

+ const ActionAll

+ const ActionPub

+ const ActionSub

+ func ParseRuleAction(s string) (RuleAction, bool)

+ func (a RuleAction) String() string

+ type SubjectKind int8

+ const SubjectCertCN

+ const SubjectCertSubject

+ const SubjectClientID

+ const SubjectIPAddr

+ const SubjectUsername

+ func ParseSubjectKind(s string) (SubjectKind, bool)

+ func (s SubjectKind) String() string

v0.1.0

May 13, 2026

Changes in this version

+ var ErrConflict = errors.New("comqttauth: conflict")

+ var ErrNotFound = errors.New("comqttauth: not found")

+ var ErrUnsupported = errors.New("comqttauth: operation not supported by this backend")

+ type ACLRule struct

+ Access Access

+ ID string

+ Subject string

+ Topic string

+ type ACLTable struct

+ AccessColumn string

+ Table string

+ TopicColumn string

+ UserColumn string

+ type Access uint8

+ const AccessDeny

+ const AccessRead

+ const AccessReadWrite

+ const AccessWrite

+ func (a Access) String() string

+ type AuthMode uint8

+ const ModeAnonymous

+ const ModeClientID

+ const ModeUsername

+ func (m AuthMode) String() string

+ type AuthTable struct

+ AllowColumn string

+ PasswordColumn string

+ Table string

+ UserColumn string

+ type Backend interface

+ Close func() error

+ DeleteRule func(ctx context.Context, id string) error

+ DeleteUser func(ctx context.Context, subject string) error

+ GetUser func(ctx context.Context, subject string) (*User, error)

+ HashType func() HashType

+ Kind func() string

+ Mode func() AuthMode

+ PutRule func(ctx context.Context, r ACLRule) (string, error)

+ PutUser func(ctx context.Context, u User, plaintextPassword string) error

+ Rules func(ctx context.Context, subject string) ([]ACLRule, error)

+ Users func(ctx context.Context) ([]User, error)

+ func New(cfg Config) (Backend, error)

+ type Config struct

+ ACLMode AuthMode

+ File *FileConfig

+ HashKey string

+ HashType HashType

+ Kind string

+ Mode AuthMode

+ Redis *RedisConfig

+ SQL *SQLConfig

+ type FileConfig struct

+ Path string

+ type HashType uint8

+ const HashBcrypt

+ const HashHmacSHA1

+ const HashHmacSHA256

+ const HashHmacSHA512

+ const HashMD5

+ const HashNone

+ const HashSHA1

+ const HashSHA256

+ const HashSHA512

+ func (h HashType) String() string

+ type RedisConfig struct

+ ACLKeyPrefix string

+ Addr string

+ AuthKeyPrefix string

+ DB int

+ Password string

+ Username string

+ type SQLConfig struct

+ ACL ACLTable

+ Auth AuthTable

+ DSN string

+ Driver string

+ type User struct

+ Allow bool

+ Subject string