SSH module |

Provides common user ssh client operations and remote filesystem mounting using sshfs.

/addsshkey/

Add public key

Add a ssh public key to a remote users authorized_keys file.

/keygen/

Generate SSH key pair

/mount/

Mount using sshfs

/resetsshkey/

Reset ssh key

Reset the remote users authorized_keys file to only hold one pub key.
The pub key uploaded should be the current one being used by you.

/ssh/

SSH into remote machine

/tunnel/

• forward
• reverse
• socks
• wrap_reverse

/umount/

Unmount sshfs mountpoint

/wrap/

Wrap other command in SSH call.

You could have a list of remote hosts
to connect through, a.k.a. jump hosts.

Functions

SSH_DEP_INSTALL()

Make sure that OpenSSH is installed.

Returns:

• 0: dependencies found
• 1: failed to find dependencies

SSH()

Connect to remote server over SSH.
Optionally use one or more "jump servers"

Parameters:

• $1: host address, or many space separated addresses if using jump hosts.

• Last address is the final destination host.

• $2: Optional matching list of user names.

• $3: Optional matching list of key files.

• $4: Optional matching list of ports. e.g. "223 22 222"

• $5: Optional matching list of flags. e.g. "q q q"

• $6: Optional shell to use on remote side, leave empty for default

• login shell. e.g. "sh" or "bash".

• $7: Optional command to execute on server, leave blank for interactive shell.

• The parameter lists do not have to be as long as the "hosts" list, if they

• are not then no or a default value is used.

• To put an item in the middle of a list as empty use ''.

• To have a space within a single value, say when using multiple flags,

• put a semicolon ";" between flags, this semicolon will later be substituted for a space.

• We can't put a space directly between flags for the same command since it will be split

• and treated as flags for different commands.

Returns:

• non-zero on error

_SSH_BUILD_COMMAND()

Helper macro

Expects:

• out_sshcommand

• SSH/SSH_FS variables

• Return:

• non-zero on error

SSH_WRAP()

Wrapper over SSH that uses environment
variables instead of positional arguments.

If connecting to multiple hosts the variables must be balanced,
see the SSH function for more information.

Expects:

• SSHHOST:
• SSHUSER: optional
• SSHKEYFILE: optional
• SSHPORT: optional - defaults to 22.
• SSHFLAGS: optional
• SSHSHELL: optional

Returns:

• non-zero on error.

SSH_KEYGEN()

Generate a SSH key pair.

Parameters:

• $1: Path of the private key to create. The pub key will have the prefix ".pub".
• $2: file path where to copy the pub key to after generation (optional).

Returns:

• 0: success
• 1: failure

SSH_FS()

Setup sshfs onto a remote machine, possibly via jump host(s).

Parameters:

• $1: remotepath, path on remote server to mount

• $2: localpath, local path to mount to

• $3: host address, or many space separated addresses if using jump hosts.

• Last address is the final destination host.

• $4: Optional matching list of user names.

• $5: Optional matching list of key files.

• $6: Optional matching list of ports. e.g. "223 22 222"

• $7: Optional matching list of flags. e.g. "q q q"

• $8: Optional shell to use on remote side, leave empty for default

• login shell. e.g. "sh" or "bash".

• $9: Optional command to execute on server, leave blank for interactive shell.

• The parameter lists do not have to be as long as the "hosts" list, if they

• are not then no or a default value is used.

• To put an item in the middle of a list as empty use ''.

Returns:

• non-zero on error

SSH_FS_UMOUNT()

Umount a sshfs mount point.

Parameters:

• $1: local path

SSH_ADD_SSH_KEY()

Add a SSH public key to a users authorized_keys file.

Parameters:

• $1: The name of the existing user to add ssh key file for
• $2: Path to the pub key file to upload for the target user

SSH_RESET_SSH_KEY()

Clear all authorized keys and re-add the current users pub key as the only one.
This is useful to revoke all other admins access to the machine.

Parameters:

• $1: The name if the existing user to add ssh key file for.
• $2: Path to the pub key file to upload for the target user.