View Javadoc
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.encrypt;
18  
19  import io.github.tonywasher.joceanus.gordianknot.api.base.GordianException;
20  import io.github.tonywasher.joceanus.gordianknot.api.keypair.GordianKeyPair;
21  
22  /**
23   * Asymmetric Encryptor.
24   */
25  public interface GordianEncryptor {
26      /**
27       * Obtain the encryptorSpec.
28       *
29       * @return the spec
30       */
31      GordianEncryptorSpec getEncryptorSpec();
32  
33      /**
34       * Initialise for encrypt.
35       *
36       * @param pKeyPair the keyPair
37       * @throws GordianException on error
38       */
39      void initForEncrypt(GordianKeyPair pKeyPair) throws GordianException;
40  
41      /**
42       * Initialise for decrypt.
43       *
44       * @param pKeyPair the keyPair
45       * @throws GordianException on error
46       */
47      void initForDecrypt(GordianKeyPair pKeyPair) throws GordianException;
48  
49      /**
50       * Encrypt the bytes.
51       *
52       * @param pBytes the bytes to encrypt
53       * @return the encrypted bytes
54       * @throws GordianException on error
55       */
56      byte[] encrypt(byte[] pBytes) throws GordianException;
57  
58      /**
59       * Decrypt the encrypted bytes.
60       *
61       * @param pEncrypted the encrypted bytes
62       * @return the decrypted bytes
63       * @throws GordianException on error
64       */
65      byte[] decrypt(byte[] pEncrypted) throws GordianException;
66  }