org.graylog2.system.urlwhitelist.UrlWhitelist Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of graylog2-server Show documentation
Graylog
There is a newer version: 6.0.1
/*
 * Copyright (C) 2020 Graylog, Inc.
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the Server Side Public License, version 1,
 * as published by MongoDB, Inc.
 *
 * 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
 * Server Side Public License for more details.
 *
 * You should have received a copy of the Server Side Public License
 * along with this program. If not, see
 * .
 */
package org.graylog2.system.urlwhitelist;

import com.fasterxml.jackson.annotation.JsonAutoDetect;
import com.fasterxml.jackson.annotation.JsonCreator;
import com.fasterxml.jackson.annotation.JsonProperty;
import com.google.auto.value.AutoValue;
import org.graylog.autovalue.WithBeanGetter;

import java.util.HashSet;
import java.util.List;
import java.util.Set;

@JsonAutoDetect
@AutoValue
@WithBeanGetter
public abstract class UrlWhitelist {

    @JsonProperty("entries")
    public abstract List entries();

    @JsonProperty("disabled")
    public abstract boolean disabled();

    @JsonCreator
    public static UrlWhitelist create(@JsonProperty("entries") List entries,
            @JsonProperty("disabled") boolean disabled) {
        return builder().entries(entries)
                .disabled(disabled)
                .build();
    }

    public static UrlWhitelist createEnabled(List entries) {
        return builder().entries(entries)
                .disabled(false)
                .build();
    }

    public abstract Builder toBuilder();

    /**
     * Checks if a URL is whitelisted by looking for a whitelist entry matching the given url.
     *
     * @param url The URL to check.
     * @return {@code false} if the whitelist is enabled and no whitelist entry matches the given url. {@code true} if
     *         there is a whitelist entry matching the given url or if the whitelist is disabled.
     */
    public boolean isWhitelisted(String url) {
        if (disabled()) {
            return true;
        }
        return entries().stream()
                .anyMatch(e -> e.isWhitelisted(url));
    }

    public static Builder builder() {
        return new AutoValue_UrlWhitelist.Builder();
    }

    @AutoValue.Builder
    public abstract static class Builder {
        public abstract Builder entries(List entries);

        public abstract Builder disabled(boolean disabled);

        public abstract UrlWhitelist autoBuild();

        public UrlWhitelist build() {
            final UrlWhitelist whitelist = autoBuild();
            checkForDuplicateIds(whitelist.entries());
            return whitelist;
        }

        private void checkForDuplicateIds(List entries) {
            Set ids = new HashSet<>();
            entries.forEach(entry -> {
                if (ids.contains(entry.id())) {
                    throw new IllegalArgumentException(
                            "Found duplicate ID '" + entry.id() + "' in whitelist entries.");
                }
                ids.add(entry.id());
            });
        }
    }
}