SSH (password-based auth) API Integrations

Overview#

The SSH (Secure Shell) API provides users with a secure and reliable way to connect to a remote server. This can be used to connect to remote systems and transfer data and files, as well as manage and configure remote systems. With the SSH API, you can authenticate with a password-based authentication.

This is a powerful tool for managing remote systems and networks, providing a secure and efficient way to access and manage resources. You can use the SSH API to build the following applications and services:

Remote Tunneling/Port Forwarding - Create secure tunnels over a network, allowing traffic to pass through a secure port.
File Transfers - Move files securely to and from remote systems.
System/Network Management - Manage and configure remote hosts, networks, and systems.
Remote System Backup/Restore - Create secure backups of systems and networks, and restore them in case of an emergency.
Scripting/Automation - Automate administrative and maintenance tasks.
Secure Shell Hosting - Create and host secure shell servers, allowing users to connect securely to remote systems and networks.
Secure Network Tunneling - Create secure tunnels over an existing network, allowing encrypted traffic to pass through.
Secure Chat - Create secure chat servers, allowing users to communicate securely through an encrypted channel.
Secure File Storage - Create secure file storage solutions, allowing users to store their data securely behind encryption.
Secure VPN - Create secure Virtual Private Network (VPN) systems, allowing users to remotely connect securely to remote networks.

1

2

3

4

5

6

7

8

9

10

11

12

13

14

15

16

17

18

19

20

21

22

23

24

25

26

27

28

29

30

31

32

33

34

35

module.exports = defineComponent({
  props: {
    ssh_password_based_auth: {
      type: "app",
      app: "ssh_password_based_auth",
    }
  },
  async run({steps, $}) {
    const SSH2Promise = require('ssh2-promise')
    
    const { 
      host, 
      port,
      username, 
      password,
    } = this.ssh_password_based_auth.$auth
    
    const ssh = new SSH2Promise({
      host,
      port,
      username,
      password,
    })
    
    await ssh.connect()
    console.log("Connection established")
    
    // Replace this with the command you'd like to run
    const resp = await ssh.exec("whoami")
    console.log(resp)
    
    await ssh.close()
  },
})