{-# LANGUAGE DeriveDataTypeable, TypeFamilies #-}

module Propellor.Property.Ssh (
	installed,
	restarted,
	PubKeyText,
	SshKeyType(..),
	-- * Daemon configuration
	sshdConfig,
	ConfigKeyword,
	setSshdConfigBool,
	setSshdConfig,
	RootLogin(..),
	permitRootLogin,
	passwordAuthentication,
	noPasswords,
	listenPort,
	-- * Host keys
	randomHostKeys,
	hostKeys,
	hostKey,
	hostPubKey,
	getHostPubKey,
	-- * User keys and configuration
	userKeys,
	userKeyAt,
	knownHost,
	unknownHost,
	authorizedKeysFrom,
	unauthorizedKeysFrom,
	authorizedKeys,
	authorizedKey,
	hasAuthorizedKeys,
	getUserPubKeys,
) where

import Propellor.Base
import qualified Propellor.Property.File as File
import qualified Propellor.Property.Service as Service
import qualified Propellor.Property.Apt as Apt
import Propellor.Property.User
import Propellor.Types.Info

import System.PosixCompat
import qualified Data.Map as M
import qualified Data.Set as S
import qualified Data.Semigroup as Sem
import Data.List

installed :: Property UnixLike
installed :: Property
  (MetaTypes
     '[ 'Targeting 'OSDebian, 'Targeting 'OSBuntish,
        'Targeting 'OSArchLinux, 'Targeting 'OSFreeBSD])
installed = PubKeyText
"ssh installed" forall i.
IsProp (Property i) =>
PubKeyText -> Property i -> Property i
==> (Property DebianLike
aptinstall forall {k} ka kb (c :: k) (a :: ka) (b :: kb).
(HasCallStack, SingKind 'KProxy, SingKind 'KProxy,
 DemoteRep 'KProxy ~ [MetaType], DemoteRep 'KProxy ~ [MetaType],
 SingI c) =>
Property (MetaTypes a)
-> Property (MetaTypes b) -> Property (MetaTypes c)
`pickOS` Property
  (MetaTypes
     '[ 'Targeting 'OSDebian, 'Targeting 'OSBuntish,
        'Targeting 'OSArchLinux, 'Targeting 'OSFreeBSD])
unsupportedOS)
  where
	aptinstall :: Property DebianLike
	aptinstall :: Property DebianLike
aptinstall = [PubKeyText] -> Property DebianLike
Apt.installed [PubKeyText
"ssh"]

restarted :: Property DebianLike
restarted :: Property DebianLike
restarted = PubKeyText -> Property DebianLike
Service.restarted PubKeyText
"ssh"

sshBool :: Bool -> String
sshBool :: Bool -> PubKeyText
sshBool Bool
True = PubKeyText
"yes"
sshBool Bool
False = PubKeyText
"no"

sshdConfig :: FilePath
sshdConfig :: PubKeyText
sshdConfig = PubKeyText
"/etc/ssh/sshd_config"

type ConfigKeyword = String

setSshdConfigBool :: ConfigKeyword -> Bool -> Property DebianLike
setSshdConfigBool :: PubKeyText -> Bool -> Property DebianLike
setSshdConfigBool PubKeyText
setting Bool
allowed = PubKeyText -> PubKeyText -> Property DebianLike
setSshdConfig PubKeyText
setting (Bool -> PubKeyText
sshBool Bool
allowed)

setSshdConfig :: ConfigKeyword -> String -> Property DebianLike
setSshdConfig :: PubKeyText -> PubKeyText -> Property DebianLike
setSshdConfig PubKeyText
setting PubKeyText
v = forall c.
(FileContent c, Eq c) =>
PubKeyText
-> (c -> c)
-> PubKeyText
-> Property
     (MetaTypes
        '[ 'Targeting 'OSDebian, 'Targeting 'OSBuntish,
           'Targeting 'OSArchLinux, 'Targeting 'OSFreeBSD])
File.fileProperty PubKeyText
desc [PubKeyText] -> [PubKeyText]
f PubKeyText
sshdConfig
	forall x y. Combines x y => x -> y -> CombinedType x y
`onChange` Property DebianLike
restarted
  where
	desc :: PubKeyText
desc = [PubKeyText] -> PubKeyText
unwords [ PubKeyText
"ssh config:", PubKeyText
setting, PubKeyText
v ]
	cfgline :: PubKeyText
cfgline = PubKeyText
setting forall a. [a] -> [a] -> [a]
++ PubKeyText
" " forall a. [a] -> [a] -> [a]
++ PubKeyText
v
	wantedline :: PubKeyText -> Bool
wantedline PubKeyText
s
		| PubKeyText
s forall a. Eq a => a -> a -> Bool
== PubKeyText
cfgline = Bool
True
		| (PubKeyText
setting forall a. [a] -> [a] -> [a]
++ PubKeyText
" ") forall a. Eq a => [a] -> [a] -> Bool
`isPrefixOf` PubKeyText
s = Bool
False
		| Bool
otherwise = Bool
True
	f :: [PubKeyText] -> [PubKeyText]
f [PubKeyText]
ls
		| PubKeyText
cfgline forall (t :: * -> *) a. (Foldable t, Eq a) => a -> t a -> Bool
`elem` [PubKeyText]
ls = forall a. (a -> Bool) -> [a] -> [a]
filter PubKeyText -> Bool
wantedline [PubKeyText]
ls
		| Bool
otherwise = forall a. (a -> Bool) -> [a] -> [a]
filter PubKeyText -> Bool
wantedline [PubKeyText]
ls forall a. [a] -> [a] -> [a]
++ [PubKeyText
cfgline]

data RootLogin
	= RootLogin Bool  -- ^ allow or prevent root login
	| WithoutPassword -- ^ disable password authentication for root, while allowing other authentication methods
	| ForcedCommandsOnly -- ^ allow root login with public-key authentication, but only if a forced command has been specified for the public key

permitRootLogin :: RootLogin -> Property DebianLike
permitRootLogin :: RootLogin -> Property DebianLike
permitRootLogin (RootLogin Bool
b) = PubKeyText -> Bool -> Property DebianLike
setSshdConfigBool PubKeyText
"PermitRootLogin" Bool
b
permitRootLogin RootLogin
WithoutPassword = PubKeyText -> PubKeyText -> Property DebianLike
setSshdConfig PubKeyText
"PermitRootLogin" PubKeyText
"without-password"
permitRootLogin RootLogin
ForcedCommandsOnly = PubKeyText -> PubKeyText -> Property DebianLike
setSshdConfig PubKeyText
"PermitRootLogin" PubKeyText
"forced-commands-only"

passwordAuthentication :: Bool -> Property DebianLike
passwordAuthentication :: Bool -> Property DebianLike
passwordAuthentication = PubKeyText -> Bool -> Property DebianLike
setSshdConfigBool PubKeyText
"PasswordAuthentication"

-- | Configure ssh to not allow password logins.
--
-- To prevent lock-out, this is done only once root's
-- authorized_keys is in place.
noPasswords :: Property DebianLike
noPasswords :: Property DebianLike
noPasswords = forall (p :: * -> *) i (m :: * -> *).
(Checkable p i, LiftPropellor m) =>
m Bool -> p i -> Property i
check (User -> IO Bool
hasAuthorizedKeys (PubKeyText -> User
User PubKeyText
"root")) forall a b. (a -> b) -> a -> b
$
	Bool -> Property DebianLike
passwordAuthentication Bool
False

dotDir :: User -> IO FilePath
dotDir :: User -> IO PubKeyText
dotDir User
user = do
	PubKeyText
h <- User -> IO PubKeyText
homedir User
user
	forall (m :: * -> *) a. Monad m => a -> m a
return forall a b. (a -> b) -> a -> b
$ PubKeyText
h PubKeyText -> PubKeyText -> PubKeyText
</> PubKeyText
".ssh"

dotFile :: FilePath -> User -> IO FilePath
dotFile :: PubKeyText -> User -> IO PubKeyText
dotFile PubKeyText
f User
user = do
	PubKeyText
d <- User -> IO PubKeyText
dotDir User
user
	forall (m :: * -> *) a. Monad m => a -> m a
return forall a b. (a -> b) -> a -> b
$ PubKeyText
d PubKeyText -> PubKeyText -> PubKeyText
</> PubKeyText
f

-- | 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.
listenPort :: Port -> RevertableProperty DebianLike DebianLike
listenPort :: Port -> RevertableProperty DebianLike DebianLike
listenPort Port
port = CombinedType
  (Property
     (MetaTypes
        '[ 'Targeting 'OSDebian, 'Targeting 'OSBuntish,
           'Targeting 'OSArchLinux, 'Targeting 'OSFreeBSD]))
  (Property DebianLike)
enable forall setupmetatypes undometatypes.
Property setupmetatypes
-> Property undometatypes
-> RevertableProperty setupmetatypes undometatypes
<!> CombinedType
  (Property
     (MetaTypes
        '[ 'Targeting 'OSDebian, 'Targeting 'OSBuntish,
           'Targeting 'OSArchLinux, 'Targeting 'OSFreeBSD]))
  (Property DebianLike)
disable
  where
	portline :: PubKeyText
portline = PubKeyText
"Port " forall a. [a] -> [a] -> [a]
++ forall t. ConfigurableValue t => t -> PubKeyText
val Port
port
	enable :: CombinedType
  (Property
     (MetaTypes
        '[ 'Targeting 'OSDebian, 'Targeting 'OSBuntish,
           'Targeting 'OSArchLinux, 'Targeting 'OSFreeBSD]))
  (Property DebianLike)
enable = PubKeyText
sshdConfig PubKeyText
-> PubKeyText
-> Property
     (MetaTypes
        '[ 'Targeting 'OSDebian, 'Targeting 'OSBuntish,
           'Targeting 'OSArchLinux, 'Targeting 'OSFreeBSD])
`File.containsLine` PubKeyText
portline
		forall p. IsProp p => p -> PubKeyText -> p
`describe` (PubKeyText
"ssh listening on " forall a. [a] -> [a] -> [a]
++ PubKeyText
portline)
		forall x y. Combines x y => x -> y -> CombinedType x y
`onChange` Property DebianLike
restarted
	disable :: CombinedType
  (Property
     (MetaTypes
        '[ 'Targeting 'OSDebian, 'Targeting 'OSBuntish,
           'Targeting 'OSArchLinux, 'Targeting 'OSFreeBSD]))
  (Property DebianLike)
disable = PubKeyText
sshdConfig PubKeyText
-> PubKeyText
-> Property
     (MetaTypes
        '[ 'Targeting 'OSDebian, 'Targeting 'OSBuntish,
           'Targeting 'OSArchLinux, 'Targeting 'OSFreeBSD])
`File.lacksLine` PubKeyText
portline
		forall p. IsProp p => p -> PubKeyText -> p
`describe` (PubKeyText
"ssh not listening on " forall a. [a] -> [a] -> [a]
++ PubKeyText
portline)
		forall x y. Combines x y => x -> y -> CombinedType x y
`onChange` Property DebianLike
restarted

hasAuthorizedKeys :: User -> IO Bool
hasAuthorizedKeys :: User -> IO Bool
hasAuthorizedKeys = PubKeyText -> IO Bool
go forall (m :: * -> *) b c a.
Monad m =>
(b -> m c) -> (a -> m b) -> a -> m c
<=< PubKeyText -> User -> IO PubKeyText
dotFile PubKeyText
"authorized_keys"
  where
	go :: PubKeyText -> IO Bool
go PubKeyText
f = Bool -> Bool
not forall b c a. (b -> c) -> (a -> b) -> a -> c
. forall (t :: * -> *) a. Foldable t => t a -> Bool
null forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
<$> forall (m :: * -> *) a. MonadCatch m => a -> m a -> m a
catchDefaultIO PubKeyText
"" (PubKeyText -> IO PubKeyText
readFile PubKeyText
f)

-- | 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.
randomHostKeys :: Property DebianLike
randomHostKeys :: Property DebianLike
randomHostKeys = forall i. Property i -> PubKeyText -> Property i
flagFile Property
  (MetaTypes
     '[ 'Targeting 'OSDebian, 'Targeting 'OSBuntish,
        'Targeting 'OSArchLinux, 'Targeting 'OSFreeBSD])
prop PubKeyText
"/etc/ssh/.unique_host_keys"
	forall x y. Combines x y => x -> y -> CombinedType x y
