Argon2

https://docs.rs/argon2
Admin
Pure Rust implementation of the Argon2 password hashing function - a memory-hard key derivation...
Tokens:48,367
Snippets:483
Trust Score:9.1
Update:7 hours ago
Show doc for...
Tokens:
Raw
### Params::parallelism

Source: https://docs.rs/argon2/latest/argon2/

Returns the parallelism (number of threads) of the parameters.

```APIDOC
## Params::parallelism

### Description
Returns the parallelism (number of threads) of the parameters.

### Method
Function

### Parameters
None

### Returns
- `u32` - The parallelism.

```

--------------------------------

### Params::output_len

Source: https://docs.rs/argon2/latest/argon2/

Returns the output length (in bytes) of the parameters.

```APIDOC
## Params::output_len

### Description
Returns the output length (in bytes) of the parameters.

### Method
Function

### Parameters
None

### Returns
- `usize` - The output length in bytes.

```

--------------------------------

### Params::secret

Source: https://docs.rs/argon2/latest/argon2/

Returns the secret key of the parameters.

```APIDOC
## Params::secret

### Description
Returns the secret key of the parameters.

### Method
Function

### Parameters
None

### Returns
- `&[u8]` - The secret key.

```

--------------------------------

### Params::key_id

Source: https://docs.rs/argon2/latest/argon2/

Returns the key identifier of the parameters.

```APIDOC
## Params::key_id

### Description
Returns the key identifier of the parameters.

### Method
Function

### Parameters
None

### Returns
- `&[u8]` - The key identifier.

```

--------------------------------

### Params::memory_cost

Source: https://docs.rs/argon2/latest/argon2/

Returns the memory cost (in KiB) of the parameters.

```APIDOC
## Params::memory_cost

### Description
Returns the memory cost (in KiB) of the parameters.

### Method
Function

### Parameters
None

### Returns
- `u32` - The memory cost in KiB.

```

--------------------------------

### Params::associated_data

Source: https://docs.rs/argon2/latest/argon2/

Returns the associated data of the parameters.

```APIDOC
## Params::associated_data

### Description
Returns the associated data of the parameters.

### Method
Function

### Parameters
None

### Returns
- `&[u8]` - The associated data.

```

--------------------------------

### Version enum variants

Source: https://docs.rs/argon2/latest/argon2/

The Version enum defines the version of the algorithm.

```APIDOC
## Version enum variants

### Description
The Version enum defines the version of the algorithm.

### Variants
- `V0x10` - Version 0x10.
- `V0x13` - Version 0x13.

```

--------------------------------

### Constants

Source: https://docs.rs/argon2/latest/argon2/

Constants for Argon2: maximum password length, salt lengths, and algorithm identifiers.

```APIDOC
## Constants

### Description
Constants for Argon2: maximum password length, salt lengths, and algorithm identifiers.

### Constants
- `MAX_PWD_LEN` - Maximum password length in bytes.
- `MAX_SALT_LEN` - Maximum salt length in bytes.
- `MAX_SECRET_LEN` - Maximum secret key length in bytes.
- `MIN_SALT_LEN` - Minimum salt length in bytes.
- `RECOMMENDED_SALT_LEN` - Recommended salt length for password hashing in bytes.
- `ARGON2D_IDENT` - Argon2d algorithm identifier.
- `ARGON2I_IDENT` - Argon2i algorithm identifier.
- `ARGON2ID_IDENT` - Argon2id algorithm identifier.

```

--------------------------------

### Params::time_cost

Source: https://docs.rs/argon2/latest/argon2/

Returns the time cost (number of iterations) of the parameters.

```APIDOC
## Params::time_cost

### Description
Returns the time cost (number of iterations) of the parameters.

### Method
Function

### Parameters
None

### Returns
- `u32` - The time cost.

```

--------------------------------

### Test for rejecting a salt shorter than 8 bytes

Source: https://docs.rs/argon2/latest/src/argon2/lib.rs.html

