tsec.passwordhashers.PasswordHashAPI.scala Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of tsec-common_2.12 Show documentation
tsec-common
The newest version!
package tsec.passwordhashers

import cats.{Functor, Id}
import tsec.common.VerificationStatus

trait PasswordHashAPI[A] {

  def hashpw[F[_]](p: String)(implicit P: PasswordHasher[F, A]): F[PasswordHash[A]] =
    P.hashpw(p)

  /** Hash a password in a char array
    * then clear the data in the password original
    * array, as well as the byte encoding change,
    * but in a pure fashion because
    * side effects suck butt.
    *
    */
  def hashpw[F[_]](p: Array[Char])(implicit P: PasswordHasher[F, A]): F[PasswordHash[A]] = P.hashpw(p)

  /** Hash a password in utf-8 encoded bytes,
    * then clear the data in the password,
    * but in a pure way.
    *
    * @param p the encoded password
    * @return
    */
  def hashpw[F[_]](p: Array[Byte])(implicit P: PasswordHasher[F, A]): F[PasswordHash[A]] =
    P.hashpw(p)

  def hashpwUnsafe(p: String)(implicit P: PasswordHasher[Id, A]): PasswordHash[A] =
    P.hashpwUnsafe(p)

  /** Hash a password in a char array
    * then clear the data in the password original
    * array, as well as the byte encoding change.
    *
    * @param p the encoded password
    * @return
    */
  def hashpwUnsafe(p: Array[Char])(implicit P: PasswordHasher[Id, A]): PasswordHash[A] =
    P.hashpwUnsafe(p)

  /** Hash a password in utf-8 encoded bytes,
    * then clear the data in the password
    *
    * @param p the encoded password
    * @return
    */
  def hashpwUnsafe(p: Array[Byte])(implicit P: PasswordHasher[Id, A]): PasswordHash[A] =
    P.hashpwUnsafe(p)

  /** Check against a bcrypt hash in a pure way
    *
    * It may raise an error for a malformed hash
    */
  def checkpwBool[F[_]](p: String, hash: PasswordHash[A])(implicit P: PasswordHasher[F, A]): F[Boolean] =
    P.checkpwBool(p, hash)

  /** Check against a password hash in a pure way
    *
    * It may raise an error for a malformed hash
    */
  def checkpwBool[F[_]](p: Array[Char], hash: PasswordHash[A])(implicit P: PasswordHasher[F, A]): F[Boolean] =
    P.checkpwBool(p, hash)

  /** Check against a password hash in a pure way
    *
    * It may raise an error for a malformed hash
    */
  def checkpwBool[F[_]](p: Array[Byte], hash: PasswordHash[A])(implicit P: PasswordHasher[F, A]): F[Boolean] =
    P.checkpwBool(p, hash)

  /** Check against a bcrypt hash in a pure way
    *
    * It may raise an error for a malformed hash
    */
  def checkpw[F[_]: Functor](p: String, hash: PasswordHash[A])(
      implicit P: PasswordHasher[F, A]
  ): F[VerificationStatus] =
    P.checkpw(p, hash)

  /** Check against a password hash in a pure way
    *
    * It may raise an error for a malformed hash
    */
  def checkpw[F[_]: Functor](p: Array[Char], hash: PasswordHash[A])(
      implicit P: PasswordHasher[F, A]
  ): F[VerificationStatus] =
    P.checkpw(p, hash)

  /** Check against a password hash in a pure way
    *
    * It may raise an error for a malformed hash
    */
  def checkpw[F[_]: Functor](p: Array[Byte], hash: PasswordHash[A])(
      implicit P: PasswordHasher[F, A]
  ): F[VerificationStatus] =
    P.checkpw(p, hash)

  /** Check against a password hash in an unsafe
    * manner.
    *
    * It may throw an exception for a malformed password
    * @return
    */
  def checkpwUnsafe(p: String, hash: PasswordHash[A])(implicit P: PasswordHasher[Id, A]): Boolean =
    P.checkpwUnsafe(p, hash)

  /** Check against a passwordhash in an unsafe
    * manner.
    *
    * It may throw an exception for a malformed password
    * @return
    */
  def checkpwUnsafe(p: Array[Byte], hash: PasswordHash[A])(implicit P: PasswordHasher[Id, A]): Boolean =
    P.checkpwUnsafe(p, hash)

  /** Check against a passwordhash in an unsafe
    * manner.
    *
    * It may throw an exception for a malformed password
    * @return
    */
  def checkpwUnsafe(p: Array[Char], hash: PasswordHash[A])(implicit P: PasswordHasher[Id, A]): Boolean =
    P.checkpwUnsafe(p, hash)

}