`onChange` Property DebianLike
restarted
  where
	prop :: Property UnixLike
	prop :: Property
  (MetaTypes
     '[ 'Targeting 'OSDebian, 'Targeting 'OSBuntish,
        'Targeting 'OSArchLinux, 'Targeting 'OSFreeBSD])
prop = forall {k} (metatypes :: k).
SingI metatypes =>
PubKeyText
-> (OuterMetaTypesWitness metatypes -> Propellor Result)
-> Property (MetaTypes metatypes)
property' PubKeyText
"ssh random host keys" forall a b. (a -> b) -> a -> b
$ \OuterMetaTypesWitness
  '[ 'Targeting 'OSDebian, 'Targeting 'OSBuntish,
     'Targeting 'OSArchLinux, 'Targeting 'OSFreeBSD]
w -> do
		forall (f :: * -> *) a. Functor f => f a -> f ()
void forall a b. (a -> b) -> a -> b
$ forall (m :: * -> *) a. MonadIO m => IO a -> m a
liftIO forall a b. (a -> b) -> a -> b
$ PubKeyText -> [CommandParam] -> IO Bool
boolSystem PubKeyText
"sh"
			[ PubKeyText -> CommandParam
Param PubKeyText
"-c"
			, PubKeyText -> CommandParam
Param PubKeyText
"rm -f /etc/ssh/ssh_host_*"
			]
		forall (inner :: [MetaType]) (outer :: [MetaType]).
EnsurePropertyAllowed inner outer =>
OuterMetaTypesWitness outer
-> Property (MetaTypes inner) -> Propellor Result
ensureProperty OuterMetaTypesWitness
  '[ 'Targeting 'OSDebian, 'Targeting 'OSBuntish,
     'Targeting 'OSArchLinux, 'Targeting 'OSFreeBSD]
w forall a b. (a -> b) -> a -> b
$ [PubKeyText]
-> UncheckedProperty
     (MetaTypes
        '[ 'Targeting 'OSDebian, 'Targeting 'OSBuntish,
           'Targeting 'OSArchLinux, 'Targeting 'OSFreeBSD])
scriptProperty [ PubKeyText
"DPKG_MAINTSCRIPT_NAME=postinst DPKG_MAINTSCRIPT_PACKAGE=openssh-server /var/lib/dpkg/info/openssh-server.postinst configure" ]
			forall (p :: * -> *) i.
Checkable p i =>
p i -> Result -> Property i
`assume` Result
MadeChange

-- | The text of a ssh public key, for example, "ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAIB3BJ2GqZiTR2LEoDXyYFgh/BduWefjdKXAsAtzS9zeI"
type PubKeyText = String

-- | Installs the specified list of ssh host keys.
--
-- The corresponding private keys come from the privdata.
--
-- Any host keys that are not in the list are removed from the host.
hostKeys :: IsContext c => c -> [(SshKeyType, PubKeyText)] -> Property (HasInfo + DebianLike)
hostKeys :: forall c.
IsContext c =>
c -> [(SshKeyType, PubKeyText)] -> Property (HasInfo + DebianLike)
hostKeys c
ctx [(SshKeyType, PubKeyText)]
l = Property (HasInfo + DebianLike)
go forall x y. Combines x y => x -> y -> CombinedType x y
`before` Property DebianLike
cleanup
  where
	desc :: PubKeyText
desc = PubKeyText
"ssh host keys configured " forall a. [a] -> [a] -> [a]
++ [SshKeyType] -> PubKeyText
typelist (forall a b. (a -> b) -> [a] -> [b]
map forall a b. (a, b) -> a
fst [(SshKeyType, PubKeyText)]
l)
	go :: Property (HasInfo + DebianLike)
	go :: Property (HasInfo + DebianLike)
go = forall {k} (metatypes :: k).
SingI metatypes =>
PubKeyText
-> Props (MetaTypes metatypes) -> Property (MetaTypes metatypes)
propertyList PubKeyText
desc forall a b. (a -> b) -> a -> b
$ forall {k} (metatypes :: k).
[Property (MetaTypes metatypes)] -> Props (MetaTypes metatypes)
toProps forall a b. (a -> b) -> a -> b
$ forall a. [Maybe a] -> [a]
catMaybes forall a b. (a -> b) -> a -> b
$
		forall a b. (a -> b) -> [a] -> [b]
map (\(SshKeyType
t, PubKeyText
pub) -> forall a. a -> Maybe a
Just forall a b. (a -> b) -> a -> b
$ forall c.
IsContext c =>
c -> SshKeyType -> PubKeyText -> Property (HasInfo + DebianLike)
hostKey c
ctx SshKeyType
t PubKeyText
pub) [(SshKeyType, PubKeyText)]
l
	typelist :: [SshKeyType] -> PubKeyText
typelist [SshKeyType]
tl = PubKeyText
"(" forall a. [a] -> [a] -> [a]
++ [PubKeyText] -> PubKeyText
unwords (forall a b. (a -> b) -> [a] -> [b]
map SshKeyType -> PubKeyText
fromKeyType [SshKeyType]
tl) forall a. [a] -> [a] -> [a]
++ PubKeyText
")"
	alltypes :: [SshKeyType]
alltypes = [forall a. Bounded a => a
minBound..forall a. Bounded a => a
maxBound]
	staletypes :: [SshKeyType]
staletypes = let have :: [SshKeyType]
have = forall a b. (a -> b) -> [a] -> [b]
map forall a b. (a, b) -> a
fst [(SshKeyType, PubKeyText)]
l in forall a. (a -> Bool) -> [a] -> [a]
filter (forall (t :: * -> *) a. (Foldable t, Eq a) => a -> t a -> Bool
`notElem` [SshKeyType]
have) [SshKeyType]
alltypes
	removestale :: Bool -> [Property DebianLike]
	removestale :: Bool -> [Property DebianLike]
removestale Bool
b = forall a b. (a -> b) -> [a] -> [b]
map (forall (p :: * -> *) (untightened :: [MetaType])
       (tightened :: [MetaType]).
(TightenTargets p, TightenTargetsAllowed untightened tightened,
 SingI tightened) =>
p (MetaTypes untightened) -> p (MetaTypes tightened)
tightenTargets forall b c a. (b -> c) -> (a -> b) -> a -> c
. PubKeyText
-> Property
     (MetaTypes
        '[ 'Targeting 'OSDebian, 'Targeting 'OSBuntish,
           'Targeting 'OSArchLinux, 'Targeting 'OSFreeBSD])
File.notPresent forall b c a. (b -> c) -> (a -> b) -> a -> c
. forall a b c. (a -> b -> c) -> b -> a -> c
flip SshKeyType -> Bool -> PubKeyText
keyFile Bool
b) [SshKeyType]
staletypes
	cleanup :: Property DebianLike
	cleanup :: Property DebianLike
cleanup
		| forall (t :: * -> *) a. Foldable t => t a -> Bool
null [SshKeyType]
staletypes Bool -> Bool -> Bool
|| forall (t :: * -> *) a. Foldable t => t a -> Bool
null [(SshKeyType, PubKeyText)]
l = forall {k} (t :: k). SingI t => Property (MetaTypes t)
doNothing
		| Bool
otherwise =
			forall {k} (metatypes :: k).
SingI metatypes =>
PubKeyText
-> Props (MetaTypes metatypes) -> Property (MetaTypes metatypes)
combineProperties (PubKeyText
"any other ssh host keys removed " forall a. [a] -> [a] -> [a]
++ [SshKeyType] -> PubKeyText
typelist [SshKeyType]
staletypes)
				(forall {k} (metatypes :: k).
[Property (MetaTypes metatypes)] -> Props (MetaTypes metatypes)
toProps forall a b. (a -> b) -> a -> b
$ Bool -> [Property DebianLike]
removestale Bool
True forall a. [a] -> [a] -> [a]
++ Bool -> [Property DebianLike]
removestale Bool
False)
				forall x y. Combines x y => x -> y -> CombinedType x y
`onChange` Property DebianLike
restarted

-- | 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;
hostKey :: IsContext c => c -> SshKeyType -> PubKeyText -> Property (HasInfo + DebianLike)
hostKey :: forall c.
IsContext c =>
c -> SshKeyType -> PubKeyText -> Property (HasInfo + DebianLike)
hostKey c
context SshKeyType
keytype PubKeyText
pub = Property
  (MetaTypes
     (Combine
        (Combine
           (Combine
              '[ 'Targeting 'OSDebian, 'Targeting 'OSBuntish,
                 'Targeting 'OSArchLinux, 'Targeting 'OSFreeBSD]
              '[ 'WithInfo, 'Targeting 'OSDebian, 'Targeting 'OSBuntish,
                 'Targeting 'OSArchLinux, 'Targeting 'OSFreeBSD])
           '[ 'Targeting 'OSDebian, 'Targeting 'OSBuntish,
              'Targeting 'OSArchLinux, 'Targeting 'OSFreeBSD])
        '[ 'WithInfo, 'Targeting 'OSDebian, 'Targeting 'OSBuntish,
           'Targeting 'OSArchLinux, 'Targeting 'OSFreeBSD]))
go forall x y. Combines x y => x -> y -> CombinedType x y
`onChange` Property DebianLike
restarted
  where
	go :: Property
  (MetaTypes
     (Combine
        (Combine
           (Combine
              '[ 'Targeting 'OSDebian, 'Targeting 'OSBuntish,
                 'Targeting 'OSArchLinux, 'Targeting 'OSFreeBSD]
              '[ 'WithInfo, 'Targeting 'OSDebian, 'Targeting 'OSBuntish,
                 'Targeting 'OSArchLinux, 'Targeting 'OSFreeBSD])
           '[ 'Targeting 'OSDebian, 'Targeting 'OSBuntish,
              'Targeting 'OSArchLinux, 'Targeting 'OSFreeBSD])
        '[ 'WithInfo, 'Targeting 'OSDebian, 'Targeting 'OSBuntish,
           'Targeting 'OSArchLinux, 'Targeting 'OSFreeBSD]))
go = forall {k} (metatypes :: k).
SingI metatypes =>
PubKeyText
-> Props (MetaTypes metatypes) -> Property (MetaTypes metatypes)
combineProperties PubKeyText
desc forall a b. (a -> b) -> a -> b
$ Props
  (MetaTypes
     '[ 'Targeting 'OSDebian, 'Targeting 'OSBuntish,
        'Targeting 'OSArchLinux, 'Targeting 'OSFreeBSD])
props
		forall {a} p (y :: [a]) (x :: [a]).
