1
# Copyright (C) 2005 Robey Pointer <robey@lag.net>, Canonical Ltd
3
# This program is free software; you can redistribute it and/or modify
4
# it under the terms of the GNU General Public License as published by
5
# the Free Software Foundation; either version 2 of the License, or
6
# (at your option) any later version.
8
# This program is distributed in the hope that it will be useful,
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11
# GNU General Public License for more details.
13
# You should have received a copy of the GNU General Public License
14
# along with this program; if not, write to the Free Software
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
18
A stub SFTP server for loopback SFTP testing.
19
Adapted from the one in paramiko's unit tests.
23
from paramiko import ServerInterface, SFTPServerInterface, SFTPServer, SFTPAttributes, \
24
SFTPHandle, SFTP_OK, AUTH_SUCCESSFUL, OPEN_SUCCEEDED
27
from bzrlib.osutils import pathjoin
28
from bzrlib.trace import mutter
31
class StubServer (ServerInterface):
33
def __init__(self, test_case):
34
ServerInterface.__init__(self)
35
self._test_case = test_case
37
def check_auth_password(self, username, password):
39
self._test_case.log('sftpserver - authorizing: %s' % (username,))
40
return AUTH_SUCCESSFUL
42
def check_channel_request(self, kind, chanid):
43
self._test_case.log('sftpserver - channel request: %s, %s' % (kind, chanid))
47
class StubSFTPHandle (SFTPHandle):
50
return SFTPAttributes.from_stat(os.fstat(self.readfile.fileno()))
52
return SFTPServer.convert_errno(e.errno)
54
def chattr(self, attr):
55
# python doesn't have equivalents to fchown or fchmod, so we have to
56
# use the stored filename
57
mutter('Changing permissions on %s to %s', self.filename, attr)
59
SFTPServer.set_file_attr(self.filename, attr)
61
return SFTPServer.convert_errno(e.errno)
64
class StubSFTPServer (SFTPServerInterface):
66
def __init__(self, server, root, home=None):
67
SFTPServerInterface.__init__(self, server)
68
# All paths are actually relative to 'root'.
69
# this is like implementing chroot().
74
if not home.startswith(self.root):
76
"home must be a subdirectory of root (%s vs %s)"
78
self.home = home[len(self.root):]
79
if self.home.startswith('/'):
80
self.home = self.home[1:]
81
server._test_case.log('sftpserver - new connection')
83
def _realpath(self, path):
84
# paths returned from self.canonicalize() always start with
85
# a path separator. So if 'root' is just '/', this would cause
86
# a double slash at the beginning '//home/dir'.
88
return self.canonicalize(path)
89
return self.root + self.canonicalize(path)
91
if sys.platform == 'win32':
92
def canonicalize(self, path):
93
# Win32 sftp paths end up looking like
94
# sftp://host@foo/h:/foo/bar
95
# which means absolute paths look like:
97
# and relative paths stay the same:
99
# win32 needs to use the Unicode APIs. so we require the
100
# paths to be utf8 (Linux just uses bytestreams)
101
thispath = path.decode('utf8')
102
if path.startswith('/'):
104
return os.path.normpath(thispath[1:])
106
return os.path.normpath(os.path.join(self.home, thispath))
108
def canonicalize(self, path):
109
if os.path.isabs(path):
110
return os.path.normpath(path)
112
return os.path.normpath('/' + os.path.join(self.home, path))
114
def chattr(self, path, attr):
116
SFTPServer.set_file_attr(path, attr)
118
return SFTPServer.convert_errno(e.errno)
121
def list_folder(self, path):
122
path = self._realpath(path)
125
# TODO: win32 incorrectly lists paths with non-ascii if path is not
126
# unicode. However on Linux the server should only deal with
127
# bytestreams and posix.listdir does the right thing
128
if sys.platform == 'win32':
129
flist = [f.encode('utf8') for f in os.listdir(path)]
131
flist = os.listdir(path)
133
attr = SFTPAttributes.from_stat(os.stat(pathjoin(path, fname)))
134
attr.filename = fname
138
return SFTPServer.convert_errno(e.errno)
140
def stat(self, path):
141
path = self._realpath(path)
143
return SFTPAttributes.from_stat(os.stat(path))
145
return SFTPServer.convert_errno(e.errno)
147
def lstat(self, path):
148
path = self._realpath(path)
150
return SFTPAttributes.from_stat(os.lstat(path))
152
return SFTPServer.convert_errno(e.errno)
154
def open(self, path, flags, attr):
155
path = self._realpath(path)
157
flags |= getattr(os, 'O_BINARY', 0)
158
if getattr(attr, 'st_mode', None):
159
fd = os.open(path, flags, attr.st_mode)
161
# os.open() defaults to 0777 which is
162
# an odd default mode for files
163
fd = os.open(path, flags, 0666)
165
return SFTPServer.convert_errno(e.errno)
167
if (flags & os.O_CREAT) and (attr is not None):
168
attr._flags &= ~attr.FLAG_PERMISSIONS
169
SFTPServer.set_file_attr(path, attr)
170
if flags & os.O_WRONLY:
172
elif flags & os.O_RDWR:
178
f = os.fdopen(fd, fstr)
179
except (IOError, OSError), e:
180
return SFTPServer.convert_errno(e.errno)
181
fobj = StubSFTPHandle()
187
def remove(self, path):
188
path = self._realpath(path)
192
return SFTPServer.convert_errno(e.errno)
195
def rename(self, oldpath, newpath):
196
oldpath = self._realpath(oldpath)
197
newpath = self._realpath(newpath)
199
os.rename(oldpath, newpath)
201
return SFTPServer.convert_errno(e.errno)
204
def mkdir(self, path, attr):
205
path = self._realpath(path)
207
# Using getattr() in case st_mode is None or 0
208
# both evaluate to False
209
if getattr(attr, 'st_mode', None):
210
os.mkdir(path, attr.st_mode)
214
attr._flags &= ~attr.FLAG_PERMISSIONS
215
SFTPServer.set_file_attr(path, attr)
217
return SFTPServer.convert_errno(e.errno)
220
def rmdir(self, path):
221
path = self._realpath(path)
225
return SFTPServer.convert_errno(e.errno)
228
# removed: chattr, symlink, readlink
229
# (nothing in bzr's sftp transport uses those)
added
removed
bzrlib/tests/stub_sftp.py
