/usr/lib/python2.7/dist-packages/sftpcloudfs/main.py is in sftpcloudfs 0.12.2-3.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 | #!/usr/bin/python
"""
Main function to setup the daemon process.
Copyright (C) 2011-2013 by Memset Ltd. http://www.memset.com/
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.
"""
import os
import signal
import sys
import logging
from logging.handlers import SysLogHandler
from ConfigParser import RawConfigParser
from optparse import OptionParser
import daemon
import tempfile
from Crypto import Random
import paramiko
from sftpcloudfs.server import ObjectStorageSFTPServer
from sftpcloudfs.constants import version, project_url, config_file, default_ks_service_type, \
default_ks_tenant_separator, default_ks_endpoint_type
from ftpcloudfs.fs import ObjectStorageFS
class PIDFile(object):
"""
PID file implementation using a context manager.
Entering the context acquires the lock, raising OSError if the file exists
and it's already locked. Leaving the context cleans the PID file.
Some methods are implemented for compatibility with lockfile and python-daemon.
"""
def __init__(self, pidfile=None):
self.pidfile = pidfile
self._fd = None
def __enter__(self):
return self.acquire()
def __exit__(self, *args, **kwargs):
self.release()
def acquire(self):
pid = os.getpid()
fd = os.open(self.pidfile, (os.O_CREAT|os.O_EXCL|os.O_WRONLY), 0644)
self._fd = os.fdopen(fd, "w")
self._fd.write("%s\n" % pid)
self._fd.flush()
return pid
def is_locked(self):
try:
os.stat(self.pidfile)
except OSError:
return False
else:
return True
def i_am_locking(self):
return self._fd != None
def release(self):
if self._fd:
self._fd.close()
os.remove(self.pidfile)
self._fd = None
class Main(object):
def __init__(self):
"""Parse configuration and CLI options."""
global config_file
# look for an alternative configuration file
alt_config_file = False
# used to show errors before we actually start parsing stuff
parser = OptionParser()
for arg in sys.argv:
if arg == '--config':
try:
alt_config_file = sys.argv[sys.argv.index(arg)+1]
config_file = alt_config_file
except IndexError:
pass
elif arg.startswith('--config='):
_, alt_config_file = arg.split('=', 1)
if alt_config_file == '':
parser.error("--config option requires an argument")
config_file = alt_config_file
config = RawConfigParser({'auth-url': None,
'host-key-file': None,
'bind-address': "127.0.0.1",
'port': 8022,
'memcache': None,
'max-children': "20",
'log-file': None,
'syslog': 'no',
'verbose': 'no',
'scp-support': 'yes',
'pid-file': None,
'uid': None,
'gid': None,
'split-large-files': "0",
# keystone auth 2.0 support
'keystone-auth': False,
'keystone-region-name': None,
'keystone-tenant-separator': default_ks_tenant_separator,
'keystone-service-type': default_ks_service_type,
'keystone-endpoint-type': default_ks_endpoint_type,
})
if not config.read(config_file) and alt_config_file:
# the default conf file is optional
parser.error("failed to read %s" % config_file)
if not config.has_section('sftpcloudfs'):
config.add_section('sftpcloudfs')
parser = OptionParser(version="%prog " + version,
description="This is a SFTP interface to OpenStack " + \
"Object Storage (Swift).",
epilog="Contact and support at: %s" % project_url)
parser.add_option("-a", "--auth-url", dest="authurl",
default=config.get('sftpcloudfs', 'auth-url'),
help="Authentication URL")
parser.add_option("-k", "--host-key-file", dest="host_key",
default=config.get('sftpcloudfs', 'host-key-file'),
help="Host RSA key used by the server")
parser.add_option("-b", "--bind-address", dest="bind_address",
default=config.get('sftpcloudfs', 'bind-address'),
help="Address to bind (default: 127.0.0.1)")
parser.add_option("-p", "--port", dest="port",
type="int",
default=config.get('sftpcloudfs', 'port'),
help="Port to bind (default: 8022)")
memcache = config.get('sftpcloudfs', 'memcache')
if memcache:
memcache = [x.strip() for x in memcache.split(',')]
parser.add_option('--memcache',
type="str",
dest="memcache",
action="append",
default=memcache,
help="Memcache server(s) to be used for cache (ip:port)")
parser.add_option("-l", "--log-file", dest="log_file",
default=config.get('sftpcloudfs', 'log-file'),
help="Log into provided file")
parser.add_option("-f", "--foreground", dest="foreground",
action="store_true",
default=False,
help="Run in the foreground (don't detach from terminal)")
parser.add_option("--disable-scp", dest="no_scp",
action="store_true",
default=not config.getboolean('sftpcloudfs', 'scp-support'),
help="Disable SCP support (default: enabled)")
parser.add_option("--syslog", dest="syslog",
action="store_true",
default=config.getboolean('sftpcloudfs', 'syslog'),
help="Enable logging to system logger (daemon facility)")
parser.add_option("-v", "--verbose", dest="verbose",
action="store_true",
default=config.getboolean('sftpcloudfs', 'verbose'),
help="Show detailed information on logging")
parser.add_option('--pid-file',
type="str",
dest="pid_file",
default=config.get('sftpcloudfs', 'pid-file'),
help="Pid file location when in daemon mode")
parser.add_option('--uid',
type="int",
dest="uid",
default=config.get('sftpcloudfs', 'uid'),
help="UID to drop the privileges to when in daemon mode")
parser.add_option('--gid',
type="int",
dest="gid",
default=config.get('sftpcloudfs', 'gid'),
help="GID to drop the privileges to when in daemon mode")
parser.add_option('--keystone-auth',
action="store_true",
dest="keystone",
default=config.get('sftpcloudfs', 'keystone-auth'),
help="Use auth 2.0 (Keystone, requires keystoneclient)")
parser.add_option('--keystone-region-name',
type="str",
dest="region_name",
default=config.get('sftpcloudfs', 'keystone-region-name'),
help="Region name to be used in auth 2.0")
parser.add_option('--keystone-tenant-separator',
type="str",
dest="tenant_separator",
default=config.get('sftpcloudfs', 'keystone-tenant-separator'),
help="Character used to separate tenant_name/username in auth 2.0, " + \
"default: TENANT%sUSERNAME" % default_ks_tenant_separator)
parser.add_option('--keystone-service-type',
type="str",
dest="service_type",
default=config.get('sftpcloudfs', 'keystone-service-type'),
help="Service type to be used in auth 2.0, default: %s" % default_ks_service_type)
parser.add_option('--keystone-endpoint-type',
type="str",
dest="endpoint_type",
default=config.get('sftpcloudfs', 'keystone-endpoint-type'),
help="Endpoint type to be used in auth 2.0, default: %s" % default_ks_endpoint_type)
parser.add_option('--config',
type="str",
dest="config",
default=config_file,
help="Use an alternative configuration file")
(options, args) = parser.parse_args()
# required parameters
if not options.authurl:
parser.error("No auth-url provided")
if not options.host_key:
parser.error("No host-key-file provided")
try:
self.host_key = paramiko.RSAKey(filename=options.host_key)
except (IOError, paramiko.SSHException), e:
parser.error("host-key-file: %s" % e)
if not options.pid_file:
options.pid_file = "%s/%s.pid" % (tempfile.gettempdir(), __package__)
if options.memcache:
ObjectStorageFS.memcache_hosts = options.memcache
try:
ObjectStorageFS(None, None, None)
except (ValueError, TypeError):
parser.error("memcache: invalid server address, ip:port expected")
self.pidfile = PIDFile(options.pid_file)
if self.pidfile.is_locked():
parser.error("pid-file found: %s\nIs the server already running?" % options.pid_file)
try:
options.max_children = int(config.get('sftpcloudfs', 'max-children'))
except ValueError:
parser.error('max-children: invalid value, integer expected')
try:
options.split_size = int(config.get('sftpcloudfs', 'split-large-files'))*10**6
except ValueError:
parser.error('split-large-files: invalid size, integer expected')
if options.keystone:
keystone_keys = ('region_name', 'tenant_separator', 'service_type', 'endpoint_type')
options.keystone = dict((key, getattr(options, key)) for key in keystone_keys)
self.options = options
def setup_log(self):
"""Setup server logging facility."""
self.log = paramiko.util.get_logger("paramiko")
if self.options.log_file:
paramiko.util.log_to_file(self.options.log_file)
if self.options.syslog is True:
try:
handler = SysLogHandler(address='/dev/log',
facility=SysLogHandler.LOG_DAEMON)
except IOError:
# fall back to UDP
handler = SysLogHandler(facility=SysLogHandler.LOG_DAEMON)
finally:
handler.setFormatter(logging.Formatter('%(name)s[%(_threadid)s]: %(levelname)s: %(message)s'))
self.log.addHandler(handler)
if self.options.foreground:
handler = logging.StreamHandler()
handler.setFormatter(logging.Formatter('%(asctime)s: %(name)s[%(_threadid)s]: %(levelname)s: %(message)s'))
self.log.addHandler(handler)
if self.options.verbose:
# enable debug for the root logger (used by ObjectStorageFS)
logging.getLogger().setLevel(logging.DEBUG)
self.log.setLevel(logging.DEBUG)
self.log.debug(self.options)
else:
self.log.setLevel(logging.INFO)
def run(self):
"""Run the server."""
server = ObjectStorageSFTPServer((self.options.bind_address, self.options.port),
host_key=self.host_key,
authurl=self.options.authurl,
max_children=self.options.max_children,
keystone=self.options.keystone,
no_scp=self.options.no_scp,
split_size=self.options.split_size,
)
dc = daemon.DaemonContext()
dc.pidfile = self.pidfile
if self.options.uid:
dc.uid = self.options.uid
if self.options.gid:
dc.gid = self.options.gid
# FIXME: we don't know the fileno for Random open files, but they're < 16
dc.files_preserve = range(server.fileno(), 16)
if self.options.foreground:
dc.detach_process = False
dc.stderr = sys.stderr
with dc:
Random.atfork()
self.setup_log()
try:
if os.getuid() == 0:
self.log.warning("UID is 0, running as root is not recommended")
self.log.info("Listening on %s:%s" % (self.options.bind_address, self.options.port))
server.serve_forever()
except (SystemExit, KeyboardInterrupt):
self.log.info("Terminating...")
if server.active_children:
for pid in server.active_children:
os.kill(pid, signal.SIGTERM)
server.server_close()
if self.pidfile.i_am_locking():
self.pidfile.release()
return 0
|