Codeception Secure Shell

The Codeception module for SSH commands, SFTP access and SSH tunnels

If you just need a SFTP connection, please consider the in-built Codeception FTP module.

Roadmap

• 0.1: Basic commands for testing remote file system and commands
• 0.2: Tunnel commands
• 0.3: Services and advanced commands

Minimum Requirements

• Codeception 2.2
• PHP 5.6
• Extension SecureShell2

Installation

The module can be installed using Composer

$ composer require edno/codeception-secureshell

Be sure to enable the module as shown in configuration below.

Configuration

Enabling Secure Shell is done in your configuration file .yml.

module:
    enabled:
        - Codeception\Extension\SecureShell

Parameters

By default the module always accepts the host public key fingerprint.

You can enable a strict mode where only known hosts will be accepted by setting the configuration parameter StrictHostKeyChecking to true.
Once enabled, the module will verify the host fingerprint against a known_hosts file located at the root directory of your Codeception project.

modules:
    config:
        Codeception\Extension\SecureShell:
            StrictHostKeyChecking: true

If you want to reuse an existing known_hosts file, you can use the parameter KnownHostsFile for specifying the location of the file.

modules:
    config:
        Codeception\Extension\SecureShell:
            StrictHostKeyChecking: true
            KnownHostsFile: '/etc/ssh/known_hosts'

The file must respect the OpenSSH ~/.ssh/known_hosts format.

Documentation

Documentation is available in the wiki List of commands and methods.