(IsProp p, MetaTypes y ~ GetMetaTypes p,
 CheckCombinableNote x y (NoteFor ('Text "&"))) =>
Props (MetaTypes x) -> p -> Props (MetaTypes (Combine x y))
& SshKeyType
-> PubKeyText
-> Property
     (HasInfo
      + MetaTypes
          '[ 'Targeting 'OSDebian, 'Targeting 'OSBuntish,
             'Targeting 'OSArchLinux, 'Targeting 'OSFreeBSD])
hostPubKey SshKeyType
keytype PubKeyText
pub
		forall {a} p (y :: [a]) (x :: [a]).
(IsProp p, MetaTypes y ~ GetMetaTypes p,
 CheckCombinableNote x y (NoteFor ('Text "&"))) =>
Props (MetaTypes x) -> p -> Props (MetaTypes (Combine x y))
& Property
  (MetaTypes
     '[ 'Targeting 'OSDebian, 'Targeting 'OSBuntish,
        'Targeting 'OSArchLinux, 'Targeting 'OSFreeBSD])
installpub
		forall {a} p (y :: [a]) (x :: [a]).
(IsProp p, MetaTypes y ~ GetMetaTypes p,
 CheckCombinableNote x y (NoteFor ('Text "&"))) =>
Props (MetaTypes x) -> p -> Props (MetaTypes (Combine x y))
& Property
  (HasInfo
   + MetaTypes
       '[ 'Targeting 'OSDebian, 'Targeting 'OSBuntish,
          'Targeting 'OSArchLinux, 'Targeting 'OSFreeBSD])
installpriv
	desc :: PubKeyText
desc = PubKeyText
"ssh host key configured (" forall a. [a] -> [a] -> [a]
++ SshKeyType -> PubKeyText
fromKeyType SshKeyType
keytype forall a. [a] -> [a] -> [a]
++ PubKeyText
")"
	keysrc :: PubKeyText -> PrivDataField -> PrivDataSource
keysrc PubKeyText
ext PrivDataField
field = PrivDataField -> PubKeyText -> PubKeyText -> PrivDataSource
PrivDataSourceFileFromCommand PrivDataField
field (PubKeyText
"sshkey"forall a. [a] -> [a] -> [a]
++PubKeyText
ext)
		(PubKeyText
"ssh-keygen -t " forall a. [a] -> [a] -> [a]
++ SshKeyType -> PubKeyText
sshKeyTypeParam SshKeyType
keytype forall a. [a] -> [a] -> [a]
++ PubKeyText
" -f sshkey")
	installpub :: Property UnixLike
	installpub :: Property
  (MetaTypes
     '[ 'Targeting 'OSDebian, 'Targeting 'OSBuntish,
        'Targeting 'OSArchLinux, 'Targeting 'OSFreeBSD])
installpub = (PubKeyText
 -> [PubKeyText]
 -> Property
      (MetaTypes
         '[ 'Targeting 'OSDebian, 'Targeting 'OSBuntish,
            'Targeting 'OSArchLinux, 'Targeting 'OSFreeBSD]))
-> Bool
-> [PubKeyText]
-> Property
     (MetaTypes
        '[ 'Targeting 'OSDebian, 'Targeting 'OSBuntish,
           'Targeting 'OSArchLinux, 'Targeting 'OSFreeBSD])
keywriter PubKeyText
-> [PubKeyText]
-> Property
     (MetaTypes
        '[ 'Targeting 'OSDebian, 'Targeting 'OSBuntish,
           'Targeting 'OSArchLinux, 'Targeting 'OSFreeBSD])
File.hasContent Bool
True (PubKeyText -> [PubKeyText]
lines PubKeyText
pub)
	installpriv :: Property (HasInfo + UnixLike)
	installpriv :: Property
  (HasInfo
   + MetaTypes
       '[ 'Targeting 'OSDebian, 'Targeting 'OSBuntish,
          'Targeting 'OSArchLinux, 'Targeting 'OSFreeBSD])
installpriv = forall c s metatypes.
(IsContext c, IsPrivDataSource s,
 IncludesInfo metatypes ~ 'True) =>
s
-> c
-> (((PrivData -> Propellor Result) -> Propellor Result)
    -> Property metatypes)
-> Property metatypes
withPrivData (PubKeyText -> PrivDataField -> PrivDataSource
keysrc PubKeyText
"" (SshKeyType -> PubKeyText -> PrivDataField
SshPrivKey SshKeyType
keytype PubKeyText
"")) c
context forall a b. (a -> b) -> a -> b
$ \(PrivData -> Propellor Result) -> Propellor Result
getkey ->
		forall {k} (metatypes :: k).
SingI metatypes =>
PubKeyText
-> (OuterMetaTypesWitness metatypes -> Propellor Result)
-> Property (MetaTypes metatypes)
property' PubKeyText
desc forall a b. (a -> b) -> a -> b
$ \OuterMetaTypesWitness
  '[ 'WithInfo, 'Targeting 'OSDebian, 'Targeting 'OSBuntish,
     'Targeting 'OSArchLinux, 'Targeting 'OSFreeBSD]
w -> (PrivData -> Propellor Result) -> Propellor Result
getkey forall a b. (a -> b) -> a -> b
$
			forall (inner :: [MetaType]) (outer :: [MetaType]).
EnsurePropertyAllowed inner outer =>
OuterMetaTypesWitness outer
-> Property (MetaTypes inner) -> Propellor Result
ensureProperty OuterMetaTypesWitness
  '[ 'WithInfo, 'Targeting 'OSDebian, 'Targeting 'OSBuntish,
     'Targeting 'OSArchLinux, 'Targeting 'OSFreeBSD]
w
				forall b c a. (b -> c) -> (a -> b) -> a -> c
. (PubKeyText
 -> [PubKeyText]
 -> Property
      (MetaTypes
         '[ 'Targeting 'OSDebian, 'Targeting 'OSBuntish,
            'Targeting 'OSArchLinux, 'Targeting 'OSFreeBSD]))
-> Bool
-> [PubKeyText]
-> Property
     (MetaTypes
        '[ 'Targeting 'OSDebian, 'Targeting 'OSBuntish,
           'Targeting 'OSArchLinux, 'Targeting 'OSFreeBSD])
keywriter PubKeyText
-> [PubKeyText]
-> Property
     (MetaTypes
        '[ 'Targeting 'OSDebian, 'Targeting 'OSBuntish,
           'Targeting 'OSArchLinux, 'Targeting 'OSFreeBSD])
File.hasContentProtected Bool
False
				forall b c a. (b -> c) -> (a -> b) -> a -> c
. PrivData -> [PubKeyText]
privDataLines
	keywriter :: (PubKeyText
 -> [PubKeyText]
 -> Property
      (MetaTypes
         '[ 'Targeting 'OSDebian, 'Targeting 'OSBuntish,
            'Targeting 'OSArchLinux, 'Targeting 'OSFreeBSD]))
-> Bool
-> [PubKeyText]
-> Property
     (MetaTypes
        '[ 'Targeting 'OSDebian, 'Targeting 'OSBuntish,
           'Targeting 'OSArchLinux, 'Targeting 'OSFreeBSD])
keywriter PubKeyText
-> [PubKeyText]
-> Property
     (MetaTypes
        '[ 'Targeting 'OSDebian, 'Targeting 'OSBuntish,
           'Targeting 'OSArchLinux, 'Targeting 'OSFreeBSD])
p Bool
ispub [PubKeyText]
keylines = do
		let f :: PubKeyText
f = SshKeyType -> Bool -> PubKeyText
keyFile SshKeyType
keytype Bool
ispub
		PubKeyText
-> [PubKeyText]
-> Property
     (MetaTypes
        '[ 'Targeting 'OSDebian, 'Targeting 'OSBuntish,
           'Targeting 'OSArchLinux, 'Targeting 'OSFreeBSD])
p PubKeyText
f ([PubKeyText] -> [PubKeyText]
keyFileContent [PubKeyText]
keylines)

-- Make sure that there is a newline at the end;
-- ssh requires this for some types of private keys.
keyFileContent :: [String] -> [File.Line]
keyFileContent :: [PubKeyText] -> [PubKeyText]
keyFileContent [PubKeyText]
keylines = [PubKeyText]
keylines forall a. [a] -> [a] -> [a]
++ [PubKeyText
""]

keyFile :: SshKeyType -> Bool -> FilePath
keyFile :: SshKeyType -> Bool -> PubKeyText
keyFile SshKeyType
keytype Bool
ispub = PubKeyText
"/etc/ssh/ssh_host_" forall a. [a] -> [a] -> [a]
++ SshKeyType -> PubKeyText
fromKeyType SshKeyType
keytype forall a. [a] -> [a] -> [a]
++ PubKeyText
"_key" forall a. [a] -> [a] -> [a]
++ PubKeyText
ext
  where
	ext :: PubKeyText
ext = if Bool
ispub then PubKeyText
".pub" else PubKeyText
""

-- | 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.
hostPubKey :: SshKeyType -> PubKeyText -> Property (HasInfo + UnixLike)
hostPubKey :: SshKeyType
-> PubKeyText
-> Property
     (HasInfo
      + MetaTypes
          '[ 'Targeting 'OSDebian, 'Targeting 'OSBuntish,
             'Targeting 'OSArchLinux, 'Targeting 'OSFreeBSD])
hostPubKey SshKeyType
t = forall v.
IsInfo v =>
PubKeyText
-> v
-> Property
     (HasInfo
      + MetaTypes
          '[ 'Targeting 'OSDebian, 'Targeting 'OSBuntish,
             'Targeting 'OSArchLinux, 'Targeting 'OSFreeBSD])
pureInfoProperty PubKeyText
"ssh pubkey known" forall b c a. (b -> c) -> (a -> b) -> a -> c
. Map SshKeyType PubKeyText -> HostKeyInfo
HostKeyInfo forall b c a. (b -> c) -> (a -> b) -> a -> c
. forall k a. k -> a -> Map k a
M.singleton SshKeyType
t

getHostPubKey :: Propellor (M.Map SshKeyType PubKeyText)
getHostPubKey :: Propellor (Map SshKeyType PubKeyText)
getHostPubKey = HostKeyInfo -> Map SshKeyType PubKeyText
fromHostKeyInfo forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
<$> forall v. IsInfo v => Propellor v
askInfo

newtype HostKeyInfo = HostKeyInfo
	{ HostKeyInfo -> Map SshKeyType PubKeyText
fromHostKeyInfo :: M.Map SshKeyType PubKeyText }
	deriving (HostKeyInfo -> HostKeyInfo -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: HostKeyInfo -> HostKeyInfo -> Bool
$c/= :: HostKeyInfo -> HostKeyInfo -> Bool
== :: HostKeyInfo -> HostKeyInfo -> Bool
$c== :: HostKeyInfo -> HostKeyInfo -> Bool
Eq, Eq HostKeyInfo
HostKeyInfo -> HostKeyInfo -> Bool
HostKeyInfo -> HostKeyInfo -> Ordering
HostKeyInfo -> HostKeyInfo -> HostKeyInfo
forall a.
Eq a
-> (a -> a -> Ordering)
-> (a -> a -> Bool)
-> (a -> a -> Bool)
-> (a -> a -> Bool)
-> (a -> a -> Bool)
-> (a -> a -> a)
-> (a -> a -> a)
-> Ord a
min :: HostKeyInfo -> HostKeyInfo -> HostKeyInfo
$cmin :: HostKeyInfo -> HostKeyInfo -> HostKeyInfo
max :: HostKeyInfo -> HostKeyInfo -> HostKeyInfo
$cmax :: HostKeyInfo -> HostKeyInfo -> HostKeyInfo
>= :: HostKeyInfo -> HostKeyInfo -> Bool
$c>= :: HostKeyInfo -> HostKeyInfo -> Bool
> :: HostKeyInfo -> HostKeyInfo -> Bool
$c> :: HostKeyInfo -> HostKeyInfo -> Bool
<= :: HostKeyInfo -> HostKeyInfo -> Bool
$c<= :: HostKeyInfo -> HostKeyInfo -> Bool
< :: HostKeyInfo -> HostKeyInfo -> Bool
$c< :: HostKeyInfo -> HostKeyInfo -> Bool
compare :: HostKeyInfo -> HostKeyInfo -> Ordering
$ccompare :: HostKeyInfo -> HostKeyInfo -> Ordering
Ord, Typeable, Int -> HostKeyInfo -> PubKeyText -> PubKeyText
[HostKeyInfo] -> PubKeyText -> PubKeyText
HostKeyInfo -> PubKeyText
forall a.
(Int -> a -> PubKeyText -> PubKeyText)
-> (a -> PubKeyText) -> ([a] -> PubKeyText -> PubKeyText) -> Show a
showList :: [HostKeyInfo] -> PubKeyText -> PubKeyText
$cshowList :: [HostKeyInfo] -> PubKeyText -> PubKeyText
show :: HostKeyInfo -> PubKeyText
$cshow :: HostKeyInfo -> PubKeyText
showsPrec :: Int -> HostKeyInfo -> PubKeyText -> PubKeyText
$cshowsPrec :: Int -> HostKeyInfo -> PubKeyText -> PubKeyText
Show)

instance IsInfo HostKeyInfo where
	propagateInfo :: HostKeyInfo -> PropagateInfo
propagateInfo HostKeyInfo
_ = Bool -> PropagateInfo
PropagateInfo Bool
False

instance Sem.Semigroup HostKeyInfo where
	HostKeyInfo Map SshKeyType PubKeyText
old <> :: HostKeyInfo -> HostKeyInfo -> HostKeyInfo
<> HostKeyInfo Map SshKeyType PubKeyText
new =
		-- new first because union prefers values from the first
		-- parameter when there is a duplicate key
		Map SshKeyType PubKeyText -> HostKeyInfo
HostKeyInfo (Map SshKeyType PubKeyText
new forall k a. Ord k => Map k a -> Map k a -> Map k a
`M.union` Map SshKeyType PubKeyText
old)

instance Monoid HostKeyInfo where
	mempty :: HostKeyInfo
mempty = Map SshKeyType PubKeyText -> HostKeyInfo
HostKeyInfo forall k a. Map k a
M.empty
	mappend :: HostKeyInfo -> HostKeyInfo -> HostKeyInfo
mappend = forall a. Semigroup a => a -> a -> a
(Sem.<>)

