mosquitto-plugin 2.1.0

A simple way to create plugins for mosquitto, using rust code
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67

[![CI](https://github.com/TotalKrill/mosquitto_plugin/workflows/ci/badge.svg)](https://github.com/TotalKrill/mosquitto_plugin/actions)

# Mosquitto Plugin

A simple way to generate ACL and PASSWORD plugins for usage with the mosquitto
broker.

Requires that mosquitto_plugin.h mosquitto.h files are installed on the system,
on linux systems this is usually achieved through the mosquitto-dev packages.
Not tested on windows.

To pass additional (clang) arguments to the clang invocation from `bindgen`, set
`MOSQUITTO_PLUGIN_CLANG_EXTRA_ARGS` for e.g a special search path for the
mosquitto headers: "-I ../mosquitto-2.0.4/include".

The optional functions are not implemented here.

## Debugging Segfaults

being a plugin utilizing the C ABI interface of mosquitto, there might be segfaults 
due to unexpected behaviour  in how  mosquitto calls into the plugin, compiling in 
debug mode will enable asserts of most raw pointer usage and can help in debugging 
such cases.

Otherwise, look at unsafe code, thats where segfaults occur. Which leaves the entire
mosquitto codebase, but mosquitto is quite well tested by now. So start looking in this code

## Supported

    - ease of access to write own mosquitto plugins
    - auth_opt_<key> value in the mosquitto_conf
    - mutable access to the structure between calls
    - ACL implementations
    - username/password implementatations

## Example usage

There is an example usage in the github repo under "examples/acl" folder.

### Basic authentification

Simple example that allows only password/username combos where the password is
reversed (and no credentials as well, since those do not invoke ACL calls, and
thus needs to be configured in a mosquitto configuration)

It also only allows messages on the topic specified in the mosquitto config as
auth_opt_topic

See the provided examples/mosquitto-acl.conf for details.

Start build and run:

```
cargo build --example basic-auth
mosquitto -c examples/basic-auth.conf
```

### Extended authentification

Example how to negotiate authentification with a client with v5 AUTH packages.

Start build and run:

```
cargo build --example extended-auth
mosquitto -c examples/extended-auth.conf
```