README
¶
nssh
SSH client for SORACOM Napter. You can easily open an SSH connection with your subscriber's name.
Napter is an on-demand networking service for devices using Soracom Air for Cellular SIM cards, which enables you to quickly and securely access your devices remotely. Napter allows you to perform remote maintenance, troubleshooting, or other typical remote access tasks, without setting up any relay servers or installing agent software on the device.
Install
- Download the archive for your platform and architecture from Releases section.
- Unpack the archive.
- Move the executable to one of your
PATHdirectories.
Or you can build executable from the source:
$ git clone https://github.com/0x6b/nssh
$ cd nssh
$ make # and you'll get `nssh` under the root directory
Usage
One-time Setup
- Create a SAM user with following permission:
{ "statements": [ { "api": [ "Auth:auth", "Subscriber:listSubscribers", "PortMapping:listPortMappingsForSubscriber", "PortMapping:createPortMapping" ], "effect": "allow" } ] } - Generate authentication key for the user.
- Save the authentication information at
$HOME/.soracom/ssh.json.{ "coverageType": "jp", // or "g" for global "authKeyId": "keyId-xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx", "authKey": "secret-xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx" } - Name your desired SIM at SORACOM User Console.
Connect
$ nssh connect pi@your-sim-name
You can specify coverage type, profile name, port number, connection duration, or identity file for SSH public key authentication. See nssh connect --help.
- Override coverage type,
jporglobal:$ nssh --coverage-type global connect pi@your-sim-name - Use another profile under
$HOME/.soracom/directory, without extension.json:$ nssh --profile-name default connect pi@your-sim-name - Use public key authentication:
$ nssh connect pi@your-sim-name -i ~/.ssh/id_rsa - Specify another port number and connection duration:
$ nssh connect pi@your-sim-name --port 2222 --duration 120
References
- Japanese
- English
License
MIT. See LICENSE for details.
Privacy
This program will send requests to following services:
- https://checkip.amazonaws.com/, to determine your global IP address.
- https://g.api.soracom.io (Global coverage) or https://api.soracom.io (Japan coverage), to use SORACOM services
Other than that, the program does not send user action/data to any server. Please consult each provider's privacy notices.
Enjoy remote connection with SORACOM Napter!
Documentation
¶
Index ¶
- Constants
- func GetIP() (net.IP, error)
- type PortMapping
- type SoracomClient
- func (c *SoracomClient) Connect(login, identity string, portMapping *PortMapping) error
- func (c *SoracomClient) CreatePortMappingsForSubscriber(subscriber Subscriber, port, duration int) (*PortMapping, error)
- func (c *SoracomClient) FindPortMappingsForSubscriber(subscriber Subscriber) ([]PortMapping, error)
- func (c *SoracomClient) FindSubscribersByName(name string) ([]Subscriber, error)
- type Subscriber
Constants ¶
const SIGWINCH = syscall.SIGWINCH
Variables ¶
This section is empty.
Functions ¶
Types ¶
type PortMapping ¶
type PortMapping struct {
Duration int `json:"duration"` // duration in seconds
Endpoint string `json:"endpoint"` // SORACOM Napter endpoint
Hostname string `json:"hostname"` // SORACOM Napter hostname
IPAddress string `json:"ipAddress"` // SORACOM Napter IP address
Port int `json:"port"` // SORACOM Napter port number
TLSRequired bool `json:"tlsRequired"` // is TLS required
Destination struct {
Imsi string `json:"imsi"` // target IMSI
Port int `json:"port"` // target port
} `json:"destination"`
Source struct {
IPRanges []string `json:"ipRanges"` // permitted source CIDRs
} `json:"source"`
}
A PortMapping represents SORACOM Napter port mapping
func (PortMapping) String ¶
func (pm PortMapping) String() string
type SoracomClient ¶
type SoracomClient struct {
APIKey string // API key
Token string // API token
Client *http.Client
Endpoint string
}
A SoracomClient represents an API client for SORACOM API. See https://developers.soracom.io/en/docs/tools/api-reference/ or https://dev.soracom.io/jp/docs/api_guide/
func NewSoracomClient ¶
func NewSoracomClient(coverageType, profileName string) (*SoracomClient, error)
NewSoracomClient returns new SoracomClient for caller
func (*SoracomClient) Connect ¶
func (c *SoracomClient) Connect(login, identity string, portMapping *PortMapping) error
Connect connects to specified port mapping with login name and identity. If identity is specified, use it for public key authentication. If not, use password authentication instead.
func (*SoracomClient) CreatePortMappingsForSubscriber ¶
func (c *SoracomClient) CreatePortMappingsForSubscriber(subscriber Subscriber, port, duration int) (*PortMapping, error)
CreatePortMappingsForSubscriber creates port mappings for specified subscriber, port, and duration
func (*SoracomClient) FindPortMappingsForSubscriber ¶
func (c *SoracomClient) FindPortMappingsForSubscriber(subscriber Subscriber) ([]PortMapping, error)
FindPortMappingsForSubscriber finds port mappings for specified subscriber
func (*SoracomClient) FindSubscribersByName ¶
func (c *SoracomClient) FindSubscribersByName(name string) ([]Subscriber, error)
FindSubscribersByName finds subscribers which has the specified name
type Subscriber ¶
type Subscriber struct {
Imsi string `json:"imsi"` // IMSI of the subscriber
Subscription string `json:"subscription"` // subscription e.g. plan01s, plan-D
Type string `json:"type"` // speed class e.g. s1.4xfast
SessionStatus struct {
Online bool `json:"online"` // represents subscriber is online or not
} `json:"sessionStatus"`
Tags struct {
Name string `json:"name,omitempty"` // name of the subscriber
} `json:"tags"`
}
A Subscriber represents a SORACOM IoT SIM
func (Subscriber) String ¶
func (s Subscriber) String() string
Source Files
Directories