A pretty quick and simple interface to paramiko SFTP

Last update: Dec 21, 2022

Overview

sftpretty

A pretty quick and simple interface to paramiko SFTP. Provides multi-threaded routines with progress notifications for reliable, asynchronous transfers. This is a Python3 optimized fork of pysftp with additional features & improvements.

Built-in retry decorator
Hash function for integrity checking
Improved local & remote directory mapping
Improved logging mechanism
More tests
Multi-threaded directory transfers
Progress notifications
Support for digests & kex connection options
Support for ED25519 & ECDSA keys
Support for private key passwords
Thread-safe connection manager

Example

from sftpretty import Connection


# Basic

with Connection('hostname', username='me', password='secret') as sftp:
    # Temporarily chdir to public/.
    with sftp.cd('public'):
        # Upload file to public/ on remote.
        sftp.put('/my/local/filename')
        # Download a remote file from public/.
        sftp.get('remote_file')


with Connection('hostname', private_key='~/.ssh/id_ed25519',
                            private_key_pass='secret') as sftp:
    # Upload local directory to remote_directory.
    sftp.put_d('/my/local', '/remote_directory')

    # Recursively download a remote_directory and save it to /tmp locally.
    sftp.get_r('remote_directory', '/tmp')


# Advanced

with Connection('hostname', username='me', password='secret') as sftp:
    # Upload local directory to remote_directory. On occurance of any
    # exception or child of, passed in the tuple, retry the operation.
    # Between each attempt increment a pause equal to backoff * delay.
    # Run a total of tries (six) times including the first attempt.
    sftp.put_d('/my/local', '/remote_directory',
               exceptions=(NoValidConnectionsError,
                           socket.timeout,
                           SSHException),
               tries=6, backoff=2, delay=1)


with Connection('hostname', private_key='~/.ssh/id_ed25519',
                            private_key_pass='secret') as sftp:
    # Recursively download a remote_directory and save it to /tmp locally.
    # Don't confirm files, useful in a scenario where the server removes
    # the remote file immediately after download. Preserve remote mtime on
    # local copy
    sftp.get_r('remote_directory', '/tmp', confirm=False,
               preserve_mtime=True)

Additional Information

Project: https://github.com/byteskeptical/sftpretty
Download: https://pypi.python.org/pypi/sftpretty
Documentation: https://sftpretty.rtfd.org
License: BSD

Requirements

paramiko >= 1.17.0

Supports

Tested on Python 3.6, 3.7, 3.8, 3.9

https://travis-ci.org/byteskeptical/sftpretty.svg?branch=master

Comments

put_d() unexpected remote path handling and issue with absolute Windows paths
I found two issues with the put_d() function.

It looks like it doesn't accept absolute Windows paths. I get the error:

ValueError: 'C:\\Users\\johnm\\PycharmProjects\\project\\.other\\folder\\file' does not start with '\\'

When I call put_d("local_folder", "folder"), I get the following error:

File "C:\Users\johnm\PycharmProjects\project\venv\lib\site-packages\sftpretty\__init__.py", line 563, in put confirm=confirm, preserve_mtime=preserve_mtime) File "C:\Users\johnm\PycharmProjects\project\venv\lib\site-packages\sftpretty\__init__.py", line 554, in _put confirm=confirm) File "C:\Users\johnm\PycharmProjects\project\venv\lib\site-packages\paramiko\sftp_client.py", line 759, in put return self.putfo(fl, remotepath, file_size, callback, confirm) File "C:\Users\johnm\PycharmProjects\project\venv\lib\site-packages\paramiko\sftp_client.py", line 714, in putfo with self.file(remotepath, "wb") as fr: File "C:\Users\johnm\PycharmProjects\project\venv\lib\site-packages\paramiko\sftp_client.py", line 372, in open t, msg = self._request(CMD_OPEN, filename, imode, attrblock) File "C:\Users\johnm\PycharmProjects\project\venv\lib\site-packages\paramiko\sftp_client.py", line 822, in _request return self._read_response(num) File "C:\Users\johnm\PycharmProjects\project\venv\lib\site-packages\paramiko\sftp_client.py", line 874, in _read_response self._convert_status(msg) File "C:\Users\johnm\PycharmProjects\project\venv\lib\site-packages\paramiko\sftp_client.py", line 903, in _convert_status raise IOError(errno.ENOENT, text) FileNotFoundError: [Errno 2] Path not found.