Verifies that `hash_password_customized` returns `password_hash::Error::SaltInvalid` when the salt is shorter than the minimum 8-byte size. Uses the example password `hunter42` and salt `weesalt`.

```rust
#[test]
fn decoded_salt_too_short() {
    let argon2 = Argon2::default();

    // Too short: minimum size 8-bytes
    let salt = b"weesalt";

    let res =
        argon2.hash_password_customized(EXAMPLE_PASSWORD, salt, None, None, Params::default());

    assert_eq!(res, Err(password_hash::Error::SaltInvalid));
}
```

--------------------------------

### ParamsBuilder::build

Source: https://docs.rs/argon2/latest/argon2/

Builds the Params from the builder's configuration. This method finalizes the builder and returns the Params struct.

```APIDOC
## ParamsBuilder::build

### Description
Builds the Params from the builder's configuration. This method finalizes the builder and returns the Params struct.

### Method
Function

### Parameters
None

### Returns
- `Result<Params>` - The constructed Params or an error.

```

--------------------------------

### Params::new

Source: https://docs.rs/argon2/latest/argon2/

Creates new Argon2 parameters with the given memory cost, time cost, parallelism, and optional output length. This is a convenience constructor.

```APIDOC
## Params::new

### Description
Creates new Argon2 parameters with the given memory cost, time cost, parallelism, and optional output length. This is a convenience constructor.

### Method
Constructor

### Parameters
- `m_cost` (u32) - Required - The memory cost in KiB.
- `t_cost` (u32) - Required - The time cost (number of iterations).
- `p_cost` (u32) - Required - The parallelism (number of threads).
- `output_len` (Option<usize>) - Optional - The output length in bytes.

### Returns
- `Result<Params>` - The constructed Params or an error.

```

--------------------------------

### From<Params> and From<&Params> conversions for Argon2

Source: https://docs.rs/argon2/latest/src/argon2/lib.rs.html

Provides conversions from `Params` and `&Params` to `Argon2`, creating an instance with default `Algorithm` and `Version`. Useful for constructing an `Argon2` hasher from a parameter set.

```rust
impl From<Params> for Argon2<'_> {
    fn from(params: Params) -> Self {
        Self::new(Algorithm::default(), Version::default(), params)
    }
}

impl From<&Params> for Argon2<'_> {
    fn from(params: &Params) -> Self {
        Self::from(params.clone())
    }
}
```

--------------------------------

### Argon2::new

Source: https://docs.rs/argon2/latest/src/argon2/lib.rs.html

Creates a new Argon2 context with the specified algorithm, version, and parameters. This is the primary constructor for the Argon2 type.

```APIDOC
## Argon2::new

### Description
Creates a new Argon2 context with the specified algorithm, version, and parameters.

### Method
Constructor

### Signature
```rust
pub fn new(algorithm: Algorithm, version: Version, params: Params) -> Self
```

### Parameters
- **algorithm** (Algorithm) - Required - The Argon2 algorithm variant to use.
- **version** (Version) - Required - The Argon2 version to use.
- **params** (Params) - Required - The algorithm parameters.

### Returns
- **Self** - A new Argon2 context.

### Example
```rust
let argon2 = Argon2::new(Algorithm::default(), Version::default(), Params::default());
```
```

--------------------------------

### ParamsBuilder::new

Source: https://docs.rs/argon2/latest/argon2/

Creates a new ParamsBuilder for constructing Argon2 parameters. The builder allows setting memory cost, time cost, parallelism, and other parameters.

```APIDOC
## ParamsBuilder::new

### Description
Creates a new ParamsBuilder for constructing Argon2 parameters. The builder allows setting memory cost, time cost, parallelism, and other parameters.

### Method
Constructor

### Parameters
None

### Returns
- `ParamsBuilder` - A new builder instance.

```

--------------------------------

### Argon2::new

Source: https://docs.rs/argon2/latest/argon2/

