Data access to s3 with WinSCP

Table of contents

Overview

WinSCP is a client tool for Microsoft Windows. It allows for managing files between a local computer and remote servers. As Provena data is stored in AWS S3 buckets WinSCP can be used to transfer data to and from the data store.


Authentication


Required inputs to establish connection

You can obtain authentication parameters from a dataset record from within the Provena Data Store. Select a target preconfigure dataset and then the ‘Upload Data’ tab. Then click the ‘Generate Credentials’ button. You will notice that there are three parts to the credentials.

  1. AWS_ACCESS_KEY_ID
  2. AWS_SECRET_ACCESS_KEY
  3. AWS_SESSION_TOKEN

Also on Step 4. you will notice a command similar to aws s3 ls s3://rrap-storage-bucket/datasets/10378-1-#######/ from this command you will require just the data path including forward slashes /rrap-storage-bucket/datasets/10378-1-#######/. Replace the ## with your records handle id.

These are the requirements to establish a connection


Establishing a connection to Data Store S3 with WinSCP

Open WinSCP and the Login dialog will appear, on the dialog enter the above credentials.

  1. Make sure the ‘New site node’ is selected
  2. On the New site node, select Amazon S3 as the ‘File protocol’
  3. Check that the host name is: s3.amazonaws.com and the port number is 443
  4. Enter your AWS user ‘Access key ID’ and ‘Secret access key’ values (without quote marks)
  5. Click the ‘Advanced’ button
  6. Select ‘Directories’
  7. Enter the above data path e.g. /rrap-storage-bucket/datasets/10378-1-#######/ replace the # with your handle id
  8. Select ‘S3’
  9. Enter your ‘AWS_SESSION_TOKEN’ as the ‘Security Token’
  10. Click ‘Ok’ on the Advanced Site Settings Dialog
  11. Click ‘Login’ on the Login Dialog
WinSCP Login
drawing
WinSCP Login (Advance settings)
drawing

Uploading

  1. Select folders or files for uploading
  2. Select the destination folder on the remote server (This MUST be YOUR registered dataset)
  3. Select Upload
Uploading
drawing

Downloading

  1. Select folder or file from the remote server
  2. Ensure you have selected the local folder to receive the download
  3. Select Download
Downloading
drawing