com.io7m.idstore.server.api.IdServerRateLimitConfiguration Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of com.io7m.idstore.server.api Show documentation
Identity server (Server API)
The newest version!
/*
 * Copyright © 2023 Mark Raynsford  https://www.io7m.com
 *
 * Permission to use, copy, modify, and/or distribute this software for any
 * purpose with or without fee is hereby granted, provided that the above
 * copyright notice and this permission notice appear in all copies.
 *
 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY
 * SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
 * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR
 * IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
 */

package com.io7m.idstore.server.api;

import java.time.Duration;
import java.util.Objects;

/**
 * Configuration for rate limiting.
 *
 * @param emailVerificationRateLimit The minimum allowed time between email
 *                                   verifications for a given user
 * @param passwordResetRateLimit     The minimum allowed time between password
 *                                   resets
 * @param userLoginRateLimit         The minimum time allowed between (user) login attempts for a host
 * @param userLoginDelay             A delay applied to each (user) login attempt
 * @param adminLoginRateLimit        The minimum time allowed between (admin) login attempts for a host
 * @param adminLoginDelay            A delay applied to each (admin) login attempt
 */

public record IdServerRateLimitConfiguration(
  Duration emailVerificationRateLimit,
  Duration passwordResetRateLimit,
  Duration userLoginRateLimit,
  Duration userLoginDelay,
  Duration adminLoginRateLimit,
  Duration adminLoginDelay)
  implements IdServerJSONConfigurationElementType
{
  /**
   * Configuration for rate limiting.
   *
   * @param emailVerificationRateLimit The minimum allowed time between email
   *                                   verifications for a given user
   * @param passwordResetRateLimit     The minimum allowed time between password
   *                                   resets
   * @param userLoginRateLimit         The minimum time allowed between (user) login attempts for a host
   * @param userLoginDelay             A delay applied to each (user) login attempt
   * @param adminLoginRateLimit        The minimum time allowed between (admin) login attempts for a host
   * @param adminLoginDelay            A delay applied to each (admin) login attempt
   */

  public IdServerRateLimitConfiguration
  {
    Objects.requireNonNull(
      emailVerificationRateLimit, "emailVerificationRateLimit");
    Objects.requireNonNull(
      passwordResetRateLimit, "passwordResetRateLimit");
    Objects.requireNonNull(
      userLoginRateLimit, "userLoginRateLimit");
    Objects.requireNonNull(
      userLoginDelay, "userLoginDelay");
    Objects.requireNonNull(
      adminLoginRateLimit, "adminLoginRateLimit");
    Objects.requireNonNull(
      adminLoginDelay, "adminLoginDelay");
  }
}