io.jsonwebtoken.security.EcPrivateJwk Maven / Gradle / Ivy

/*
 * Copyright (C) 2021 jsonwebtoken.io
 *
 * 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.jsonwebtoken.security;

import java.security.interfaces.ECPrivateKey;
import java.security.interfaces.ECPublicKey;

/**
 * JWK representation of an {@link ECPrivateKey} as defined by the JWA (RFC 7518) specification sections on
 * Parameters for Elliptic Curve Keys and
 * Parameters for Elliptic Curve Private Keys.
 *
 * Note that the various EC-specific properties are not available as separate dedicated getter methods, as most Java
 * applications should rarely, if ever, need to access these individual key properties since they typically represent
 * internal key material and/or serialization details. If you need to access these key properties, it is usually
 * recommended to obtain the corresponding {@link ECPrivateKey} instance returned by {@link #toKey()} and
 * query that instead.
 *
 * Even so, because these properties exist and are readable by nature of every JWK being a
 * {@link java.util.Map Map}, they are still accessible via the standard {@code Map} {@link #get(Object) get} method
 * using an appropriate JWK parameter id, for example:
 *  * jwk.get("x");
 * jwk.get("y");
 * // ... etc ...
 *
 * @since 0.12.0
 */
public interface EcPrivateJwk extends PrivateJwk {
}