1 /*
2 * GordianKnot: Security Suite
3 * Copyright 2012-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 package io.github.tonywasher.joceanus.gordianknot.api.cipher;
18
19 import io.github.tonywasher.joceanus.gordianknot.api.base.GordianException;
20
21 /**
22 * GordianKnot base for AEAD Cipher.
23 */
24 public interface GordianAEADCipher {
25 /**
26 * Process the passed AEAD data.
27 *
28 * @param pBytes AEAD Bytes to update cipher with
29 * @throws GordianException on error
30 */
31 default void updateAAD(final byte[] pBytes) throws GordianException {
32 updateAAD(pBytes, 0, pBytes.length);
33 }
34
35 /**
36 * Process the passed AEAD data.
37 *
38 * @param pBytes AEAD Bytes to update cipher with
39 * @param pOffset offset within pBytes to read bytes from
40 * @param pLength length of data to update with
41 * @throws GordianException on error
42 */
43 void updateAAD(byte[] pBytes,
44 int pOffset,
45 int pLength) throws GordianException;
46 }