Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/voxpupuli/puppet-augeasproviders_ssh
Augeas-based ssh types and providers for Puppet
https://github.com/voxpupuli/puppet-augeasproviders_ssh
augeas augeasproviders centos-puppet-module configuration-files debian-puppet-module fedora-puppet-module hacktoberfest linux-puppet-module oraclelinux-puppet-module puppet puppet-module puppet-resources redhat-puppet-module ssh ssh-keys ssh-server ubuntu-puppet-module
Last synced: 4 months ago
JSON representation
Augeas-based ssh types and providers for Puppet
- Host: GitHub
- URL: https://github.com/voxpupuli/puppet-augeasproviders_ssh
- Owner: voxpupuli
- License: apache-2.0
- Created: 2014-08-05T08:29:41.000Z (over 10 years ago)
- Default Branch: master
- Last Pushed: 2024-04-12T11:15:10.000Z (10 months ago)
- Last Synced: 2024-04-13T21:20:06.548Z (10 months ago)
- Topics: augeas, augeasproviders, centos-puppet-module, configuration-files, debian-puppet-module, fedora-puppet-module, hacktoberfest, linux-puppet-module, oraclelinux-puppet-module, puppet, puppet-module, puppet-resources, redhat-puppet-module, ssh, ssh-keys, ssh-server, ubuntu-puppet-module
- Language: Ruby
- Homepage:
- Size: 309 KB
- Stars: 7
- Watchers: 43
- Forks: 31
- Open Issues: 17
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: .github/CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# puppet-augeasproviders\_ssh
[](https://github.com/voxpupuli/puppet-augeasproviders_ssh/actions?query=workflow%3ACI)
[](https://github.com/voxpupuli/puppet-augeasproviders_ssh/actions/workflows/release.yml)
[](https://coveralls.io/github/voxpupuli/puppet-augeasproviders_ssh)
[](https://forge.puppetlabs.com/puppet/augeasproviders_ssh)
[](https://forge.puppetlabs.com/puppet/augeasproviders_ssh)
[](https://forge.puppetlabs.com/puppet/augeasproviders_ssh)
[](https://forge.puppetlabs.com/puppet/augeasproviders_ssh)
[](http://www.puppetmodule.info/m/puppet-augeasproviders_ssh)
[](LICENSE)
[](#transfer-notice)
# ssh: type/provider for ssh files for Puppet
This module provides a new type/provider for Puppet to read and modify ssh
config files using the Augeas configuration library.
The advantage of using Augeas over the default Puppet `parsedfile`
implementations is that Augeas will go to great lengths to preserve file
formatting and comments, while also failing safely when needed.
This provider will hide *all* of the Augeas commands etc., you don't need to
know anything about Augeas to make use of it.
## Requirements
Ensure both Augeas and ruby-augeas 0.3.0+ bindings are installed and working as
normal. Both are usually bundled in the puppet agent AIO packages from Puppet Inc.
See [Puppet/Augeas pre-requisites](http://docs.puppetlabs.com/guides/augeas.html#pre-requisites).
## Installing
The module can be installed easily ([documentation](http://docs.puppetlabs.com/puppet/latest/reference/modules_installing.html)):
```
puppet module install puppet/augeasproviders_ssh
```
Ensure the module is present in your puppetmaster's own environment (it doesn't
have to use it) and that the master has pluginsync enabled. Run the agent on
the puppetmaster to cause the custom types to be synced to its local libdir
(`puppet master --configprint libdir`) and then restart the puppetmaster so it
loads them.
## Compatibility
### Puppet versions
In theory. Puppet 2.7 is the minimal version. We currently (2022-08-29) we test against Puppet 6 and 7.
Check the Puppet version range in metadata.json for supported versions.
### Augeas versions
Augeas Versions | 0.10.0 | 1.0.0 | 1.1.0 | 1.2.0 |
:-------------------------|:-------:|:-------:|:-------:|:-------:|
**FEATURES** |
case-insensitive keys | no | **yes** | **yes** | **yes** |
**PROVIDERS** |
ssh\_config | **yes** | **yes** | **yes** | **yes** |
sshd\_config | **yes** | **yes** | **yes** | **yes** |
sshd\_config\_match | **yes** | **yes** | **yes** | **yes** |
sshd\_config\_subsystem | **yes** | **yes** | **yes** | **yes** |
sshkey | **yes** | **yes** | **yes** | **yes** |
## Documentation and examples
Type documentation can be generated with `puppet doc -r type` or viewed on the
[Puppet Forge page](http://forge.puppetlabs.com/herculesteam/augeasproviders_ssh).
### ssh_config provider
#### manage simple entry
ssh_config { "ForwardAgent":
ensure => present,
value => "yes",
}
#### manage array entry
ssh_config { "SendEnv":
ensure => present,
value => ["LC_*", "LANG"],
}
#### manage entry for a specific host
ssh_config { "X11Forwarding":
ensure => present,
host => "example.net",
value => "yes",
}
#### manage entries with same name for different hosts
ssh_config { "ForwardAgent global":
ensure => present,
key => "ForwardAgent",
value => "no",
}
ssh_config { "ForwardAgent on example.net":
ensure => present,
key => "ForwardAgent",
host => "example.net",
value => "yes",
}
#### manage entry with a comment
ssh_config { "ForwardAgent":
ensure => present,
key => "ForwardAgent",
value => "no",
comment => "Do not forward",
}
#### delete entry
ssh_config { "HashKnownHosts":
ensure => absent,
}
ssh_config { "BatchMode":
ensure => absent,
host => "example.net",
}
#### manage entry in another ssh_config location
ssh_config { "CheckHostIP":
ensure => present,
value => "yes",
target => "/etc/ssh/another_sshd_config",
}
### sshd_config provider
#### manage simple entry
sshd_config { "PermitRootLogin":
ensure => present,
value => "yes",
}
#### manage array entry
sshd_config { "AllowGroups":
ensure => present,
value => ["sshgroups", "admins"],
}
#### append to array entry
sshd_config { "AllowGroups":
ensure => present,
value => ["sshgroups", "admins"],
array_append => true,
}
#### manage entry in a Match block
sshd_config { "X11Forwarding":
ensure => present,
condition => "Host foo User root",
value => "yes",
}
sshd_config { "AllowAgentForwarding":
ensure => present,
condition => "Host *.example.net",
value => "yes",
}
#### manage entries with same name in different blocks
sshd_config { "X11Forwarding global":
ensure => present,
key => "X11Forwarding",
value => "no",
}
sshd_config { "X11Forwarding foo":
ensure => present,
key => "X11Forwarding",
condition => "User foo",
value => "yes",
}
sshd_config { "X11Forwarding root":
ensure => present,
key => "X11Forwarding",
condition => "User root",
value => "no",
}
#### manage entry with a comment
sshd_config { "X11Forwarding":
ensure => present,
key => "X11Forwarding",
value => "no",
comment => "No X11",
}
#### delete entry
sshd_config { "PermitRootLogin":
ensure => absent,
}
sshd_config { "AllowAgentForwarding":
ensure => absent,
condition => "Host *.example.net User *",
}
#### manage entry in another sshd_config location
sshd_config { "PermitRootLogin":
ensure => present,
value => "yes",
target => "/etc/ssh/another_sshd_config",
}
### sshd_config_match provider
#### manage entry
sshd_config_match { "Host *.example.net":
ensure => present,
}
#### manage entry with position
sshd_config_match { "Host *.example.net":
ensure => present,
position => "before first match",
}
sshd_config_match { "User foo":
ensure => present,
position => "after Host *.example.net",
}
#### manage entry with a comment
sshd_config_match { "Host *.example.net":
ensure => present,
comment => "Example network",
}
#### delete entry
sshd_config_match { "User foo Host *.example.net":
ensure => absent,
}
#### manage entry in another sshd_config location
sshd_config_match { "Host *.example.net":
ensure => present,
target => "/etc/ssh/another_sshd_config",
}
### sshd_config_subsystem provider
#### manage entry
sshd_config_subsystem { "sftp":
ensure => present,
command => "/usr/lib/openssh/sftp-server",
}
#### manage entry with a comment
sshd_config_subsystem { "sftp":
ensure => present,
command => "/usr/lib/openssh/sftp-server",
comment => "SFTP sub",
}
#### delete entry
sshd_config_subsystem { "sftp":
ensure => absent,
}
#### manage entry in another sshd_config location
sshd_config_subsystem { "sftp":
ensure => present,
command => "/usr/lib/openssh/sftp-server",
target => "/etc/ssh/another_sshd_config",
}
### sshkey provider
#### manage entry
sshkey { "foo.example.com":
ensure => present,
type => "ssh-rsa",
key => "AAADEADMEAT",
}
#### manage entry with aliases
sshkey { "foo.example.com":
ensure => present,
type => "ssh-rsa",
key => "AAADEADMEAT",
host_aliases => [ 'foo', '192.168.0.1' ],
}
#### manage hashed entry
sshkey { "foo.example.com":
ensure => present,
type => "ssh-rsa",
key => "AAADEADMEAT",
hash_hostname => true,
}
#### hash existing entry
sshkey { "foo.example.com":
ensure => hashed,
type => "ssh-rsa",
key => "AAADEADMEAT",
hash_hostname => true,
}
#### delete entry
sshkey { "foo.example.com":
ensure => absent,
}
#### manage entry in another ssh_known_hosts location
sshkey { "foo.example.com":
ensure => present,
type => "ssh-rsa",
key => "AAADEADMEAT",
target => "/root/.ssh/known_hosts",
}
## Issues
Please file any issues or suggestions [on GitHub](https://github.com/voxpupuli/puppet-augeasproviders_ssh/issues).