NYCPlanning / NYCPlanning/data-engineering
SFTP Connector: Utility for Pulling Known Hosts & Private Keys to Local
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 43
- Forks
- 3
- Avg merge
- 23h 3m
- Merged PRs (30d)
- 44
Description
Basically the title.
The current implementation of the SFTP connector assumes the presence of the following:
- env vars for: host name, username, path where to find known hosts key file, and a path where to find private key file
- the key files being actually present in the paths listed in the env vars.
So, we are currently missing a code utility that will go grab the key files from 1Password and download them to the desired paths. This utility then could be added as a step before interacting with an sftp server via our connector. OR, maybe 1Password has an out-of-the box solution and we just need to know how to use it.
Acceptance criteria:
- being able to add a step using the utility that will download the keys to a local machine.
See this comment as an idea for the implementation.
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reading the current SFTP connector and the implementation idea in issue 1270's linked comment. Determine how 1Password access and the local destination paths should be handled, then add a usable step that downloads the known-hosts and private-key files before SFTP interaction. Done means the utility can be added as a step and places both keys at the paths expected by the connector.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- infrastructure
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 38/100