# `PasswordCheck`

What checking a password says: `wrong`, `correct` or `correct_outdated`.

Use what `crypto.verify_password` gives you. On `correct_outdated` the password is right, but its hash was made with older settings, so store a fresh one.

## Shape

One of these 3 values:

`PasswordCheck.wrong`, `PasswordCheck.correct`, `PasswordCheck.correct_outdated`.

## Example

```jadpo
PasswordCheck.correct
```

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

This operation gives one: `crypto.verify_password`.

## Good to know

- `==` tells you whether two are the same. `<` and `list.sort_by` don't take it.

## In JSON

A string, in a request, a response or `json.write`:

```json
"wrong"
"correct"
"correct_outdated"
```

## Details

<details>
<summary>Text form, storage, how it is shown, and operations</summary>

`PasswordCheck` is in the group Security, and has been in Jadpo since 0.1.0.

### Text form

`text.from` writes one standard text form, the same form `text.parse` reads back: `wrong`, `correct` and `correct_outdated`.

### How it is stored

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

### How it is 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.

It also takes `text.parse`, `text.from`, `text.format`, `json.read`, `json.write` and `==`. [How every standard type behaves](/docs/every-standard-type-meets-one-contract.md) says how they work.

</details>