Skip to content
Projects
Groups
Snippets
Help
Loading...
Help
Support
Keyboard shortcuts
?
Submit feedback
Contribute to GitLab
Sign in / Register
Toggle navigation
slapos
Project overview
Project overview
Details
Activity
Releases
Repository
Repository
Files
Commits
Branches
Tags
Contributors
Graph
Compare
Issues
0
Issues
0
List
Boards
Labels
Milestones
Merge Requests
0
Merge Requests
0
Analytics
Analytics
Repository
Value Stream
Wiki
Wiki
Snippets
Snippets
Members
Members
Collapse sidebar
Close sidebar
Activity
Graph
Create a new issue
Commits
Issue Boards
Open sidebar
Thomas Gambier
slapos
Commits
1ecd1871
Commit
1ecd1871
authored
Nov 14, 2021
by
Jérome Perrin
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
software/proftpd: implement log rotation
parent
8bfcf46a
Changes
4
Show whitespace changes
Inline
Side-by-side
Showing
4 changed files
with
147 additions
and
21 deletions
+147
-21
software/proftpd/README.md
software/proftpd/README.md
+0
-1
software/proftpd/buildout.hash.cfg
software/proftpd/buildout.hash.cfg
+1
-1
software/proftpd/instance-default.cfg.in
software/proftpd/instance-default.cfg.in
+12
-0
software/proftpd/test/test.py
software/proftpd/test/test.py
+134
-19
No files found.
software/proftpd/README.md
View file @
1ecd1871
...
@@ -12,6 +12,5 @@ http://www.proftpd.org/docs/
...
@@ -12,6 +12,5 @@ http://www.proftpd.org/docs/
# TODO
# TODO
*
log rotation
*
make sure SFTPLog is useful (seems very verbose and does not contain more than stdout)
*
make sure SFTPLog is useful (seems very verbose and does not contain more than stdout)
*
allow configuring webhooks when new file is uploaded
*
allow configuring webhooks when new file is uploaded
software/proftpd/buildout.hash.cfg
View file @
1ecd1871
...
@@ -19,7 +19,7 @@ md5sum = efb4238229681447aa7fe73898dffad4
...
@@ -19,7 +19,7 @@ md5sum = efb4238229681447aa7fe73898dffad4
[instance-default]
[instance-default]
filename = instance-default.cfg.in
filename = instance-default.cfg.in
md5sum =
f6c583d24940a3a6838bd421dbb84a20
md5sum =
4df64032e14c19363ad3dfe9aecf8e0c
[proftpd-config-file]
[proftpd-config-file]
filename = proftpd-config-file.cfg.in
filename = proftpd-config-file.cfg.in
...
...
software/proftpd/instance-default.cfg.in
View file @
1ecd1871
[buildout]
[buildout]
parts =
parts =
promises
promises
cron-service
cron-entry-logrotate
logrotate-entry-proftpd
publish-connection-parameter
publish-connection-parameter
extends = {{ template_monitor }}
extends = {{ template_monitor }}
...
@@ -137,6 +140,15 @@ recipe =
...
@@ -137,6 +140,15 @@ recipe =
instance-promises =
instance-promises =
${proftpd-listen-promise:name}
${proftpd-listen-promise:name}
[logrotate-entry-proftpd]
<= logrotate-entry-base
name = proftpd
log =
${proftpd:sftp-log}
${proftpd:xfer-log}
${proftpd:ban-log}
post =
test ! -s ${proftpd:pid-file} || kill -HUP $(cat "${proftpd:pid-file}")
[publish-connection-parameter]
[publish-connection-parameter]
recipe = slapos.cookbook:publish
recipe = slapos.cookbook:publish
...
...
software/proftpd/test/test.py
View file @
1ecd1871
...
@@ -25,26 +25,25 @@
...
@@ -25,26 +25,25 @@
#
#
##############################################################################
##############################################################################
import
contextlib
import
io
import
logging
import
lzma
import
os
import
os
import
shutil
import
shutil
from
urllib.parse
import
urlparse
,
parse_qs
import
tempfile
import
io
import
subprocess
import
subprocess
import
tempfile
import
time
import
time
from
http.server
import
BaseHTTPRequestHandler
from
http.server
import
BaseHTTPRequestHandler
import
logging
from
urllib.parse
import
parse_qs
,
urlparse
import
pysftp
import
psutil
import
paramiko
import
paramiko
from
paramiko.ssh_exception
import
SSHException
import
psutil
from
paramiko.ssh_exception
import
AuthenticationException
import
pysftp
from
paramiko.ssh_exception
import
AuthenticationException
,
SSHException
from
slapos.testing.testcase
import
makeModuleSetUpAndTestCaseClass
from
slapos.testing.testcase
import
makeModuleSetUpAndTestCaseClass
from
slapos.testing.utils
import
findFreeTCPPort
from
slapos.testing.utils
import
(
CrontabMixin
,
ManagedHTTPServer
,
from
slapos.testing.utils
import
ManagedHTTPServer
findFreeTCPPort
)
setUpModule
,
SlapOSInstanceTestCase
=
makeModuleSetUpAndTestCaseClass
(
setUpModule
,
SlapOSInstanceTestCase
=
makeModuleSetUpAndTestCaseClass
(
os
.
path
.
abspath
(
os
.
path
.
abspath
(
...
@@ -227,8 +226,7 @@ class TestFilesAndSocketsInInstanceDir(ProFTPdTestCase):
...
@@ -227,8 +226,7 @@ class TestFilesAndSocketsInInstanceDir(ProFTPdTestCase):
"""
"""
with
self
.
slap
.
instance_supervisor_rpc
as
supervisor
:
with
self
.
slap
.
instance_supervisor_rpc
as
supervisor
:
all_process_info
=
supervisor
.
getAllProcessInfo
()
all_process_info
=
supervisor
.
getAllProcessInfo
()
# there is only one process in this instance
process_info
,
=
[
p
for
p
in
all_process_info
if
'proftpd'
in
p
[
'name'
]]
process_info
,
=
[
p
for
p
in
all_process_info
if
p
[
'name'
]
!=
'watchdog'
]
process
=
psutil
.
Process
(
process_info
[
'pid'
])
process
=
psutil
.
Process
(
process_info
[
'pid'
])
self
.
assertEqual
(
'proftpd'
,
process
.
name
())
# sanity check
self
.
assertEqual
(
'proftpd'
,
process
.
name
())
# sanity check
self
.
proftpdProcess
=
process
self
.
proftpdProcess
=
process
...
@@ -316,8 +314,7 @@ class TestSSHKey(TestSFTPOperations):
...
@@ -316,8 +314,7 @@ class TestSSHKey(TestSFTPOperations):
class
TestAuthenticationURL
(
TestSFTPOperations
):
class
TestAuthenticationURL
(
TestSFTPOperations
):
class
AuthenticationServer
(
ManagedHTTPServer
):
class
AuthenticationServer
(
ManagedHTTPServer
):
class
RequestHandler
(
BaseHTTPRequestHandler
):
class
RequestHandler
(
BaseHTTPRequestHandler
):
def
do_POST
(
self
):
def
do_POST
(
self
)
->
None
:
# type: () -> None
assert
self
.
headers
[
assert
self
.
headers
[
'Content-Type'
]
==
'application/x-www-form-urlencoded'
,
self
.
headers
[
'Content-Type'
]
==
'application/x-www-form-urlencoded'
,
self
.
headers
[
'Content-Type'
]
'Content-Type'
]
...
@@ -330,11 +327,13 @@ class TestAuthenticationURL(TestSFTPOperations):
...
@@ -330,11 +327,13 @@ class TestAuthenticationURL(TestSFTPOperations):
self
.
send_response
(
200
)
self
.
send_response
(
200
)
self
.
send_header
(
"X-Proftpd-Authentication-Result"
,
"Success"
)
self
.
send_header
(
"X-Proftpd-Authentication-Result"
,
"Success"
)
self
.
end_headers
()
self
.
end_headers
()
return
self
.
wfile
.
write
(
b"OK"
)
self
.
wfile
.
write
(
b"OK"
)
return
self
.
send_response
(
401
)
self
.
send_response
(
401
)
return
self
.
wfile
.
write
(
b"Forbidden"
)
self
.
wfile
.
write
(
b"Forbidden"
)
log_message
=
logging
.
getLogger
(
__name__
+
'.AuthenticationServer'
).
info
def
log_message
(
self
,
msg
,
*
args
)
->
None
:
logging
.
getLogger
(
__name__
+
'.AuthenticationServer'
).
info
(
msg
,
*
args
)
@
classmethod
@
classmethod
def
getInstanceParameterDict
(
cls
):
def
getInstanceParameterDict
(
cls
):
...
@@ -364,3 +363,119 @@ class TestAuthenticationURL(TestSFTPOperations):
...
@@ -364,3 +363,119 @@ class TestAuthenticationURL(TestSFTPOperations):
parameter_dict
=
self
.
computer_partition
.
getConnectionParameterDict
()
parameter_dict
=
self
.
computer_partition
.
getConnectionParameterDict
()
self
.
assertNotIn
(
'username'
,
parameter_dict
)
self
.
assertNotIn
(
'username'
,
parameter_dict
)
self
.
assertNotIn
(
'password'
,
parameter_dict
)
self
.
assertNotIn
(
'password'
,
parameter_dict
)
class
LogRotationMixin
(
CrontabMixin
):
"""Mixin test for log rotations.
Verifies that after `_access` the `expected_logged_text` is found in `log_filename`.
This also checks that the log files are rotated properly.
"""
log_filename
:
str
=
NotImplemented
expected_logged_text
:
str
=
NotImplemented
def
_access
(
self
)
->
None
:
raise
NotImplementedError
()
def
assertFileContains
(
self
,
filename
:
str
,
text
:
str
)
->
None
:
"""assert that files contain the text, waiting for file to be created and
retrying a few times to tolerate the cases where text is not yet written
to file.
"""
file_exists
=
False
for
retry
in
range
(
10
):
if
os
.
path
.
exists
(
filename
):
file_exists
=
True
if
filename
.
endswith
(
'.xz'
):
f
=
lzma
.
open
(
filename
,
'rt'
)
else
:
f
=
open
(
filename
,
'rt'
)
with
contextlib
.
closing
(
f
):
content
=
f
.
read
()
if
text
in
content
:
return
time
.
sleep
(
0.1
*
retry
)
self
.
assertTrue
(
file_exists
,
f'
{
filename
}
does not exist'
)
self
.
assertIn
(
text
,
content
)
def
test
(
self
)
->
None
:
self
.
_access
()
self
.
assertFileContains
(
os
.
path
.
join
(
self
.
computer_partition_root_path
,
'var'
,
'log'
,
self
.
log_filename
,
),
self
.
expected_logged_text
,
)
# first log rotation initialize the state, but does not actually rotate
self
.
_executeCrontabAtDate
(
'logrotate'
,
'2050-01-01'
)
self
.
_executeCrontabAtDate
(
'logrotate'
,
'2050-01-02'
)
# today's file is not compressed
self
.
assertFileContains
(
os
.
path
.
join
(
self
.
computer_partition_root_path
,
'srv'
,
'backup'
,
'logrotate'
,
f'
{
self
.
log_filename
}
-20500102'
,
),
self
.
expected_logged_text
,
)
# after rotation, the program re-opened original log file and writes in
# expected location, so access are logged again.
self
.
_access
()
self
.
assertFileContains
(
os
.
path
.
join
(
self
.
computer_partition_root_path
,
'var'
,
'log'
,
self
.
log_filename
,
),
self
.
expected_logged_text
,
)
self
.
_executeCrontabAtDate
(
'logrotate'
,
'2050-01-03'
)
# yesterday's file is compressed
self
.
assertFileContains
(
os
.
path
.
join
(
self
.
computer_partition_root_path
,
'srv'
,
'backup'
,
'logrotate'
,
f'
{
self
.
log_filename
}
-20500102.xz'
,
),
self
.
expected_logged_text
,
)
class
TestAccessLog
(
ProFTPdTestCase
,
LogRotationMixin
):
log_filename
=
'proftpd-sftp.log'
expected_logged_text
=
"user 'proftpd' authenticated via 'password' method"
def
_access
(
self
)
->
None
:
self
.
_getConnection
().
close
()
class
TestXferLog
(
ProFTPdTestCase
,
LogRotationMixin
):
log_filename
=
'proftpd-xfer.log'
expected_logged_text
=
'/testfile'
def
_access
(
self
)
->
None
:
with
self
.
_getConnection
()
as
sftp
:
with
tempfile
.
NamedTemporaryFile
(
mode
=
'w'
)
as
f
:
f
.
write
(
"Hello FTP !"
)
f
.
flush
()
sftp
.
put
(
f
.
name
,
remotepath
=
'testfile'
)
class
TestBanLog
(
ProFTPdTestCase
,
LogRotationMixin
):
log_filename
=
'proftpd-ban.log'
expected_logged_text
=
'denied due to host ban'
def
_access
(
self
)
->
None
:
for
_
in
range
(
6
):
with
self
.
assertRaisesRegex
(
Exception
,
'(Authentication failed|Connection reset by peer)'
):
self
.
_getConnection
(
password
=
'wrong'
)
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment