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.keypair;
18
19 /**
20 * Asymmetric StateAware KeyPair.
21 */
22 public interface GordianStateAwareKeyPair {
23 /**
24 * Obtain number of signatures remaining.
25 *
26 * @return the number of signatures remaining
27 */
28 long getUsagesRemaining();
29
30 /**
31 * Obtain a subKeyPair shard with the required number of usages, and update this keyPair's usage count.
32 *
33 * @param pNumUsages the number of usage for the shard
34 * @return the subKeyPair
35 */
36 GordianKeyPair getKeyPairShard(int pNumUsages);
37 }