Propellor.Property.Ssh

Documentation

type PubKeyText = String

sshdConfig :: FilePath

setSshdConfig :: String -> Bool -> Property NoInfo

permitRootLogin :: Bool -> Property NoInfo

passwordAuthentication :: Bool -> Property NoInfo

noPasswords :: Property NoInfo

Configure ssh to not allow password logins.

To prevent lock-out, this is done only once root's authorized_keys is in place.

hasAuthorizedKeys :: User -> IO Bool

authorizedKey :: User -> String -> Property NoInfo

Ensures that a user's authorized_keys contains a line. Any other lines in the file are preserved as-is.

restarted :: Property NoInfo

randomHostKeys :: Property NoInfo

Blows away existing host keys and make new ones. Useful for systems installed from an image that might reuse host keys. A flag file is used to only ever do this once.

hostKeys :: IsContext c => c -> [(SshKeyType, PubKeyText)] -> Property HasInfo

Installs the specified list of ssh host keys.

The corresponding private keys come from the privdata.

Any host keysthat are not in the list are removed from the host.

hostKey :: IsContext c => c -> SshKeyType -> PubKeyText -> Property HasInfo

Installs a single ssh host key of a particular type.

The public key is provided to this function; the private key comes from the privdata;

pubKey :: SshKeyType -> PubKeyText -> Property HasInfo

Indicates the host key that is used by a Host, but does not actually configure the host to use it. Normally this does not need to be used; use hostKey instead.

getPubKey :: Propellor (Map SshKeyType String)

keyImported :: IsContext c => SshKeyType -> User -> c -> Property HasInfo

Sets up a user with a ssh private key and public key pair from the PrivData.

If the user already has a private/public key, it is left unchanged.

keyImported' :: IsContext c => Maybe FilePath -> SshKeyType -> User -> c -> Property HasInfo

A file can be speficied to write the key to somewhere other than usual. Allows a user to have multiple keys for different roles.

knownHost :: [Host] -> HostName -> User -> Property NoInfo

Puts some host's ssh public key(s), as set using pubKey or hostKey into the known_hosts file for a user.

authorizedKeys :: IsContext c => User -> c -> Property HasInfo

Makes a user have authorized_keys from the PrivData

This removes any other lines from the file.

listenPort :: Int -> RevertableProperty

Makes the ssh server listen on a given port, in addition to any other ports it is configured to listen on.

Revert to prevent it listening on a particular port.