gmqtt

README

中文文档

Gmqtt

Project state

This project is less maintained due to personal reasons. Here are some information for people who want to use this project.

Gmqtt was used in production and worked well. The production environment was serving hundreds of clients(or maybe thousands or 10 thousands now), and each client published QoS 1 message to report their state every 15 seconds. The subscribers on the cloud would store those state into persist backend. All clients were non-persistent session and using v3.1.1 protocol.

It is suggested to evaluate and test carefully before running in your production environment.

Features

• Provide hook method to customized the broker behaviours(Authentication, ACL, etc..). See server/hooks.go for details
• Support tls/ssl and websocket
• Provide flexible plugable mechanism. See server/plugin.go and /plugin for details.
• Provide Go interface for extensions to interact with the server. For examples, the extensions or plugins can publish message or add/remove subscription through function call. See Server interface in server/server.go and admin for details.
• Provide metrics (by using Prometheus). (plugin: prometheus)
• Provide GRPC and REST APIs to interact with server. (plugin:admin)
• Provide session persistence which means the broker can retrieve the session data after restart. Currently, only redis backend is supported.
• Provide clustering, see federation plugin for examples and details. (WARNING: This is an experimental feature, and has never been used in production environment.)

Get Started

To get started with gmqtt, we need to compile it from the source code. Please ensure that you have a working Go environment.

The following command will start gmqtt broker with default configuration. The broker listens on 1883 for tcp server and 8883 for websocket server with admin and prometheus plugin loaded.

$ git clone https://github.com/twxstar/gmqtt
$ cd gmqtt/cmd/gmqttd
$ go run . start -c default_config.yml

configuration

Gmqtt use -c flag to define configuration path. If not set, gmqtt reads $HOME/gmqtt.yml as default. Here is a sample configuration.

session persistence

Gmqtt uses memory to store session data by default and it is the recommended way because of the good performance. But the session data will be lose after the broker restart. You can use redis as backend storage to prevent data loss from restart:

persistence:
  type: redis  
  redis:
    # redis server address
    addr: "127.0.0.1:6379"
    # the maximum number of idle connections in the redis connection pool
    max_idle: 1000
    # the maximum number of connections allocated by the redis connection pool at a given time.
    # If zero, there is no limit on the number of connections in the pool.
    max_active: 0
    # the connection idle timeout, connection will be closed after remaining idle for this duration. If the value is zero, then idle connections are not closed
    idle_timeout: 240s
    password: ""
    # the number of the redis database
    database: 0

Authentication

Gmqtt provides a simple username/password authentication mechanism. (Provided by auth plugin). It is not enabled in default configuration, you can change the configuration to enable it:

# plugin loading orders
plugin_order:
  - auth
  - prometheus
  - admin

When auth plugin enabled, every clients need an account to get connected.You can add accounts through the HTTP API:

# Create: username = user1, password = user1pass
$ curl -X POST -d '{"password":"user1pass"}' 127.0.0.1:8083/v1/accounts/user1
{}
# Query
$ curl 127.0.0.1:8083/v1/accounts/user1
{"account":{"username":"user1","password":"20a0db53bc1881a7f739cd956b740039"}}

API Doc swagger

Docker

$ docker build -t gmqtt .
$ docker run -p 1883:1883 -p 8883:8883 -p 8082:8082 -p 8083:8083  -p 8084:8084  gmqtt

Documentation

godoc

Hooks

Gmqtt implements the following hooks:

Name	hooking point	possible usages
OnAccept	When accepts a TCP connection.(Not supported in websocket)	Connection rate limit, IP allow/block list.
OnStop	When gmqtt stop
OnSubscribe	When received a subscribe packet	Subscribe access control, modifies subscriptions.
OnSubscribed	When subscribe succeed
OnUnsubscribe	When received a unsubscribe packet	Unsubscribe access controls, modifies the topics that is going to unsubscribe.
OnUnsubscribed	When unsubscribe succeed
OnMsgArrived	When received a publish packet	Publish access control, modifies message before delivery.
OnBasicAuth	When received a connect packet without AuthMethod property	Authentication
OnEnhancedAuth	When received a connect packet with AuthMethod property (Only for v5 clients)	Authentication
OnReAuth	When received a auth packet (Only for v5 clients)	Authentication
OnConnected	When the client connected succeed
OnSessionCreated	When creates a new session
OnSessionResumed	When resumes from old session
OnSessionTerminated	When session terminated
OnDelivered	When a message is delivered to the client
OnClosed	When the client is closed
OnMsgDropped	When a message is dropped for some reasons
OnWillPublish	When the client is going to deliver a will message	Modify or drop the will message
OnWillPublished	When a will message has been delivered

