IP-FILTER

개요

IP 접근 허용/차단 위한 간단한 자바 기반 IP 필터링 모듈

모듈 목록

모듈 이름	설명	필요 모듈
ip-filter-core	IP 필터링 위한 핵심 API 제공	-
ip-filter-conf-parser	문자열을 Config로 변환해주는 파서 제공	ip-filter-core
ip-filter-web-api	특정 IP를 차단해주는 웹 필터 API 제공	-
ip-filter-web-simple	ip-filter-web-api의 간단한 구현 제공	ip-filter-web-simple ip-filter-conf-parser ip-filter-core

Maven 설정

    <repositories>
        <!-- repository for ip-filter module -->
        <repository>
            <id>ip-filter-mvn-repo</id>
            <url>https://raw.github.com/madvirus/ip-filter/mvn-repo/</url>
            <snapshots>
                <enabled>true</enabled>
                <updatePolicy>always</updatePolicy>
            </snapshots>
        </repository>
    </repositories>

    <dependencies>
        <dependency>
            <groupId>org.chimi.ipfilter</groupId>
            <artifactId>ip-filter-core</artifactId> <!-- Module name -->
            <version>0.2</version>
        </dependency>
    </dependencies>

ip-filter-core

사용법

import org.chimi.ipfilter.Config;
import org.chimi.ipfilter.IpFilter;
import org.chimi.ipfilter.IpFilters;
import org.junit.Test;

import static org.junit.Assert.assertFalse;
import static org.junit.Assert.assertTrue;

public class IpFilterTest {
    @Test
    public void basicUsageOfIpFilter() {
        // Config 초기화
        Config config = new Config();
        config.setAllowFirst(true);
        config.setDefaultAllow(false);
        config.allow("1.2.3.4"); // 허용 IP 추가
        config.allow("10.20.30.40");
        config.deny("101.102.103.104"); // 차단 IP 추가
        
        // IpFilters.create() 또는 IpFilters.createCached() 메서드를 이용해서 IpFilter 생성
        IpFilter ipFilter = IpFilters.create(config);
        // accept() 메서드를 이용해 IP 필터링
        assertTrue(ipFilter.accept("1.2.3.4"));
        assertFalse(ipFilter.accept("101.102.103.104"));
    }
}

IP 패턴

Config 클래스의 allow/deny 메서드에의 파라미터 값으로 사용할 수 있는 문자열 패턴:

IP: 1.2.3.4 (정확하게 일치)
네트워크 범위: 1.1.1.64/26 (1.1.1.64 ~ 1.1.1.127) ** 64/26: 26은 네트워크 주소의 비트 길이
전체: 1.2.3.*, 1.2.*, 1.*, *

허용 먼저 확인 여부

Config 객체의 allowFirst 프로퍼티 값이 true일 경우, IpFilter는 허용 IP인지 여부를 먼저 확인하고, 그 다음에 차단 IP 여부를 확인한다. 예를 들어, 다음 코드에서 ipFilter.accept("1.2.3.4")는 true를 리턴한다.

Config config = new Config();
config.setAllowFirst(true);
config.setDefaultAllow(false);
config.allow("1.2.3.4");
config.deny("1.2.3.*");
config.accept("1.2.3.4"); // true

allowFirst가 false라면, 차단 목록을 먼저 검사하므로 config.accept("1.2.3.4")는 false를 리턴한다.

기본 허용 값

IpFilter의 accept() 메서드는 검사 대상 IP가 allow/deny 목록과 매칭되지 않을 경우 defaultAllow에 지정한 값을 리턴한다.

Config config = new Config();
config.setAllowFirst(true);
config.setDefaultAllow(false);
config.allow("1.2.3.4");
config.deny("1.2.3.5");
config.accept("1.2.3.6"); // 어떤 설정도 일치하지 않음! 따라서 false 리턴 (defaultAllow가 false)

ip-filter-conf-parser

ip-filter-conf-parser는 문자열을 Config 객체로 변환해준다.

문법

아파치 htaccess와 비슷한 문법을 사용:

# 주석
order allow,deny
default true
allow from 1.2.3.4
allow from 1.2.3.* # 뒤에 주석
deny from all

사용법

// 실제로는, confValue 대신 파일 같은 곳에서 데이터를 읽어올 것이다.
String confValue =
        "order deny,allow\n" +
        "allow from 1.2.3.4\n" +
        "deny from 10.20.30.40\n" +
        "allow from 101.102.103.*\n" +
        "allow from 201.202.203.10/64";

Config config = new ConfParser().parse(confValue);

ip-filter-web-api

