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
|
# Copyright (C) 2005 Robey Pointer <robey@lag.net>, Canonical Ltd
#
# This program is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation; either version 2 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 General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program; if not, write to the Free Software
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
"""
A stub SFTP server for loopback SFTP testing.
Adapted from the one in paramiko's unit tests.
"""
import os
from paramiko import ServerInterface, SFTPServerInterface, SFTPServer, SFTPAttributes, \
SFTPHandle, SFTP_OK, AUTH_SUCCESSFUL, OPEN_SUCCEEDED
import sys
from bzrlib.osutils import pathjoin
from bzrlib.trace import mutter
class StubServer (ServerInterface):
def __init__(self, test_case):
ServerInterface.__init__(self)
self._test_case = test_case
def check_auth_password(self, username, password):
# all are allowed
self._test_case.log('sftpserver - authorizing: %s' % (username,))
return AUTH_SUCCESSFUL
def check_channel_request(self, kind, chanid):
self._test_case.log('sftpserver - channel request: %s, %s' % (kind, chanid))
return OPEN_SUCCEEDED
class StubSFTPHandle (SFTPHandle):
def stat(self):
try:
return SFTPAttributes.from_stat(os.fstat(self.readfile.fileno()))
except OSError, e:
return SFTPServer.convert_errno(e.errno)
def chattr(self, attr):
# python doesn't have equivalents to fchown or fchmod, so we have to
# use the stored filename
mutter('Changing permissions on %s to %s', self.filename, attr)
try:
SFTPServer.set_file_attr(self.filename, attr)
except OSError, e:
return SFTPServer.convert_errno(e.errno)
class StubSFTPServer (SFTPServerInterface):
def __init__(self, server, root, home=None):
SFTPServerInterface.__init__(self, server)
# All paths are actually relative to 'root'.
# this is like implementing chroot().
self.root = root
if home is None:
self.home = ''
else:
assert home.startswith(self.root), \
"home must be a subdirectory of root (%s vs %s)" \
% (home, root)
self.home = home[len(self.root):]
if self.home.startswith('/'):
self.home = self.home[1:]
server._test_case.log('sftpserver - new connection')
def _realpath(self, path):
# paths returned from self.canonicalize() always start with
# a path separator. So if 'root' is just '/', this would cause
# a double slash at the beginning '//home/dir'.
if self.root == '/':
return self.canonicalize(path)
return self.root + self.canonicalize(path)
if sys.platform == 'win32':
def canonicalize(self, path):
# Win32 sftp paths end up looking like
# sftp://host@foo/h:/foo/bar
# which means absolute paths look like:
# /h:/foo/bar
# and relative paths stay the same:
# foo/bar
# win32 needs to use the Unicode APIs. so we require the
# paths to be utf8 (Linux just uses bytestreams)
thispath = path.decode('utf8')
if path.startswith('/'):
# Abspath H:/foo/bar
return os.path.normpath(thispath[1:])
else:
return os.path.normpath(os.path.join(self.home, thispath))
else:
def canonicalize(self, path):
if os.path.isabs(path):
return os.path.normpath(path)
else:
return os.path.normpath('/' + os.path.join(self.home, path))
def chattr(self, path, attr):
try:
SFTPServer.set_file_attr(path, attr)
except OSError, e:
return SFTPServer.convert_errno(e.errno)
return SFTP_OK
def list_folder(self, path):
path = self._realpath(path)
try:
out = [ ]
# TODO: win32 incorrectly lists paths with non-ascii if path is not
# unicode. However on Linux the server should only deal with
# bytestreams and posix.listdir does the right thing
if sys.platform == 'win32':
flist = [f.encode('utf8') for f in os.listdir(path)]
else:
flist = os.listdir(path)
for fname in flist:
attr = SFTPAttributes.from_stat(os.stat(pathjoin(path, fname)))
attr.filename = fname
out.append(attr)
return out
except OSError, e:
return SFTPServer.convert_errno(e.errno)
def stat(self, path):
path = self._realpath(path)
try:
return SFTPAttributes.from_stat(os.stat(path))
except OSError, e:
return SFTPServer.convert_errno(e.errno)
def lstat(self, path):
path = self._realpath(path)
try:
return SFTPAttributes.from_stat(os.lstat(path))
except OSError, e:
return SFTPServer.convert_errno(e.errno)
def open(self, path, flags, attr):
path = self._realpath(path)
try:
flags |= getattr(os, 'O_BINARY', 0)
if getattr(attr, 'st_mode', None):
fd = os.open(path, flags, attr.st_mode)
else:
# os.open() defaults to 0777 which is
# an odd default mode for files
fd = os.open(path, flags, 0666)
except OSError, e:
return SFTPServer.convert_errno(e.errno)
if (flags & os.O_CREAT) and (attr is not None):
attr._flags &= ~attr.FLAG_PERMISSIONS
SFTPServer.set_file_attr(path, attr)
if flags & os.O_WRONLY:
fstr = 'wb'
elif flags & os.O_RDWR:
fstr = 'rb+'
else:
# O_RDONLY (== 0)
fstr = 'rb'
try:
f = os.fdopen(fd, fstr)
except (IOError, OSError), e:
return SFTPServer.convert_errno(e.errno)
fobj = StubSFTPHandle()
fobj.filename = path
fobj.readfile = f
fobj.writefile = f
return fobj
def remove(self, path):
path = self._realpath(path)
try:
os.remove(path)
except OSError, e:
return SFTPServer.convert_errno(e.errno)
return SFTP_OK
def rename(self, oldpath, newpath):
oldpath = self._realpath(oldpath)
newpath = self._realpath(newpath)
try:
os.rename(oldpath, newpath)
except OSError, e:
return SFTPServer.convert_errno(e.errno)
return SFTP_OK
def mkdir(self, path, attr):
path = self._realpath(path)
try:
# Using getattr() in case st_mode is None or 0
# both evaluate to False
if getattr(attr, 'st_mode', None):
os.mkdir(path, attr.st_mode)
else:
os.mkdir(path)
if attr is not None:
attr._flags &= ~attr.FLAG_PERMISSIONS
SFTPServer.set_file_attr(path, attr)
except OSError, e:
return SFTPServer.convert_errno(e.errno)
return SFTP_OK
def rmdir(self, path):
path = self._realpath(path)
try:
os.rmdir(path)
except OSError, e:
return SFTPServer.convert_errno(e.errno)
return SFTP_OK
# removed: chattr, symlink, readlink
# (nothing in bzr's sftp transport uses those)
|