org.graylog.plugins.pipelineprocessor.functions.ips.CidrMatch 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
/**
 * This file is part of Graylog.
 *
 * Graylog is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * Graylog 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 General Public License
 * along with Graylog.  If not, see .
 */
package org.graylog.plugins.pipelineprocessor.functions.ips;

import org.graylog.plugins.pipelineprocessor.EvaluationContext;
import org.graylog.plugins.pipelineprocessor.ast.functions.AbstractFunction;
import org.graylog.plugins.pipelineprocessor.ast.functions.FunctionArgs;
import org.graylog.plugins.pipelineprocessor.ast.functions.FunctionDescriptor;
import org.graylog.plugins.pipelineprocessor.ast.functions.ParameterDescriptor;
import org.graylog2.utilities.IpSubnet;

import java.net.UnknownHostException;

import static com.google.common.collect.ImmutableList.of;

public class CidrMatch extends AbstractFunction {

    public static final String NAME = "cidr_match";
    public static final String IP = "ip";

    private final ParameterDescriptor cidrParam;
    private final ParameterDescriptor ipParam;

    public CidrMatch() {
        // a little ugly because newCIDR throws a checked exception :(
        cidrParam = ParameterDescriptor.string("cidr", IpSubnet.class).transform(cidrString -> {
            try {
                return new IpSubnet(cidrString);
            } catch (UnknownHostException e) {
                throw new IllegalArgumentException(e);
            }
        }).description("The CIDR subnet mask").build();
        ipParam = ParameterDescriptor.type(IP, IpAddress.class).description("The parsed IP address to match against the CIDR mask").build();
    }

    @Override
    public Boolean evaluate(FunctionArgs args, EvaluationContext context) {
        final IpSubnet cidr = cidrParam.required(args, context);
        final IpAddress ipAddress = ipParam.required(args, context);
        if (cidr == null || ipAddress == null) {
            return null;
        }
        return cidr.contains(ipAddress.inetAddress());
    }

    @Override
    public FunctionDescriptor descriptor() {
        return FunctionDescriptor.builder()
                .name(NAME)
                .returnType(Boolean.class)
                .params(of(
                        cidrParam,
                        ipParam))
                .description("Checks if an IP address matches a CIDR subnet mask")
                .build();
    }
}