ip-filter-web-api는 IP 차단 위한 서블릿 필터인 IpBlockFilter를 제공한다. IpBlockFilter는 클라이언트 IP가 차단 IP인 경우 404 에러 코드를 전송한다.

ip-filter-web-simple 모듈 사용

ip-filter-web-simple은 ip-filter-web-api 모듈의 구현체이다. 이 모듈은 간단한 설정을 사용한다.

Maven 의존

    <repositories>
        <!-- repository for ip-filter module -->
        <repository>
            <id>ip-filter-mvn-repo</id>
            <url>https://raw.github.com/madvirus/ip-filter/mvn-repo/</url>
            <snapshots>
                <enabled>true</enabled>
                <updatePolicy>always</updatePolicy>
            </snapshots>
        </repository>
    </repositories>

    <dependencies>
        <dependency>
            <groupId>org.chimi.ipfilter</groupId>
            <artifactId>ip-filter-web-api</artifactId>
            <version>0.2</version>
        </dependency>
        <dependency>
            <groupId>org.chimi.ipfilter</groupId>
            <artifactId>ip-filter-web-simple</artifactId>
            <version>0.2</version>
        </dependency>
        ...

설정 1, web.xml 파일에 설정 정보를 입력하기

web.xml:

    <filter>
        <filter-name>ipBlockFilter</filter-name>
        <filter-class>org.chimi.ipfilter.web.IpBlockFilter</filter-class>
        <init-param>
            <param-name>type</param-name>
            <param-value>text</param-value>
        </init-param>
        <init-param>
            <param-name>value</param-name>
            <param-value>
                order allow,deny
                allow from 127.0.0.1
                deny from all
            </param-value>
        </init-param>
    </filter>

    <filter-mapping>
        <filter-name>ipBlockFilter</filter-name>
        <url-pattern>/*</url-pattern>
    </filter-mapping>

설정 2, 외부 설정 파일 사용하기

web.xml:

    <filter>
        <filter-name>ipBlockFilter</filter-name>
        <filter-class>org.chimi.ipfilter.web.IpBlockFilter</filter-class>
        <init-param>
            <param-name>type</param-name>
            <param-value>file</param-value>
        </init-param>
        <init-param>
            <param-name>value</param-name>
            <param-value>
                c:\somepath\access.conf
            </param-value>
        </init-param>
    </filter>

    <filter-mapping>
        <filter-name>ipBlockFilter</filter-name>
        <url-pattern>/*</url-pattern>
    </filter-mapping>

access.conf:

order allow,deny
allow from 127.0.0.1
deny from all

설정 3, 클래스패스의 자원 파일 사용하기

    <filter>
        <filter-name>ipBlockFilter</filter-name>
        <filter-class>org.chimi.ipfilter.web.IpBlockFilter</filter-class>
        <init-param>
            <param-name>type</param-name>
            <param-value>classpath</param-value>
        </init-param>
        <init-param>
            <param-name>value</param-name>
            <param-value>
                /org/chimi/config/access.conf
            </param-value>
        </init-param>
    </filter>

    <filter-mapping>
        <filter-name>ipBlockFilter</filter-name>
        <url-pattern>/*</url-pattern>
    </filter-mapping>

커스텀 ip-filter-web-api 구현 만들기

TODO

HOME_kr - madvirus/ip-filter GitHub Wiki

IP-FILTER

개요

모듈 목록

Maven 설정

ip-filter-core

사용법

IP 패턴

허용 먼저 확인 여부

기본 허용 값

ip-filter-conf-parser

문법

사용법

ip-filter-web-api

ip-filter-web-simple 모듈 사용

Maven 의존

설정 1, web.xml 파일에 설정 정보를 입력하기

설정 2, 외부 설정 파일 사용하기

설정 3, 클래스패스의 자원 파일 사용하기

커스텀 ip-filter-web-api 구현 만들기

⚠️ GitHub.com Fallback ⚠️

HOME_kr - madvirus/ip-filter GitHub Wiki

IP-FILTER

개요

모듈 목록

Maven 설정

ip-filter-core

사용법

IP 패턴

허용 먼저 확인 여부

기본 허용 값

ip-filter-conf-parser

문법

사용법

ip-filter-web-api

ip-filter-web-simple 모듈 사용

Maven 의존

설정 1, web.xml 파일에 설정 정보를 입력하기

설정 2, 외부 설정 파일 사용하기

설정 3, 클래스패스의 자원 파일 사용하기

커스텀 ip-filter-web-api 구현 만들기

⚠️ **GitHub.com Fallback** ⚠️

⚠️ GitHub.com Fallback ⚠️