You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Bohdan Horbeshko e55463fc98 Fix passing Component to StreamManager 8 months ago
.github/workflows Added coverage 3 years ago
_examples Refactor tests 2 years ago
cmd Refactor tests 2 years ago
stanza Support partial JIDs in Bare/Full methods 8 months ago
.gitignore Ignore directory where I put private notes 3 years ago
CHANGELOG.md Changelog and doc 2 years ago
CODE_OF_CONDUCT.md Add CoC and contribution guide 4 years ago
CONTRIBUTING.md Add CoC and contribution guide 4 years ago
LICENSE Moving XMPP library to Fluux project 5 years ago
README.md Remove "no depdencies" statement from README 3 years ago
auth.go Refactor tests 2 years ago
backoff.go Add constants (enumlike) for stanza types and simplify packet creation (#62) 3 years ago
backoff_test.go Add constants (enumlike) for stanza types and simplify packet creation (#62) 3 years ago
bi_dir_iterator.go - Changed IQ stanzas to pointer semantics 3 years ago
cert_checker.go Tests for Component and code style fixes (#129) 3 years ago
client.go Fix issue #160 2 years ago
client_internal_test.go Refactor tests 2 years ago
client_test.go Renamed Hooks 2 years ago
component.go Refactor tests 2 years ago
component_test.go Refactor tests 2 years ago
config.go Refactor tests 2 years ago
conn_error.go With go modules, we should be able to remove import comments 3 years ago
doc.go Fixed decoder usage. 3 years ago
go.mod Removed unnecessary dependencies from the core lib go.mod 3 years ago
go.sum Support for XEP-0334 2 years ago
network.go Tests for Component and code style fixes (#129) 3 years ago
network_test.go Tests for Component and code style fixes (#129) 3 years ago
router.go Changelog and doc 2 years ago
router_test.go - Changed IQ stanzas to pointer semantics 3 years ago
session.go Refactor tests 2 years ago
stream_logger.go Comments clean-up 3 years ago
stream_manager.go Fix passing Component to StreamManager 8 months ago
tcp_server_mock.go Refactor tests 2 years ago
test.sh Removed last bits of codecov 3 years ago
transport.go - Changed IQ stanzas to pointer semantics 3 years ago
websocket_transport.go Changed "Disconnect" to wait for the closing stream tag. (#141) 3 years ago
xmpp_transport.go Reset isSecure in StartTLS() 2 years ago

README.md

Fluux XMPP

GoDoc GoReportCard Coverage Status

Fluux XMPP is a Go XMPP library, focusing on simplicity, simple automation, and IoT.

The goal is to make simple to write simple XMPP clients and components:

  • For automation (like for example monitoring of an XMPP service),
  • For building connected "things" by plugging them on an XMPP server,
  • For writing simple chatbot to control a service or a thing,
  • For writing XMPP servers components.

The library is designed to have minimal dependencies. Currently it requires at least Go 1.13.

Configuration and connection

Allowing Insecure TLS connection during development

It is not recommended to disable the check for domain name and certificate chain. Doing so would open your client to man-in-the-middle attacks.

However, in development, XMPP servers often use self-signed certificates. In that situation, it is better to add the root CA that signed the certificate to your trusted list of root CA. It avoids changing the code and limit the risk of shipping an insecure client to production.

That said, if you really want to allow your client to trust any TLS certificate, you can customize Go standard tls.Config and set it in Config struct.

Here is an example code to configure a client to allow connecting to a server with self-signed certificate. Note the InsecureSkipVerify option. When using this tls.Config option, all the checks on the certificate are skipped.

config := xmpp.Config{
	Address:      "localhost:5222",
	Jid:          "test@localhost",
	Credential:   xmpp.Password("Test"),
	TLSConfig:    tls.Config{InsecureSkipVerify: true},
}

Supported specifications

Clients

Components

Extensions

Package overview

Stanza subpackage

XMPP stanzas are basic and extensible XML elements. Stanzas (or sometimes special stanzas called 'nonzas') are used to leverage the XMPP protocol features. During a session, a client (or a component) and a server will be exchanging stanzas back and forth.

At a low-level, stanzas are XML fragments. However, Fluux XMPP library provides the building blocks to interact with stanzas at a high-level, providing a Go-friendly API.

The stanza subpackage provides support for XMPP stream parsing, marshalling and unmarshalling of XMPP stanza. It is a bridge between high-level Go structure and low-level XMPP protocol.

Parsing, marshalling and unmarshalling is automatically handled by Fluux XMPP client library. As a developer, you will generally manipulates only the high-level structs provided by the stanza package.

The XMPP protocol, as the name implies is extensible. If your application is using custom stanza extensions, you can implement your own extensions directly in your own application.

To learn more about the stanza package, you can read more in the stanza package documentation.

Router

TODO

Getting IQ response from server

TODO

Examples

We have several examples to help you get started using Fluux XMPP library.

Here is the demo "echo" client:

package main

import (
	"fmt"
	"log"
	"os"

	"gosrc.io/xmpp"
	"gosrc.io/xmpp/stanza"
)

func main() {
	config := xmpp.Config{
		TransportConfiguration: xmpp.TransportConfiguration{
			Address: "localhost:5222",
		},
		Jid:          "test@localhost",
		Credential:   xmpp.Password("test"),
		StreamLogger: os.Stdout,
		Insecure:     true,
		// TLSConfig: tls.Config{InsecureSkipVerify: true},
	}

	router := xmpp.NewRouter()
	router.HandleFunc("message", handleMessage)

	client, err := xmpp.NewClient(config, router, errorHandler)
	if err != nil {
		log.Fatalf("%+v", err)
	}

	// If you pass the client to a connection manager, it will handle the reconnect policy
	// for you automatically.
	cm := xmpp.NewStreamManager(client, nil)
	log.Fatal(cm.Run())
}

func handleMessage(s xmpp.Sender, p stanza.Packet) {
	msg, ok := p.(stanza.Message)
	if !ok {
		_, _ = fmt.Fprintf(os.Stdout, "Ignoring packet: %T\n", p)
		return
	}

	_, _ = fmt.Fprintf(os.Stdout, "Body = %s - from = %s\n", msg.Body, msg.From)
	reply := stanza.Message{Attrs: stanza.Attrs{To: msg.From}, Body: msg.Body}
	_ = s.Send(reply)
}

func errorHandler(err error) {
	fmt.Println(err.Error())
}

Reference documentation

The code documentation is available on GoDoc: gosrc.io/xmpp