Creates a new Argon2 context with the given algorithm, version, and parameters. This is the primary constructor for the Argon2 password hashing function.

```APIDOC
## Argon2::new

### Description
Creates a new Argon2 context with the given algorithm, version, and parameters. This is the primary constructor for the Argon2 password hashing function.

### Method
Constructor

### Parameters
- `alg` (Algorithm) - Required - The Argon2 algorithm variant (Argon2d, Argon2i, Argon2id).
- `version` (Version) - Required - The version of the algorithm.
- `params` (Params) - Required - The password hash parameters.

### Returns
- `Argon2` - The Argon2 context.

```

--------------------------------

### ParamsBuilder::output_len

Source: https://docs.rs/argon2/latest/argon2/

Sets the output length (in bytes) for the Argon2 algorithm. This method is part of the builder pattern.

```APIDOC
## ParamsBuilder::output_len

### Description
Sets the output length (in bytes) for the Argon2 algorithm. This method is part of the builder pattern.

### Method
Function

### Parameters
- `output_len` (u32) - Required - The output length in bytes.

### Returns
- `&mut Self` - The builder for chaining.

```

--------------------------------

### ParamsBuilder::parallelism

Source: https://docs.rs/argon2/latest/argon2/

Sets the parallelism (number of threads) for the Argon2 algorithm. This method is part of the builder pattern.

```APIDOC
## ParamsBuilder::parallelism

### Description
Sets the parallelism (number of threads) for the Argon2 algorithm. This method is part of the builder pattern.

### Method
Function

### Parameters
- `parallelism` (u32) - Required - The parallelism (number of threads).

### Returns
- `&mut Self` - The builder for chaining.

```

--------------------------------

### ParamsBuilder::secret

Source: https://docs.rs/argon2/latest/argon2/

Sets the secret key for the Argon2 algorithm. This method is part of the builder pattern.

```APIDOC
## ParamsBuilder::secret

### Description
Sets the secret key for the Argon2 algorithm. This method is part of the builder pattern.

### Method
Function

### Parameters
- `secret` (impl Into<Vec<u8>>) - Required - The secret key.

### Returns
- `&mut Self` - The builder for chaining.

```

--------------------------------

### ParamsBuilder::memory_cost

Source: https://docs.rs/argon2/latest/argon2/

Sets the memory cost (in KiB) for the Argon2 algorithm. This method is part of the builder pattern.

```APIDOC
## ParamsBuilder::memory_cost

### Description
Sets the memory cost (in KiB) for the Argon2 algorithm. This method is part of the builder pattern.

### Method
Function

### Parameters
- `memory_cost` (u32) - Required - The memory cost in KiB.

### Returns
- `&mut Self` - The builder for chaining.

```

--------------------------------

### ParamsBuilder::key_id

Source: https://docs.rs/argon2/latest/argon2/

Sets the key identifier for the Argon2 algorithm. This method is part of the builder pattern.

```APIDOC
## ParamsBuilder::key_id

### Description
Sets the key identifier for the Argon2 algorithm. This method is part of the builder pattern.

### Method
Function

### Parameters
- `key_id` (impl Into<Vec<u8>>) - Required - The key identifier.

### Returns
- `&mut Self` - The builder for chaining.

```

--------------------------------

### Argon2::hash_password_into

Source: https://docs.rs/argon2/latest/src/argon2/lib.rs.html

Hashes a password and associated parameters into the provided output buffer. This method is available when the 'alloc' feature is enabled.

