io.jsonwebtoken.impl.security.JwkContext Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of jjwt-impl Show documentation
There is a newer version: 0.12.6
/*
 * 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.impl.security;

import io.jsonwebtoken.Identifiable;
import io.jsonwebtoken.impl.X509Context;
import io.jsonwebtoken.impl.lang.Nameable;
import io.jsonwebtoken.impl.lang.Parameter;
import io.jsonwebtoken.impl.lang.ParameterReadable;
import io.jsonwebtoken.security.HashAlgorithm;
import io.jsonwebtoken.security.KeyOperation;

import java.security.Key;
import java.security.Provider;
import java.security.PublicKey;
import java.security.SecureRandom;
import java.util.Collection;
import java.util.Map;
import java.util.Set;

public interface JwkContext extends Identifiable, Map, ParameterReadable, Nameable,
        X509Context> {

    JwkContext parameter(Parameter param);

    JwkContext setId(String id);

    JwkContext setIdThumbprintAlgorithm(HashAlgorithm alg);

    HashAlgorithm getIdThumbprintAlgorithm();

    String getType();

    JwkContext setType(String type);

    Set getOperations();

    JwkContext setOperations(Collection operations);

    String getAlgorithm();

    JwkContext setAlgorithm(String algorithm);

    String getPublicKeyUse();

    JwkContext setPublicKeyUse(String use);

    /**
     * Returns {@code true} if relevant context values indicate JWK use with MAC or digital signature algorithms,
     * {@code false} otherwise.  Specifically {@code true} is only returned if either:
     * 
     *     "sig".equals({@link #getPublicKeyUse()}), OR
     *     {@link #getOperations()} is not empty and contains either "sign" or "verify"
     * 
     * otherwise {@code false}.
     *
     * @return {@code true} if relevant context values indicate JWK use with MAC or digital signature algorithms,
     * {@code false} otherwise.
     */
    boolean isSigUse();

    K getKey();

    JwkContext setKey(K key);

    PublicKey getPublicKey();

    JwkContext setPublicKey(PublicKey publicKey);

    Provider getProvider();

    JwkContext setProvider(Provider provider);

    SecureRandom getRandom();

    JwkContext setRandom(SecureRandom random);
}