GordianPasswordLockSpec.java

/*
 * GordianKnot: Security Suite
 * Copyright 2026. Tony Washer
 *
 * Licensed under the Apache License, Version 2.0 (the "License"); you may not
 * use this file except in compliance with the License.  You may obtain a copy
 * of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.  See the
 * License for the specific language governing permissions and limitations under
 * the License.
 */

package io.github.tonywasher.joceanus.gordianknot.api.lock.spec;

import io.github.tonywasher.joceanus.gordianknot.api.keyset.spec.GordianKeySetSpec;

/**
 * PasswordLock Specification.
 */
public interface GordianPasswordLockSpec {
    /**
     * Minimum iterations.
     */
    Integer MINIMUM_ITERATIONS = 1;

    /**
     * Maximum iterations.
     */
    Integer MAXIMUM_ITERATIONS = 64;

    /**
     * Default iterations.
     */
    Integer DEFAULT_ITERATIONS = 8;

    /**
     * Access the number of Iterations.
     *
     * @return the number of iterations
     */
    int getNumIterations();

    /**
     * Access the number of Hash Iterations (x 1K).
     *
     * @return the number of hash iterations
     */
    int getKIterations();

    /**
     * Access the keySetSpec.
     *
     * @return the keySetSpec
     */
    GordianKeySetSpec getKeySetSpec();

    /**
     * is the hashSpec valid?
     *
     * @return true/false
     */
    boolean isValid();
}