userPubKeys :: User -> [(SshKeyType, PubKeyText)] -> Property (HasInfo + UnixLike)
userPubKeys :: User
-> [(SshKeyType, PubKeyText)]
-> Property
     (HasInfo
      + MetaTypes
          '[ 'Targeting 'OSDebian, 'Targeting 'OSBuntish,
             'Targeting 'OSArchLinux, 'Targeting 'OSFreeBSD])
userPubKeys u :: User
u@(User PubKeyText
n) [(SshKeyType, PubKeyText)]
l = forall v.
IsInfo v =>
PubKeyText
-> v
-> Property
     (HasInfo
      + MetaTypes
          '[ 'Targeting 'OSDebian, 'Targeting 'OSBuntish,
             'Targeting 'OSArchLinux, 'Targeting 'OSFreeBSD])
pureInfoProperty (PubKeyText
"ssh pubkey for " forall a. [a] -> [a] -> [a]
++ PubKeyText
n) forall a b. (a -> b) -> a -> b
$
	Map User (Set (SshKeyType, PubKeyText)) -> UserKeyInfo
UserKeyInfo (forall k a. k -> a -> Map k a
M.singleton User
u (forall a. Ord a => [a] -> Set a
S.fromList [(SshKeyType, PubKeyText)]
l))

getUserPubKeys :: User -> Propellor [(SshKeyType, PubKeyText)]
getUserPubKeys :: User -> Propellor [(SshKeyType, PubKeyText)]
getUserPubKeys User
u = forall b a. b -> (a -> b) -> Maybe a -> b
maybe [] forall a. Set a -> [a]
S.toList forall b c a. (b -> c) -> (a -> b) -> a -> c
. forall k a. Ord k => k -> Map k a -> Maybe a
M.lookup User
u forall b c a. (b -> c) -> (a -> b) -> a -> c
. UserKeyInfo -> Map User (Set (SshKeyType, PubKeyText))
fromUserKeyInfo forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
<$> forall v. IsInfo v => Propellor v
askInfo

newtype UserKeyInfo = UserKeyInfo
	{ UserKeyInfo -> Map User (Set (SshKeyType, PubKeyText))
fromUserKeyInfo :: M.Map User (S.Set (SshKeyType, PubKeyText)) }
	deriving (UserKeyInfo -> UserKeyInfo -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: UserKeyInfo -> UserKeyInfo -> Bool
$c/= :: UserKeyInfo -> UserKeyInfo -> Bool
== :: UserKeyInfo -> UserKeyInfo -> Bool
$c== :: UserKeyInfo -> UserKeyInfo -> Bool
Eq, Eq UserKeyInfo
UserKeyInfo -> UserKeyInfo -> Bool
UserKeyInfo -> UserKeyInfo -> Ordering
UserKeyInfo -> UserKeyInfo -> UserKeyInfo
forall a.
Eq a
-> (a -> a -> Ordering)
-> (a -> a -> Bool)
-> (a -> a -> Bool)
-> (a -> a -> Bool)
-> (a -> a -> Bool)
-> (a -> a -> a)
-> (a -> a -> a)
-> Ord a
min :: UserKeyInfo -> UserKeyInfo -> UserKeyInfo
$cmin :: UserKeyInfo -> UserKeyInfo -> UserKeyInfo
max :: UserKeyInfo -> UserKeyInfo -> UserKeyInfo
$cmax :: UserKeyInfo -> UserKeyInfo -> UserKeyInfo
>= :: UserKeyInfo -> UserKeyInfo -> Bool
$c>= :: UserKeyInfo -> UserKeyInfo -> Bool
> :: UserKeyInfo -> UserKeyInfo -> Bool
$c> :: UserKeyInfo -> UserKeyInfo -> Bool
<= :: UserKeyInfo -> UserKeyInfo -> Bool
$c<= :: UserKeyInfo -> UserKeyInfo -> Bool
< :: UserKeyInfo -> UserKeyInfo -> Bool
$c< :: UserKeyInfo -> UserKeyInfo -> Bool
compare :: UserKeyInfo -> UserKeyInfo -> Ordering
$ccompare :: UserKeyInfo -> UserKeyInfo -> Ordering
Ord, Typeable, Int -> UserKeyInfo -> PubKeyText -> PubKeyText
[UserKeyInfo] -> PubKeyText -> PubKeyText
UserKeyInfo -> PubKeyText
forall a.
(Int -> a -> PubKeyText -> PubKeyText)
-> (a -> PubKeyText) -> ([a] -> PubKeyText -> PubKeyText) -> Show a
showList :: [UserKeyInfo] -> PubKeyText -> PubKeyText
$cshowList :: [UserKeyInfo] -> PubKeyText -> PubKeyText
show :: UserKeyInfo -> PubKeyText
$cshow :: UserKeyInfo -> PubKeyText
showsPrec :: Int -> UserKeyInfo -> PubKeyText -> PubKeyText
$cshowsPrec :: Int -> UserKeyInfo -> PubKeyText -> PubKeyText
Show)

instance IsInfo UserKeyInfo where
	propagateInfo :: UserKeyInfo -> PropagateInfo
propagateInfo UserKeyInfo
_ = Bool -> PropagateInfo
PropagateInfo Bool
False

instance Sem.Semigroup UserKeyInfo where
	UserKeyInfo Map User (Set (SshKeyType, PubKeyText))
old <> :: UserKeyInfo -> UserKeyInfo -> UserKeyInfo
<> UserKeyInfo Map User (Set (SshKeyType, PubKeyText))
new =
		Map User (Set (SshKeyType, PubKeyText)) -> UserKeyInfo
UserKeyInfo (forall k a. Ord k => (a -> a -> a) -> Map k a -> Map k a -> Map k a
M.unionWith forall a. Ord a => Set a -> Set a -> Set a
S.union Map User (Set (SshKeyType, PubKeyText))
old Map User (Set (SshKeyType, PubKeyText))
new)

instance Monoid UserKeyInfo where
	mempty :: UserKeyInfo
mempty = Map User (Set (SshKeyType, PubKeyText)) -> UserKeyInfo
UserKeyInfo forall k a. Map k a
M.empty
	mappend :: UserKeyInfo -> UserKeyInfo -> UserKeyInfo
mappend = forall a. Semigroup a => a -> a -> a
(Sem.<>)

-- | Sets up a user with the specified public keys, and the corresponding
-- private keys from the privdata.
--
-- The public keys are added to the Info, so other properties like
-- `authorizedKeysFrom` can use them.
userKeys :: IsContext c => User -> c -> [(SshKeyType, PubKeyText)] -> Property (HasInfo + UnixLike)
userKeys :: forall c.
IsContext c =>
User
-> c
-> [(SshKeyType, PubKeyText)]
-> Property
     (HasInfo
      + MetaTypes
          '[ 'Targeting 'OSDebian, 'Targeting 'OSBuntish,
             'Targeting 'OSArchLinux, 'Targeting 'OSFreeBSD])
userKeys user :: User
user@(User PubKeyText
name) c
context [(SshKeyType, PubKeyText)]
ks = forall {k} (metatypes :: k).
SingI metatypes =>
PubKeyText
-> Props (MetaTypes metatypes) -> Property (MetaTypes metatypes)
combineProperties PubKeyText
desc forall a b. (a -> b) -> a -> b
$ forall {k} (metatypes :: k).
[Property (MetaTypes metatypes)] -> Props (MetaTypes metatypes)
toProps forall a b. (a -> b) -> a -> b
$
	User
-> [(SshKeyType, PubKeyText)]
-> Property
     (HasInfo
      + MetaTypes
          '[ 'Targeting 'OSDebian, 'Targeting 'OSBuntish,
             'Targeting 'OSArchLinux, 'Targeting 'OSFreeBSD])
userPubKeys User
user [(SshKeyType, PubKeyText)]
ks forall a. a -> [a] -> [a]
: forall a b. (a -> b) -> [a] -> [b]
map (forall c.
IsContext c =>
Maybe PubKeyText
-> User
-> c
-> (SshKeyType, PubKeyText)
-> Property
     (HasInfo
      + MetaTypes
          '[ 'Targeting 'OSDebian, 'Targeting 'OSBuntish,
             'Targeting 'OSArchLinux, 'Targeting 'OSFreeBSD])
userKeyAt forall a. Maybe a
Nothing User
user c
context) [(SshKeyType, PubKeyText)]
ks
  where
	desc :: PubKeyText
desc = [PubKeyText] -> PubKeyText
unwords
		[ PubKeyText
name
		, PubKeyText
"has ssh key"
		, PubKeyText
"(" forall a. [a] -> [a] -> [a]
++ [PubKeyText] -> PubKeyText
unwords (forall a b. (a -> b) -> [a] -> [b]
map (SshKeyType -> PubKeyText
fromKeyType forall b c a. (b -> c) -> (a -> b) -> a -> c
. forall a b. (a, b) -> a
fst) [(SshKeyType, PubKeyText)]
ks) forall a. [a] -> [a] -> [a]
++ PubKeyText
")"
		]

-- | Sets up a user with the specified pubic key, and a private
-- key from the privdata.
--
-- A FilePath can be specified to write the key to somewhere other than
-- the default locations. Allows a user to have multiple keys for
-- different roles.
--
-- When the FilePath is relative, is put inside the User's 
-- ~/.ssh/ directory.
userKeyAt :: IsContext c => Maybe FilePath -> User -> c -> (SshKeyType, PubKeyText) -> Property (HasInfo + UnixLike)
userKeyAt :: forall c.
IsContext c =>
Maybe PubKeyText
-> User
-> c
-> (SshKeyType, PubKeyText)
-> Property
     (HasInfo
      + MetaTypes
          '[ 'Targeting 'OSDebian, 'Targeting 'OSBuntish,
             'Targeting 'OSArchLinux, 'Targeting 'OSFreeBSD])
userKeyAt Maybe PubKeyText
dest user :: User
user@(User PubKeyText
u) c
context (SshKeyType
keytype, PubKeyText
pubkeytext) =
	forall {k} (metatypes :: k).
SingI metatypes =>
PubKeyText
-> Props (MetaTypes metatypes) -> Property (MetaTypes metatypes)
combineProperties PubKeyText
desc forall a b. (a -> b) -> a -> b
$ Props
  (MetaTypes
     '[ 'Targeting 'OSDebian, 'Targeting 'OSBuntish,
        'Targeting 'OSArchLinux, 'Targeting 'OSFreeBSD])
props
		forall {a} p (y :: [a]) (x :: [a]).
(IsProp p, MetaTypes y ~ GetMetaTypes p,
 CheckCombinableNote x y (NoteFor ('Text "&"))) =>
Props (MetaTypes x) -> p -> Props (MetaTypes (Combine x y))
& Property
  (MetaTypes
     '[ 'Targeting 'OSDebian, 'Targeting 'OSBuntish,
        'Targeting 'OSArchLinux, 'Targeting 'OSFreeBSD])
pubkey
		forall {a} p (y :: [a]) (x :: [a]).
(IsProp p, MetaTypes y ~ GetMetaTypes p,
 CheckCombinableNote x y (NoteFor ('Text "&"))) =>
Props (MetaTypes x) -> p -> Props (MetaTypes (Combine x y))
& Property
  (HasInfo
   + MetaTypes
       '[ 'Targeting 'OSDebian, 'Targeting 'OSBuntish,
          'Targeting 'OSArchLinux, 'Targeting 'OSFreeBSD])
privkey
  where
	desc :: PubKeyText
desc = [PubKeyText] -> PubKeyText
unwords forall a b. (a -> b) -> a -> b
$ forall a. [Maybe a] -> [a]
catMaybes
		[ forall a. a -> Maybe a
Just PubKeyText
u
		, forall a. a -> Maybe a
Just PubKeyText
"has ssh key"
		, Maybe PubKeyText
dest
		, forall a. a -> Maybe a
Just forall a b. (a -> b) -> a -> b
$ PubKeyText
"(" forall a. [a] -> [a] -> [a]
++ SshKeyType -> PubKeyText
fromKeyType SshKeyType
keytype forall a. [a] -> [a] -> [a]
++ PubKeyText
")"
		]
	pubkey :: Property UnixLike
	pubkey :: Property
  (MetaTypes
     '[ 'Targeting 'OSDebian, 'Targeting 'OSBuntish,
        'Targeting 'OSArchLinux, 'Targeting 'OSFreeBSD])
pubkey = forall {k} (metatypes :: k).
SingI metatypes =>
PubKeyText
-> (OuterMetaTypesWitness metatypes -> Propellor Result)
-> Property (MetaTypes metatypes)
property' PubKeyText
desc forall a b. (a -> b) -> a -> b
$ \OuterMetaTypesWitness
  '[ 'Targeting 'OSDebian, 'Targeting 'OSBuntish,
     'Targeting 'OSArchLinux, 'Targeting 'OSFreeBSD]
w -> 
		forall (inner :: [MetaType]) (outer :: [MetaType]).
EnsurePropertyAllowed inner outer =>
OuterMetaTypesWitness outer
-> Property (MetaTypes inner) -> Propellor Result
ensureProperty OuterMetaTypesWitness
  '[ 'Targeting 'OSDebian, 'Targeting 'OSBuntish,
     'Targeting 'OSArchLinux, 'Targeting 'OSFreeBSD]
w forall (m :: * -> *) a b. Monad m => (a -> m b) -> m a -> m b
=<< (PubKeyText
 -> [PubKeyText]
 -> Property
      (MetaTypes
         '[ 'Targeting 'OSDebian, 'Targeting 'OSBuntish,
            'Targeting 'OSArchLinux, 'Targeting 'OSFreeBSD]))
