GordianPrivateKey.java

/*
 * GordianKnot: Security Suite
 * Copyright 2012-2026. Tony Washer
 *
 * Licensed under the Apache License, Version 2.0 (the "License"); you may not
 * use this file except in compliance with the License.  You may obtain a copy
 * of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.  See the
 * License for the specific language governing permissions and limitations under
 * the License.
 */
package io.github.tonywasher.joceanus.gordianknot.impl.core.keypair;

import io.github.tonywasher.joceanus.gordianknot.api.keypair.GordianKeyPairSpec;

/**
 * Asymmetric PrivateKey.
 */
public abstract class GordianPrivateKey {
    /**
     * The KeySpec.
     */
    private final GordianKeyPairSpec theKeySpec;

    /**
     * Constructor.
     *
     * @param pKeySpec the keySpec
     */
    protected GordianPrivateKey(final GordianKeyPairSpec pKeySpec) {
        theKeySpec = pKeySpec;
    }

    /**
     * Obtain the keySpec.
     *
     * @return the keySpec
     */
    public GordianKeyPairSpec getKeySpec() {
        return theKeySpec;
    }

    /**
     * StateAware PrivateKey.
     */
    public interface GordianStateAwarePrivateKey {
        /**
         * Obtain number of signatures remaining.
         *
         * @return the number of signatures remaining
         */
        long getUsagesRemaining();

        /**
         * Obtain a keyShard from the number of usages.
         *
         * @param pNumUsages the number of usage for the shard
         * @return the keyShard
         */
        GordianStateAwarePrivateKey getKeyShard(int pNumUsages);
    }
}