io.micronaut.security.token.jwt.signature.jwks.StaticJwksSignatureConfiguration Maven / Gradle / Ivy

Go to download
/*
 * Copyright 2017-2023 original authors
 *
 * 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
 *
 * https://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.micronaut.security.token.jwt.signature.jwks;

import io.micronaut.core.annotation.NonNull;

/**
 * Configuration JSON Web Key Sets defined as static resources.
 */
public interface StaticJwksSignatureConfiguration {

    /**
     * A path either starting with `classpath:` or `file:`. You can serve a JSON JWKS from anywhere on disk or the classpath.
     * For example to serve static resources from `src/main/resources/security/jwks.json`, you would use `classpath:security/jwks.json` as the path.
     * @return A path either starting with `classpath:` or `file:`.
     */
    @NonNull
    String getPath();
}