```APIDOC
## Argon2::hash_password_into

### Description
Hashes a password and associated parameters into the provided output buffer. This method is available when the 'alloc' feature is enabled.

### Method
Function

### Signature
```rust
pub fn hash_password_into(&self, pwd: &[u8], salt: &[u8], out: &mut [u8]) -> Result<()>
```

### Parameters
- **pwd** (&[u8]) - Required - The password to hash.
- **salt** (&[u8]) - Required - The salt to use.
- **out** (&mut [u8]) - Required - The output buffer to write the hash into.

### Returns
- **Result<()>** - Ok if the hash was written successfully, or an error.

### Errors
- Returns `Error::PwdTooLong` if `pwd` is longer than `MAX_PWD_LEN`.
- Returns `Error::SaltTooShort` if `salt` is shorter than `MIN_SALT_LEN`.
- Returns `Error::SaltTooLong` if `salt` is longer than `MAX_SALT_LEN`.
- Returns `Error::OutputTooShort` if `out` is too short.
- Returns `Error::OutputTooLong` if `out` is too long.

### Example
```rust
let mut out = [0u8; 32];
argon2.hash_password_into(b"password", b"somesalt", &mut out)?;
```
```

--------------------------------

### ParamsBuilder::time_cost

Source: https://docs.rs/argon2/latest/argon2/

Sets the time cost (number of iterations) for the Argon2 algorithm. This method is part of the builder pattern.

```APIDOC
## ParamsBuilder::time_cost

### Description
Sets the time cost (number of iterations) for the Argon2 algorithm. This method is part of the builder pattern.

### Method
Function

### Parameters
- `time_cost` (u32) - Required - The time cost (number of iterations).

### Returns
- `&mut Self` - The builder for chaining.

```

--------------------------------

### ParamsBuilder::associated_data

Source: https://docs.rs/argon2/latest/argon2/

Sets the associated data for the Argon2 algorithm. This method is part of the builder pattern.

```APIDOC
## ParamsBuilder::associated_data

### Description
Sets the associated data for the Argon2 algorithm. This method is part of the builder pattern.

### Method
Function

### Parameters
- `associated_data` (impl Into<Vec<u8>>) - Required - The associated data.

### Returns
- `&mut Self` - The builder for chaining.

```

--------------------------------

### Key Derivation with Argon2 (hash_password_into)

Source: https://docs.rs/argon2/latest/argon2/

Derives cryptographic keys from a password and salt using `Argon2::default().hash_password_into`. The output key material is a 32-byte array, but can be any desired size. The salt should be unique per password.

```rust
use argon2::Argon2;

let password = b"hunter42"; // Bad password; don't actually use!
let salt = b"example salt"; // Salt should be unique per password

let mut output_key_material = [0u8; 32]; // Can be any desired size
Argon2::default().hash_password_into(password, salt, &mut output_key_material)?;
```

--------------------------------

### fill_memory

Source: https://docs.rs/argon2/latest/src/argon2/lib.rs.html

Uses a password and associated parameters only to fill the given memory blocks, omitting the calculation of a hash. This can be used when only the filled memory is required.

```APIDOC
## fill_memory

### Description
Uses a password and associated parameters only to fill the given memory blocks, omitting the calculation of a hash. This can be used when only the filled memory is required.

### Method
Rust function

### Signature
```rust
pub fn fill_memory(
    &self,
    pwd: &[u8],
    salt: &[u8],
    mut memory_blocks: impl AsMut<[Block]>,
) -> Result<()>
```

### Parameters
- **pwd** (`&[u8]`) - Required - The password to use.
- **salt** (`&[u8]`) - Required - The salt to use.
- **memory_blocks** (`impl AsMut<[Block]>`) - Required - The memory blocks to fill.

### Errors
- Returns `Error::PwdTooLong` if `pwd` is longer than `MAX_PWD_LEN`.
- Returns `Error::SaltTooShort` if `salt` is shorter than `MIN_SALT_LEN`.
- Returns `Error::SaltTooLong` if `salt` is longer than `MAX_SALT_LEN`.

### Returns
`Result<()>` - Ok on success, or an error as described above.
```

--------------------------------

### Argon2::new_with_secret

Source: https://docs.rs/argon2/latest/src/argon2/lib.rs.html

Creates a new Argon2 context with a secret key (pepper) in addition to the algorithm, version, and parameters. Returns an error if the secret is too long.