-> PubKeyText
-> [PubKeyText]
-> Propellor
     (Property
        (MetaTypes
           (Combine
              (Combine
                 (Combine
                    '[ 'Targeting 'OSDebian, 'Targeting 'OSBuntish,
                       'Targeting 'OSArchLinux, 'Targeting 'OSFreeBSD]
                    '[ 'Targeting 'OSDebian, 'Targeting 'OSBuntish,
                       'Targeting 'OSArchLinux, 'Targeting 'OSFreeBSD])
                 '[ 'Targeting 'OSDebian, 'Targeting 'OSBuntish,
                    'Targeting 'OSArchLinux, 'Targeting 'OSFreeBSD])
              '[ 'Targeting 'OSDebian, 'Targeting 'OSBuntish,
                 'Targeting 'OSArchLinux, 'Targeting 'OSFreeBSD])))
installprop PubKeyText
-> [PubKeyText]
-> Property
     (MetaTypes
        '[ 'Targeting 'OSDebian, 'Targeting 'OSBuntish,
           'Targeting 'OSArchLinux, 'Targeting 'OSFreeBSD])
File.hasContent PubKeyText
".pub" [PubKeyText
pubkeytext]
	privkey :: Property (HasInfo + UnixLike)
	privkey :: Property
  (HasInfo
   + MetaTypes
       '[ 'Targeting 'OSDebian, 'Targeting 'OSBuntish,
          'Targeting 'OSArchLinux, 'Targeting 'OSFreeBSD])
privkey = forall c s metatypes.
(IsContext c, IsPrivDataSource s,
 IncludesInfo metatypes ~ 'True) =>
s
-> c
-> (((PrivData -> Propellor Result) -> Propellor Result)
    -> Property metatypes)
-> Property metatypes
withPrivData (SshKeyType -> PubKeyText -> PrivDataField
SshPrivKey SshKeyType
keytype PubKeyText
u) c
context ((PrivData -> Propellor Result) -> Propellor Result)
-> Property
     (HasInfo
      + MetaTypes
          '[ 'Targeting 'OSDebian, 'Targeting 'OSBuntish,
             'Targeting 'OSArchLinux, 'Targeting 'OSFreeBSD])
privkey'
	privkey' :: ((PrivData -> Propellor Result) -> Propellor Result) -> Property (HasInfo + UnixLike)
	privkey' :: ((PrivData -> Propellor Result) -> Propellor Result)
-> Property
     (HasInfo
      + MetaTypes
          '[ 'Targeting 'OSDebian, 'Targeting 'OSBuntish,
             'Targeting 'OSArchLinux, 'Targeting 'OSFreeBSD])
privkey' (PrivData -> Propellor Result) -> Propellor Result
getkey = forall {k} (metatypes :: k).
SingI metatypes =>
PubKeyText
-> (OuterMetaTypesWitness metatypes -> Propellor Result)
-> Property (MetaTypes metatypes)
property' PubKeyText
desc forall a b. (a -> b) -> a -> b
$ \OuterMetaTypesWitness
  '[ 'WithInfo, 'Targeting 'OSDebian, 'Targeting 'OSBuntish,
     'Targeting 'OSArchLinux, 'Targeting 'OSFreeBSD]
w -> (PrivData -> Propellor Result) -> Propellor Result
getkey forall a b. (a -> b) -> a -> b
$ \PrivData
k ->
		forall (inner :: [MetaType]) (outer :: [MetaType]).
EnsurePropertyAllowed inner outer =>
OuterMetaTypesWitness outer
-> Property (MetaTypes inner) -> Propellor Result
ensureProperty OuterMetaTypesWitness
  '[ 'WithInfo, 'Targeting 'OSDebian, 'Targeting 'OSBuntish,
     'Targeting 'OSArchLinux, 'Targeting 'OSFreeBSD]
w
			forall (m :: * -> *) a b. Monad m => (a -> m b) -> m a -> m b
=<< (PubKeyText
 -> [PubKeyText]
 -> Property
      (MetaTypes
         '[ 'Targeting 'OSDebian, 'Targeting 'OSBuntish,
            'Targeting 'OSArchLinux, 'Targeting 'OSFreeBSD]))
-> PubKeyText
-> [PubKeyText]
-> Propellor
     (Property
        (MetaTypes
           (Combine
              (Combine
                 (Combine
                    '[ 'Targeting 'OSDebian, 'Targeting 'OSBuntish,
                       'Targeting 'OSArchLinux, 'Targeting 'OSFreeBSD]
                    '[ 'Targeting 'OSDebian, 'Targeting 'OSBuntish,
                       'Targeting 'OSArchLinux, 'Targeting 'OSFreeBSD])
                 '[ 'Targeting 'OSDebian, 'Targeting 'OSBuntish,
                    'Targeting 'OSArchLinux, 'Targeting 'OSFreeBSD])
              '[ 'Targeting 'OSDebian, 'Targeting 'OSBuntish,
                 'Targeting 'OSArchLinux, 'Targeting 'OSFreeBSD])))
installprop PubKeyText
-> [PubKeyText]
-> Property
     (MetaTypes
        '[ 'Targeting 'OSDebian, 'Targeting 'OSBuntish,
           'Targeting 'OSArchLinux, 'Targeting 'OSFreeBSD])
File.hasContentProtected PubKeyText
"" (PrivData -> [PubKeyText]
privDataLines PrivData
k)
	installprop :: (PubKeyText
 -> [PubKeyText]
 -> Property
      (MetaTypes
         '[ 'Targeting 'OSDebian, 'Targeting 'OSBuntish,
            'Targeting 'OSArchLinux, 'Targeting 'OSFreeBSD]))
-> PubKeyText
-> [PubKeyText]
-> Propellor
     (Property
        (MetaTypes
           (Combine
              (Combine
                 (Combine
                    '[ 'Targeting 'OSDebian, 'Targeting 'OSBuntish,
                       'Targeting 'OSArchLinux, 'Targeting 'OSFreeBSD]
                    '[ 'Targeting 'OSDebian, 'Targeting 'OSBuntish,
                       'Targeting 'OSArchLinux, 'Targeting 'OSFreeBSD])
                 '[ 'Targeting 'OSDebian, 'Targeting 'OSBuntish,
                    'Targeting 'OSArchLinux, 'Targeting 'OSFreeBSD])
              '[ 'Targeting 'OSDebian, 'Targeting 'OSBuntish,
                 'Targeting 'OSArchLinux, 'Targeting 'OSFreeBSD])))
installprop PubKeyText
-> [PubKeyText]
-> Property
     (MetaTypes
        '[ 'Targeting 'OSDebian, 'Targeting 'OSBuntish,
           'Targeting 'OSArchLinux, 'Targeting 'OSFreeBSD])
writer PubKeyText
ext [PubKeyText]
key = do
		PubKeyText
f <- forall (m :: * -> *) a. MonadIO m => IO a -> m a
liftIO forall a b. (a -> b) -> a -> b
$ PubKeyText -> IO PubKeyText
keyfile PubKeyText
ext
		forall (m :: * -> *) a. Monad m => a -> m a
return forall a b. (a -> b) -> a -> b
$ forall {k} (metatypes :: k).
SingI metatypes =>
PubKeyText
-> Props (MetaTypes metatypes) -> Property (MetaTypes metatypes)
combineProperties PubKeyText
desc forall a b. (a -> b) -> a -> b
$ Props
  (MetaTypes
     '[ 'Targeting 'OSDebian, 'Targeting 'OSBuntish,
        'Targeting 'OSArchLinux, 'Targeting 'OSFreeBSD])
props
			forall {a} p (y :: [a]) (x :: [a]).
