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.cipher.spec;
19
20 import io.github.tonywasher.joceanus.gordianknot.api.digest.spec.GordianDigestSpec;
21
22 /**
23 * PBE Specification.
24 */
25 public interface GordianPBESpec {
26 /**
27 * Obtain the PBEType.
28 *
29 * @return the PBEType
30 */
31 GordianPBEType getPBEType();
32
33 /**
34 * Is the Spec valid?
35 *
36 * @return true/false
37 */
38 boolean isValid();
39
40 /**
41 * DigestAndCountSpec.
42 */
43 interface GordianPBEDigestAndCountSpec
44 extends GordianPBESpec {
45 /**
46 * Obtain the digestSpec.
47 *
48 * @return the digestSpec
49 */
50 GordianDigestSpec getDigestSpec();
51
52 /**
53 * Obtain the iteration count.
54 *
55 * @return the count
56 */
57 int getIterationCount();
58 }
59
60 /**
61 * SCryptSpec.
62 */
63 interface GordianPBESCryptSpec
64 extends GordianPBESpec {
65 /**
66 * Obtain the blockSize.
67 *
68 * @return the blockSize
69 */
70 int getBlockSize();
71
72 /**
73 * Obtain the cost.
74 *
75 * @return the cost
76 */
77 int getCost();
78
79 /**
80 * Obtain the parallelism.
81 *
82 * @return the parallelism
83 */
84 int getParallel();
85 }
86
87 /**
88 * Argon2Spec.
89 */
90 interface GordianPBEArgon2Spec
91 extends GordianPBESpec {
92 /**
93 * Obtain the lanes.
94 *
95 * @return the lanes
96 */
97 int getLanes();
98
99 /**
100 * Obtain the memory.
101 *
102 * @return the memory
103 */
104 int getMemory();
105
106 /**
107 * Obtain the iteration count.
108 *
109 * @return the count
110 */
111 int getIterationCount();
112 }
113 }