sshmitm.forwarders.sftp module
- class sshmitm.forwarders.sftp.SFTPBaseHandle(session, plugin, filename, flags=0)
Bases:
SFTPHandle
- Parameters:
session (sshmitm.session.Session)
plugin (
Type
[SFTPHandlerBasePlugin
])filename (
str
)flags (
int
, default:0
)
- close()
When a client closes a file, this method is called on the handle. Normally you would use this method to close the underlying OS level file object(s).
The default implementation checks for attributes on
self
namedreadfile
and/orwritefile
, and if either or both are present, theirclose()
methods are called. This means that if you are using the default implementations of read and write, this method’s default implementation should be fine also.- Return type:
None
- read(offset, length)
Read up to
length
bytes from this file, starting at positionoffset
. The offset may be a Python long, since SFTP allows it to be 64 bits.If the end of the file has been reached, this method may return an empty string to signify EOF, or it may also return
SFTP_EOF
.The default implementation checks for an attribute on
self
namedreadfile
, and if present, performs the read operation on the Python file-like object found there. (This is meant as a time saver for the common case where you are wrapping a Python file object.)- Parameters:
offset (
int
) – position in the file to start reading from.length (
int
) – number of bytes to attempt to read.length
- Return type:
Union
[bytes
,int
]- Returns:
the bytes read, or an error code int.
- write(offset, data)
Write
data
into this file at positionoffset
. Extending the file past its original end is expected. Unlike Python’s normalwrite()
methods, this method cannot do a partial write: it must write all ofdata
or else return an error.The default implementation checks for an attribute on
self
namedwritefile
, and if present, performs the write operation on the Python file-like object found there. The attribute is named differently fromreadfile
to make it easy to implement read-only (or write-only) files, but if both attributes are present, they should refer to the same file.- Parameters:
offset (
int
) – position in the file to start reading from.data (ReadableBuffer) – data to write into the file.
data
- Return type:
int
- Returns:
an SFTP error code like
SFTP_OK
.
- class sshmitm.forwarders.sftp.SFTPHandlerBasePlugin(sftp, filename)
Bases:
BaseModule
- Parameters:
sftp (
SFTPBaseHandle
)filename (
str
)
- close()
- Return type:
None
- classmethod get_file_handle()
- Return type:
Type
[SFTPBaseHandle
]
- classmethod get_interface()
- Return type:
Optional
[Type
[BaseSFTPServerInterface
]]
- handle_data(data, *, offset=None, length=None)
- Parameters:
data (
bytes
)offset (
Optional
[int
], default:None
)length (
Optional
[int
], default:None
)
- Return type:
bytes
- class sshmitm.forwarders.sftp.SFTPHandlerPlugin(sftp, filename)
Bases:
SFTPHandlerBasePlugin
transfer files from/to remote sftp server
- Parameters:
sftp (
SFTPBaseHandle
)filename (
str
)