Skip to main content

Tool to find ssh-able devices on your network.

Project description

Find SSH-able

Python application

Find SSH-able devices on your network and (optionally) add them to you ssh config in a cleanish way. Tested locally with MacOS and runs with Actions on Ubuntu.

Setup

  1. Install nmap

    # MacOS
    brew install nmap
    # Debian
    sudo apt-get install nmap
    
  2. (optional / recommended) create a python virtual env and activate it.

  3. pip isntall

    pip install find-sshable
    
  4. Run the program

    find-sshable --help
    

Testing

# pip install pytest
PYTHONPATH=. pytest -vs .

Headless Raspberry Pi

The idea is to stand up a headless raspberry pi that you can ssh into and do things on.

If you will run this on Wifi (not ethernet), start from here to configure the WiFi on your raspberry pi. However, if you can connect to ethernet, I would recommend doing so, and you can skip this step.

As per here add an empty ssh file to the root partition when you frist boot up.

Locally run the following. This will find and add your Pi to the local ssh config.

find-sshable --host-pattern "raspberrypi" --update-ssh-config --ssh-user "pi"
    scanning for devices... 00:15

    Found 2 devices...
    Host(name='raspberrypi.lan', ip=IPv4Address('192.168.86.20'))
    Host(name='raspberrypi.lan', ip=IPv4Address('192.168.86.36'))

    Devices will be added to your ssh config as follows
    find-sshable.raspberrypi.lan-0    192.168.86.20
    find-sshable.raspberrypi.lan-1    192.168.86.36

ssh into it,

ssh find-sshable.raspberrypi.lan-0

On there, you should change your password, update locale, etc

sudo raspi-config

Also ensure that ssh runs on start up

sudo systemctl enable ssh
sudo systemctl start ssh

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

find-sshable-0.2.0.tar.gz (18.1 kB view details)

Uploaded Source

Built Distribution

find_sshable-0.2.0-py3-none-any.whl (18.9 kB view details)

Uploaded Python 3

File details

Details for the file find-sshable-0.2.0.tar.gz.

File metadata

  • Download URL: find-sshable-0.2.0.tar.gz
  • Upload date:
  • Size: 18.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.7.1 importlib_metadata/4.10.0 pkginfo/1.8.2 requests/2.27.1 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.9.9

File hashes

Hashes for find-sshable-0.2.0.tar.gz
Algorithm Hash digest
SHA256 0d06e9315194183648ec8471ed080b13960889351d03bd2f7e62d2edcc19da2b
MD5 0d545247e19b39ac10fd986c7a77a245
BLAKE2b-256 17314610c05408bab8e77be30158aae8fd7502c1beb68390ba77a18742e13709

See more details on using hashes here.

File details

Details for the file find_sshable-0.2.0-py3-none-any.whl.

File metadata

  • Download URL: find_sshable-0.2.0-py3-none-any.whl
  • Upload date:
  • Size: 18.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.7.1 importlib_metadata/4.10.0 pkginfo/1.8.2 requests/2.27.1 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.9.9

File hashes

Hashes for find_sshable-0.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 bc23d0b1e413d514d9ded1a801ff28a702aedc3a0882317679c7a9188a43a825
MD5 501b8e9cdb175b629369a7b06f61b4bb
BLAKE2b-256 335e464e0dcdd58eef227b3edb2ac8a43964c15a994bc2bf1162a9f594123c84

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page