# `PasswordCheck`

What checking a password against its hash says (`crypto.verify_password`): `correct_outdated` is correct against a hash made with older parameters, so store a fresh one.

[Security](types.md#security); not ordered; since Jadpo 0.1.0.

## Make one

Pick one of its variants, `PasswordCheck.wrong`.

`text.parse(raw, as: PasswordCheck)` reads one from its text; text that isn't one at all fails `malformed`, such as `right`, `correctly` or `correct `.

This operation gives one: `crypto.verify_password`.

## Variants

3 variants, each written as its own name: `wrong`, `correct`, `correct_outdated`.

## Text, JSON and storage

`text.from` writes its canonical text, the one form `text.parse` reads back. JSON sends its canonical text as a string.

| Text | JSON |
|---|---|
| `wrong` | `"wrong"` |
| `correct` | `"correct"` |
| `correct_outdated` | `"correct_outdated"` |

It is stored in one column named for the field, of type `text`. `correct` is stored as `'correct'`.

## Shown to people

`text.format(value, locale:)` shows it to people in their locale.

With `locale: Locale.en_gb`:

| Value | Shown |
|---|---|
| `wrong` | `wrong` |
| `correct` | `correct` |
| `correct_outdated` | `correct_outdated` |

## Operations

- `crypto.verify_password(password: Password, hash: PasswordHash) -> PasswordCheck`: `correct`, `wrong`, or `correct_outdated` when the hash was made with older parameters and a fresh one should be stored; compared in constant time.

Like every standard type, it also has the contract's own operations: `text.parse`, `text.from`, `text.format`, `json.read`, `json.write` and `==`. It isn't ordered, so `<` and sorting don't take it. [Every standard type meets one contract](../topics/every-standard-type-meets-one-contract.md) says how they work.