(IsProp p, MetaTypes y ~ GetMetaTypes p,
 CheckCombinableNote x y (NoteFor ('Text "&"))) =>
Props (MetaTypes x) -> p -> Props (MetaTypes (Combine x y))
& PubKeyText
-> Property
     (MetaTypes
        '[ 'Targeting 'OSDebian, 'Targeting 'OSBuntish,
           'Targeting 'OSArchLinux, 'Targeting 'OSFreeBSD])
File.dirExists (PubKeyText -> PubKeyText
takeDirectory PubKeyText
f)
			forall {a} p (y :: [a]) (x :: [a]).
(IsProp p, MetaTypes y ~ GetMetaTypes p,
 CheckCombinableNote x y (NoteFor ('Text "&"))) =>
Props (MetaTypes x) -> p -> Props (MetaTypes (Combine x y))
& PubKeyText
-> [PubKeyText]
-> Property
     (MetaTypes
        '[ 'Targeting 'OSDebian, 'Targeting 'OSBuntish,
           'Targeting 'OSArchLinux, 'Targeting 'OSFreeBSD])
writer PubKeyText
f ([PubKeyText] -> [PubKeyText]
keyFileContent [PubKeyText]
key)
			forall {a} p (y :: [a]) (x :: [a]).
(IsProp p, MetaTypes y ~ GetMetaTypes p,
 CheckCombinableNote x y (NoteFor ('Text "&"))) =>
Props (MetaTypes x) -> p -> Props (MetaTypes (Combine x y))
& PubKeyText
-> User
-> Group
-> Property
     (MetaTypes
        '[ 'Targeting 'OSDebian, 'Targeting 'OSBuntish,
           'Targeting 'OSArchLinux, 'Targeting 'OSFreeBSD])
File.ownerGroup PubKeyText
f User
user (User -> Group
userGroup User
user)
			forall {a} p (y :: [a]) (x :: [a]).
(IsProp p, MetaTypes y ~ GetMetaTypes p,
 CheckCombinableNote x y (NoteFor ('Text "&"))) =>
Props (MetaTypes x) -> p -> Props (MetaTypes (Combine x y))
& PubKeyText
-> User
-> Group
-> Property
     (MetaTypes
        '[ 'Targeting 'OSDebian, 'Targeting 'OSBuntish,
           'Targeting 'OSArchLinux, 'Targeting 'OSFreeBSD])
File.ownerGroup (PubKeyText -> PubKeyText
takeDirectory PubKeyText
f) User
user (User -> Group
userGroup User
user)
	keyfile :: PubKeyText -> IO PubKeyText
keyfile PubKeyText
ext = case Maybe PubKeyText
dest of
		Maybe PubKeyText
Nothing -> PubKeyText -> IO PubKeyText
relhomessh forall a b. (a -> b) -> a -> b
$ PubKeyText
"id_" forall a. [a] -> [a] -> [a]
++ SshKeyType -> PubKeyText
fromKeyType SshKeyType
keytype forall a. [a] -> [a] -> [a]
++ PubKeyText
ext
		Just PubKeyText
f
			| PubKeyText -> Bool
isRelative PubKeyText
f -> PubKeyText -> IO PubKeyText
relhomessh (PubKeyText
f forall a. [a] -> [a] -> [a]
++ PubKeyText
ext)
			| Bool
otherwise -> forall (m :: * -> *) a. Monad m => a -> m a
return (PubKeyText
f forall a. [a] -> [a] -> [a]
++ PubKeyText
ext)
	relhomessh :: PubKeyText -> IO PubKeyText
relhomessh PubKeyText
f = do
		PubKeyText
home <- UserEntry -> PubKeyText
homeDirectory forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
<$> PubKeyText -> IO UserEntry
getUserEntryForName PubKeyText
u
		forall (m :: * -> *) a. Monad m => a -> m a
return forall a b. (a -> b) -> a -> b
$ PubKeyText
home PubKeyText -> PubKeyText -> PubKeyText
</> PubKeyText
".ssh" PubKeyText -> PubKeyText -> PubKeyText
</> PubKeyText
f

fromKeyType :: SshKeyType -> String
fromKeyType :: SshKeyType -> PubKeyText
fromKeyType SshKeyType
SshRsa = PubKeyText
"rsa"
fromKeyType SshKeyType
SshDsa = PubKeyText
"dsa"
fromKeyType SshKeyType
SshEcdsa = PubKeyText
"ecdsa"
fromKeyType SshKeyType
SshEd25519 = PubKeyText
"ed25519"

-- | Puts some host's ssh public key(s), as set using `hostPubKey`
-- or `hostKey` into the known_hosts file for a user.
knownHost :: [Host] -> HostName -> User -> Property UnixLike
knownHost :: [Host]
-> PubKeyText
-> User
-> Property
     (MetaTypes
        '[ 'Targeting 'OSDebian, 'Targeting 'OSBuntish,
           'Targeting 'OSArchLinux, 'Targeting 'OSFreeBSD])
knownHost [Host]
hosts PubKeyText
hn user :: User
user@(User PubKeyText
u) = forall {k} (metatypes :: k).
SingI metatypes =>
PubKeyText
-> (OuterMetaTypesWitness metatypes -> Propellor Result)
-> Property (MetaTypes metatypes)
property' PubKeyText
desc forall a b. (a -> b) -> a -> b
$ \OuterMetaTypesWitness
  '[ 'Targeting 'OSDebian, 'Targeting 'OSBuntish,
     'Targeting 'OSArchLinux, 'Targeting 'OSFreeBSD]
w ->
	OuterMetaTypesWitness
  '[ 'Targeting 'OSDebian, 'Targeting 'OSBuntish,
     'Targeting 'OSArchLinux, 'Targeting 'OSFreeBSD]
-> [PubKeyText] -> Propellor Result
go OuterMetaTypesWitness
  '[ 'Targeting 'OSDebian, 'Targeting 'OSBuntish,
     'Targeting 'OSArchLinux, 'Targeting 'OSFreeBSD]
w forall (m :: * -> *) a b. Monad m => (a -> m b) -> m a -> m b
=<< [Host] -> PubKeyText -> Propellor [PubKeyText]
knownHostLines [Host]
hosts PubKeyText
hn
  where
	desc :: PubKeyText
desc = PubKeyText
u forall a. [a] -> [a] -> [a]
++ PubKeyText
" knows ssh key for " forall a. [a] -> [a] -> [a]
++ PubKeyText
hn

	go :: OuterMetaTypesWitness
  '[ 'Targeting 'OSDebian, 'Targeting 'OSBuntish,
     'Targeting 'OSArchLinux, 'Targeting 'OSFreeBSD]
-> [PubKeyText] -> Propellor Result
go OuterMetaTypesWitness
  '[ 'Targeting 'OSDebian, 'Targeting 'OSBuntish,
     'Targeting 'OSArchLinux, 'Targeting 'OSFreeBSD]
_ [] = do
		forall (m :: * -> *). MonadIO m => PubKeyText -> m ()
warningMessage forall a b. (a -> b) -> a -> b
$ PubKeyText
"no configured ssh host keys for " forall a. [a] -> [a] -> [a]
++ PubKeyText
hn
		forall (m :: * -> *) a. Monad m => a -> m a
return Result
FailedChange
	go OuterMetaTypesWitness
  '[ 'Targeting 'OSDebian, 'Targeting 'OSBuntish,
     'Targeting 'OSArchLinux, 'Targeting 'OSFreeBSD]
w [PubKeyText]
ls = do
		PubKeyText
f <- forall (m :: * -> *) a. MonadIO m => IO a -> m a
liftIO forall a b. (a -> b) -> a -> b
$ PubKeyText -> User -> IO PubKeyText
dotFile PubKeyText
"known_hosts" User
user
		forall (inner :: [MetaType]) (outer :: [MetaType]).
EnsurePropertyAllowed inner outer =>
OuterMetaTypesWitness outer
-> Property (MetaTypes inner) -> Propellor Result
ensureProperty OuterMetaTypesWitness
  '[ 'Targeting 'OSDebian, 'Targeting 'OSBuntish,
     'Targeting 'OSArchLinux, 'Targeting 'OSFreeBSD]
w forall a b. (a -> b) -> a -> b
$ User
-> PubKeyText
-> Property
     (MetaTypes
        '[ 'Targeting 'OSDebian, 'Targeting 'OSBuntish,
           'Targeting 'OSArchLinux, 'Targeting 'OSFreeBSD])
-> Property
     (MetaTypes
        '[ 'Targeting 'OSDebian, 'Targeting 'OSBuntish,
           'Targeting 'OSArchLinux, 'Targeting 'OSFreeBSD])
modKnownHost User
user PubKeyText
f forall a b. (a -> b) -> a -> b
$
			PubKeyText
f PubKeyText
-> [PubKeyText]
-> Property
     (MetaTypes
        '[ 'Targeting 'OSDebian, 'Targeting 'OSBuntish,
           'Targeting 'OSArchLinux, 'Targeting 'OSFreeBSD])
`File.containsLines` [PubKeyText]
ls
				forall x y. Combines x y => x -> y -> CombinedType x y
`requires` PubKeyText
-> Property
     (MetaTypes
        '[ 'Targeting 'OSDebian, 'Targeting 'OSBuntish,
           'Targeting 'OSArchLinux, 'Targeting 'OSFreeBSD])
File.dirExists (PubKeyText -> PubKeyText
takeDirectory PubKeyText
f)

-- | Reverts `knownHost`
unknownHost :: [Host] -> HostName -> User -> Property UnixLike
unknownHost :: [Host]
-> PubKeyText
-> User
-> Property
     (MetaTypes
        '[ 'Targeting 'OSDebian, 'Targeting 'OSBuntish,
           'Targeting 'OSArchLinux, 'Targeting 'OSFreeBSD])
unknownHost [Host]
hosts PubKeyText
hn user :: User
user@(User PubKeyText
u) = forall {k} (metatypes :: k).
SingI metatypes =>
PubKeyText
-> (OuterMetaTypesWitness metatypes -> Propellor Result)
-> Property (MetaTypes metatypes)
property' PubKeyText
desc forall a b. (a -> b) -> a -> b
$ \OuterMetaTypesWitness
  '[ 'Targeting 'OSDebian, 'Targeting 'OSBuntish,
     'Targeting 'OSArchLinux, 'Targeting 'OSFreeBSD]
w ->
	OuterMetaTypesWitness
  '[ 'Targeting 'OSDebian, 'Targeting 'OSBuntish,
     'Targeting 'OSArchLinux, 'Targeting 'OSFreeBSD]
-> [PubKeyText] -> Propellor Result
go OuterMetaTypesWitness
  '[ 'Targeting 'OSDebian, 'Targeting 'OSBuntish,
     'Targeting 'OSArchLinux, 'Targeting 'OSFreeBSD]
w forall (m :: * -> *) a b. Monad m => (a -> m b) -> m a -> m b
=<< [Host] -> PubKeyText -> Propellor [PubKeyText]
knownHostLines [Host]
hosts PubKeyText
hn
  where
	desc :: PubKeyText
desc = PubKeyText
u forall a. [a] -> [a] -> [a]
++ PubKeyText
" does not know ssh key for " forall a. [a] -> [a] -> [a]
++ PubKeyText
hn

	go :: OuterMetaTypesWitness
  '[ 'Targeting 'OSDebian, 'Targeting 'OSBuntish,
     'Targeting 'OSArchLinux, 'Targeting 'OSFreeBSD]
-> [PubKeyText] -> Propellor Result
go OuterMetaTypesWitness
  '[ 'Targeting 'OSDebian, 'Targeting 'OSBuntish,
     'Targeting 'OSArchLinux, 'Targeting 'OSFreeBSD]
_ [] = forall (m :: * -> *) a. Monad m => a -> m a
return Result
NoChange
	go OuterMetaTypesWitness
  '[ 'Targeting 'OSDebian, 'Targeting 'OSBuntish,
     'Targeting 'OSArchLinux, 'Targeting 'OSFreeBSD]
w [PubKeyText]
ls = do
		PubKeyText
f <- forall (m :: * -> *) a. MonadIO m => IO a -> m a
liftIO forall a b. (a -> b) -> a -> b
$ PubKeyText -> User -> IO PubKeyText
dotFile PubKeyText
"known_hosts" User
user
		forall (m :: * -> *) a. Monad m => m Bool -> (m a, m a) -> m a
ifM (forall (m :: * -> *) a. MonadIO m => IO a -> m a
liftIO forall a b. (a -> b) -> a -> b
$ PubKeyText -> IO Bool
doesFileExist PubKeyText
f)
			( forall (inner :: [MetaType]) (outer :: [MetaType]).
EnsurePropertyAllowed inner outer =>
OuterMetaTypesWitness outer
-> Property (MetaTypes inner) -> Propellor Result
ensureProperty OuterMetaTypesWitness
  '[ 'Targeting 'OSDebian, 'Targeting 'OSBuntish,
     'Targeting 'OSArchLinux, 'Targeting 'OSFreeBSD]
w forall a b. (a -> b) -> a -> b
$ User
-> PubKeyText
-> Property
     (MetaTypes
        '[ 'Targeting 'OSDebian, 'Targeting 'OSBuntish,
           'Targeting 'OSArchLinux, 'Targeting 'OSFreeBSD])
-> Property
     (MetaTypes
        '[ 'Targeting 'OSDebian, 'Targeting 'OSBuntish,
           'Targeting 'OSArchLinux, 'Targeting 'OSFreeBSD])
modKnownHost User
user PubKeyText
f forall a b. (a -> b) -> a -> b
$
				PubKeyText
f PubKeyText
-> [PubKeyText]
-> Property
     (MetaTypes
        '[ 'Targeting 'OSDebian, 'Targeting 'OSBuntish,
           'Targeting 'OSArchLinux, 'Targeting 'OSFreeBSD])
`File.lacksLines` [PubKeyText]
ls
			, forall (m :: * -> *) a. Monad m => a -> m a
return Result
NoChange
			)

knownHostLines :: [Host] -> HostName -> Propellor [File.Line]
knownHostLines :: [Host] -> PubKeyText -> Propellor [PubKeyText]
knownHostLines [Host]
hosts PubKeyText
hn = Maybe (Map SshKeyType PubKeyText) -> [PubKeyText]
keylines forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
<$> forall a.
[Host] -> PubKeyText -> Propellor a -> Propellor (Maybe a)
fromHost [Host]
hosts PubKeyText
hn Propellor (Map SshKeyType PubKeyText)
getHostPubKey
  where
	keylines :: Maybe (Map SshKeyType PubKeyText) -> [PubKeyText]
keylines (Just Map SshKeyType PubKeyText
m) = forall a b. (a -> b) -> [a] -> [b]
map (\PubKeyText
k -> PubKeyText
hn forall a. [a] -> [a] -> [a]
++ PubKeyText
" " forall a. [a] -> [a] -> [a]
++ PubKeyText
k) (forall k a. Map k a -> [a]
M.elems Map SshKeyType PubKeyText
m)
	keylines Maybe (Map SshKeyType PubKeyText)
Nothing = []

modKnownHost :: User -> FilePath -> Property UnixLike -> Property UnixLike
modKnownHost :: User
-> PubKeyText
-> Property
     (MetaTypes
        '[ 'Targeting 'OSDebian, 'Targeting 'OSBuntish,
           'Targeting 'OSArchLinux, 'Targeting 'OSFreeBSD])
-> Property
     (MetaTypes
        '[ 'Targeting 'OSDebian, 'Targeting 'OSBuntish,
           'Targeting 'OSArchLinux, 'Targeting 'OSFreeBSD])
modKnownHost User
user PubKeyText
f Property
  (MetaTypes
     '[ 'Targeting 'OSDebian, 'Targeting 'OSBuntish,
        'Targeting 'OSArchLinux, 'Targeting 'OSFreeBSD])
p = Property
  (MetaTypes
     '[ 'Targeting 'OSDebian, 'Targeting 'OSBuntish,
        'Targeting 'OSArchLinux, 'Targeting 'OSFreeBSD])
p
	forall x y. Combines x y => x -> y -> CombinedType x y
