Add deny-protocol-version example plugin, for 2.0 only.
This commit is contained in:
parent
e5bf040fb7
commit
4ac8c0bcc3
@ -1,5 +1,6 @@
|
|||||||
DIRS= \
|
DIRS= \
|
||||||
auth-by-ip \
|
auth-by-ip \
|
||||||
|
deny-protocol-version \
|
||||||
dynamic-security \
|
dynamic-security \
|
||||||
message-timestamp \
|
message-timestamp \
|
||||||
payload-modification
|
payload-modification
|
||||||
|
24
plugins/deny-protocol-version/CMakeLists.txt
Normal file
24
plugins/deny-protocol-version/CMakeLists.txt
Normal file
@ -0,0 +1,24 @@
|
|||||||
|
set (PLUGIN_NAME mosquitto_deny_protocol_version)
|
||||||
|
|
||||||
|
add_library(${PLUGIN_NAME} MODULE
|
||||||
|
${PLUGIN_NAME}.c
|
||||||
|
)
|
||||||
|
|
||||||
|
target_include_directories(${PLUGIN_NAME} PRIVATE
|
||||||
|
"${OPENSSL_INCLUDE_DIR}"
|
||||||
|
"${STDBOOL_H_PATH} ${STDINT_H_PATH}"
|
||||||
|
"${mosquitto_SOURCE_DIR}"
|
||||||
|
"${mosquitto_SOURCE_DIR}/include"
|
||||||
|
)
|
||||||
|
|
||||||
|
set_target_properties(${PLUGIN_NAME} PROPERTIES
|
||||||
|
PREFIX ""
|
||||||
|
POSITION_INDEPENDENT_CODE 1
|
||||||
|
)
|
||||||
|
|
||||||
|
if(WIN32)
|
||||||
|
target_link_libraries(${PLUGIN_NAME} PRIVATE mosquitto)
|
||||||
|
endif()
|
||||||
|
|
||||||
|
# Don't install, these are example plugins only.
|
||||||
|
#install(TARGETS ${PLUGIN_NAME} RUNTIME DESTINATION "${CMAKE_INSTALL_BINDIR}" LIBRARY DESTINATION "${CMAKE_INSTALL_LIBDIR}")
|
29
plugins/deny-protocol-version/Makefile
Normal file
29
plugins/deny-protocol-version/Makefile
Normal file
@ -0,0 +1,29 @@
|
|||||||
|
R=../..
|
||||||
|
include ${R}/config.mk
|
||||||
|
|
||||||
|
.PHONY : all binary check clean reallyclean test install uninstall
|
||||||
|
|
||||||
|
PLUGIN_NAME=mosquitto_deny_protocol_version
|
||||||
|
PLUGIN_CFLAGS+=-I${R}/include -I${R}/
|
||||||
|
|
||||||
|
all : binary
|
||||||
|
|
||||||
|
binary : ${PLUGIN_NAME}.so
|
||||||
|
|
||||||
|
${PLUGIN_NAME}.so : ${PLUGIN_NAME}.c
|
||||||
|
$(CROSS_COMPILE)$(CC) $(PLUGIN_CPPFLAGS) $(PLUGIN_CFLAGS) $(PLUGIN_LDFLAGS) -fPIC -shared $< -o $@
|
||||||
|
|
||||||
|
reallyclean : clean
|
||||||
|
clean:
|
||||||
|
-rm -f *.o ${PLUGIN_NAME}.so *.gcda *.gcno
|
||||||
|
|
||||||
|
check: test
|
||||||
|
test:
|
||||||
|
|
||||||
|
install: ${PLUGIN_NAME}.so
|
||||||
|
# Don't install, these are examples only.
|
||||||
|
#$(INSTALL) -d "${DESTDIR}$(libdir)"
|
||||||
|
#$(INSTALL) ${STRIP_OPTS} ${PLUGIN_NAME}.so "${DESTDIR}${libdir}/${PLUGIN_NAME}.so"
|
||||||
|
|
||||||
|
uninstall :
|
||||||
|
-rm -f "${DESTDIR}${libdir}/${PLUGIN_NAME}.so"
|
110
plugins/deny-protocol-version/mosquitto_deny_protocol_version.c
Normal file
110
plugins/deny-protocol-version/mosquitto_deny_protocol_version.c
Normal file
@ -0,0 +1,110 @@
|
|||||||
|
/*
|
||||||
|
Copyright (c) 2022 Roger Light <roger@atchoo.org>
|
||||||
|
|
||||||
|
All rights reserved. This program and the accompanying materials
|
||||||
|
are made available under the terms of the Eclipse Public License 2.0
|
||||||
|
and Eclipse Distribution License v1.0 which accompany this distribution.
|
||||||
|
|
||||||
|
The Eclipse Public License is available at
|
||||||
|
https://www.eclipse.org/legal/epl-2.0/
|
||||||
|
and the Eclipse Distribution License is available at
|
||||||
|
http://www.eclipse.org/org/documents/edl-v10.php.
|
||||||
|
|
||||||
|
SPDX-License-Identifier: EPL-2.0 OR EDL-1.0
|
||||||
|
|
||||||
|
Contributors:
|
||||||
|
Roger Light - initial implementation and documentation.
|
||||||
|
*/
|
||||||
|
|
||||||
|
/*
|
||||||
|
* This is an example plugin showing how to deny access based on the version of
|
||||||
|
* the protocol spec a client connects with. It does no other authentication
|
||||||
|
* checks.
|
||||||
|
*
|
||||||
|
* It could be used with other authentication plugins by specifying it in the
|
||||||
|
* config file before another plugin, for example:
|
||||||
|
*
|
||||||
|
* plugin /usr/lib/mosquitto_deny_protocol_version.so
|
||||||
|
* plugin /usr/lib/mosquitto_dynamic_security.so
|
||||||
|
*
|
||||||
|
* or:
|
||||||
|
*
|
||||||
|
* plugin /usr/lib/mosquitto_deny_protocol_version.so
|
||||||
|
* password_file pwfile
|
||||||
|
*
|
||||||
|
* It will *not* work on its own.
|
||||||
|
*
|
||||||
|
* In Mosquitto 2.1, this can be achieved with the `accept_protocol_version`
|
||||||
|
* option instead.
|
||||||
|
*
|
||||||
|
*
|
||||||
|
* To compile:
|
||||||
|
*
|
||||||
|
* gcc -I<path to mosquitto-repo/include> -fPIC -shared mosquitto_deny_protocol_version.c -o mosquitto_deny_protocol_version.so
|
||||||
|
*
|
||||||
|
* Note that this only works on Mosquitto 2.0 or later.
|
||||||
|
*/
|
||||||
|
#include "config.h"
|
||||||
|
|
||||||
|
#include <stdio.h>
|
||||||
|
#include <string.h>
|
||||||
|
|
||||||
|
#include "mosquitto_broker.h"
|
||||||
|
#include "mosquitto_plugin.h"
|
||||||
|
#include "mosquitto.h"
|
||||||
|
#include "mqtt_protocol.h"
|
||||||
|
|
||||||
|
static mosquitto_plugin_id_t *mosq_pid = NULL;
|
||||||
|
|
||||||
|
int mosquitto_plugin_version(int supported_version_count, const int *supported_versions)
|
||||||
|
{
|
||||||
|
int i;
|
||||||
|
|
||||||
|
for(i=0; i<supported_version_count; i++){
|
||||||
|
if(supported_versions[i] == 5){
|
||||||
|
return 5;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return -1;
|
||||||
|
}
|
||||||
|
|
||||||
|
static int basic_auth_callback(int event, void *event_data, void *userdata)
|
||||||
|
{
|
||||||
|
struct mosquitto_evt_basic_auth *ed = event_data;
|
||||||
|
int protocol_version;
|
||||||
|
|
||||||
|
UNUSED(event);
|
||||||
|
UNUSED(userdata);
|
||||||
|
|
||||||
|
protocol_version = mosquitto_client_protocol_version(ed->client);
|
||||||
|
|
||||||
|
if(protocol_version == 5 || protocol_version == 4){
|
||||||
|
/* Allow access to MQTT v5.0 and v3.1.1 - this passes on responsibility
|
||||||
|
* for the actual auth checks to the next plugin/password file in the
|
||||||
|
* config list. If no other plugins/password file is defined, then
|
||||||
|
* access will be denied. */
|
||||||
|
return MOSQ_ERR_PLUGIN_DEFER;
|
||||||
|
}else{
|
||||||
|
/* Deny access to all others */
|
||||||
|
return MOSQ_ERR_AUTH;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
int mosquitto_plugin_init(mosquitto_plugin_id_t *identifier, void **user_data, struct mosquitto_opt *opts, int opt_count)
|
||||||
|
{
|
||||||
|
UNUSED(user_data);
|
||||||
|
UNUSED(opts);
|
||||||
|
UNUSED(opt_count);
|
||||||
|
|
||||||
|
mosq_pid = identifier;
|
||||||
|
return mosquitto_callback_register(mosq_pid, MOSQ_EVT_BASIC_AUTH, basic_auth_callback, NULL, NULL);
|
||||||
|
}
|
||||||
|
|
||||||
|
int mosquitto_plugin_cleanup(void *user_data, struct mosquitto_opt *opts, int opt_count)
|
||||||
|
{
|
||||||
|
UNUSED(user_data);
|
||||||
|
UNUSED(opts);
|
||||||
|
UNUSED(opt_count);
|
||||||
|
|
||||||
|
return mosquitto_callback_unregister(mosq_pid, MOSQ_EVT_MESSAGE, basic_auth_callback, NULL);
|
||||||
|
}
|
4
plugins/deny-protocol-version/test.conf
Normal file
4
plugins/deny-protocol-version/test.conf
Normal file
@ -0,0 +1,4 @@
|
|||||||
|
listener 1883
|
||||||
|
|
||||||
|
plugin ./mosquitto_deny_protocol_version.so
|
||||||
|
password_file pwfile
|
4
plugins/deny-protocol-version/test.sh
Executable file
4
plugins/deny-protocol-version/test.sh
Executable file
@ -0,0 +1,4 @@
|
|||||||
|
#!/bin/sh
|
||||||
|
|
||||||
|
../../apps/mosquitto_passwd/mosquitto_passwd -c -b pwfile username password
|
||||||
|
../../src/mosquitto -c test.conf -v
|
Loading…
Reference in New Issue
Block a user