RetroShare/libretroshare/src/retroshare/rsbanlist.h

/*******************************************************************************
 * IPv4 address filtering interface                                            *
 *                                                                             *
 * libretroshare: retroshare core library                                      *
 *                                                                             *
 * Copyright (C) 2015  Cyril Soler <retroshare.team@gmail.com>                 *
 *                                                                             *
 * This program is free software: you can redistribute it and/or modify        *
 * it under the terms of the GNU Lesser 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 Lesser General Public License for more details.                         *
 *                                                                             *
 * You should have received a copy of the GNU Lesser General Public License    *
 * along with this program. If not, see <https://www.gnu.org/licenses/>.       *
 *                                                                             *
 *******************************************************************************/
#pragma once

#include <list>

#include "util/rsnet.h"
#include "util/rstime.h"
#include "util/rsmemory.h"

class RsBanList;

/**
 * Pointer to global instance of RsBanList service implementation
 * @jsonapi{development}
 */
extern RsBanList* rsBanList;

// TODO: use enum class instead of defines
#define RSBANLIST_ORIGIN_UNKNOWN	0
#define RSBANLIST_ORIGIN_SELF		1
#define RSBANLIST_ORIGIN_FRIEND		2
#define RSBANLIST_ORIGIN_FOF		3

#define RSBANLIST_REASON_UNKNOWN	0
#define RSBANLIST_REASON_USER		1
#define RSBANLIST_REASON_DHT		2
#define RSBANLIST_REASON_AUTO_RANGE     3

// These are flags. Can be combined.

#define RSBANLIST_CHECKING_FLAGS_NONE   	0x00
#define RSBANLIST_CHECKING_FLAGS_BLACKLIST   	0x01
#define RSBANLIST_CHECKING_FLAGS_WHITELIST   	0x02

// These are not flags. Cannot be combined. Used to give the reson for acceptance/denial of connections.

#define RSBANLIST_CHECK_RESULT_UNKNOWN  	0x00
#define RSBANLIST_CHECK_RESULT_NOCHECK  	0x01
#define RSBANLIST_CHECK_RESULT_BLACKLISTED  	0x02
#define RSBANLIST_CHECK_RESULT_NOT_WHITELISTED  0x03
#define RSBANLIST_CHECK_RESULT_ACCEPTED     	0x04

#define RSBANLIST_TYPE_PEERLIST	  		1
#define RSBANLIST_TYPE_BLACKLIST		2
#define RSBANLIST_TYPE_WHITELIST		3

class RsTlvBanListEntry;

class BanListPeer
{
public:
    BanListPeer() ;

    void toRsTlvBanListEntry(RsTlvBanListEntry& e) const ;
    void fromRsTlvBanListEntry(const RsTlvBanListEntry& e) ;

    struct sockaddr_storage addr;
    uint8_t masked_bytes ;		// 0 = []/32. 1=[]/24, 2=[]/16
    uint32_t reason; 			 // User, DHT
    uint32_t level; 			 // LOCAL, FRIEND, FoF.
    bool state ; 			// true=>active, false=>just stored but inactive
    int  connect_attempts ; 	// recorded by the BanList service
    rstime_t mTs;
    std::string comment ;		//
};

class RsBanList
{
public:
	/**
	 * @brief Enable or disable IP filtering service
	 * @jsonapi{development}
	 * @param[in] enable pass true to enable, false to disable
	 */
	virtual void enableIPFiltering(bool enable) = 0;

	/**
	 * @brief Get ip filtering service status
	 * @jsonapi{development}
	 * @return true if enabled, false if disabled
	 */
	virtual bool ipFilteringEnabled() = 0;

	/**
	 * @brief addIpRange
	 * @param addr full IPv4 address. Port is ignored.
	 * @param masked_bytes 0=full IP, 1="/24", 2="/16"
	 * @param list_type RSBANLIST_TYPE_WHITELIST or RSBANLIST_TYPE_BLACKLIST
	 * @param comment anything, user-based
	 * @return
	 */
	virtual bool addIpRange(
	        const sockaddr_storage& addr, int masked_bytes, uint32_t list_type,
	        const std::string& comment ) = 0;

	/**
	 * @brief removeIpRange
	 * @param addr full IPv4 address. Port is ignored.
	 * @param masked_bytes 0=full IP, 1="/24", 2="/16"
	 * @param list_type RSBANLIST_TYPE_WHITELIST or RSBANLIST_TYPE_BLACKLIST
	 * @return
	 */
	virtual bool removeIpRange(
	        const sockaddr_storage& addr, int masked_bytes, uint32_t list_type
	        ) = 0;

	/**
	 * @brief isAddressAccepted
	 * @param addr full IPv4 address. Port is ignored.
	 * @param checking_flags any combination of
	 * 	RSBANLIST_CHECKING_FLAGS_BLACKLIST and
	 * 	RSBANLIST_CHECKING_FLAGS_WHITELIST
	 * @param check_result returned result of the check in
	 *	RSBANLIST_CHECK_RESULT_*
	 * @return true if address is accepted, false false if address is rejected.
	 */
	virtual bool isAddressAccepted(
	        const sockaddr_storage& addr, uint32_t checking_flags,
	        uint32_t& check_result = RS_DEFAULT_STORAGE_PARAM(uint32_t) ) = 0;

	virtual void getBannedIps(std::list<BanListPeer>& list) = 0;
	virtual void getWhiteListedIps(std::list<BanListPeer>& list) = 0;

	virtual bool autoRangeEnabled() = 0;
	virtual void enableAutoRange(bool b) = 0;

	virtual int autoRangeLimit() = 0;
	virtual void setAutoRangeLimit(int n) = 0;

	virtual void enableIPsFromFriends(bool b) = 0;
	virtual bool IPsFromFriendsEnabled() = 0;

	virtual void enableIPsFromDHT(bool b) = 0;
	virtual bool iPsFromDHTEnabled() = 0;

	virtual ~RsBanList();
};