ssh4iot

Easy way to configure and register reverse ssh tunnels for iot devices by key sharing over https to manage and enjoy

PRERELEASE

Installation

Add this line to your application's Gemfile:

gem 'ssh4iot'

And then execute:

$ bundle install

Or install it yourself as:

$ gem install ssh4iot

Usage

TODO: Write usage instructions here

Development

After checking out the repo, run bin/setup to install dependencies. Then, run rake spec to run the tests. You can also run bin/console for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run bundle exec rake install. To release a new version, update the version number in version.rb, and then run bundle exec rake release, which will create a git tag for the version, push git commits and tags, and push the .gem file to rubygems.org.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/ssh4iot. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the code of conduct.

License

The gem is available as open source under the terms of the MIT License.

Code of Conduct

Everyone interacting in the Ssh4iot project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.

Intoduction

When deploying several iot devices on a private network and there is a need to manage them centrally for updates and administration. While the most appropriate way of interacting with these devices is through ssh connections there are many conciderations when the number of appliances grows beyond a couple of devices. More over we need to group these appliances into groups based on some organizational criteria namelly to split up administration. We aim at minimizing the setup needs for the appliances to:

  1. the server address
  2. one shared api token per deployment group for the initial setup
  3. one identifier per device

Architecture

  • Server:
  • Web application/administration
  • Repository
  • one user per deployment group

  • ssh server

  • Client:

  • Client application

  • one user per client device

  • autossh

Considerations

  1. initial setup
  2. networking and wifi registration
  3. security

Implementation

Case Study

Given a deployment which uses many Raspberry Pi's with SenseHat to collect environmental measuremements from an number of buildings, storing them in a central data base, we need an easy way to register and manage devices

References

https://xtermjs.org/ https://github.com/huashengdun/webssh https://github.com/stuicey/SSHy

https://www.rubydoc.info/github/net-ssh/net-ssh/Net/SSH https://net-ssh.github.io/net-ssh/