ssh

Table of Contents

1. Overview
2. Module Description - What the module does and why it is useful
3. Setup - The basics of getting started with ssh
   • What ssh affects
   • Setup requirements
   • Beginning with ssh
4. Usage - Configuration options and additional functionality
   • Manage client and server
   • SSH client
   • SSH Server
5. Reference - An under-the-hood peek at what the module is doing and how
   • Classes
6. Limitations - OS compatibility, etc.
7. Development - Guide for contributing to the module

Overview

This module installs and manages openssh-client and openssh-server

Module Description

This module uses augeas to manage sshd_config and file_line to manage ssh_config

Setup

What ssh affects

• installs ssh client packages
• installes ssh server pacvkages
• manages /etc/ssh/ssh_config
• manages /etc/ssh/sshd_config

Setup Requirements OPTIONAL

• stdlib 4.6.0

Beginning with ssh

just add the ssh class

class {'::ssh' }

Usage

Manage client and server

The main ssh class has two parameters to allow you to decide if you want to manage both the client and the server.

class {'::ssh' 
  manage_client => false,
  manage_server => true,
}

of with hiera

ssh::manage_client: false
ssh::manage_server: true

SSH Client

The ssh client currently only supports CheckHostIP

class {'::ssh::client' 
  check_host_ip => true,
}

of with hiera

ssh::client::check_host_ip: true

SSH Server

The ssh server class manages a reduced set of parameters used by sshd

class {'::ssh::server' 
  password_authentication => false,
  x11_forwading           => false,
}

of with hiera

ssh::server::password_authentication: false
ssh::server::x11_forwading: false

Reference

Classes

Public Classes

• ssh
• ssh::client
• ssh::server

Private Classes

• ssh::params

Class: ssh

Main class, includes all other classes

Parameters (all optional)

• manage_client: run ssh::client. Valid options: 'true' and 'false'. Default: 'false'.
• manage_server: run ssh::server. Valid options: 'true' and 'false'. Default: 'false'.

Class: ssh::client

Manage openssh client

Parameters (all optional)

• package: Specifies the package to install. Valid options: string. Default: os specific
• check_host_ip: Specifies whether to set CheckHostIP. Valid options: 'true' and 'false'. Default: 'false'.

Class: ssh::server

Manage openssh server

Parameters (all optional)

• package: Specifies the package to install. Valid options: string. Default: os specific
• challenge_response_authentication: Specifies whether to set ChallengeResponseAuthentication. Valid options: 'true' and 'false'. Default: 'false'.
• password_authentication: Specifies whether to set PasswordAuthentication. Valid options: 'true' and 'false'. Default: 'true'.
• x11_forwading: Specifies whether to set X11Forwarding. Valid options: 'true' and 'false'. Default: 'true'.
• print_mod: Specifies whether to set PrintMotd. Valid options: 'true' and 'false'. Default: 'false'.

Limitations

This is where you list OS compatibility, version compatibility, etc.

Development

This module is tested on Ubuntu 12.04, and 14.04 and FreeBSD 10