org.restheart.security.predicates.BsonRequestWhitelistPredicate Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of restheart-security Show documentation
RESTHeart Security - Security plugins
There is a newer version: 8.1.6
/*-
 * ========================LICENSE_START=================================
 * restheart-security
 * %%
 * Copyright (C) 2018 - 2024 SoftInstigate
 * %%
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Affero General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU Affero General Public License
 * along with this program.  If not, see .
 * =========================LICENSE_END==================================
 */
package org.restheart.security.predicates;

import java.util.Collections;
import java.util.Map;
import java.util.Set;

import com.google.common.collect.Sets;

import org.bson.BsonDocument;
import org.bson.BsonValue;
import org.restheart.exchange.BsonRequest;
import org.restheart.exchange.Request;
import org.restheart.utils.BsonUtils;

import io.undertow.predicate.Predicate;
import io.undertow.predicate.PredicateBuilder;
import io.undertow.server.HttpServerExchange;

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

/**
 * a predicate that resolve to true if the request content is bson and
 * all keys in the request content are in the specified whitelist
 */
public class BsonRequestWhitelistPredicate implements Predicate {
    private static final Logger LOGGER = LoggerFactory.getLogger(BsonRequestWhitelistPredicate.class);

    private final Set whitelist;

    public BsonRequestWhitelistPredicate(String[] whitelist) {
        this.whitelist = whitelist == null ? Sets.newHashSet() : Sets.newHashSet(whitelist);
    }

    @Override
    public boolean resolve(HttpServerExchange exchange) {
        var _request = Request.of(exchange);

        if (_request == null || !(_request instanceof BsonRequest)) {
            LOGGER.warn("bson-request-whitelist predicate not invoked on BsonRequest but {}, it won't allow the request", _request == null ? _request: _request.getClass().getSimpleName());
            return false;
        } else {
            return areAllKeysWhitelisted(this.whitelist, ((BsonRequest)_request).getContent());
        }
    }

    private boolean areAllKeysWhitelisted(Set whitelist, BsonValue docArArrayOfDocs) {
        if (docArArrayOfDocs == null ) {
            return true;
        } else if (docArArrayOfDocs.isDocument()) {
            return areAllKeysWhitelisted(whitelist, docArArrayOfDocs.asDocument());
        } else if (docArArrayOfDocs.isArray()){
            return docArArrayOfDocs.asArray().stream().filter(BsonValue::isDocument).map(BsonValue::asDocument)
                .allMatch(doc -> areAllKeysWhitelisted(whitelist, doc));
        } else {
            throw new IllegalArgumentException("bson-request-whitelist predicate cannot be invoked on JSON type " + docArArrayOfDocs.getBsonType().toString());
        }
    }

    private boolean areAllKeysWhitelisted(Set whitelist, BsonDocument doc) {
        if (doc == null || doc.isEmpty()) {
            return true;
        } if (whitelist == null || whitelist.isEmpty() ) {
            return false;
        } else {
            return getLeafsKeys(doc).stream().allMatch(key -> isWhitelisted(whitelist, key));
        }
    }

    private boolean isWhitelisted(Set whitelist, String leafKey) {
        return whitelist.stream().anyMatch(whitelistedKey ->
        leafKey.equals(whitelistedKey) || leafKey.startsWith(whitelistedKey.concat(".")));
    }

    private Set getLeafsKeys(BsonDocument d) {
        var flatten = BsonUtils.flatten(d, true);

        final Set leafsKeys = Sets.newHashSet();
        leafsKeys.addAll(flatten.keySet());

        d.keySet().stream().filter(BsonUtils::isUpdateOperator)
            .map(uo -> d.get(uo))
            .filter(doc -> doc.isDocument())
            .map(doc -> doc.asDocument())
            .map(doc -> doc.keySet())
            .forEach(leafsKeys::addAll);

        d.keySet().stream().filter(BsonUtils::isUpdateOperator).forEach(leafsKeys::remove);

        return leafsKeys;
    }


    public static class Builder implements PredicateBuilder {
        @Override
        public String name() {
            return "bson-request-whitelist";
        }

        @Override
        public Map> parameters() {
            return Collections.>singletonMap("whitelist", String[].class);
        }

        @Override
        public Set requiredParameters() {
            return Collections.emptySet();
        }

        @Override
        public String defaultParameter() {
            return "whitelist";
        }

        @Override
        public Predicate build(Map config) {
            return new BsonRequestWhitelistPredicate((String[]) config.get("whitelist"));
        }
    }
}