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 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253
|
/*
Copyright (c) 2020 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 "dynamic_security.h"
#include "mosquitto.h"
#include "mosquitto_broker.h"
#include "mosquitto_plugin.h"
typedef int (*MOSQ_FUNC_acl_check)(struct mosquitto_evt_acl_check *, struct dynsec__rolelist *);
/* FIXME - CACHE! */
/* ################################################################
* #
* # ACL check - publish broker to client
* #
* ################################################################ */
static int acl_check_publish_c_recv(struct mosquitto_evt_acl_check *ed, struct dynsec__rolelist *base_rolelist)
{
struct dynsec__rolelist *rolelist, *rolelist_tmp = NULL;
struct dynsec__acl *acl, *acl_tmp = NULL;
bool result;
HASH_ITER(hh, base_rolelist, rolelist, rolelist_tmp){
HASH_ITER(hh, rolelist->role->acls.publish_c_recv, acl, acl_tmp){
mosquitto_topic_matches_sub(acl->topic, ed->topic, &result);
if(result){
if(acl->allow){
return MOSQ_ERR_SUCCESS;
}else{
return MOSQ_ERR_ACL_DENIED;
}
}
}
}
return MOSQ_ERR_NOT_FOUND;
}
/* ################################################################
* #
* # ACL check - publish client to broker
* #
* ################################################################ */
static int acl_check_publish_c_send(struct mosquitto_evt_acl_check *ed, struct dynsec__rolelist *base_rolelist)
{
struct dynsec__rolelist *rolelist, *rolelist_tmp = NULL;
struct dynsec__acl *acl, *acl_tmp = NULL;
bool result;
HASH_ITER(hh, base_rolelist, rolelist, rolelist_tmp){
HASH_ITER(hh, rolelist->role->acls.publish_c_send, acl, acl_tmp){
mosquitto_topic_matches_sub(acl->topic, ed->topic, &result);
if(result){
if(acl->allow){
return MOSQ_ERR_SUCCESS;
}else{
return MOSQ_ERR_ACL_DENIED;
}
}
}
}
return MOSQ_ERR_NOT_FOUND;
}
/* ################################################################
* #
* # ACL check - subscribe
* #
* ################################################################ */
static int acl_check_subscribe(struct mosquitto_evt_acl_check *ed, struct dynsec__rolelist *base_rolelist)
{
struct dynsec__rolelist *rolelist, *rolelist_tmp = NULL;
struct dynsec__acl *acl, *acl_tmp = NULL;
size_t len;
len = strlen(ed->topic);
HASH_ITER(hh, base_rolelist, rolelist, rolelist_tmp){
HASH_FIND(hh, rolelist->role->acls.subscribe_literal, ed->topic, len, acl);
if(acl){
if(acl->allow){
return MOSQ_ERR_SUCCESS;
}else{
return MOSQ_ERR_ACL_DENIED;
}
}
HASH_ITER(hh, rolelist->role->acls.subscribe_pattern, acl, acl_tmp){
if(sub_acl_check(acl->topic, ed->topic)){
if(acl->allow){
return MOSQ_ERR_SUCCESS;
}else{
return MOSQ_ERR_ACL_DENIED;
}
}
}
}
return MOSQ_ERR_NOT_FOUND;
}
/* ################################################################
* #
* # ACL check - unsubscribe
* #
* ################################################################ */
static int acl_check_unsubscribe(struct mosquitto_evt_acl_check *ed, struct dynsec__rolelist *base_rolelist)
{
struct dynsec__rolelist *rolelist, *rolelist_tmp = NULL;
struct dynsec__acl *acl, *acl_tmp = NULL;
size_t len;
len = strlen(ed->topic);
HASH_ITER(hh, base_rolelist, rolelist, rolelist_tmp){
HASH_FIND(hh, rolelist->role->acls.unsubscribe_literal, ed->topic, len, acl);
if(acl){
if(acl->allow){
return MOSQ_ERR_SUCCESS;
}else{
return MOSQ_ERR_ACL_DENIED;
}
}
HASH_ITER(hh, rolelist->role->acls.unsubscribe_pattern, acl, acl_tmp){
if(sub_acl_check(acl->topic, ed->topic)){
if(acl->allow){
return MOSQ_ERR_SUCCESS;
}else{
return MOSQ_ERR_ACL_DENIED;
}
}
}
}
return MOSQ_ERR_NOT_FOUND;
}
/* ################################################################
* #
* # ACL check - generic check
* #
* ################################################################ */
static int acl_check(struct mosquitto_evt_acl_check *ed, MOSQ_FUNC_acl_check check, bool acl_default_access)
{
struct dynsec__client *client;
struct dynsec__grouplist *grouplist, *grouplist_tmp = NULL;
const char *username;
int rc;
username = mosquitto_client_username(ed->client);
if(username){
client = dynsec_clients__find(username);
if(client == NULL) return MOSQ_ERR_PLUGIN_DEFER;
/* Client roles */
rc = check(ed, client->rolelist);
if(rc != MOSQ_ERR_NOT_FOUND){
return rc;
}
HASH_ITER(hh, client->grouplist, grouplist, grouplist_tmp){
rc = check(ed, grouplist->group->rolelist);
if(rc != MOSQ_ERR_NOT_FOUND){
return rc;
}
}
}else if(dynsec_anonymous_group){
/* If we have a group for anonymous users, use that for checking. */
rc = check(ed, dynsec_anonymous_group->rolelist);
if(rc != MOSQ_ERR_NOT_FOUND){
return rc;
}
}
if(acl_default_access == false){
return MOSQ_ERR_PLUGIN_DEFER;
}else{
if(!strncmp(ed->topic, "$CONTROL", strlen("$CONTROL"))){
/* We never give fall through access to $CONTROL topics, they must
* be granted explicitly. */
return MOSQ_ERR_PLUGIN_DEFER;
}else{
return MOSQ_ERR_SUCCESS;
}
}
}
/* ################################################################
* #
* # ACL check - plugin callback
* #
* ################################################################ */
int dynsec__acl_check_callback(int event, void *event_data, void *userdata)
{
struct mosquitto_evt_acl_check *ed = event_data;
UNUSED(event);
UNUSED(userdata);
/* ACL checks are made in the order below until a match occurs, at which
* point the decision is made.
*
* User roles in priority order highest to lowest.
* Roles have their ACLs checked in priority order, highest to lowest
* Groups are processed in priority order highest to lowest
* Group roles are processed in priority order, highest to lowest
* Roles have their ACLs checked in priority order, highest to lowest
*/
switch(ed->access){
case MOSQ_ACL_SUBSCRIBE:
return acl_check(event_data, acl_check_subscribe, default_access.subscribe);
break;
case MOSQ_ACL_UNSUBSCRIBE:
return acl_check(event_data, acl_check_unsubscribe, default_access.unsubscribe);
break;
case MOSQ_ACL_WRITE: /* Client to broker */
return acl_check(event_data, acl_check_publish_c_send, default_access.publish_c_send);
break;
case MOSQ_ACL_READ:
return acl_check(event_data, acl_check_publish_c_recv, default_access.publish_c_recv);
break;
default:
return MOSQ_ERR_PLUGIN_DEFER;
}
return MOSQ_ERR_PLUGIN_DEFER;
}
|