sftp_jail

Leverage saz-ssh module to build SFTP jails

49,608 downloads

203 latest version

5.0 quality score

Version information

  • 5.0.0 (latest)
  • 4.1.0
  • 4.0.0
  • 3.0.0
  • 2.0.2
  • 2.0.1
  • 2.0.0
  • 1.1.0
  • 1.0.0
released Mar 7th 2025
This version is compatible with:
  • Puppet Enterprise 2025.4.x, 2025.3.x, 2025.2.x, 2025.1.x, 2023.8.x, 2023.7.x, 2023.6.x, 2023.5.x, 2023.4.x, 2023.3.x, 2023.2.x, 2023.1.x, 2023.0.x, 2021.7.x, 2021.6.x, 2021.5.x, 2021.4.x, 2021.3.x, 2021.2.x, 2021.1.x, 2021.0.x
  • Puppet >= 7.0.0 < 9.0.0
  • RedHat
    ,
    CentOS
    ,
    Rocky
    ,
    AlmaLinux
    ,
    Debian
    ,
    Ubuntu

Start using this module

  • r10k or Code Manager
  • Bolt
  • Manual installation
  • Direct download

Add this module to your Puppetfile:

mod 'puppet-sftp_jail', '5.0.0'
Learn more about managing modules with a Puppetfile

Add this module to your Bolt project:

bolt module add puppet-sftp_jail
Learn more about using this module with an existing project

Manually install this module globally with Puppet module tool:

puppet module install puppet-sftp_jail --version 5.0.0

Direct download is not typically how you would use a Puppet module to manage your infrastructure, but you may want to download the module in order to inspect the code.

Download

Documentation

puppet/sftp_jail — version 5.0.0 Mar 7th 2025

sftp_jail

CI Code Coverage Puppet Forge Puppet Forge - downloads Puppet Forge - endorsement Puppet Forge - scores License

Overview

This module leverages saz-ssh to more easily create a more robust-ier SFTP jail. Because of how SSH key pairs work in Linux, this module creates a home dir for each jail user, so that keys can be added to authorized_keys and a homedir assigned without the nasty problem of the user escaping from the jail and landing in / because of a mistaken homedir assignment.

Usage

Create sftp_jail::jail resources to create jails. Each jail has one main user. If you need more then one user in a jail, create sftp_jail::user resources for additional users and pass the correct jail to it.

Changelog

see CHANGELOG.md

References

see REFERENCE.md