As I understand, the path it refers to is the remote path. When I debug it, in put_d(), the paths it creates are the following: As you can see, the remotedir "folder/local_folder/file" is probably the issue. In my remote location, it creates the folder "folder". This of course makes sense as it successfully calls self.mkdir_p(remotedir) in line 599. Do you think this has to do with the location of the self.mkdir_p(remotedir) call? Should there be code that also creates the subfolders of the "local_folder" in the remote location(here the "folder/local_folder" subfolder)?

Thank you for your time.
bug
opened by Johnmaras 9
Add support to use a single channel for all commands. Some servers do…

Certain SFTP server do not allow to open a channel for every command. The original pysftp used a single channel for all actions. I've added a flag to allow us to work in a similar way, while by default keeping the new behavior.

Those servers will simply close the connection on the second command issued and it makes sftpretty not very useful with these old(er) SFTP servers.

opened by erans 5
Typo in argument name - tires/tries

Hi,

In sftpretty/init.py:716 there is a typo in the tries argument which causes the call to putfo() to raise an exception

retry() got an unexpected keyword argument 'tires'

bug

opened by Johnmaras 2
Fix potential `_channel` `UnboundLocalError`

Sometimes when assigning to _channel, an exception can occur in SFTPClient.from_transport(). Because _channel doesn't exist if that happens, it causes a second exception when trying to call close() in the finally block. Assign to the variable outside the try block initially so that this exception can't happen in the future. Also make sure that _channel is not None before we try to close it to account for it being sometimes None.
bug

opened by RobertCochran 1
calling basicConfig at this level for a library that should be embedded changes all dowstream logs

Calling basicConfig on the top of the file for a library that is embedded into other projects can cause issue. I suggest you drop it completely specifically because there are no change to it other than setting the default level to INFO.

https://github.com/byteskeptical/sftpretty/blob/ca8e2414ac156276059fcd091cc91e489d856e7d/sftpretty/init.py#L22

In our case it added ":" to the start of every log line.
enhancement

opened by erans 1

Releases(1.0.5)

1.0.5(Nov 29, 2022)

Version 1.0.5
Source code(tar.gz)
Source code(zip)
1.0.4(Sep 24, 2022)

Version 1.0.4
Source code(tar.gz)
Source code(zip)
1.0.3(Sep 13, 2022)

Version 1.0.3
Source code(tar.gz)
Source code(zip)
1.0.2(Sep 10, 2022)

Version 1.0.2
Source code(tar.gz)
Source code(zip)
1.0.1(Jul 22, 2022)

Version 1.0.1
Source code(tar.gz)
Source code(zip)
1.0.0(Jun 4, 2021)

Source code(tar.gz)
Source code(zip)

Owner

GitHub Repository https://github.com/byteskeptical/sftpretty

Readable, simple and fast asynchronous non-blocking network apps

Fast and readable async non-blocking network apps Netius is a Python network library that can be used for the rapid creation of asynchronous non-block

120 Nov 20, 2022

Asyncer, async and await, focused on developer experience

Asyncer, async and await, focused on developer experience. Documentation: https:

895 Dec 28, 2022

API to establish connection between server and client

Socket-programming API to establish connection between server and client, socket.socket() creates a socket object that supports the context manager ty

1 Oct 30, 2021

A benchmark for stateful fuzzing of network protocols

