https://github.com/voxpupuli/puppet-sftp_jail

https://github.com/voxpupuli/puppet-sftp_jail

centos-puppet-module debian-puppet-module hacktoberfest linux-puppet-module puppet redhat-puppet-module ubuntu-puppet-module

Last synced: 3 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/voxpupuli/puppet-sftp_jail
• Owner: voxpupuli
• License: apache-2.0
• Created: 2016-03-25T00:15:45.000Z (about 9 years ago)
• Default Branch: master
• Last Pushed: 2024-09-17T07:27:32.000Z (8 months ago)
• Last Synced: 2025-02-02T18:44:07.180Z (3 months ago)
• Topics: centos-puppet-module, debian-puppet-module, hacktoberfest, linux-puppet-module, puppet, redhat-puppet-module, ubuntu-puppet-module
• Language: Ruby
• Homepage: https://forge.puppet.com/puppet/sftp_jail
• Size: 287 KB
• Stars: 4
• Watchers: 42
• Forks: 12
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: .github/CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# sftp_jail

[![CI](https://github.com/voxpupuli/puppet-sftp_jail/actions/workflows/ci.yml/badge.svg)](https://github.com/voxpupuli/puppet-sftp_jail/actions/workflows/ci.yml)

[![Code Coverage](https://coveralls.io/repos/github/voxpupuli/puppet-sftp_jail/badge.svg?branch=master)](https://coveralls.io/github/voxpupuli/puppet-sftp_jail)

[![Puppet Forge](https://img.shields.io/puppetforge/v/puppet/sftp_jail.svg)](https://forge.puppetlabs.com/puppet/sftp_jail)

[![Puppet Forge - downloads](https://img.shields.io/puppetforge/dt/puppet/sftp_jail.svg)](https://forge.puppetlabs.com/puppet/sftp_jail)

[![Puppet Forge - endorsement](https://img.shields.io/puppetforge/e/puppet/sftp_jail.svg)](https://forge.puppetlabs.com/puppet/sftp_jail)

[![Puppet Forge - scores](https://img.shields.io/puppetforge/f/puppet/sftp_jail.svg)](https://forge.puppetlabs.com/puppet/sftp_jail)

[![License](https://img.shields.io/github/license/voxpupuli/puppet-sftp_jail.svg)](https://github.com/voxpupuli/puppet-sftp_jail/blob/master/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](CHANGELOG.md)

## References

see [REFERENCE.md](REFERENCE.md)