Commit b7b4dc0d authored by Viktor Szakats's avatar Viktor Szakats Committed by Jay Satiro
Browse files

ssh: add the ability to enable compression (for SCP/SFTP) 

The required low-level logic was already available as part of
`libssh2` (via `LIBSSH2_FLAG_COMPRESS` `libssh2_session_flag()`[1]
option.)

This patch adds the new `libcurl` option `CURLOPT_SSH_COMPRESSION`
(boolean) and the new `curl` command-line option `--compressed-ssh`
to request this `libssh2` feature. To have compression enabled, it
is required that the SSH server supports a (zlib) compatible
compression method and that `libssh2` was built with `zlib` support
enabled.

[1] https://www.libssh2.org/libssh2_session_flag.html

Ref: https://github.com/curl/curl/issues/1732
Closes https://github.com/curl/curl/pull/1735
parent d18941ea

docs/cmdline-opts/Makefile.inc

+2 −1
Original line number Diff line number Diff line 
# Shared between Makefile.am and CMakeLists.txt



DPAGES = abstract-unix-socket.d anyauth.d append.d basic.d cacert.d capath.d cert.d \

  cert-status.d cert-type.d ciphers.d compressed.d config.d             \

  cert-status.d cert-type.d ciphers.d compressed.d compressed-ssh.d     \

  config.d                                                              \

  connect-timeout.d connect-to.d continue-at.d cookie.d cookie-jar.d    \

  create-dirs.d crlf.d crlfile.d data-ascii.d data-binary.d data.d      \

  data-raw.d data-urlencode.d delegation.d digest.d disable.d           \

docs/cmdline-opts/compressed-ssh.d

0 → 100644
+6 −0
Original line number Diff line number Diff line 
Long: compressed-ssh

Help: Enable SSH compression

Protocols: SCP SFTP

---

Enables built-in SSH compression.

This is a request, not an order; the server may or may not do it.

docs/libcurl/curl_easy_setopt.3

+2 −0
Original line number Diff line number Diff line
@@ -547,6 +547,8 @@ Disable GSS-API delegation. See \fICURLOPT_GSSAPI_DELEGATION(3)\fP 
.SH SSH OPTIONS

.IP CURLOPT_SSH_AUTH_TYPES

SSH authentication types. See \fICURLOPT_SSH_AUTH_TYPES(3)\fP

.IP CURLOPT_SSH_COMPRESSION

Enable SSH compression. See \fICURLOPT_SSH_COMPRESSION(3)\fP

.IP CURLOPT_SSH_HOST_PUBLIC_KEY_MD5

MD5 of host's public key. See \fICURLOPT_SSH_HOST_PUBLIC_KEY_MD5(3)\fP

.IP CURLOPT_SSH_PUBLIC_KEYFILE

docs/libcurl/opts/CURLOPT_SSH_COMPRESSION.3

0 → 100644
+58 −0
Original line number Diff line number Diff line 
.\" **************************************************************************

.\" *                                  _   _ ____  _

.\" *  Project                     ___| | | |  _ \| |

.\" *                             / __| | | | |_) | |

.\" *                            | (__| |_| |  _ <| |___

.\" *                             \___|\___/|_| \_\_____|

.\" *

.\" * Copyright (C) 1998 - 2017, Daniel Stenberg, <daniel@haxx.se>, et al.

.\" *

.\" * This software is licensed as described in the file COPYING, which

.\" * you should have received as part of this distribution. The terms

.\" * are also available at https://curl.haxx.se/docs/copyright.html.

.\" *

.\" * You may opt to use, copy, modify, merge, publish, distribute and/or sell

.\" * copies of the Software, and permit persons to whom the Software is

.\" * furnished to do so, under the terms of the COPYING file.

.\" *

.\" * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY

.\" * KIND, either express or implied.

.\" *

.\" **************************************************************************

.\"

.TH CURLOPT_SSH_COMPRESSION 3 "05 Aug 2017" "libcurl 7.56.0" "curl_easy_setopt options"

.SH NAME

CURLOPT_SSH_COMPRESSION \- enables automatic decompression of HTTP downloads

.SH SYNOPSIS

#include <curl/curl.h>



CURLcode curl_easy_setopt(CURL *handle, CURLOPT_SSH_COMPRESSION, long enable);

.SH DESCRIPTION

Pass a long as parameter to enable or disable.



Enables built-in SSH compression.

This is a request, not an order; the server may or may not do it.

.SH DEFAULT



.SH PROTOCOLS

All SSH based protocols: SCP, SFTP

.SH EXAMPLE

.nf

CURL *curl = curl_easy_init();

if(curl) {

  curl_easy_setopt(curl, CURLOPT_URL, "sftp://example.com");



  /* enable built-in compression */

  curl_easy_setopt(curl, CURLOPT_SSH_COMPRESSION, 1L);



  /* Perform the request */

  curl_easy_perform(curl);

}

.fi

.SH AVAILABILITY

Added in 7.56.0

.SH RETURN VALUE

Returns CURLE_OK if the option is supported, CURLE_UNKNOWN_OPTION if not, or

CURLE_OUT_OF_MEMORY if there was insufficient heap space.

.SH "SEE ALSO"

.BR CURLOPT_ACCEPT_ENCODING "(3), " CURLOPT_TRANSFER_ENCODING "(3), "

docs/libcurl/opts/Makefile.inc

+1 −0
Original line number Diff line number Diff line
@@ -258,6 +258,7 @@ man_MANS = \ 
  CURLOPT_SOCKS5_GSSAPI_NEC.3                   \

  CURLOPT_SOCKS5_GSSAPI_SERVICE.3               \

  CURLOPT_SSH_AUTH_TYPES.3                      \

  CURLOPT_SSH_COMPRESSION.3                     \

  CURLOPT_SSH_HOST_PUBLIC_KEY_MD5.3             \

  CURLOPT_SSH_KEYDATA.3                         \

  CURLOPT_SSH_KEYFUNCTION.3                     \