3 Apr 25, 2022

Tiny JSON RPC via HTTP library.

jrpc Simplest ever possible Asynchronous JSON RPC via HTTP library for Python, backed by httpx. Installation pip install async-jrpc Usage Import JRPC

2 Jan 31, 2022

This is the code repository for the USENIX Security 2021 paper, "Weaponizing Middleboxes for TCP Reflected Amplification".

weaponizing-censors Censors pose a threat to the entire Internet. In this work, we show that censoring middleboxes and firewalls can be weaponized by

119 Dec 31, 2022

Exfiltrate files using the HTTP protocol version ("HTTP/1.0" is a 0 and "HTTP/1.1" is a 1)

http-protocol-exfil Use the HTTP protocol version to send a file bit by bit ("HTTP/1.0" is a 0 and "HTTP/1.1" is a 1). It uses GET requests so the Blu

23 Apr 30, 2022

An HTML interface for finetuning the sync map output from aeneas

finetuneas 3.0 finetuneas is a simple HTML interface for fine tuning sync maps output by aeneas Version 3.0 Easier adjusting time: following cells wil

50 Mar 12, 2022

Arp Spoofer using Python 3.

ARP Spoofer / Wifi Killer By Auax Run: Run the application with the following command: python3 spoof.py -t target_ip_address -lh host_ip_address I

6 Sep 15, 2022

TLD records archive. Revisiting the original TLDR project by mandatoryprogrammer, on the hunt for more root nameserver changes.

tldr A(nother) continuously updated historical TLD records archive. This repository is updated approximately every three hours with the results from D

11 Dec 14, 2022

Fast and configurable script to get and check free HTTP, SOCKS4 and SOCKS5 proxy lists from different sources and save them to files

Fast and configurable script to get and check free HTTP, SOCKS4 and SOCKS5 proxy lists from different sources and save them to files. It can also get geolocation for each proxy and check if proxies a

385 Dec 31, 2022

GhostVPN - Simple and lightweight TUI application for CyberGhostVPN

GhostVPN Simple and lightweight TUI application for CyberGhostVPN. Screenshot Us

5 Jul 27, 2022

Initial code of an A3C network

A3C-network Initial code of an A3C network Open the python file named as "APL452 Project Report2" The following libraries and packages have been insta

0 Jun 11, 2022

This Tool can help enginners and biggener in network, the tool help you to find of any ip with subnet mask that can calucate them and show you ( Availble IP's , Subnet Mask, Network-ID, Broadcast-ID )

This Tool can help enginners and biggener in network, the tool help you to find of any ip with subnet mask that can calucate them and show you ( Availble IP's , Subnet Mask, Network-ID, Broadcast-ID

12 Dec 13, 2022

An advanced real time threat intelligence framework to identify threats and malicious web traffic on the basis of IP reputation and historical data.

ARTIF is a new advanced real time threat intelligence framework built that adds another abstraction layer on the top of MISP to identify threats and malicious web traffic on the basis of IP reputatio

225 Dec 31, 2022

Malcolm is a powerful, easily deployable network traffic analysis tool suite for full packet capture artifacts (PCAP files) and Zeek logs.

1.3k Jan 08, 2023

A pretty quick and simple interface to paramiko SFTP

Related tags

Overview

sftpretty

Example

Additional Information

Requirements

Supports

Comments

put_d() unexpected remote path handling and issue with absolute Windows paths

Add support to use a single channel for all commands. Some servers do…

Typo in argument name - tires/tries

Fix potential `_channel` `UnboundLocalError`

calling basicConfig at this level for a library that should be embedded changes all dowstream logs

Releases(1.0.5)

1.0.5(Nov 29, 2022)

1.0.4(Sep 24, 2022)

1.0.3(Sep 13, 2022)

1.0.2(Sep 10, 2022)

1.0.1(Jul 22, 2022)

1.0.0(Jun 4, 2021)