Safe Haskell | None |
---|---|
Language | Haskell98 |
- data PrivDataField
- data PrivDataSource
- type PrivDataSourceDesc = String
- class IsPrivDataSource s where
- newtype Context = Context String
- newtype HostContext = HostContext {
- mkHostContext :: HostName -> Context
- class IsContext c where
- anyContext :: Context
- hostContext :: HostContext
- newtype PrivData = PrivData String
- privDataLines :: PrivData -> [String]
- privDataVal :: PrivData -> String
- privDataByteString :: PrivData -> ByteString
- data SshKeyType
- = SshRsa
- | SshDsa
- | SshEcdsa
- | SshEd25519
- sshKeyTypeParam :: SshKeyType -> String
- data DnsSecKey
Documentation
data PrivDataField Source #
Note that removing or changing constructors or changing types will break the serialized privdata files, so don't do that! It's fine to add new constructors.
DockerAuthentication | |
SshPubKey SshKeyType UserName | Not used anymore, but retained to avoid breaking serialization of old files |
SshPrivKey SshKeyType UserName | For host key, use empty UserName |
SshAuthorizedKeys UserName | |
Password UserName | |
CryptPassword UserName | |
PrivFile FilePath | |
GpgKey | |
DnsSec DnsSecKey |
data PrivDataSource Source #
Combines a PrivDataField with a description of how to generate its value.
type PrivDataSourceDesc = String Source #
class IsPrivDataSource s where Source #
privDataField :: s -> PrivDataField Source #
describePrivDataSource :: s -> Maybe PrivDataSourceDesc Source #
A context in which a PrivDataField is used.
Often this will be a domain name. For example, Context "www.example.com" could be used for the SSL cert for the web server serving that domain. Multiple hosts might use that privdata.
This appears in serialized privdata files.
newtype HostContext Source #
A context that may vary depending on the HostName where it's used.
class IsContext c where Source #
Class of things that can be used as a Context.
asContext :: HostName -> c -> Context Source #
asHostContext :: c -> HostContext Source #
anyContext :: Context Source #
Use when a PrivDataField is not dependent on any paricular context.
hostContext :: HostContext Source #
Makes a HostContext that consists just of the hostname.
Contains the actual private data.
Note that this may contain exta newlines at the end, or they may have been stripped off, depending on how the user entered the privdata, and which version of propellor stored it. Use the accessor functions below to avoid newline problems.
privDataLines :: PrivData -> [String] Source #
When PrivData is the content of a file, this is the lines thereof.
privDataVal :: PrivData -> String Source #
When the PrivData is a single value, like a password, this extracts it. Note that if multiple lines are present in the PrivData, only the first is returned; there is never a newline in the String.
privDataByteString :: PrivData -> ByteString Source #
Use to get ByteString out of PrivData.
data SshKeyType Source #
sshKeyTypeParam :: SshKeyType -> String Source #
Parameter that would be passed to ssh-keygen to generate key of this type