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.sign;
18
19 import io.github.tonywasher.joceanus.gordianknot.api.base.GordianConsumer;
20 import io.github.tonywasher.joceanus.gordianknot.api.base.GordianException;
21 import io.github.tonywasher.joceanus.gordianknot.api.sign.spec.GordianSignatureSpec;
22
23 /**
24 * GordianKnot base for signature.
25 */
26 public interface GordianSignature
27 extends GordianConsumer {
28 /**
29 * Obtain the signatureSpec.
30 *
31 * @return the Spec
32 */
33 GordianSignatureSpec getSignatureSpec();
34
35 /**
36 * Initialise for signature.
37 *
38 * @param pParams the parameters
39 * @throws GordianException on error
40 */
41 void initForSigning(GordianNewSignParams pParams) throws GordianException;
42
43 /**
44 * Initialise for verify.
45 *
46 * @param pParams the parameters
47 * @throws GordianException on error
48 */
49 void initForVerify(GordianNewSignParams pParams) throws GordianException;
50
51 /**
52 * Complete the signature operation and return the signature bytes.
53 *
54 * @return the signature
55 * @throws GordianException on error
56 */
57 byte[] sign() throws GordianException;
58
59 /**
60 * Verify the signature against the supplied signature bytes.
61 *
62 * @param pSignature the supplied signature
63 * @return the signature
64 * @throws GordianException on error
65 */
66 boolean verify(byte[] pSignature) throws GordianException;
67 }