```APIDOC
## Argon2::new_with_secret

### Description
Creates a new Argon2 context with a secret key (pepper) in addition to the algorithm, version, and parameters. Returns an error if the secret is too long.

### Method
Constructor

### Signature
```rust
pub fn new_with_secret(
    secret: &'key [u8],
    algorithm: Algorithm,
    version: Version,
    params: Params,
) -> Result<Self>
```

### Parameters
- **secret** (&[u8]) - Required - The secret key (pepper) to use.
- **algorithm** (Algorithm) - Required - The Argon2 algorithm variant to use.
- **version** (Version) - Required - The Argon2 version to use.
- **params** (Params) - Required - The algorithm parameters.

### Returns
- **Result<Self>** - A new Argon2 context, or an error if the secret is too long.

### Errors
- Returns `Error::SecretTooLong` if `secret` is longer than `MAX_SECRET_LEN`.

### Example
```rust
let argon2 = Argon2::new_with_secret(b"secret", Algorithm::default(), Version::default(), Params::default())?;
```
```

--------------------------------

### Test that hashed password retains configured parameters

Source: https://docs.rs/argon2/latest/src/argon2/lib.rs.html

Checks that the `PasswordHash` produced by `hash_password_with_salt` retains the configured cost parameters (`t`, `m`, `p`) and version. Uses non-default parameters `t_cost=4`, `m_cost=2048`, `p_cost=2`, and `Version::V0x10`.

```rust
#[test]
fn password_hash_retains_configured_params() {
    // Non-default but valid parameters
    let t_cost = 4;
    let m_cost = 2048;
    let p_cost = 2;
    let version = Version::V0x10;

    let params = Params::new(m_cost, t_cost, p_cost, None).unwrap();
    let hasher = Argon2::new(Algorithm::default(), version, params);
    let hash = hasher
        .hash_password_with_salt(EXAMPLE_PASSWORD, EXAMPLE_SALT)
        .unwrap();

    assert_eq!(hash.version.unwrap(), version.into());

    for &(param, value) in &[("t", t_cost), ("m", m_cost), ("p", p_cost)] {
        assert_eq!(
            hash.params
                .get(param)
                .and_then(|p| p.decimal().ok())
                .unwrap(),
            value,
        );
    }
}
```

--------------------------------

### Argon2::hash_password

Source: https://docs.rs/argon2/latest/argon2/

Hashes a password using the Argon2 algorithm with the configured parameters. This method is part of the PasswordHasher trait and returns a PasswordHash.

```APIDOC
## Argon2::hash_password

### Description
Hashes a password using the Argon2 algorithm with the configured parameters. This method is part of the PasswordHasher trait and returns a PasswordHash.

### Method
Function

### Parameters
- `password` (impl AsRef<[u8]>) - Required - The password to hash.
- `salt` (impl AsRef<[u8]>) - Required - The salt to use for hashing.

### Returns
- `Result<PasswordHash>` - The resulting password hash or an error.

```

--------------------------------

### Password Hashing with Pepper (Argon2 new_with_secret)

Source: https://docs.rs/argon2/latest/argon2/

Hashes a password with an additional secret pepper using `Argon2::new_with_secret` and default parameters. Requires the `getrandom` feature. Verifies the password against the parsed hash, noting that hash parameters from the parsed hash are used instead of the configured ones.

```rust
// NOTE: example requires `getrandom` feature is enabled

use argon2::{
    password_hash::{PasswordHasher, PasswordVerifier, phc::PasswordHash},
    Algorithm, Argon2, Params, Version
};

let password = b"hunter42"; // Bad password; don't actually use!

// Argon2 with default params (Argon2id v19) and pepper
let argon2 = Argon2::new_with_secret(
    b"secret pepper",
    Algorithm::default(),
    Version::default(),
    Params::default()
)?;

// Hash password to PHC string ($argon2id$v=19$...), generating a random salt
let password_hash = argon2.hash_password(password)?.to_string();

// Verify password against PHC string.
//
// NOTE: hash params from `parsed_hash` are used instead of what is configured in the
// `Argon2` instance.
let parsed_hash = PasswordHash::new(&password_hash)?;
let argon2 = Argon2::new_with_secret(
    b"secret pepper",
    Algorithm::default(),
    Version::default(),
    Params::default(),
)
.unwrap();
let res = argon2.verify_password(password, &parsed_hash);
assert!(res.is_ok());
```