How to write plugins

How to write plugins

Contributing

Contributions are always welcome, see Contribution Guide for a complete contributing guide.

Test

Unit Test

$ go test -race ./...

Integration Test

paho.mqtt.testing.

Documentation

Index

• func MessageToPublish(msg *Message, version packets.Version) *packets.Publish
• type Message
  • func MessageFromPublish(p *packets.Publish) *Message
  • func (m *Message) Copy() *Message
  • func (m *Message) TotalBytes(version packets.Version) uint32
• type Session
  • func (s *Session) IsExpired(now time.Time) bool
• type Subscription
  • func (s *Subscription) Copy() *Subscription
  • func (s *Subscription) GetFullTopicName() string
  • func (s *Subscription) Validate() error

Functions

func MessageToPublish

func MessageToPublish(msg *Message, version packets.Version) *packets.Publish

MessageToPublish create the publish packet instance from *Message

Types

type Message

type Message struct {
	Dup      bool
	QoS      uint8
	Retained bool
	Topic    string
	Payload  []byte
	PacketID packets.PacketID
	// The following fields are introduced in v5 specification.
	// Excepting MessageExpiry, these fields will not take effect when it represents a v3.x publish packet.
	ContentType            string
	CorrelationData        []byte
	MessageExpiry          uint32
	PayloadFormat          packets.PayloadFormat
	ResponseTopic          string
	SubscriptionIdentifier []uint32
	UserProperties         []packets.UserProperty
}

func MessageFromPublish

func MessageFromPublish(p *packets.Publish) *Message

MessageFromPublish create the Message instance from publish packets

func (*Message) Copy

func (m *Message) Copy() *Message

Copy deep copies the Message and return the new one

func (*Message) TotalBytes

func (m *Message) TotalBytes(version packets.Version) uint32

TotalBytes return the publish packets total bytes.

type Session

type Session struct {
	// ClientID represents the client id.
	ClientID string
	// Will is the will message of the client, can be nil if there is no will message.
	Will *Message
	// WillDelayInterval represents the Will Delay Interval in seconds
	WillDelayInterval uint32
	// ConnectedAt is the session create time.
	ConnectedAt time.Time
	// ExpiryInterval represents the Session Expiry Interval in seconds
	ExpiryInterval uint32
}

Session represents a MQTT session.

func (*Session) IsExpired

func (s *Session) IsExpired(now time.Time) bool

IsExpired return whether the session is expired

type Subscription

type Subscription struct {
	// ShareName is the share name of a shared subscription.
	// set to "" if it is a non-shared subscription.
	ShareName string
	// TopicFilter is the topic filter which does not include the share name.
	TopicFilter string
	// ID is the subscription identifier
	ID uint32

	// QoS is the qos level of the Subscription.
	QoS packets.QoS
	// NoLocal is the No Local option.
	NoLocal bool
	// RetainAsPublished is the Retain As Published option.
	RetainAsPublished bool
	// RetainHandling the Retain Handling option.
	RetainHandling byte
}

Subscription represents a subscription in gmqtt.

func (*Subscription) Copy

func (s *Subscription) Copy() *Subscription

Copy makes a copy of subscription.

func (*Subscription) GetFullTopicName

func (s *Subscription) GetFullTopicName() string

GetFullTopicName returns the full topic name of the subscription.

func (*Subscription) Validate

func (s *Subscription) Validate() error

Validate returns whether the subscription is valid. If you can ensure the subscription is valid then just skip the validation.