Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ropensci/ssh
Native SSH client in R based on libssh
https://github.com/ropensci/ssh
libssh r r-package rstats ssh ssh-client
Last synced: about 2 months ago
JSON representation
Native SSH client in R based on libssh
- Host: GitHub
- URL: https://github.com/ropensci/ssh
- Owner: ropensci
- License: other
- Created: 2017-03-01T18:39:54.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2024-08-23T13:38:39.000Z (4 months ago)
- Last Synced: 2024-08-23T14:30:27.755Z (4 months ago)
- Topics: libssh, r, r-package, rstats, ssh, ssh-client
- Language: C
- Homepage: https://docs.ropensci.org/ssh
- Size: 917 KB
- Stars: 127
- Watchers: 6
- Forks: 21
- Open Issues: 25
-
Metadata Files:
- Readme: README.md
- Changelog: NEWS
- License: LICENSE
Awesome Lists containing this project
- jimsghstars - ropensci/ssh - Native SSH client in R based on libssh (C)
README
# SSH
[](http://www.repostatus.org/#active)
[](http://cran.r-project.org/package=ssh)
[](http://cran.r-project.org/web/packages/ssh/index.html)
> Secure Shell (SSH) Client for R
## Installation
This package is available on CRAN and can be installed via:
```r
install.packages('ssh')
```
Alternatively it can be installed from source using `devtools`:
```r
remotes::install_github('ropensci/ssh')
```
Installation from source on MacOS or Linux requires [`libssh`](https://www.libssh.org/) (the original `libssh`, __not__ the unrelated `libssh2` library). On __Debian__ or __Ubuntu__ use [libssh-dev](https://packages.debian.org/testing/libssh-dev):
```
sudo apt-get install -y libssh-dev
```
On __Fedora__ we need [libssh-devel](https://src.fedoraproject.org/rpms/libssh):
```
sudo yum install libssh-devel
````
On __CentOS / RHEL__ we install [libssh-devel](https://src.fedoraproject.org/rpms/libssh) via EPEL:
```
sudo yum install epel-release
sudo yum install libssh-devel
```
On __OS-X__ use [libssh](https://github.com/Homebrew/homebrew-core/blob/master/Formula/libssh.rb) from Homebrew:
```
brew install libssh
```
Using __conda__ (need a conda R environment `conda create -n Renv r-base r-essentials`)
```
conda install --channel conda-forge r-ssh
```
If you have issues with the conda installation please submit an issue in [`conda-forge/r-ssh-feedstock`](https://github.com/conda-forge/r-ssh-feedstock/issues)
## Getting Started
First create an ssh session by connecting to an SSH server. You can either use private key or passphrase authentication:
```{r}
session <- ssh_connect("[email protected]")
```
You can use the session in subsequent ssh functions below.
### Run a command
Run a command or script on the host while streaming stdout and stderr directly to the client.
```{r}
ssh_exec_wait(session, command = c(
'curl -fOL https://cloud.r-project.org/src/contrib/Archive/jsonlite/jsonlite_1.5.tar.gz',
'R CMD check jsonlite_1.5.tar.gz',
'rm -f jsonlite_1.5.tar.gz'
))
```
If you want to capture the stdout/stderr:
```r
out <- ssh_exec_internal(session, "R -e 'rnorm(100)'")
cat(rawToChar(out$stdout))
```
#### Using 'sudo'
Note that the exec functions are non interactive so they cannot prompt for a sudo password. A trick is to use `-S` which reads the password from stdin:
```
out <- ssh_exec_wait(session, 'echo "mypassword!" | sudo -s -S apt-get update -y')
```
Be very careful with hardcoding passwords!
### Uploading and Downloading via SCP
Upload and download files via SCP. Directories are automatically traversed as in `scp -r`.
```r
# Upload a file to the server
file_path <- R.home("COPYING")
scp_upload(session, file_path)
```
```r
# Download the file back and verify it is the same
scp_download(session, "COPYING", to = tempdir())
tools::md5sum(file_path)
tools::md5sum(file.path(tempdir(), "COPYING"))
```
### Create a Tunnel
Opens a port on your machine and tunnel all traffic to a custom target host via the SSH server.
```r
ssh_tunnel(session, port = 5555,target = "ds043942.mongolab.com:43942")
```
This function blocks while the tunnel is active. Use the tunnel by connecting to `localhost:5555` from a separate process. The tunnel can only be used once and will automatically be closed when the client disconnects.
### Disconnect
When you are done with the session you should disconnect:
```r
ssh_disconnect(session)
```
If you forgot to disconnect, the garbage collector will do so for you (with a warning).