Skip to content

README.md

Latest commit

 

History

History
67 lines (46 loc) · 2.32 KB

README.md

File metadata and controls

67 lines (46 loc) · 2.32 KB

Configures sshd and restarts the service when configuration changes.

Promiser

The sshd configuration keyword to manage (e.g. PermitRootLogin, AllowUsers). Each promise manages a single directive in the drop-in config file.

Attributes

  • value (required) — the value for the directive, either a string or an slist

What the module manages internally

  1. Include directive — ensures the base sshd_config includes the drop-in directory (sshd_config.d/) as its first non-comment directive
  2. Drop-in directory — creates the drop-in directory if it doesn't exist
  3. Drop-in file — writes directives to sshd_config.d/00-cfengine.conf
  4. Service restart — restarts sshd if configuration was changed and the service is already running
  5. Verification — verifies the desired directive appears in the effective sshd config (sshd -T)

Conflicting promisers

Having multiple promises with the same sshd keyword is not recommended. In case of conflicting promisers, the agent will attempt to converge the correct state for each one in the order they are evaluated. This means the last promise wins and determines the final value in the configuration file. It will also cause multiple restarts of the sshd service, which may be disruptive.

What the module does NOT do

  • Install sshd — that is a packages: promise
  • Ensure sshd is running — that is a services: promise
  • Manage match blocks — those are a policy-level concern

Policy

bundle agent sshd_config
{
  packages:
    "openssh-server" policy => "present";

  services:
    "sshd" service_policy => "start";

  vars:
    "allowed_users" slist => { "alice", "bob" };

  sshd:
    "PermitRootLogin" value => "no";
    "PasswordAuthentication" value => "no";
    "Port" value => "22";
    "AllowUsers" value => @(allowed_users);
}

Authors

This software was created by the team at Northern.tech, with many contributions from the community. Thanks everyone!

Contribute

Feel free to open pull requests to expand this documentation, add features, or fix problems. You can also pick up an existing task or file an issue in our bug tracker.

License

This software is licensed under the MIT License. See LICENSE in the root of the repository for the full license text.