View Javadoc
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.base.GordianKeySpec;
21  import io.github.tonywasher.joceanus.gordianknot.api.base.GordianLength;
22  
23  /**
24   * SymKey specification.
25   */
26  public interface GordianSymKeySpec
27          extends GordianKeySpec {
28      /**
29       * Obtain symKey Type.
30       *
31       * @return the symKeyType
32       */
33      GordianSymKeyType getSymKeyType();
34  
35      /**
36       * Obtain Block Length.
37       *
38       * @return the blockLength
39       */
40      GordianLength getBlockLength();
41  
42      /**
43       * Is the symKeySpec valid?
44       *
45       * @return true/false.
46       */
47      boolean isValid();
48  }