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 /**
21 * The StreamCipherSpec Builder class.
22 */
23 public interface GordianStreamCipherSpecBuilder {
24 /**
25 * Define StreamKeySpec.
26 *
27 * @param pSpec the spec
28 * @return the Builder
29 */
30 GordianStreamCipherSpecBuilder withKeySpec(GordianStreamKeySpec pSpec);
31
32 /**
33 * Request AEAD variant.
34 *
35 * @return the Builder
36 */
37 GordianStreamCipherSpecBuilder asAEAD();
38
39 /**
40 * Access streamKeySpecBuilder.
41 *
42 * @return the streamKeySpec builder
43 */
44 GordianStreamKeySpecBuilder usingStreamKeySpecBuilder();
45
46 /**
47 * Build streamCipherSpec.
48 *
49 * @return the streamCipherSpec
50 */
51 GordianStreamCipherSpec build();
52
53 /**
54 * Create a generic streamCipherSpec.
55 *
56 * @param pKeySpec the keySpec
57 * @return the cipherSpec
58 */
59 default GordianStreamCipherSpec streamCipher(final GordianStreamKeySpec pKeySpec) {
60 return streamCipher(pKeySpec, false);
61 }
62
63 /**
64 * Create a generic streamCipherSpec.
65 *
66 * @param pKeySpec the keySpec
67 * @param pAAD is this an AAD cipher?
68 * @return the cipherSpec
69 */
70 default GordianStreamCipherSpec streamCipher(final GordianStreamKeySpec pKeySpec,
71 final boolean pAAD) {
72 withKeySpec(pKeySpec);
73 if (pAAD) {
74 asAEAD();
75 }
76 return build();
77 }
78 }