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