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.mac;
19
20 import io.github.tonywasher.joceanus.gordianknot.api.key.GordianKey;
21 import io.github.tonywasher.joceanus.gordianknot.api.mac.spec.GordianMacSpec;
22
23 /**
24 * Mac Parameters.
25 */
26 public interface GordianMacParams {
27 /**
28 * Obtain the key.
29 *
30 * @return the key
31 */
32 GordianKey<GordianMacSpec> getKey();
33
34 /**
35 * Obtain the Nonce.
36 *
37 * @return the nonce
38 */
39 byte[] getNonce();
40
41 /**
42 * Is the nonce randomly generated?
43 *
44 * @return true/false
45 */
46 boolean randomNonce();
47
48 /**
49 * Obtain the Personalisation.
50 *
51 * @return the personalisation
52 */
53 byte[] getPersonal();
54
55 /**
56 * Obtain the Output length.
57 *
58 * @return the outLength
59 */
60 long getOutputLength();
61
62 /**
63 * Obtain the treeLeafLength.
64 *
65 * @return the leafLength
66 */
67 int getTreeLeafLen();
68
69 /**
70 * Obtain the treeFanOut.
71 *
72 * @return the fanOut
73 */
74 short getTreeFanOut();
75
76 /**
77 * Obtain the treeMaxDepth.
78 *
79 * @return the maxDepth
80 */
81 short getTreeMaxDepth();
82 }