org.restheart.security.predicates.BsonRequestPropEqualsPredicate 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.Map;
import java.util.Set;

import com.google.common.collect.Maps;
import com.google.common.collect.Sets;

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

import io.undertow.attribute.ExchangeAttribute;
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
 * the value of the property 'key' (can use the dot notation) is equal to 'value'
 */
public class BsonRequestPropEqualsPredicate implements Predicate {
    private static final Logger LOGGER = LoggerFactory.getLogger(BsonRequestPropEqualsPredicate.class);

    private final String key;
    private final ExchangeAttribute value;

    public BsonRequestPropEqualsPredicate(String key, ExchangeAttribute value) {
        if (key == null || value == null) {
            throw new IllegalArgumentException("bson-request-prop-equals predicate must specify key and value");
        }

        this.key = key;
        this.value = value;
    }

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

        if (_request == null) {
            LOGGER.warn("bson-request-prop-equals predicate invkoed on null BsonRequest");
            return false;
        }

        if (_request instanceof BsonRequest bsonRequest) {
            if (bsonRequest.getContent() == null) {
                LOGGER.warn("bson-request-prop-equals predicate invoked on a BsonRequest with null content");
                return false;
            }

            if (bsonRequest.getContent() instanceof BsonDocument contentDoc) {
                var _value = BsonUtils.get(contentDoc, this.key);

                if (_value.isPresent()) {
                    var expected = BsonUtils.parse(this.value.readAttribute(exchange));
                    return _value.get().equals(expected);

                } else {
                    return false;
                }
            } else {
                LOGGER.warn("bson-request-prop-equals predicate invoked on a BsonRequest with content {}, it requires a BsonDocument",  bsonRequest.getContent().getClass().getSimpleName());
                return false;
            }

        } else {
            LOGGER.warn("bson-request-prop-equals predicate not invoked on a BsonRequest");
            return false;
        }
    }

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

        @Override
        public Map> parameters() {
            var params = Maps.>newHashMap();
            params.put("key", String.class);
            params.put("value", ExchangeAttribute.class);
            return params;
        }

        @Override
        public Set requiredParameters() {
            return Sets.newHashSet("key", "value");
        }

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

        @Override
        public Predicate build(Map config) {
            return new BsonRequestPropEqualsPredicate((String) config.get("key"), (ExchangeAttribute) config.get("value"));
        }
    }
}