`before` PubKeyText
-> User
-> Group
-> Property
     (MetaTypes
        '[ 'Targeting 'OSDebian, 'Targeting 'OSBuntish,
           'Targeting 'OSArchLinux, 'Targeting 'OSFreeBSD])
File.ownerGroup PubKeyText
f User
user (User -> Group
userGroup User
user)
	forall x y. Combines x y => x -> y -> CombinedType x y
`before` PubKeyText
-> User
-> Group
-> Property
     (MetaTypes
        '[ 'Targeting 'OSDebian, 'Targeting 'OSBuntish,
           'Targeting 'OSArchLinux, 'Targeting 'OSFreeBSD])
File.ownerGroup (PubKeyText -> PubKeyText
takeDirectory PubKeyText
f) User
user (User -> Group
userGroup User
user)

-- | Ensures that a local user's authorized_keys contains lines allowing
-- logins from a remote user on the specified Host.
--
-- The ssh keys of the remote user can be set using `userKeys`
--
-- Any other lines in the authorized_keys file are preserved as-is.
authorizedKeysFrom :: User -> (User, Host) -> Property UnixLike
localuser :: User
localuser@(User PubKeyText
ln) authorizedKeysFrom :: User
-> (User, Host)
-> Property
     (MetaTypes
        '[ 'Targeting 'OSDebian, 'Targeting 'OSBuntish,
           'Targeting 'OSArchLinux, 'Targeting 'OSFreeBSD])
`authorizedKeysFrom` (remoteuser :: User
remoteuser@(User PubKeyText
rn), Host
remotehost) =
	forall {k} (metatypes :: k).
SingI metatypes =>
PubKeyText
-> (OuterMetaTypesWitness metatypes -> Propellor Result)
-> Property (MetaTypes metatypes)
property' PubKeyText
desc (\OuterMetaTypesWitness
  '[ 'Targeting 'OSDebian, 'Targeting 'OSBuntish,
     'Targeting 'OSArchLinux, 'Targeting 'OSFreeBSD]
w -> OuterMetaTypesWitness
  '[ 'Targeting 'OSDebian, 'Targeting 'OSBuntish,
     'Targeting 'OSArchLinux, 'Targeting 'OSFreeBSD]
-> [PubKeyText] -> Propellor Result
go OuterMetaTypesWitness
  '[ 'Targeting 'OSDebian, 'Targeting 'OSBuntish,
     'Targeting 'OSArchLinux, 'Targeting 'OSFreeBSD]
w forall (m :: * -> *) a b. Monad m => (a -> m b) -> m a -> m b
=<< User -> Host -> Propellor [PubKeyText]
authorizedKeyLines User
remoteuser Host
remotehost)
  where
	remote :: PubKeyText
remote = PubKeyText
rn forall a. [a] -> [a] -> [a]
++ PubKeyText
"@" forall a. [a] -> [a] -> [a]
++ Host -> PubKeyText
hostName Host
remotehost
	desc :: PubKeyText
desc = PubKeyText
ln forall a. [a] -> [a] -> [a]
++ PubKeyText
" authorized_keys from " forall a. [a] -> [a] -> [a]
++ PubKeyText
remote

	go :: OuterMetaTypesWitness
  '[ 'Targeting 'OSDebian, 'Targeting 'OSBuntish,
     'Targeting 'OSArchLinux, 'Targeting 'OSFreeBSD]
-> [PubKeyText] -> Propellor Result
go OuterMetaTypesWitness
  '[ 'Targeting 'OSDebian, 'Targeting 'OSBuntish,
     'Targeting 'OSArchLinux, 'Targeting 'OSFreeBSD]
_ [] = do
		forall (m :: * -> *). MonadIO m => PubKeyText -> m ()
warningMessage forall a b. (a -> b) -> a -> b
$ PubKeyText
"no configured ssh user keys for " forall a. [a] -> [a] -> [a]
++ PubKeyText
remote
		forall (m :: * -> *) a. Monad m => a -> m a
return Result
FailedChange
	go OuterMetaTypesWitness
  '[ 'Targeting 'OSDebian, 'Targeting 'OSBuntish,
     'Targeting 'OSArchLinux, 'Targeting 'OSFreeBSD]
w [PubKeyText]
ls = forall (inner :: [MetaType]) (outer :: [MetaType]).
EnsurePropertyAllowed inner outer =>
OuterMetaTypesWitness outer
-> Property (MetaTypes inner) -> Propellor Result
ensureProperty OuterMetaTypesWitness
  '[ 'Targeting 'OSDebian, 'Targeting 'OSBuntish,
     'Targeting 'OSArchLinux, 'Targeting 'OSFreeBSD]
w forall a b. (a -> b) -> a -> b
$ forall {k} (metatypes :: k).
SingI metatypes =>
PubKeyText
-> Props (MetaTypes metatypes) -> Property (MetaTypes metatypes)
combineProperties PubKeyText
desc forall a b. (a -> b) -> a -> b
$ forall {k} (metatypes :: k).
[Property (MetaTypes metatypes)] -> Props (MetaTypes metatypes)
toProps forall a b. (a -> b) -> a -> b
$
		forall a b. (a -> b) -> [a] -> [b]
map (forall setupmetatypes undometatypes.
RevertableProperty setupmetatypes undometatypes
-> Property setupmetatypes
setupRevertableProperty forall b c a. (b -> c) -> (a -> b) -> a -> c
. User
-> PubKeyText
-> RevertableProperty
     (MetaTypes
        '[ 'Targeting 'OSDebian, 'Targeting 'OSBuntish,
           'Targeting 'OSArchLinux, 'Targeting 'OSFreeBSD])
     (MetaTypes
        '[ 'Targeting 'OSDebian, 'Targeting 'OSBuntish,
           'Targeting 'OSArchLinux, 'Targeting 'OSFreeBSD])
authorizedKey User
localuser) [PubKeyText]
ls

-- | Reverts `authorizedKeysFrom`
unauthorizedKeysFrom :: User -> (User, Host) -> Property UnixLike
localuser :: User
localuser@(User PubKeyText
ln) unauthorizedKeysFrom :: User
-> (User, Host)
-> Property
     (MetaTypes
        '[ 'Targeting 'OSDebian, 'Targeting 'OSBuntish,
           'Targeting 'OSArchLinux, 'Targeting 'OSFreeBSD])
`unauthorizedKeysFrom` (remoteuser :: User
remoteuser@(User PubKeyText
rn), Host
remotehost) =
	forall {k} (metatypes :: k).
SingI metatypes =>
PubKeyText
-> (OuterMetaTypesWitness metatypes -> Propellor Result)
-> Property (MetaTypes metatypes)
property' PubKeyText
desc (\OuterMetaTypesWitness
  '[ 'Targeting 'OSDebian, 'Targeting 'OSBuntish,
     'Targeting 'OSArchLinux, 'Targeting 'OSFreeBSD]
w -> OuterMetaTypesWitness
  '[ 'Targeting 'OSDebian, 'Targeting 'OSBuntish,
     'Targeting 'OSArchLinux, 'Targeting 'OSFreeBSD]
-> [PubKeyText] -> Propellor Result
go OuterMetaTypesWitness
  '[ 'Targeting 'OSDebian, 'Targeting 'OSBuntish,
     'Targeting 'OSArchLinux, 'Targeting 'OSFreeBSD]
w forall (m :: * -> *) a b. Monad m => (a -> m b) -> m a -> m b
=<< User -> Host -> Propellor [PubKeyText]
authorizedKeyLines User
remoteuser Host
remotehost)
  where
	remote :: PubKeyText
remote = PubKeyText
rn forall a. [a] -> [a] -> [a]
++ PubKeyText
"@" forall a. [a] -> [a] -> [a]
++ Host -> PubKeyText
hostName Host
remotehost
	desc :: PubKeyText
desc = PubKeyText
ln forall a. [a] -> [a] -> [a]
++ PubKeyText
" unauthorized_keys from " forall a. [a] -> [a] -> [a]
++ PubKeyText
remote

	go :: OuterMetaTypesWitness
  '[ 'Targeting 'OSDebian, 'Targeting 'OSBuntish,
     'Targeting 'OSArchLinux, 'Targeting 'OSFreeBSD]
-> [PubKeyText] -> Propellor Result
go OuterMetaTypesWitness
  '[ 'Targeting 'OSDebian, 'Targeting 'OSBuntish,
     'Targeting 'OSArchLinux, 'Targeting 'OSFreeBSD]
_ [] = forall (m :: * -> *) a. Monad m => a -> m a
return Result
NoChange
	go OuterMetaTypesWitness
  '[ 'Targeting 'OSDebian, 'Targeting 'OSBuntish,
     'Targeting 'OSArchLinux, 'Targeting 'OSFreeBSD]
w [PubKeyText]
ls = forall (inner :: [MetaType]) (outer :: [MetaType]).
EnsurePropertyAllowed inner outer =>
OuterMetaTypesWitness outer
-> Property (MetaTypes inner) -> Propellor Result
ensureProperty OuterMetaTypesWitness
  '[ 'Targeting 'OSDebian, 'Targeting 'OSBuntish,
     'Targeting 'OSArchLinux, 'Targeting 'OSFreeBSD]
w forall a b. (a -> b) -> a -> b
$ forall {k} (metatypes :: k).
SingI metatypes =>
PubKeyText
-> Props (MetaTypes metatypes) -> Property (MetaTypes metatypes)
combineProperties PubKeyText
desc forall a b. (a -> b) -> a -> b
$ forall {k} (metatypes :: k).
[Property (MetaTypes metatypes)] -> Props (MetaTypes metatypes)
toProps forall a b. (a -> b) -> a -> b
$
		forall a b. (a -> b) -> [a] -> [b]
map (forall setupmetatypes undometatypes.
RevertableProperty setupmetatypes undometatypes
-> Property undometatypes
undoRevertableProperty forall b c a. (b -> c) -> (a -> b) -> a -> c
. User
-> PubKeyText
-> RevertableProperty
     (MetaTypes
        '[ 'Targeting 'OSDebian, 'Targeting 'OSBuntish,
           'Targeting 'OSArchLinux, 'Targeting 'OSFreeBSD])
     (MetaTypes
        '[ 'Targeting 'OSDebian, 'Targeting 'OSBuntish,
           'Targeting 'OSArchLinux, 'Targeting 'OSFreeBSD])
authorizedKey User
localuser) [PubKeyText]
ls

authorizedKeyLines :: User -> Host -> Propellor [File.Line]
authorizedKeyLines :: User -> Host -> Propellor [PubKeyText]
authorizedKeyLines User
remoteuser Host
remotehost =
	forall a b. (a -> b) -> [a] -> [b]
map forall a b. (a, b) -> b
snd forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
<$> forall a. Host -> Propellor a -> Propellor a
fromHost' Host
remotehost (User -> Propellor [(SshKeyType, PubKeyText)]
getUserPubKeys User
remoteuser)

-- | Makes a user have authorized_keys from the PrivData
--
-- This removes any other lines from the file.
authorizedKeys :: IsContext c => User -> c -> Property (HasInfo + UnixLike)
authorizedKeys :: forall c.
IsContext c =>
User
-> c
-> Property
     (HasInfo
      + MetaTypes
          '[ 'Targeting 'OSDebian, 'Targeting 'OSBuntish,
             'Targeting 'OSArchLinux, 'Targeting 'OSFreeBSD])
authorizedKeys user :: User
user@(User PubKeyText
u) c
context = forall c s metatypes.
(IsContext c, IsPrivDataSource s,
 IncludesInfo metatypes ~ 'True) =>
s
-> c
-> (((PrivData -> Propellor Result) -> Propellor Result)
    -> Property metatypes)
-> Property metatypes
withPrivData (PubKeyText -> PrivDataField
SshAuthorizedKeys PubKeyText
u) c
context forall a b. (a -> b) -> a -> b
$ \(PrivData -> Propellor Result) -> Propellor Result
get ->
	forall {k} (metatypes :: k).
SingI metatypes =>
PubKeyText
-> (OuterMetaTypesWitness metatypes -> Propellor Result)
-> Property (MetaTypes metatypes)
property' PubKeyText
desc forall a b. (a -> b) -> a -> b
$ \OuterMetaTypesWitness
  '[ 'WithInfo, 'Targeting 'OSDebian, 'Targeting 'OSBuntish,
     'Targeting 'OSArchLinux, 'Targeting 'OSFreeBSD]
w -> (PrivData -> Propellor Result) -> Propellor Result
get forall a b. (a -> b) -> a -> b
$ \PrivData
v -> do
		PubKeyText
