An environment in which authentication is performed.
It is expected that you will have a singleton instance of this class for
your entire app/service. The default method in the companion object
creates an instance with some reasonable defaults and caching.
It is not strictly necessary to use this class, but it certain classes such
as EncryptedCodec and SignedCodec have convenient instantiation methods
that take an authentication environment.
The environment can also be set up for asymmetric signing and verification.
To set it up for asymmetric signing, set the signing key. For asymmetric
verification, set the verify key. Both can be set if the library user needs
to perform both functions.
F
the context wrapping most of the results of the environment.
For example, F is usually AuthResult, which means that an F[A]
is either an AuthFailure or a successful A.
An environment in which authentication is performed.
It is expected that you will have a singleton instance of this class for your entire app/service. The
defaultmethod in the companion object creates an instance with some reasonable defaults and caching.It is not strictly necessary to use this class, but it certain classes such as
EncryptedCodecandSignedCodechave convenient instantiation methods that take an authentication environment.The environment can also be set up for asymmetric signing and verification. To set it up for asymmetric signing, set the signing key. For asymmetric verification, set the verify key. Both can be set if the library user needs to perform both functions.
the context wrapping most of the results of the environment. For example,
Fis usuallyAuthResult, which means that anF[A]is either anAuthFailureor a successfulA.