Class BasePasswordHasher

Declaration

Documentation

When creating your own hasher, you need to override algorithm,
verify(), encode() and safe_summary().

PasswordHasher objects are immutable.

Methods

• ▶ def decode(self, encoded)

  Return a decoded database value.

  source link

  The result is a dictionary and should contain `algorithm`, `hash`, and
  `salt`. Extra keys can be algorithm specific like `iterations` or
  `work_factor`.

  Overrides

  This method is overriden in:

  • django.contrib.auth.hashers.PBKDF2PasswordHasher
  • django.contrib.auth.hashers.Argon2PasswordHasher
  • django.contrib.auth.hashers.BCryptSHA256PasswordHasher
  • django.contrib.auth.hashers.SHA1PasswordHasher
  • django.contrib.auth.hashers.MD5PasswordHasher
  • django.contrib.auth.hashers.UnsaltedSHA1PasswordHasher
  • django.contrib.auth.hashers.UnsaltedMD5PasswordHasher
  • django.contrib.auth.hashers.CryptPasswordHasher
• ▶ def encode(self, password, salt)

  Create an encoded database value.

  source link

  The result is normally formatted as "algorithm$salt$hash" and
  must be fewer than 128 characters.

  Overrides

  This method is overriden in:

  • django.contrib.auth.hashers.PBKDF2PasswordHasher
  • django.contrib.auth.hashers.Argon2PasswordHasher
  • django.contrib.auth.hashers.BCryptSHA256PasswordHasher
  • django.contrib.auth.hashers.SHA1PasswordHasher
  • django.contrib.auth.hashers.MD5PasswordHasher
  • django.contrib.auth.hashers.UnsaltedSHA1PasswordHasher
  • django.contrib.auth.hashers.UnsaltedMD5PasswordHasher
  • django.contrib.auth.hashers.CryptPasswordHasher
• ▶ def harden_runtime(self, password, encoded)

  Bridge the runtime gap between the work factor supplied in `encoded` and the work factor suggested by this hasher.

  source link

  Taking PBKDF2 as an example, if `encoded` contains 20000 iterations and
  `self.iterations` is 30000, this method should run password through
  another 10000 iterations of PBKDF2. Similar approaches should exist
  for any hasher that has a work factor. If not, this method should be
  defined as a no-op to silence the warning.

  Overrides

  This method is overriden in:

  • django.contrib.auth.hashers.PBKDF2PasswordHasher
  • django.contrib.auth.hashers.Argon2PasswordHasher
  • django.contrib.auth.hashers.BCryptSHA256PasswordHasher
  • django.contrib.auth.hashers.SHA1PasswordHasher
  • django.contrib.auth.hashers.MD5PasswordHasher
  • django.contrib.auth.hashers.UnsaltedSHA1PasswordHasher
  • django.contrib.auth.hashers.UnsaltedMD5PasswordHasher
  • django.contrib.auth.hashers.CryptPasswordHasher
• ▶ def must_update(self, encoded)

  source link

  Overrides

  This method is overriden in:

  • django.contrib.auth.hashers.PBKDF2PasswordHasher
  • django.contrib.auth.hashers.Argon2PasswordHasher
  • django.contrib.auth.hashers.BCryptSHA256PasswordHasher
• ▶ def safe_summary(self, encoded)

  Return a summary of safe values.

  source link

  The result is a dictionary and will be used where the password field
  must be displayed to construct a safe representation of the password.

  Overrides

  This method is overriden in:

  • django.contrib.auth.hashers.PBKDF2PasswordHasher
  • django.contrib.auth.hashers.Argon2PasswordHasher
  • django.contrib.auth.hashers.BCryptSHA256PasswordHasher
  • django.contrib.auth.hashers.SHA1PasswordHasher
  • django.contrib.auth.hashers.MD5PasswordHasher
  • django.contrib.auth.hashers.UnsaltedSHA1PasswordHasher
  • django.contrib.auth.hashers.UnsaltedMD5PasswordHasher
  • django.contrib.auth.hashers.CryptPasswordHasher
• ▶ def salt(self)

  Generate a cryptographically secure nonce salt in ASCII.

  source link

  Overrides

  This method is overriden in:

  • django.contrib.auth.hashers.BCryptSHA256PasswordHasher
  • django.contrib.auth.hashers.UnsaltedSHA1PasswordHasher
  • django.contrib.auth.hashers.UnsaltedMD5PasswordHasher
  • django.contrib.auth.hashers.CryptPasswordHasher
• ▶ def verify(self, password, encoded)

  Check if the given password is correct.

  source link

  Overrides

  This method is overriden in:

  • django.contrib.auth.hashers.PBKDF2PasswordHasher
  • django.contrib.auth.hashers.Argon2PasswordHasher
  • django.contrib.auth.hashers.BCryptSHA256PasswordHasher
  • django.contrib.auth.hashers.SHA1PasswordHasher
  • django.contrib.auth.hashers.MD5PasswordHasher
  • django.contrib.auth.hashers.UnsaltedSHA1PasswordHasher
  • django.contrib.auth.hashers.UnsaltedMD5PasswordHasher
  • django.contrib.auth.hashers.CryptPasswordHasher

Subclasses

• django.contrib.auth.hashers.PBKDF2PasswordHasher
• django.contrib.auth.hashers.Argon2PasswordHasher
• django.contrib.auth.hashers.BCryptSHA256PasswordHasher
• django.contrib.auth.hashers.SHA1PasswordHasher
• django.contrib.auth.hashers.MD5PasswordHasher
• django.contrib.auth.hashers.UnsaltedSHA1PasswordHasher
• django.contrib.auth.hashers.UnsaltedMD5PasswordHasher
• django.contrib.auth.hashers.CryptPasswordHasher

Generated by nedoc v0.9 at 2020-12-29 14:04