f <- forall (m :: * -> *) a. MonadIO m => IO a -> m a
liftIO forall a b. (a -> b) -> a -> b
$ PubKeyText -> User -> IO PubKeyText
dotFile PubKeyText
"authorized_keys" User
user
		forall (inner :: [MetaType]) (outer :: [MetaType]).
EnsurePropertyAllowed inner outer =>
OuterMetaTypesWitness outer
-> Property (MetaTypes inner) -> Propellor Result
ensureProperty OuterMetaTypesWitness
  '[ 'WithInfo, 'Targeting 'OSDebian, 'Targeting 'OSBuntish,
     'Targeting 'OSArchLinux, 'Targeting 'OSFreeBSD]
w forall a b. (a -> b) -> a -> b
$ forall {k} (metatypes :: k).
SingI metatypes =>
PubKeyText
-> Props (MetaTypes metatypes) -> Property (MetaTypes metatypes)
combineProperties PubKeyText
desc forall a b. (a -> b) -> a -> b
$ Props
  (MetaTypes
     '[ 'Targeting 'OSDebian, 'Targeting 'OSBuntish,
        'Targeting 'OSArchLinux, 'Targeting 'OSFreeBSD])
props
			forall {a} p (y :: [a]) (x :: [a]).
(IsProp p, MetaTypes y ~ GetMetaTypes p,
 CheckCombinableNote x y (NoteFor ('Text "&"))) =>
Props (MetaTypes x) -> p -> Props (MetaTypes (Combine x y))
& PubKeyText
-> [PubKeyText]
-> Property
     (MetaTypes
        '[ 'Targeting 'OSDebian, 'Targeting 'OSBuntish,
           'Targeting 'OSArchLinux, 'Targeting 'OSFreeBSD])
File.hasContentProtected PubKeyText
f ([PubKeyText] -> [PubKeyText]
keyFileContent (PrivData -> [PubKeyText]
privDataLines PrivData
v))
			forall {a} p (y :: [a]) (x :: [a]).
(IsProp p, MetaTypes y ~ GetMetaTypes p,
 CheckCombinableNote x y (NoteFor ('Text "&"))) =>
Props (MetaTypes x) -> p -> Props (MetaTypes (Combine x y))
& PubKeyText
-> User
-> Group
-> Property
     (MetaTypes
        '[ 'Targeting 'OSDebian, 'Targeting 'OSBuntish,
           'Targeting 'OSArchLinux, 'Targeting 'OSFreeBSD])
File.ownerGroup PubKeyText
f User
user (User -> Group
userGroup User
user)
			forall {a} p (y :: [a]) (x :: [a]).
(IsProp p, MetaTypes y ~ GetMetaTypes p,
 CheckCombinableNote x y (NoteFor ('Text "&"))) =>
Props (MetaTypes x) -> p -> Props (MetaTypes (Combine x y))
& PubKeyText
-> User
-> Group
-> Property
     (MetaTypes
        '[ 'Targeting 'OSDebian, 'Targeting 'OSBuntish,
           'Targeting 'OSArchLinux, 'Targeting 'OSFreeBSD])
File.ownerGroup (PubKeyText -> PubKeyText
takeDirectory PubKeyText
f) User
user (User -> Group
userGroup User
user)
  where
	desc :: PubKeyText
desc = PubKeyText
u forall a. [a] -> [a] -> [a]
++ PubKeyText
" has authorized_keys"

-- | Ensures that a user's authorized_keys contains a line.
-- Any other lines in the file are preserved as-is.
authorizedKey :: User -> String -> RevertableProperty UnixLike UnixLike
authorizedKey :: User
-> PubKeyText
-> RevertableProperty
     (MetaTypes
        '[ 'Targeting 'OSDebian, 'Targeting 'OSBuntish,
           'Targeting 'OSArchLinux, 'Targeting 'OSFreeBSD])
     (MetaTypes
        '[ 'Targeting 'OSDebian, 'Targeting 'OSBuntish,
           'Targeting 'OSArchLinux, 'Targeting 'OSFreeBSD])
authorizedKey user :: User
user@(User PubKeyText
u) PubKeyText
l = Property
  (MetaTypes
     '[ 'Targeting 'OSDebian, 'Targeting 'OSBuntish,
        'Targeting 'OSArchLinux, 'Targeting 'OSFreeBSD])
add forall setupmetatypes undometatypes.
Property setupmetatypes
-> Property undometatypes
-> RevertableProperty setupmetatypes undometatypes
<!> Property
  (MetaTypes
     '[ 'Targeting 'OSDebian, 'Targeting 'OSBuntish,
        'Targeting 'OSArchLinux, 'Targeting 'OSFreeBSD])
remove
  where
	add :: Property
  (MetaTypes
     '[ 'Targeting 'OSDebian, 'Targeting 'OSBuntish,
        'Targeting 'OSArchLinux, 'Targeting 'OSFreeBSD])
add = forall {k} (metatypes :: k).
SingI metatypes =>
PubKeyText
-> (OuterMetaTypesWitness metatypes -> Propellor Result)
-> Property (MetaTypes metatypes)
property' (PubKeyText
u forall a. [a] -> [a] -> [a]
++ PubKeyText
" has authorized_keys") forall a b. (a -> b) -> a -> b
$ \OuterMetaTypesWitness
  '[ 'Targeting 'OSDebian, 'Targeting 'OSBuntish,
     'Targeting 'OSArchLinux, 'Targeting 'OSFreeBSD]
w -> do
		PubKeyText
f <- forall (m :: * -> *) a. MonadIO m => IO a -> m a
liftIO forall a b. (a -> b) -> a -> b
$ PubKeyText -> User -> IO PubKeyText
dotFile PubKeyText
"authorized_keys" User
user
		forall (inner :: [MetaType]) (outer :: [MetaType]).
EnsurePropertyAllowed inner outer =>
OuterMetaTypesWitness outer
-> Property (MetaTypes inner) -> Propellor Result
ensureProperty OuterMetaTypesWitness
  '[ 'Targeting 'OSDebian, 'Targeting 'OSBuntish,
     'Targeting 'OSArchLinux, 'Targeting 'OSFreeBSD]
w forall a b. (a -> b) -> a -> b
$ PubKeyText
-> User
-> Property
     (MetaTypes
        '[ 'Targeting 'OSDebian, 'Targeting 'OSBuntish,
           'Targeting 'OSArchLinux, 'Targeting 'OSFreeBSD])
-> Property
     (MetaTypes
        '[ 'Targeting 'OSDebian, 'Targeting 'OSBuntish,
           'Targeting 'OSArchLinux, 'Targeting 'OSFreeBSD])
modAuthorizedKey PubKeyText
f User
user forall a b. (a -> b) -> a -> b
$
			PubKeyText
f PubKeyText
-> PubKeyText
-> Property
     (MetaTypes
        '[ 'Targeting 'OSDebian, 'Targeting 'OSBuntish,
           'Targeting 'OSArchLinux, 'Targeting 'OSFreeBSD])
`File.containsLine` PubKeyText
l
				forall x y. Combines x y => x -> y -> CombinedType x y
`requires` PubKeyText
-> Property
     (MetaTypes
        '[ 'Targeting 'OSDebian, 'Targeting 'OSBuntish,
           'Targeting 'OSArchLinux, 'Targeting 'OSFreeBSD])
File.dirExists (PubKeyText -> PubKeyText
takeDirectory PubKeyText
f)
	remove :: Property
  (MetaTypes
     '[ 'Targeting 'OSDebian, 'Targeting 'OSBuntish,
        'Targeting 'OSArchLinux, 'Targeting 'OSFreeBSD])
remove = forall {k} (metatypes :: k).
SingI metatypes =>
PubKeyText
-> (OuterMetaTypesWitness metatypes -> Propellor Result)
-> Property (MetaTypes metatypes)
property' (PubKeyText
u forall a. [a] -> [a] -> [a]
++ PubKeyText
" lacks authorized_keys") forall a b. (a -> b) -> a -> b
$ \OuterMetaTypesWitness
  '[ 'Targeting 'OSDebian, 'Targeting 'OSBuntish,
     'Targeting 'OSArchLinux, 'Targeting 'OSFreeBSD]
w -> do
		PubKeyText
f <- forall (m :: * -> *) a. MonadIO m => IO a -> m a
liftIO forall a b. (a -> b) -> a -> b
$ PubKeyText -> User -> IO PubKeyText
dotFile PubKeyText
"authorized_keys" User
user
		forall (m :: * -> *) a. Monad m => m Bool -> (m a, m a) -> m a
ifM (forall (m :: * -> *) a. MonadIO m => IO a -> m a
liftIO forall a b. (a -> b) -> a -> b
$ PubKeyText -> IO Bool
doesFileExist PubKeyText
f)
			( forall (inner :: [MetaType]) (outer :: [MetaType]).
EnsurePropertyAllowed inner outer =>
OuterMetaTypesWitness outer
-> Property (MetaTypes inner) -> Propellor Result
ensureProperty OuterMetaTypesWitness
  '[ 'Targeting 'OSDebian, 'Targeting 'OSBuntish,
     'Targeting 'OSArchLinux, 'Targeting 'OSFreeBSD]
w forall a b. (a -> b) -> a -> b
$ PubKeyText
-> User
-> Property
     (MetaTypes
        '[ 'Targeting 'OSDebian, 'Targeting 'OSBuntish,
           'Targeting 'OSArchLinux, 'Targeting 'OSFreeBSD])
-> Property
     (MetaTypes
        '[ 'Targeting 'OSDebian, 'Targeting 'OSBuntish,
           'Targeting 'OSArchLinux, 'Targeting 'OSFreeBSD])
modAuthorizedKey PubKeyText
f User
user forall a b. (a -> b) -> a -> b
$
				PubKeyText
f PubKeyText
-> PubKeyText
-> Property
     (MetaTypes
        '[ 'Targeting 'OSDebian, 'Targeting 'OSBuntish,
           'Targeting 'OSArchLinux, 'Targeting 'OSFreeBSD])
`File.lacksLine` PubKeyText
l
			, forall (m :: * -> *) a. Monad m => a -> m a
return Result
NoChange
			)

modAuthorizedKey :: FilePath -> User -> Property UnixLike -> Property UnixLike
modAuthorizedKey :: PubKeyText
-> User
-> Property
     (MetaTypes
        '[ 'Targeting 'OSDebian, 'Targeting 'OSBuntish,
           'Targeting 'OSArchLinux, 'Targeting 'OSFreeBSD])
-> Property
     (MetaTypes
        '[ 'Targeting 'OSDebian, 'Targeting 'OSBuntish,
           'Targeting 'OSArchLinux, 'Targeting 'OSFreeBSD])
modAuthorizedKey PubKeyText
f User
user Property
  (MetaTypes
     '[ 'Targeting 'OSDebian, 'Targeting 'OSBuntish,
        'Targeting 'OSArchLinux, 'Targeting 'OSFreeBSD])
p = Property
  (MetaTypes
     '[ 'Targeting 'OSDebian, 'Targeting 'OSBuntish,
        'Targeting 'OSArchLinux, 'Targeting 'OSFreeBSD])
p
	forall x y. Combines x y => x -> y -> CombinedType x y
`before` PubKeyText
-> FileMode
-> Property
     (MetaTypes
        '[ 'Targeting 'OSDebian, 'Targeting 'OSBuntish,
           'Targeting 'OSArchLinux, 'Targeting 'OSFreeBSD])
File.mode PubKeyText
f ([FileMode] -> FileMode
combineModes [FileMode
ownerWriteMode, FileMode
ownerReadMode])
	forall x y. Combines x y => x -> y -> CombinedType x y
`before` PubKeyText
-> User
-> Group
-> Property
     (MetaTypes
        '[ 'Targeting 'OSDebian, 'Targeting 'OSBuntish,
           'Targeting 'OSArchLinux, 'Targeting 'OSFreeBSD])
File.ownerGroup PubKeyText
f User
user (User -> Group
userGroup User
user)
	forall x y. Combines x y => x -> y -> CombinedType x y
`before` PubKeyText
-> User
-> Group
-> Property
     (MetaTypes
        '[ 'Targeting 'OSDebian, 'Targeting 'OSBuntish,
           'Targeting 'OSArchLinux, 'Targeting 'OSFreeBSD])
File.ownerGroup (PubKeyText -> PubKeyText
takeDirectory PubKeyText
f) User
user (User -> Group
userGroup User
user)