--------------------------------

### Argon2::verify_password

Source: https://docs.rs/argon2/latest/argon2/

Verifies a password against a given password hash. This method is part of the PasswordVerifier trait and returns a boolean indicating whether the password matches.

```APIDOC
## Argon2::verify_password

### Description
Verifies a password against a given password hash. This method is part of the PasswordVerifier trait and returns a boolean indicating whether the password matches.

### Method
Function

### Parameters
- `password` (impl AsRef<[u8]>) - Required - The password to verify.
- `hash` (PasswordHash) - Required - The password hash to verify against.

### Returns
- `Result<bool>` - `true` if the password matches, `false` otherwise, or an error.

```

--------------------------------

### hash_password_into_with_memory

Source: https://docs.rs/argon2/latest/src/argon2/lib.rs.html

Hashes a password and associated parameters into the provided output buffer using an explicit memory buffer. This method allows callers to provide backing storage for the algorithm's state, which is useful for no_std or heapless targets.

```APIDOC
## hash_password_into_with_memory

### Description
Hashes a password and associated parameters into the provided output buffer using an explicit memory buffer. This method allows callers to provide backing storage for the algorithm's state, which is useful for no_std or heapless targets.

### Method
Rust function

### Signature
```rust
pub fn hash_password_into_with_memory(
    &self,
    pwd: &[u8],
    salt: &[u8],
    out: &mut [u8],
    mut memory_blocks: impl AsMut<[Block]>,
) -> Result<()>
```

### Parameters
- **pwd** (`&[u8]`) - Required - The password to hash.
- **salt** (`&[u8]`) - Required - The salt to use.
- **out** (`&mut [u8]`) - Required - The output buffer to write the hash into.
- **memory_blocks** (`impl AsMut<[Block]>`) - Required - The backing storage for the algorithm's state.

### Errors
- Returns `Error::PwdTooLong` if `pwd` is longer than `MAX_PWD_LEN`.
- Returns `Error::SaltTooShort` if `salt` is shorter than `MIN_SALT_LEN`.
- Returns `Error::SaltTooLong` if `salt` is longer than `MAX_SALT_LEN`.
- Returns `Error::OutputTooShort` if `out` is too short.
- Returns `Error::OutputTooLong` if `out` is too long.

### Returns
`Result<()>` - Ok on success, or an error as described above.
```

--------------------------------

### Password Hashing with Argon2 (PHC string)

Source: https://docs.rs/argon2/latest/argon2/

Hashes a password to a PHC string using Argon2 with default parameters (Argon2id v19) and a random salt. Requires the `getrandom` feature. Verifies the password against the parsed hash, noting that hash parameters from the parsed hash are used instead of the configured ones.

```rust
// NOTE: example requires `getrandom` feature is enabled

use argon2::{
    password_hash::{PasswordHasher, PasswordVerifier, phc::PasswordHash},
    Argon2
};

let password = b"hunter42"; // Bad password; don't actually use!

// Argon2 with default params (Argon2id v19), generating a random salt
let argon2 = Argon2::default();

// Hash password to PHC string ($argon2id$v=19$...)
let password_hash = argon2.hash_password(password)?.to_string();

// Verify password against PHC string.
//
// NOTE: hash params from `parsed_hash` are used instead of what is configured in the
// `Argon2` instance.
let parsed_hash = PasswordHash::new(&password_hash)?;
assert!(Argon2::default().verify_password(password, &parsed_hash).is_ok());
```

--------------------------------

### PasswordHasher implementation for Argon2 with salt

