mirror of
https://github.com/drakkan/sftpgo.git
synced 2024-11-22 07:30:25 +00:00
784b7585c1
so we don't have to update all the files every year Signed-off-by: Nicola Murino <nicola.murino@gmail.com>
320 lines
10 KiB
Go
320 lines
10 KiB
Go
// Copyright (C) 2019 Nicola Murino
|
|
//
|
|
// 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, version 3.
|
|
//
|
|
// 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 Affero 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 <https://www.gnu.org/licenses/>.
|
|
|
|
package common
|
|
|
|
import (
|
|
"encoding/hex"
|
|
"testing"
|
|
"time"
|
|
|
|
"github.com/stretchr/testify/assert"
|
|
|
|
"github.com/drakkan/sftpgo/v2/internal/dataprovider"
|
|
"github.com/drakkan/sftpgo/v2/internal/util"
|
|
)
|
|
|
|
func TestBasicDbDefender(t *testing.T) {
|
|
if !isDbDefenderSupported() {
|
|
t.Skip("this test is not supported with the current database provider")
|
|
}
|
|
entries := []dataprovider.IPListEntry{
|
|
{
|
|
IPOrNet: "172.16.1.1/32",
|
|
Type: dataprovider.IPListTypeDefender,
|
|
Mode: dataprovider.ListModeDeny,
|
|
},
|
|
{
|
|
IPOrNet: "172.16.1.2/32",
|
|
Type: dataprovider.IPListTypeDefender,
|
|
Mode: dataprovider.ListModeDeny,
|
|
},
|
|
{
|
|
IPOrNet: "10.8.0.0/24",
|
|
Type: dataprovider.IPListTypeDefender,
|
|
Mode: dataprovider.ListModeDeny,
|
|
},
|
|
{
|
|
IPOrNet: "172.16.1.3/32",
|
|
Type: dataprovider.IPListTypeDefender,
|
|
Mode: dataprovider.ListModeAllow,
|
|
},
|
|
{
|
|
IPOrNet: "172.16.1.4/32",
|
|
Type: dataprovider.IPListTypeDefender,
|
|
Mode: dataprovider.ListModeAllow,
|
|
},
|
|
{
|
|
IPOrNet: "192.168.8.0/24",
|
|
Type: dataprovider.IPListTypeDefender,
|
|
Mode: dataprovider.ListModeAllow,
|
|
},
|
|
}
|
|
|
|
for idx := range entries {
|
|
e := entries[idx]
|
|
err := dataprovider.AddIPListEntry(&e, "", "", "")
|
|
assert.NoError(t, err)
|
|
}
|
|
|
|
config := &DefenderConfig{
|
|
Enabled: true,
|
|
BanTime: 10,
|
|
BanTimeIncrement: 2,
|
|
Threshold: 5,
|
|
ScoreInvalid: 2,
|
|
ScoreValid: 1,
|
|
ScoreNoAuth: 2,
|
|
ScoreLimitExceeded: 3,
|
|
ObservationTime: 15,
|
|
EntriesSoftLimit: 1,
|
|
EntriesHardLimit: 10,
|
|
}
|
|
d, err := newDBDefender(config)
|
|
assert.NoError(t, err)
|
|
defender := d.(*dbDefender)
|
|
assert.True(t, defender.IsBanned("172.16.1.1", ProtocolFTP))
|
|
assert.False(t, defender.IsBanned("172.16.1.10", ProtocolSSH))
|
|
assert.False(t, defender.IsBanned("10.8.1.3", ProtocolHTTP))
|
|
assert.True(t, defender.IsBanned("10.8.0.4", ProtocolWebDAV))
|
|
assert.False(t, defender.IsBanned("invalid ip", ProtocolSSH))
|
|
hosts, err := defender.GetHosts()
|
|
assert.NoError(t, err)
|
|
assert.Len(t, hosts, 0)
|
|
_, err = defender.GetHost("10.8.0.3")
|
|
assert.Error(t, err)
|
|
|
|
defender.AddEvent("172.16.1.4", ProtocolSSH, HostEventLoginFailed)
|
|
defender.AddEvent("192.168.8.4", ProtocolSSH, HostEventUserNotFound)
|
|
defender.AddEvent("172.16.1.3", ProtocolSSH, HostEventLimitExceeded)
|
|
hosts, err = defender.GetHosts()
|
|
assert.NoError(t, err)
|
|
assert.Len(t, hosts, 0)
|
|
assert.True(t, defender.getLastCleanup().IsZero())
|
|
|
|
testIP := "123.45.67.89"
|
|
defender.AddEvent(testIP, ProtocolSSH, HostEventLoginFailed)
|
|
lastCleanup := defender.getLastCleanup()
|
|
assert.False(t, lastCleanup.IsZero())
|
|
score, err := defender.GetScore(testIP)
|
|
assert.NoError(t, err)
|
|
assert.Equal(t, 1, score)
|
|
hosts, err = defender.GetHosts()
|
|
assert.NoError(t, err)
|
|
if assert.Len(t, hosts, 1) {
|
|
assert.Equal(t, 1, hosts[0].Score)
|
|
assert.True(t, hosts[0].BanTime.IsZero())
|
|
assert.Empty(t, hosts[0].GetBanTime())
|
|
}
|
|
host, err := defender.GetHost(testIP)
|
|
assert.NoError(t, err)
|
|
assert.Equal(t, 1, host.Score)
|
|
assert.Empty(t, host.GetBanTime())
|
|
banTime, err := defender.GetBanTime(testIP)
|
|
assert.NoError(t, err)
|
|
assert.Nil(t, banTime)
|
|
defender.AddEvent(testIP, ProtocolSSH, HostEventLimitExceeded)
|
|
score, err = defender.GetScore(testIP)
|
|
assert.NoError(t, err)
|
|
assert.Equal(t, 4, score)
|
|
hosts, err = defender.GetHosts()
|
|
assert.NoError(t, err)
|
|
if assert.Len(t, hosts, 1) {
|
|
assert.Equal(t, 4, hosts[0].Score)
|
|
assert.True(t, hosts[0].BanTime.IsZero())
|
|
assert.Empty(t, hosts[0].GetBanTime())
|
|
}
|
|
defender.AddEvent(testIP, ProtocolSSH, HostEventNoLoginTried)
|
|
defender.AddEvent(testIP, ProtocolSSH, HostEventNoLoginTried)
|
|
score, err = defender.GetScore(testIP)
|
|
assert.NoError(t, err)
|
|
assert.Equal(t, 0, score)
|
|
banTime, err = defender.GetBanTime(testIP)
|
|
assert.NoError(t, err)
|
|
assert.NotNil(t, banTime)
|
|
hosts, err = defender.GetHosts()
|
|
assert.NoError(t, err)
|
|
if assert.Len(t, hosts, 1) {
|
|
assert.Equal(t, 0, hosts[0].Score)
|
|
assert.False(t, hosts[0].BanTime.IsZero())
|
|
assert.NotEmpty(t, hosts[0].GetBanTime())
|
|
assert.Equal(t, hex.EncodeToString([]byte(testIP)), hosts[0].GetID())
|
|
}
|
|
host, err = defender.GetHost(testIP)
|
|
assert.NoError(t, err)
|
|
assert.Equal(t, 0, host.Score)
|
|
assert.NotEmpty(t, host.GetBanTime())
|
|
// ban time should increase
|
|
assert.True(t, defender.IsBanned(testIP, ProtocolSSH))
|
|
newBanTime, err := defender.GetBanTime(testIP)
|
|
assert.NoError(t, err)
|
|
assert.True(t, newBanTime.After(*banTime))
|
|
|
|
assert.True(t, defender.DeleteHost(testIP))
|
|
assert.False(t, defender.DeleteHost(testIP))
|
|
// test cleanup
|
|
testIP1 := "123.45.67.90"
|
|
testIP2 := "123.45.67.91"
|
|
testIP3 := "123.45.67.92"
|
|
for i := 0; i < 3; i++ {
|
|
defender.AddEvent(testIP, ProtocolSSH, HostEventUserNotFound)
|
|
defender.AddEvent(testIP1, ProtocolSSH, HostEventNoLoginTried)
|
|
defender.AddEvent(testIP2, ProtocolSSH, HostEventUserNotFound)
|
|
}
|
|
hosts, err = defender.GetHosts()
|
|
assert.NoError(t, err)
|
|
assert.Len(t, hosts, 3)
|
|
for _, host := range hosts {
|
|
assert.Equal(t, 0, host.Score)
|
|
assert.False(t, host.BanTime.IsZero())
|
|
assert.NotEmpty(t, host.GetBanTime())
|
|
}
|
|
defender.AddEvent(testIP3, ProtocolSSH, HostEventLoginFailed)
|
|
hosts, err = defender.GetHosts()
|
|
assert.NoError(t, err)
|
|
assert.Len(t, hosts, 4)
|
|
// now set a ban time in the past, so the host will be cleanead up
|
|
for _, ip := range []string{testIP1, testIP2} {
|
|
err = dataprovider.SetDefenderBanTime(ip, util.GetTimeAsMsSinceEpoch(time.Now().Add(-1*time.Minute)))
|
|
assert.NoError(t, err)
|
|
}
|
|
hosts, err = defender.GetHosts()
|
|
assert.NoError(t, err)
|
|
assert.Len(t, hosts, 4)
|
|
for _, host := range hosts {
|
|
switch host.IP {
|
|
case testIP:
|
|
assert.Equal(t, 0, host.Score)
|
|
assert.False(t, host.BanTime.IsZero())
|
|
assert.NotEmpty(t, host.GetBanTime())
|
|
case testIP3:
|
|
assert.Equal(t, 1, host.Score)
|
|
assert.True(t, host.BanTime.IsZero())
|
|
assert.Empty(t, host.GetBanTime())
|
|
default:
|
|
assert.Equal(t, 6, host.Score)
|
|
assert.True(t, host.BanTime.IsZero())
|
|
assert.Empty(t, host.GetBanTime())
|
|
}
|
|
}
|
|
host, err = defender.GetHost(testIP)
|
|
assert.NoError(t, err)
|
|
assert.Equal(t, 0, host.Score)
|
|
assert.False(t, host.BanTime.IsZero())
|
|
assert.NotEmpty(t, host.GetBanTime())
|
|
host, err = defender.GetHost(testIP3)
|
|
assert.NoError(t, err)
|
|
assert.Equal(t, 1, host.Score)
|
|
assert.True(t, host.BanTime.IsZero())
|
|
assert.Empty(t, host.GetBanTime())
|
|
// set a negative observation time so the from field in the queries will be in the future
|
|
// we still should get the banned hosts
|
|
defender.config.ObservationTime = -2
|
|
assert.Greater(t, defender.getStartObservationTime(), time.Now().UnixMilli())
|
|
hosts, err = defender.GetHosts()
|
|
assert.NoError(t, err)
|
|
if assert.Len(t, hosts, 1) {
|
|
assert.Equal(t, testIP, hosts[0].IP)
|
|
assert.Equal(t, 0, hosts[0].Score)
|
|
assert.False(t, hosts[0].BanTime.IsZero())
|
|
assert.NotEmpty(t, hosts[0].GetBanTime())
|
|
}
|
|
_, err = defender.GetHost(testIP)
|
|
assert.NoError(t, err)
|
|
// cleanup db
|
|
err = dataprovider.CleanupDefender(util.GetTimeAsMsSinceEpoch(time.Now().Add(10 * time.Minute)))
|
|
assert.NoError(t, err)
|
|
// the banned host must still be there
|
|
hosts, err = defender.GetHosts()
|
|
assert.NoError(t, err)
|
|
if assert.Len(t, hosts, 1) {
|
|
assert.Equal(t, testIP, hosts[0].IP)
|
|
assert.Equal(t, 0, hosts[0].Score)
|
|
assert.False(t, hosts[0].BanTime.IsZero())
|
|
assert.NotEmpty(t, hosts[0].GetBanTime())
|
|
}
|
|
_, err = defender.GetHost(testIP)
|
|
assert.NoError(t, err)
|
|
err = dataprovider.SetDefenderBanTime(testIP, util.GetTimeAsMsSinceEpoch(time.Now().Add(-1*time.Minute)))
|
|
assert.NoError(t, err)
|
|
err = dataprovider.CleanupDefender(util.GetTimeAsMsSinceEpoch(time.Now().Add(10 * time.Minute)))
|
|
assert.NoError(t, err)
|
|
hosts, err = defender.GetHosts()
|
|
assert.NoError(t, err)
|
|
assert.Len(t, hosts, 0)
|
|
|
|
for _, e := range entries {
|
|
err := dataprovider.DeleteIPListEntry(e.IPOrNet, e.Type, "", "", "")
|
|
assert.NoError(t, err)
|
|
}
|
|
}
|
|
|
|
func TestDbDefenderCleanup(t *testing.T) {
|
|
if !isDbDefenderSupported() {
|
|
t.Skip("this test is not supported with the current database provider")
|
|
}
|
|
config := &DefenderConfig{
|
|
Enabled: true,
|
|
BanTime: 10,
|
|
BanTimeIncrement: 2,
|
|
Threshold: 5,
|
|
ScoreInvalid: 2,
|
|
ScoreValid: 1,
|
|
ScoreLimitExceeded: 3,
|
|
ObservationTime: 15,
|
|
EntriesSoftLimit: 1,
|
|
EntriesHardLimit: 10,
|
|
}
|
|
d, err := newDBDefender(config)
|
|
assert.NoError(t, err)
|
|
defender := d.(*dbDefender)
|
|
lastCleanup := defender.getLastCleanup()
|
|
assert.True(t, lastCleanup.IsZero())
|
|
defender.cleanup()
|
|
lastCleanup = defender.getLastCleanup()
|
|
assert.False(t, lastCleanup.IsZero())
|
|
defender.cleanup()
|
|
assert.Equal(t, lastCleanup, defender.getLastCleanup())
|
|
defender.setLastCleanup(time.Time{})
|
|
assert.True(t, defender.getLastCleanup().IsZero())
|
|
defender.setLastCleanup(time.Now().Add(-time.Duration(config.ObservationTime) * time.Minute * 4))
|
|
time.Sleep(20 * time.Millisecond)
|
|
defender.cleanup()
|
|
assert.True(t, lastCleanup.Before(defender.getLastCleanup()))
|
|
|
|
providerConf := dataprovider.GetProviderConfig()
|
|
err = dataprovider.Close()
|
|
assert.NoError(t, err)
|
|
|
|
lastCleanup = util.GetTimeFromMsecSinceEpoch(time.Now().Add(-time.Duration(config.ObservationTime) * time.Minute * 4).UnixMilli())
|
|
defender.setLastCleanup(lastCleanup)
|
|
defender.cleanup()
|
|
// cleanup will fail and so last cleanup should be reset to the previous value
|
|
assert.Equal(t, lastCleanup, defender.getLastCleanup())
|
|
|
|
err = dataprovider.Initialize(providerConf, configDir, true)
|
|
assert.NoError(t, err)
|
|
}
|
|
|
|
func isDbDefenderSupported() bool {
|
|
// SQLite shares the implementation with other SQL-based provider but it makes no sense
|
|
// to use it outside test cases
|
|
switch dataprovider.GetProviderStatus().Driver {
|
|
case dataprovider.MySQLDataProviderName, dataprovider.PGSQLDataProviderName,
|
|
dataprovider.CockroachDataProviderName, dataprovider.SQLiteDataProviderName:
|
|
return true
|
|
default:
|
|
return false
|
|
}
|
|
}
|