Mirrors_Framework/mosquitto
1
0
Fork 0
mirror of https://github.com/eclipse-mosquitto/mosquitto.git synced 2026-02-05 18:50:06 +08:00
Code Issues Packages Projects Releases Wiki Activity
Files
master
mosquitto/libcommon/topic_common.c
Roger A. Light 7ea73f6d60 Formatting: Forbid single line if statements 
These hide cases from coverage checks
2025-09-17 12:48:02 +01:00

743 lines
16 KiB
C
Raw Permalink Blame History

/*
Copyright (c) 2009-2021 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 BSD-3-Clause
Contributors:
Roger Light - initial implementation and documentation.
*/
#include "config.h"
#include <string.h>
#ifdef WIN32
# include <winsock2.h>
# include <aclapi.h>
# include <io.h>
# include <lmcons.h>
#else
# include <sys/stat.h>
#endif
#include "mosquitto.h"
/* Check that a topic used for publishing is valid.
* Search for + or # in a topic. Return MOSQ_ERR_INVAL if found.
* Also returns MOSQ_ERR_INVAL if the topic string is too long.
* Returns MOSQ_ERR_SUCCESS if everything is fine.
*/
BROKER_EXPORT int mosquitto_pub_topic_check(const char *str)
{
int len = 0;
int hier_count = 0;
if(str == NULL){
return MOSQ_ERR_INVAL;
}
while(str && str[0]){
if(str[0] == '+' || str[0] == '#'){
return MOSQ_ERR_INVAL;
}else if(str[0] == '/'){
hier_count++;
}
len++;
str = &str[1];
}
if(len == 0 || len > 65535){
return MOSQ_ERR_INVAL;
}
if(hier_count > TOPIC_HIERARCHY_LIMIT){
return MOSQ_ERR_INVAL;
}
return MOSQ_ERR_SUCCESS;
}
BROKER_EXPORT int mosquitto_pub_topic_check2(const char *str, size_t len)
{
size_t i;
int hier_count = 0;
if(str == NULL || len == 0 || len > 65535){
return MOSQ_ERR_INVAL;
}
for(i=0; i<len; i++){
if(str[i] == '+' || str[i] == '#'){
return MOSQ_ERR_INVAL;
}else if(str[i] == '/'){
hier_count++;
}
}
if(hier_count > TOPIC_HIERARCHY_LIMIT){
return MOSQ_ERR_INVAL;
}
return MOSQ_ERR_SUCCESS;
}
/* Check that a topic used for subscriptions is valid.
* Search for + or # in a topic, check they aren't in invalid positions such as
* foo/#/bar, foo/+bar or foo/bar#.
* Return MOSQ_ERR_INVAL if invalid position found.
* Also returns MOSQ_ERR_INVAL if the topic string is too long.
* Returns MOSQ_ERR_SUCCESS if everything is fine.
*/
BROKER_EXPORT int mosquitto_sub_topic_check(const char *str)
{
char c = '\0';
int len = 0;
int hier_count = 0;
if(str == NULL){
return MOSQ_ERR_INVAL;
}
while(str[0]){
if(str[0] == '+'){
if((c != '\0' && c != '/') || (str[1] != '\0' && str[1] != '/')){
return MOSQ_ERR_INVAL;
}
}else if(str[0] == '#'){
if((c != '\0' && c != '/') || str[1] != '\0'){
return MOSQ_ERR_INVAL;
}
}else if(str[0] == '/'){
hier_count++;
}
len++;
c = str[0];
str = &str[1];
}
if(len == 0 || len > 65535){
return MOSQ_ERR_INVAL;
}
if(hier_count > TOPIC_HIERARCHY_LIMIT){
return MOSQ_ERR_INVAL;
}
return MOSQ_ERR_SUCCESS;
}
BROKER_EXPORT int mosquitto_sub_topic_check2(const char *str, size_t len)
{
char c = '\0';
size_t i;
int hier_count = 0;
if(str == NULL || len == 0 || len > 65535){
return MOSQ_ERR_INVAL;
}
for(i=0; i<len; i++){
if(str[i] == '+'){
if((c != '\0' && c != '/') || (i<len-1 && str[i+1] != '/')){
return MOSQ_ERR_INVAL;
}
}else if(str[i] == '#'){
if((c != '\0' && c != '/') || i<len-1){
return MOSQ_ERR_INVAL;
}
}else if(str[i] == '/'){
hier_count++;
}
c = str[i];
}
if(hier_count > TOPIC_HIERARCHY_LIMIT){
return MOSQ_ERR_INVAL;
}
return MOSQ_ERR_SUCCESS;
}
static int topic_matches_sub(const char *sub, const char *topic, const char *clientid, const char *username, bool match_patterns, bool *result)
{
size_t spos;
const char *pattern_check;
const char *lastchar = NULL;
if(!result){
return MOSQ_ERR_INVAL;
}
*result = false;
if(!sub || !topic || sub[0] == 0 || topic[0] == 0){
return MOSQ_ERR_INVAL;
}
if((sub[0] == '$' && topic[0] != '$')
|| (topic[0] == '$' && sub[0] != '$')){
return MOSQ_ERR_SUCCESS;
}
spos = 0;
while(sub[0] != 0){
if(topic[0] == '+' || topic[0] == '#'){
return MOSQ_ERR_INVAL;
}
if(match_patterns &&
(lastchar == NULL || lastchar[0] == '/') &&
sub[0] == '%' &&
(sub[1] == 'c' || sub[1] == 'u') &&
(sub[2] == '/' || sub[2] == '\0')
){
if(sub[1] == 'c'){
pattern_check = clientid;
}else{
pattern_check = username;
}
if(pattern_check == NULL || pattern_check[0] == '\0'){
return MOSQ_ERR_SUCCESS;
}
spos += 2;
sub += 2;
while(pattern_check[0] != 0 && topic[0] != 0 && topic[0] != '/'){
if(pattern_check[0] != topic[0]){
/* Valid input, but no match */
return MOSQ_ERR_SUCCESS;
}
pattern_check++;
topic++;
}
if(pattern_check[0] != '\0'){
/* substituted pattern part smaller than publish topic part, so fail */
return MOSQ_ERR_SUCCESS;
}
if((sub[0] == '\0' && topic[0] == '\0') ||
(sub[0] == '/' && sub[1] == '#' && sub[2] == '\0' && topic[0] == '\0')
){
*result = true;
return MOSQ_ERR_SUCCESS;
}
}
if(sub[0] != topic[0] || topic[0] == 0){ /* Check for wildcard matches */
if(sub[0] == '+'){
/* Check for bad "+foo" or "a/+foo" subscription */
if(spos > 0 && sub[-1] != '/'){
return MOSQ_ERR_INVAL;
}
/* Check for bad "foo+" or "foo+/a" subscription */
if(sub[1] != 0 && sub[1] != '/'){
return MOSQ_ERR_INVAL;
}
spos++;
sub++;
while(topic[0] != 0 && topic[0] != '/'){
if(topic[0] == '+' || topic[0] == '#'){
return MOSQ_ERR_INVAL;
}
topic++;
}
if(topic[0] == 0 && sub[0] == 0){
*result = true;
return MOSQ_ERR_SUCCESS;
}
}else if(sub[0] == '#'){
/* Check for bad "foo#" subscription */
if(spos > 0 && sub[-1] != '/'){
return MOSQ_ERR_INVAL;
}
/* Check for # not the final character of the sub, e.g. "#foo" */
if(sub[1] != 0){
return MOSQ_ERR_INVAL;
}else{
while(topic[0] != 0){
if(topic[0] == '+' || topic[0] == '#'){
return MOSQ_ERR_INVAL;
}
topic++;
}
*result = true;
return MOSQ_ERR_SUCCESS;
}
}else{
/* Check for e.g. foo/bar matching foo/+/# */
if(topic[0] == 0
&& spos > 0
&& sub[-1] == '+'
&& sub[0] == '/'
&& sub[1] == '#'){
*result = true;
return MOSQ_ERR_SUCCESS;
}
/* There is no match at this point, but is the sub invalid? */
while(sub[0] != 0){
if(sub[0] == '#' && sub[1] != 0){
return MOSQ_ERR_INVAL;
}
spos++;
sub++;
}
/* Valid input, but no match */
return MOSQ_ERR_SUCCESS;
}
}else{
/* sub[spos] == topic[tpos] */
if(topic[1] == 0){
/* Check for e.g. foo matching foo/# */
if(sub[1] == '/'
&& sub[2] == '#'
&& sub[3] == 0){
*result = true;
return MOSQ_ERR_SUCCESS;
}
}
spos++;
sub++;
topic++;
if(sub[0] == 0 && topic[0] == 0){
*result = true;
return MOSQ_ERR_SUCCESS;
}else if(topic[0] == 0 && sub[0] == '+' && sub[1] == 0){
if(spos > 0 && sub[-1] != '/'){
return MOSQ_ERR_INVAL;
}
spos++;
sub++;
*result = true;
return MOSQ_ERR_SUCCESS;
}
}
lastchar = sub-1;
}
if((topic[0] != 0 || sub[0] != 0)){
*result = false;
}
while(topic[0] != 0){
if(topic[0] == '+' || topic[0] == '#'){
return MOSQ_ERR_INVAL;
}
topic++;
}
return MOSQ_ERR_SUCCESS;
}
static int sub_matches_acl(const char *acl, const char *sub, const char *clientid, const char *username, bool match_patterns, bool *result)
{
size_t apos;
const char *pattern_check;
const char *lastchar = NULL;
*result = false;
if(!acl || !sub || acl[0] == 0 || sub[0] == 0){
return MOSQ_ERR_INVAL;
}
if((acl[0] == '$' && sub[0] != '$')
|| (sub[0] == '$' && acl[0] != '$')){
return MOSQ_ERR_SUCCESS;
}
apos = 0;
while(acl[0] != 0){
if(match_patterns &&
(lastchar == NULL || lastchar[0] == '/') &&
acl[0] == '%' &&
(acl[1] == 'c' || acl[1] == 'u') &&
(acl[2] == '/' || acl[2] == '\0')
){
if(acl[1] == 'c'){
pattern_check = clientid;
}else{
pattern_check = username;
}
if(pattern_check == NULL || pattern_check[0] == '\0'){
/* no match */
return MOSQ_ERR_SUCCESS;
}
if(pattern_check[1] == '\0' &&
(
pattern_check[0] == '+' ||
pattern_check[0] == '#' ||
pattern_check[0] == '/')
){
/* username/client id of just + / # not allowed */
return MOSQ_ERR_SUCCESS;
}
apos +=2;
acl += 2;
while(pattern_check[0] != 0 && sub[0] != 0 && sub[0] != '/'){
if(pattern_check[0] != sub[0]){
/* Valid input, but no match */
return MOSQ_ERR_SUCCESS;
}
pattern_check++;
sub++;
}
if(pattern_check[0] != '\0'){
/* substituted pattern part smaller than publish topic part, so fail */
return MOSQ_ERR_SUCCESS;
}
if(sub[0] == '\0' && (acl[0] == '\0' ||
(acl[0] == '/' && acl[1] == '#' && acl[2] == '\0'))
){
*result = true;
return MOSQ_ERR_SUCCESS;
}
}
if(acl[0] != sub[0] || sub[0] == 0){ /* Check for wildcard matches */
if(acl[0] == '+'){
if(sub[0] == '#'){
/* + doesn't match # */
return MOSQ_ERR_SUCCESS;
}
/* Check for bad "+foo" or "a/+foo" subscription */
if(apos > 0 && acl[-1] != '/'){
return MOSQ_ERR_INVAL;
}
/* Check for bad "foo+" or "foo+/a" subscription */
if(acl[1] != 0 && acl[1] != '/'){
return MOSQ_ERR_INVAL;
}
apos++;
acl++;
while(sub[0] != 0 && sub[0] != '/'){
sub++;
}
if(sub[0] == 0 && acl[0] == 0){
*result = true;
return MOSQ_ERR_SUCCESS;
}
}else if(acl[0] == '#'){
/* Check for bad "foo#" subscription */
if(apos > 0 && acl[-1] != '/'){
return MOSQ_ERR_INVAL;
}
/* Check for # not the final character of the sub, e.g. "#foo" */
if(acl[1] != 0){
return MOSQ_ERR_INVAL;
}else{
*result = true;
return MOSQ_ERR_SUCCESS;
}
}else{
/* Check for e.g. foo/bar matching foo/+/# */
if(sub[0] == 0
&& apos > 0
&& acl[-1] == '+'
&& acl[0] == '/'
&& acl[1] == '#'){
*result = true;
return MOSQ_ERR_SUCCESS;
}
/* There is no match at this point, but is the sub invalid? */
while(acl[0] != 0){
if(acl[0] == '#' && acl[1] != 0){
return MOSQ_ERR_INVAL;
}
apos++;
acl++;
}
/* Valid input, but no match */
return MOSQ_ERR_SUCCESS;
}
}else{
/* acl[apos] == sub[spos] */
if(sub[1] == 0){
/* Check for e.g. foo matching foo/# */
if(acl[1] == '/'
&& acl[2] == '#'
&& acl[3] == 0){
*result = true;
return MOSQ_ERR_SUCCESS;
}
}
apos++;
acl++;
sub++;
if(acl[0] == 0 && sub[0] == 0){
*result = true;
return MOSQ_ERR_SUCCESS;
}else if(sub[0] == 0 && acl[0] == '+' && acl[1] == 0){
if(apos > 0 && acl[-1] != '/'){
return MOSQ_ERR_INVAL;
}
apos++;
acl++;
*result = true;
return MOSQ_ERR_SUCCESS;
}
}
lastchar = acl-1;
}
if((sub[0] != 0 || acl[0] != 0)){
return MOSQ_ERR_SUCCESS;
}
while(sub[0] != 0){
if(sub[0] == '+' || sub[0] == '#'){
return MOSQ_ERR_SUCCESS;
}
sub++;
}
*result = true;
return MOSQ_ERR_SUCCESS;
}
BROKER_EXPORT int mosquitto_sub_matches_acl(const char *acl, const char *sub, bool *result)
{
return sub_matches_acl(acl, sub, NULL, NULL, false, result);
}
BROKER_EXPORT int mosquitto_sub_matches_acl_with_pattern(const char *acl, const char *sub, const char *clientid, const char *username, bool *result)
{
return sub_matches_acl(acl, sub, clientid, username, true, result);
}
BROKER_EXPORT int mosquitto_topic_matches_sub(const char *sub, const char *topic, bool *result)
{
return topic_matches_sub(sub, topic, NULL, NULL, false, result);
}
BROKER_EXPORT int mosquitto_topic_matches_sub_with_pattern(const char *sub, const char *topic, const char *clientid, const char *username, bool *result)
{
return topic_matches_sub(sub, topic, clientid, username, true, result);
}
/* Does a topic match a subscription? */
BROKER_EXPORT int mosquitto_topic_matches_sub2(const char *sub, size_t sublen, const char *topic, size_t topiclen, bool *result)
{
size_t spos, tpos;
if(!result){
return MOSQ_ERR_INVAL;
}
*result = false;
if(!sub || !topic || !sublen || !topiclen){
return MOSQ_ERR_INVAL;
}
if((sub[0] == '$' && topic[0] != '$')
|| (topic[0] == '$' && sub[0] != '$')){
return MOSQ_ERR_SUCCESS;
}
spos = 0;
tpos = 0;
while(spos < sublen){
if(tpos < topiclen && (topic[tpos] == '+' || topic[tpos] == '#')){
return MOSQ_ERR_INVAL;
}
if(tpos == topiclen || sub[spos] != topic[tpos]){
if(sub[spos] == '+'){
/* Check for bad "+foo" or "a/+foo" subscription */
if(spos > 0 && sub[spos-1] != '/'){
return MOSQ_ERR_INVAL;
}
/* Check for bad "foo+" or "foo+/a" subscription */
if(spos+1 < sublen && sub[spos+1] != '/'){
return MOSQ_ERR_INVAL;
}
spos++;
while(tpos < topiclen && topic[tpos] != '/'){
if(topic[tpos] == '+' || topic[tpos] == '#'){
return MOSQ_ERR_INVAL;
}
tpos++;
}
if(tpos == topiclen && spos == sublen){
*result = true;
return MOSQ_ERR_SUCCESS;
}
}else if(sub[spos] == '#'){
/* Check for bad "foo#" subscription */
if(spos > 0 && sub[spos-1] != '/'){
return MOSQ_ERR_INVAL;
}
/* Check for # not the final character of the sub, e.g. "#foo" */
if(spos+1 < sublen){
return MOSQ_ERR_INVAL;
}else{
while(tpos < topiclen){
if(topic[tpos] == '+' || topic[tpos] == '#'){
return MOSQ_ERR_INVAL;
}
tpos++;
}
*result = true;
return MOSQ_ERR_SUCCESS;
}
}else{
/* Check for e.g. foo/bar matching foo/+/# */
if(tpos == topiclen
&& spos > 0
&& sub[spos-1] == '+'
&& sub[spos] == '/'
&& spos+1 < sublen
&& sub[spos+1] == '#'){
*result = true;
return MOSQ_ERR_SUCCESS;
}
/* There is no match at this point, but is the sub invalid? */
while(spos < sublen){
if(sub[spos] == '#' && spos+1 < sublen){
return MOSQ_ERR_INVAL;
}
spos++;
}
/* Valid input, but no match */
return MOSQ_ERR_SUCCESS;
}
}else{
/* sub[spos] == topic[tpos] */
if(tpos+1 == topiclen){
/* Check for e.g. foo matching foo/# */
if(spos+3 == sublen
&& sub[spos+1] == '/'
&& sub[spos+2] == '#'){
*result = true;
return MOSQ_ERR_SUCCESS;
}
}
spos++;
tpos++;
if(spos == sublen && tpos == topiclen){
*result = true;
return MOSQ_ERR_SUCCESS;
}else if(tpos == topiclen && sub[spos] == '+' && spos+1 == sublen){
if(spos > 0 && sub[spos-1] != '/'){
return MOSQ_ERR_INVAL;
}
spos++;
*result = true;
return MOSQ_ERR_SUCCESS;
}
}
}
if(tpos < topiclen || spos < sublen){
*result = false;
}
while(tpos < topiclen){
if(topic[tpos] == '+' || topic[tpos] == '#'){
return MOSQ_ERR_INVAL;
}
tpos++;
}
return MOSQ_ERR_SUCCESS;
}
int mosquitto_sub_topic_tokenise(const char *subtopic, char ***topics, int *count)
{
size_t len;
size_t hier_count = 1;
size_t start, stop;
size_t hier;
size_t tlen;
size_t i, j;
if(!subtopic || !topics || !count){
return MOSQ_ERR_INVAL;
}
len = strlen(subtopic);
for(i=0; i<len; i++){
if(subtopic[i] == '/'){
if(i > len-1){
/* Separator at end of line */
}else{
hier_count++;
}
}
}
(*topics) = mosquitto_calloc(hier_count, sizeof(char *));
if(!(*topics)){
return MOSQ_ERR_NOMEM;
}
start = 0;
hier = 0;
for(i=0; i<len+1; i++){
if(subtopic[i] == '/' || subtopic[i] == '\0'){
stop = i;
if(start != stop){
tlen = stop-start + 1;
(*topics)[hier] = mosquitto_calloc(tlen, sizeof(char));
if(!(*topics)[hier]){
for(j=0; j<hier; j++){
mosquitto_FREE((*topics)[j]);
}
mosquitto_FREE((*topics));
return MOSQ_ERR_NOMEM;
}
for(j=start; j<stop; j++){
(*topics)[hier][j-start] = subtopic[j];
}
}
start = i+1;
hier++;
}
}
*count = (int)hier_count;
return MOSQ_ERR_SUCCESS;
}
int mosquitto_sub_topic_tokens_free(char ***topics, int count)
{
int i;
if(!topics || !(*topics) || count<1){
return MOSQ_ERR_INVAL;
}
for(i=0; i<count; i++){
mosquitto_FREE((*topics)[i]);
}
mosquitto_FREE(*topics);
return MOSQ_ERR_SUCCESS;
}
Reference in New Issue View Git Blame Copy Permalink