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

/*
 * Copyright © 2022 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 io.jsonwebtoken.Identifiable;

/**
 * A cryptographic Elliptic Curve for use with digital signature or key agreement algorithms.
 *
 * Curve Identifier
 *
 * This interface extends {@link Identifiable}; the value returned from {@link #getId()} will
 * be used as the JWK
 * crv value.
 *
 * KeyPair Generation
 *
 * A secure-random KeyPair of sufficient strength on the curve may be obtained with its {@link #keyPair()} builder.
 *
 * Standard Implementations
 *
 * Constants for all JWA standard Curves are available via the {@link Jwks.CRV} registry.
 *
 * @see Jwks.CRV
 * @since 0.12.0
 */
public interface Curve extends Identifiable, KeyPairBuilderSupplier {
}