Source: https://docs.rs/argon2/latest/src/argon2/lib.rs.html

Implements the `PasswordHasher` trait for `Argon2`, hashing a password with a provided salt. Requires the `alloc` and `password-hash` features. Uses `Params::DEFAULT_OUTPUT_LEN` if no output length is configured, and returns `password_hash::Error::OutputSize` if the output length exceeds `Output::MAX_LENGTH`.

```rust
#[cfg(all(feature = "alloc", feature = "password-hash"))]
impl PasswordHasher<PasswordHash> for Argon2<'_> {
    fn hash_password_with_salt(
        &self,
        password: &[u8],
        salt: &[u8],
    ) -> password_hash::Result<PasswordHash> {
        let salt = Salt::new(salt)?;

        let output_len = self
            .params
            .output_len()
            .unwrap_or(Params::DEFAULT_OUTPUT_LEN);

        let mut buffer = [0u8; Output::MAX_LENGTH];
        let out = buffer
            .get_mut(..output_len)
            .ok_or(password_hash::Error::OutputSize)?;

        self.hash_password_into(password, &salt, out)?;
        let output = Output::new(out)?;

        Ok(PasswordHash {
            algorithm: self.algorithm.ident(),
            version: Some(self.version.into()),
            params: ParamsString::try_from(&self.params)?,
            salt: Some(salt),
            hash: Some(output),
        })
    }
}
```

--------------------------------

### KeyId::len

Source: https://docs.rs/argon2/latest/argon2/struct.KeyId.html

Gets the length in bytes of the KeyId.

```APIDOC
## KeyId::len

### Description
Gets the length in bytes of the KeyId.

### Method
`pub const fn len(&self) -> usize`

### Returns
`usize` - The length in bytes.
```

--------------------------------

### Error enum variants

Source: https://docs.rs/argon2/latest/argon2/

The Error enum represents the error type for Argon2 operations.

```APIDOC
## Error enum variants

### Description
The Error enum represents the error type for Argon2 operations.

### Variants
- `MemoryTooLittle` - Memory cost is too little.
- `MemoryTooMuch` - Memory cost is too much.
- `TimeTooSmall` - Time cost is too small.
- `TimeTooLarge` - Time cost is too large.
- `ParallelismTooSmall` - Parallelism is too small.
- `ParallelismTooLarge` - Parallelism is too large.
- `OutputTooShort` - Output length is too short.
- `OutputTooLong` - Output length is too long.
- `PwdTooShort` - Password is too short.
- `PwdTooLong` - Password is too long.
- `SaltTooShort` - Salt is too short.
- `SaltTooLong` - Salt is too long.
- `SecretTooShort` - Secret is too short.
- `SecretTooLong` - Secret is too long.
- `AssociatedDataTooShort` - Associated data is too short.
- `AssociatedDataTooLong` - Associated data is too long.
- `KeyIdTooShort` - Key ID is too short.
- `KeyIdTooLong` - Key ID is too long.
- `DecodingFail` - Decoding failed.
- `PasswordHash` - Password hash error.
- `Kdf` - KDF error.

```

--------------------------------

### Argon2::new

Source: https://docs.rs/argon2/latest/argon2/struct.Argon2.html

Creates a new Argon2 context with the specified algorithm, version, and parameters.

```APIDOC
## Argon2::new

### Description
Creates a new Argon2 context with the specified algorithm, version, and parameters.

### Method
Constructor

### Parameters
- **algorithm** (Algorithm) - Required - The Argon2 algorithm variant to use.
- **version** (Version) - Required - The Argon2 version to use.
- **params** (Params) - Required - The default set of parameters to use.

### Returns
- `Self` - A new Argon2 context.

### Example
```rust
let argon2 = Argon2::new(Algorithm::Argon2id, Version::V0x13, Params::default());
```
```

--------------------------------

### Block::new

Source: https://docs.rs/argon2/latest/argon2/struct.Block.html

Creates a new Block instance initialized with zeros. This is a constructor for the Block struct.

