This commit is contained in:
Philippe PITTOLI 2024-04-16 22:40:26 +02:00
parent 915e779511
commit 9dfbc12e80
7 changed files with 11 additions and 11 deletions

View File

@ -1,5 +1,5 @@
{- Administration interface. {- Administration interface.
Allows to: Enables to:
- add, remove, search users - add, remove, search users
- TODO: validate users - TODO: validate users
- TODO: change user password - TODO: change user password

View File

@ -1,7 +1,7 @@
-- | `App.DomainListInterface` is a simple component with the list of own domains -- | `App.DomainListInterface` is a simple component with the list of own domains
-- | and a form to add a new domain. -- | and a form to add a new domain.
-- | -- |
-- | This interface allows to: -- | This interface enables to:
-- | - display the list of own domains -- | - display the list of own domains
-- | - show and select accepted domains (TLDs) -- | - show and select accepted domains (TLDs)
-- | - create new domains -- | - create new domains

View File

@ -117,7 +117,7 @@ render _ = HH.div_
""" """
, link "https://git.baguette.netlib.re/Baguette/dnsmanager" "dnsmanagerd" , link "https://git.baguette.netlib.re/Baguette/dnsmanager" "dnsmanagerd"
""" """
the dns manager daemon, used as an interactive database, allowing clients the dns manager daemon, used as an interactive database, enabling clients
to ask for domains, then handle the domain zones; to ask for domains, then handle the domain zones;
""" """
, link "https://git.baguette.netlib.re/Baguette/dnsmanager-webclient" , link "https://git.baguette.netlib.re/Baguette/dnsmanager-webclient"
@ -137,7 +137,7 @@ render _ = HH.div_
""" """
, link "https://git.baguette.netlib.re/Baguette/dodb.cr" "dodb" , link "https://git.baguette.netlib.re/Baguette/dodb.cr" "dodb"
""" """
the Document Oriented DataBase, allowing to store serialized objects the Document Oriented DataBase, enabling to store serialized objects
(a Zone, a User, etc.) in simple files as opposed to the usual complexity of (a Zone, a User, etc.) in simple files as opposed to the usual complexity of
traditional databases. traditional databases.
""" """

View File

@ -1,4 +1,4 @@
-- | `App.SetupInterface` allows users to change their password or their email address. -- | `App.SetupInterface` enables users to change their password or their email address.
-- | Users can also erase their account. -- | Users can also erase their account.
module App.Page.Setup where module App.Page.Setup where

View File

@ -1,6 +1,6 @@
-- | `App.ZoneInterface` provides an interface to display and modify a DNS zone. -- | `App.ZoneInterface` provides an interface to display and modify a DNS zone.
-- | -- |
-- | This interface allows to: -- | This interface enables to:
-- | - display all resource records of a zone (SOA, NS, A, AAAA, CNAME, TXT, MX, SRV) -- | - display all resource records of a zone (SOA, NS, A, AAAA, CNAME, TXT, MX, SRV)
-- | - provide dedicated interfaces for SPF and DKIM (TODO: DMARC) -- | - provide dedicated interfaces for SPF and DKIM (TODO: DMARC)
-- | - add, modify, remove resource records -- | - add, modify, remove resource records

View File

@ -148,7 +148,7 @@ dkim_introduction :: forall w i. Array (HH.HTML w i)
dkim_introduction = dkim_introduction =
[ Bulma.p """ [ Bulma.p """
DKIM is a way to share a public signature key for the domain. DKIM is a way to share a public signature key for the domain.
This allows emails to be signed by the sender, and for the receiver to prove the origin of the mail. This enables emails to be signed by the sender and for the receiver to verify the origin of the mail.
""" """
, HH.p [] , HH.p []
[ HH.text """ [ HH.text """
@ -168,7 +168,7 @@ dmarc_introduction =
DMARC is a spam mitigation mechanism on top of SPF and DKIM. DMARC is a spam mitigation mechanism on top of SPF and DKIM.
Upon receiving a mail, the server checks whether the "From:" field of the mail is consistent with the SPF and DKIM Upon receiving a mail, the server checks whether the "From:" field of the mail is consistent with the SPF and DKIM
records of the sender's domain. records of the sender's domain.
The DMARC record tells what to do with the mail in case of an inconsistency, and DMARC allows to define email The DMARC record tells what to do with the mail in case of an inconsistency, and DMARC enables to define email
addresses that should receive error reports. addresses that should receive error reports.
""" """
] ]
@ -176,7 +176,7 @@ dmarc_introduction =
dmarc_policy :: forall w i. Array (HH.HTML w i) dmarc_policy :: forall w i. Array (HH.HTML w i)
dmarc_policy = dmarc_policy =
[ Bulma.p """ [ Bulma.p """
DMARC record allows to tell receivers what to do with a non-conforming message; DMARC record enables to tell receivers what to do with a non-conforming message;
a message that wasn't properly secured with SPF and DKIM. a message that wasn't properly secured with SPF and DKIM.
""" """
, Bulma.p """ , Bulma.p """

View File

@ -108,7 +108,7 @@ txt_parser = do pos <- G.current_position
then pure $ CU.fromCharArray v then pure $ CU.fromCharArray v
else G.Parser \_ -> G.failureError pos (Just $ TXTTooLong max_txt nbchar) else G.Parser \_ -> G.failureError pos (Just $ TXTTooLong max_txt nbchar)
-- | `parse` allows to run any parser based on `GenericParser` and provide a validation error. -- | `parse` enables to run any parser based on `GenericParser` and provide a validation error.
-- | The actual validation error contains the parser's error including the position. -- | The actual validation error contains the parser's error including the position.
parse :: forall e v. G.Parser e v -> String -> ((G.Error e) -> Error) -> V (Array Error) v parse :: forall e v. G.Parser e v -> String -> ((G.Error e) -> Error) -> V (Array Error) v
parse (G.Parser p) str c = case p { string: str, position: 0 } of parse (G.Parser p) str c = case p { string: str, position: 0 } of
@ -273,7 +273,7 @@ validationSPF form = ado
-- | Accepted RSA key sizes = 2048 or 4096 bits, 256 bits for ED25519. -- | Accepted RSA key sizes = 2048 or 4096 bits, 256 bits for ED25519.
-- | -- |
-- | Since the public key representation for the RSA algorithm is in PKCS format (RFC 5958) -- | Since the public key representation for the RSA algorithm is in PKCS format (RFC 5958)
-- | then converted in PEM (RFC 7468), and knowing this format allows some optional parameters, -- | then converted in PEM (RFC 7468), and knowing this format enables some optional parameters,
-- | it is not possible to expect an exact size for the public key input. -- | it is not possible to expect an exact size for the public key input.
-- | Consequently, we expect *at least* an input of 250 bytes for public key, loosely leading -- | Consequently, we expect *at least* an input of 250 bytes for public key, loosely leading
-- | to accept key sizes of at least 2048 bits. Maximum allowed key size is also arbitrary. -- | to accept key sizes of at least 2048 bits. Maximum allowed key size is also arbitrary.