Metadata-Version: 2.1
Name: sshnpd
Version: 0.4.2
Summary: Python implementation of SSH No Ports daemon
Home-page: https://github.com/atsign-foundation/noports
Author: Xavier Lin
Author-email: xavier.lin@atsign.com 
Maintainer: Chris Swan
Maintainer-email: chris@atsign.com
Requires-Python: >=3.10,<4.0
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Requires-Dist: PyNaCl (>=1.5.0,<2.0.0)
Requires-Dist: atsdk (>=0.2.3,<0.3.0)
Requires-Dist: bcrypt (>=4.0.1,<5.0.0)
Requires-Dist: cffi (>=1.15.1,<2.0.0)
Requires-Dist: cryptography (>=42.0.2,<43.0.0)
Requires-Dist: paramiko (==3.4.0)
Requires-Dist: pycparser (>=2.21,<3.0)
Requires-Dist: setuptools (>=69.0.0,<70.0.0)
Description-Content-Type: text/markdown

<h1><img width=250px src="https://atsign.dev/assets/img/atPlatform_logo_gray.svg?sanitize=true" alt="The atPlatform logo"></h1>

[![GitHub License](https://img.shields.io/badge/license-BSD3-blue.svg)](./LICENSE)

# SSHNPD Python

SSH No Ports provides a way to ssh to a remote linux host/device without that
device or the client having any open ports (not even 22) on external
interfaces. All network connectivity is outbound and there is no need to
know the IP address the device has been given. As long as the device and
client has an IP address (public or private 1918), DNS and Internet access,
you will be able to connect to it.

This version is SSHNP Daemon written in Python, it is still in its beta
stage of developement.

## Prerequisites

SSHNPD Python requires the following:

* 2 atsigns, one for the client and one for the device
* any machine with sshd running and python3 installed
* atsdk installed

## Installation

This package can be installed from PyPI with:

```sh
pip install sshnpd
```

Alternatively clone this repo and from the repo root:

```sh
cd packages/python/sshnpd
pip install -r requirements.txt
pip install .
```

## Running the program

```sh
sshnpd -m @{clientAtsign} -a @{deviceAtsign} -d {deviceName}
```

## No Ports SDK Python (experimental)

There is a simple python SDK which allows you to create scripts for common
administrative patterns via SSH No Ports.

