1 /*
2 * GordianKnot: Security Suite
3 * Copyright 2026. Tony Washer
4 *
5 * Licensed under the Apache License, Version 2.0 (the "License"); you may not
6 * use this file except in compliance with the License. You may obtain a copy
7 * of the License at
8 *
9 * http://www.apache.org/licenses/LICENSE-2.0
10 *
11 * Unless required by applicable law or agreed to in writing, software
12 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
13 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
14 * License for the specific language governing permissions and limitations under
15 * the License.
16 */
17
18 package io.github.tonywasher.joceanus.gordianknot.api.lock.spec;
19
20 import io.github.tonywasher.joceanus.gordianknot.api.keyset.spec.GordianKeySetSpec;
21
22 /**
23 * PasswordLock Specification.
24 */
25 public interface GordianPasswordLockSpec {
26 /**
27 * Minimum iterations.
28 */
29 Integer MINIMUM_ITERATIONS = 1;
30
31 /**
32 * Maximum iterations.
33 */
34 Integer MAXIMUM_ITERATIONS = 64;
35
36 /**
37 * Default iterations.
38 */
39 Integer DEFAULT_ITERATIONS = 8;
40
41 /**
42 * Access the number of Iterations.
43 *
44 * @return the number of iterations
45 */
46 int getNumIterations();
47
48 /**
49 * Access the number of Hash Iterations (x 1K).
50 *
51 * @return the number of hash iterations
52 */
53 int getKIterations();
54
55 /**
56 * Access the keySetSpec.
57 *
58 * @return the keySetSpec
59 */
60 GordianKeySetSpec getKeySetSpec();
61
62 /**
63 * is the hashSpec valid?
64 *
65 * @return true/false
66 */
67 boolean isValid();
68 }