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.agree.spec;
19
20 import io.github.tonywasher.joceanus.gordianknot.api.keypair.spec.GordianKeyPairSpec;
21
22 /**
23 * KeyPair Agreement Specification.
24 */
25 public interface GordianAgreementSpec {
26 /**
27 * Obtain the keyPairSpec.
28 *
29 * @return the keyPairSpec
30 */
31 GordianKeyPairSpec getKeyPairSpec();
32
33 /**
34 * Obtain the agreementType.
35 *
36 * @return the agreementType
37 */
38 GordianAgreementType getAgreementType();
39
40 /**
41 * Obtain the kdfType.
42 *
43 * @return the kdfType
44 */
45 GordianAgreementKDF getKDFType();
46
47 /**
48 * Is this agreement with key confirmation?
49 *
50 * @return true/false
51 */
52 boolean withConfirm();
53
54 /**
55 * Is this Agreement supported?
56 *
57 * @return true/false
58 */
59 boolean isSupported();
60
61 /**
62 * Is the agreementSpec valid?
63 *
64 * @return true/false.
65 */
66 boolean isValid();
67 }