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.cert;
18
19 import io.github.tonywasher.joceanus.gordianknot.api.base.GordianException;
20 import io.github.tonywasher.joceanus.gordianknot.api.keypair.GordianKeyPair;
21
22 import java.time.LocalDate;
23
24 /**
25 * Certificate API.
26 */
27 public interface GordianCertificate {
28 /**
29 * Obtain the subject of the certificate.
30 *
31 * @return the subject
32 */
33 GordianCertificateId getSubject();
34
35 /**
36 * Obtain the issuer of the certificate.
37 *
38 * @return the issuer name
39 */
40 GordianCertificateId getIssuer();
41
42 /**
43 * Obtain the keyPair of the certificate.
44 *
45 * @return the keyPair
46 */
47 GordianKeyPair getKeyPair();
48
49 /**
50 * Obtain the encoded representation of the certificate.
51 *
52 * @return the encoded representation
53 */
54 byte[] getEncoded();
55
56 /**
57 * Is the certificate valid at this moment?
58 *
59 * @return true/false
60 */
61 boolean isValidNow();
62
63 /**
64 * Is the certificate valid on the specified date?
65 *
66 * @param pDate the date to test
67 * @return true/false
68 */
69 boolean isValidOnDate(LocalDate pDate);
70
71 /**
72 * Is this certificate self-signed?
73 *
74 * @return true/false
75 */
76 boolean isSelfSigned();
77
78 /**
79 * Obtain the keyPair usage?
80 *
81 * @return the usage
82 */
83 GordianKeyPairUsage getUsage();
84
85 /**
86 * Validate the certificate.
87 *
88 * @param pSigner the signer of the certificate
89 * @return valid? true/false
90 * @throws GordianException on error
91 */
92 boolean validateCertificate(GordianCertificate pSigner) throws GordianException;
93 }