std/bcrypt

Index

• const MIN_COST
• const MAX_COST
• const DEFAULT_COST
• type BcryptErr
  • method BcryptErr.display
• fn hash
• fn compare
• fn cost

Constants

MIN_COST

const MIN_COST: Int = 4

The lowest cost hash accepts; a lower one is replaced by DEFAULT_COST (Go’s MinCost).

Source: std/bcrypt.xo:11

MAX_COST

const MAX_COST: Int = 31

The highest cost (Go’s MaxCost).

Source: std/bcrypt.xo:13

DEFAULT_COST

const DEFAULT_COST: Int = 10

The cost hash uses by default and for a cost below MIN_COST (Go’s DefaultCost).

Source: std/bcrypt.xo:16

Types

BcryptErr

enum BcryptErr {
  Mismatch
  HashTooShort
  VersionTooNew(version: Int)
  InvalidPrefix(byte: Int)
  InvalidCost(cost: Int)
  PasswordTooLong
  Corrupt(msg: Str)
}

Go’s errors, with Go’s texts as display(): crypto/bcrypt: hashedPassword is not the hash of the given password, crypto/bcrypt: hashedSecret too short to be a bcrypted password, crypto/bcrypt: bcrypt algorithm version '3' requested is newer than current version '2', crypto/bcrypt: bcrypt hashes must start with '$', but hashedSecret started with 'x', crypto/bcrypt: cost 3 is outside allowed inclusive range 4..31, bcrypt: password length exceeds 72 bytes; Corrupt is a cost or salt that is not valid text (Go’s strconv and base64 errors).

Source: std/bcrypt.xo:26

BcryptErr.display

fn (e: BcryptErr) display() -> Str

Source: std/bcrypt.xo:36

Functions

hash

fn hash(password: Bytes, rand: Rand, cost: Int = 10) -> Str ! BcryptErr uses rand

A new hash of password (Go’s GenerateFromPassword): 60 characters, with a random salt drawn from rand. A cost below MIN_COST is DEFAULT_COST; above MAX_COST is InvalidCost; a password over 72 bytes is PasswordTooLong.

Source: std/bcrypt.xo:42

compare

fn compare(hashed: Str, password: Bytes) -> () ! BcryptErr

Ok when hashed is the bcrypt hash of password (Go’s CompareHashAndPassword), Mismatch when it is not, and the other errors when hashed is not a bcrypt hash. The comparison of the hashes takes the same time wherever they differ.

Source: std/bcrypt.xo:47

cost

fn cost(hashed: Str) -> Int ! BcryptErr

The cost hashed was made with (Go’s Cost).

Source: std/bcrypt.xo:49