https://github.com/cconstab/traversable-worm-hole-tools

Simple Inter machine encrypted communication across IP networks WITHOUT open ports or network address translation
https://github.com/cconstab/traversable-worm-hole-tools

Last synced: 4 days ago
JSON representation

Simple Inter machine encrypted communication across IP networks WITHOUT open ports or network address translation

• Host: GitHub
• URL: https://github.com/cconstab/traversable-worm-hole-tools
• Owner: cconstab
• License: bsd-3-clause
• Created: 2024-08-02T20:52:52.000Z (5 months ago)
• Default Branch: trunk
• Last Pushed: 2024-11-29T17:01:21.000Z (about 1 month ago)
• Last Synced: 2024-12-29T21:06:12.561Z (7 days ago)
• Language: Dart
• Size: 2.63 MB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: code_of_conduct.md
  • Security: SECURITY.md

Awesome Lists containing this project

README

        








# Digital traversable wormhole tools

Simple tools that use Atsign's atSDK that feel like a digital traversable wormhole between machines

## Who is this for?

Anyone wanting some simple,private and secure ways to get data from one machine to another

### Contributor

This code is useful as a starting point for other tools or just to be used in thier own right.

[CONTRIBUTING.md](CONTRIBUTING.md) is going to have the detailed guidance

on how to setup their tools, tests and how to make a pull request.

## Why, What, How?

### Why?

In DevSecOps we often need tools to get files like certificates or keys from one place to another. This is often troublesome as you need to send encrypted but either networking or the lack of encryption keys gets in the way of transfering these small but critical files around safely.

### What?

The code is written in Dart but the GitHub Action produces binaries for Mac/Linux and Windows

### How?

To use the code/binaries

**Full instructions are** [here](https://github.com/cconstab/traversable-worm-hole-tools/tree/trunk/packages/dart/twh_tools)

**TL;DR**

Get two atSigns from my.atsign.com

activate the atSigns using `at_activate` on your local machine get keys setup on the remote machine using `at_activate` then use the put/get and pub/sub tools. 

`twh_put`/`twh_get` allow the sending/receiving of a simple string

`twh_pub`/`twh_sub` allow the sending/receiving of streams of strings

## Maintainers

Created by Colin Constable but on the shoulders of giants at Atsign