c

nelson.crypto

AuthEnvironment

sealed abstract class AuthEnvironment[F[_]] extends AnyRef

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.

Source
AuthEnvironment.scala
Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. AuthEnvironment
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Abstract Value Members

  1. abstract def decryptor: Decryptor[F]
  2. abstract def encryptionKey: EncryptionKey
  3. abstract def encryptor: Encryptor[F]
  4. abstract def nextNonce: IO[Nonce]
  5. abstract def signer: Signer[F]
  6. abstract def signingKey: SignatureKey