```APIDOC
## Block::new

### Description
Returns a Block initialized with zeros.

### Method
`pub const fn new() -> Self`

### Parameters
None

### Returns
- `Self` - A new `Block` instance with all bytes set to zero.

### Example
```rust
let block = Block::new();
```
```

--------------------------------

### Argon2::params

Source: https://docs.rs/argon2/latest/argon2/struct.Argon2.html

Returns the default configured parameters of the Argon2 context.

```APIDOC
## Argon2::params

### Description
Returns the default configured parameters of the Argon2 context.

### Method
Getter

### Parameters
None

### Returns
- `&Params` - The default configured parameters.

### Example
```rust
let params = argon2.params();
```
```

--------------------------------

### Algorithm enum variants

Source: https://docs.rs/argon2/latest/argon2/

The Algorithm enum defines the Argon2 primitive type: variants of the algorithm (Argon2d, Argon2i, Argon2id).

```APIDOC
## Algorithm enum variants

### Description
The Algorithm enum defines the Argon2 primitive type: variants of the algorithm (Argon2d, Argon2i, Argon2id).

### Variants
- `Argon2d` - Argon2d algorithm.
- `Argon2i` - Argon2i algorithm.
- `Argon2id` - Argon2id algorithm.

```

--------------------------------

### ParamsBuilder::build(&self) -> Result<Params>

Source: https://docs.rs/argon2/latest/argon2/struct.ParamsBuilder.html

Get the finished Params. This performs validations to ensure that the given parameters are valid and compatible with each other, and will return an error if they are not.

```APIDOC
## ParamsBuilder::build(&self) -> Result<Params>

### Description
Get the finished Params. This performs validations to ensure that the given parameters are valid and compatible with each other, and will return an error if they are not.

### Method
N/A (builder method)

### Endpoint
N/A

### Parameters
None

### Request Example
N/A

### Response
#### Success Response
- **value** (Result<Params>) - The finished Params.

#### Error Response
- Propagates errors from `Params::new`.

#### Response Example
N/A
```

--------------------------------

### ParamsBuilder::context(&self, algorithm: Algorithm, version: Version) -> Result<Argon2<'_>>

Source: https://docs.rs/argon2/latest/argon2/struct.ParamsBuilder.html

Create a new Argon2 context using the provided algorithm/version.

```APIDOC
## ParamsBuilder::context(&self, algorithm: Algorithm, version: Version) -> Result<Argon2<'_>>

### Description
Create a new Argon2 context using the provided algorithm/version.

### Method
N/A (builder method)

### Endpoint
N/A

### Parameters
- **algorithm** (Algorithm) - Required - The Argon2 algorithm.
- **version** (Version) - Required - The Argon2 version.

### Request Example
N/A

### Response
#### Success Response
- **value** (Result<Argon2<'_>>) - A new Argon2 context.

#### Error Response
- Propagates errors from `Params::new`.

#### Response Example
N/A
```

--------------------------------

### ParamsBuilder::new

Source: https://docs.rs/argon2/latest/src/argon2/params.rs.html

Creates a new ParamsBuilder with default parameters. This is a constructor method that initializes the builder with recommended default values.

```APIDOC
## ParamsBuilder::new

### Description
Creates a new ParamsBuilder with default parameters.

### Method
`pub const fn new() -> Self`

### Parameters
None

### Returns
- **Self** - A new ParamsBuilder instance with default parameters.

```

--------------------------------

### ParamsBuilder::new()

Source: https://docs.rs/argon2/latest/argon2/struct.ParamsBuilder.html

Create a new builder with the default parameters.

```APIDOC
## ParamsBuilder::new()

### Description
Create a new builder with the default parameters.

### Method
N/A (constructor)

### Endpoint
N/A

### Parameters
None

### Request Example
N/A

### Response
#### Success Response
- **value** (ParamsBuilder) - A new builder with default parameters.

#### Response Example
N/A
```
Tokens:
Raw