io.jsonwebtoken.impl.DefaultJweHeaderMutator 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) 2023 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;

import io.jsonwebtoken.JweHeaderMutator;
import io.jsonwebtoken.impl.lang.DefaultNestedCollection;
import io.jsonwebtoken.impl.lang.DelegatingMapMutator;
import io.jsonwebtoken.impl.lang.Parameter;
import io.jsonwebtoken.impl.security.X509BuilderSupport;
import io.jsonwebtoken.lang.Collections;
import io.jsonwebtoken.lang.NestedCollection;
import io.jsonwebtoken.lang.Strings;
import io.jsonwebtoken.security.PublicJwk;

import java.net.URI;
import java.security.cert.X509Certificate;
import java.util.List;

/**
 * @param  return type for method chaining
 * @since 0.12.0
 */
public class DefaultJweHeaderMutator>
        extends DelegatingMapMutator implements JweHeaderMutator {

    protected X509BuilderSupport x509;

    public DefaultJweHeaderMutator() {
        // Any type of header can be created, but JWE parameters reflect all potential standard ones, so we use those
        // params to catch any value being set, especially through generic 'put' or 'putAll' methods:
        super(new ParameterMap(DefaultJweHeader.PARAMS));
        clear(); // initialize new X509Builder
    }

    public DefaultJweHeaderMutator(DefaultJweHeaderMutator src) {
        super(src.DELEGATE);
        this.x509 = src.x509;
    }

    // =============================================================
    // MapMutator methods
    // =============================================================

    private  T put(Parameter param, F value) {
        this.DELEGATE.put(param, value);
        return self();
    }

    @Override
    public void clear() {
        super.clear();
        this.x509 = new X509BuilderSupport(this.DELEGATE, IllegalStateException.class);
    }

    // =============================================================
    // JWT Header methods
    // =============================================================

//    @Override
//    public T algorithm(String alg) {
//        return put(DefaultHeader.ALGORITHM, alg);
//    }

    @Override
    public T contentType(String cty) {
        return put(DefaultHeader.CONTENT_TYPE, cty);
    }

    @Override
    public T type(String typ) {
        return put(DefaultHeader.TYPE, typ);
    }

    @Override
    public T setType(String typ) {
        return type(typ);
    }

    @Override
    public T setContentType(String cty) {
        return contentType(cty);
    }

    @Override
    public T setCompressionAlgorithm(String zip) {
        return put(DefaultHeader.COMPRESSION_ALGORITHM, zip);
    }

    // =============================================================
    // Protected Header methods
    // =============================================================

    @Override
    public NestedCollection critical() {
        return new DefaultNestedCollection(self(), this.DELEGATE.get(DefaultProtectedHeader.CRIT)) {
            @Override
            protected void changed() {
                put(DefaultProtectedHeader.CRIT, Collections.asSet(getCollection()));
            }
        };
    }

    @Override
    public T jwk(PublicJwk jwk) {
        return put(DefaultProtectedHeader.JWK, jwk);
    }

    @Override
    public T jwkSetUrl(URI uri) {
        return put(DefaultProtectedHeader.JKU, uri);
    }

    @Override
    public T keyId(String kid) {
        return put(DefaultProtectedHeader.KID, kid);
    }

    @Override
    public T setKeyId(String kid) {
        return keyId(kid);
    }

    @Override
    public T setAlgorithm(String alg) {
        return put(DefaultHeader.ALGORITHM, alg);
    }

    // =============================================================
    // X.509 methods
    // =============================================================

    @Override
    public T x509Url(URI uri) {
        this.x509.x509Url(uri);
        return self();
    }

    @Override
    public T x509Chain(List chain) {
        this.x509.x509Chain(chain);
        return self();
    }

    @Override
    public T x509Sha1Thumbprint(byte[] thumbprint) {
        this.x509.x509Sha1Thumbprint(thumbprint);
        return self();
    }

    @Override
    public T x509Sha256Thumbprint(byte[] thumbprint) {
        this.x509.x509Sha256Thumbprint(thumbprint);
        return self();
    }

    // =============================================================
    // JWE Header methods
    // =============================================================

    @Override
    public T agreementPartyUInfo(byte[] info) {
        return put(DefaultJweHeader.APU, info);
    }

    @Override
    public T agreementPartyUInfo(String info) {
        return agreementPartyUInfo(Strings.utf8(Strings.clean(info)));
    }

    @Override
    public T agreementPartyVInfo(byte[] info) {
        return put(DefaultJweHeader.APV, info);
    }

    @Override
    public T agreementPartyVInfo(String info) {
        return agreementPartyVInfo(Strings.utf8(Strings.clean(info)));
    }

    @Override
    public T pbes2Count(int count) {
        return put(DefaultJweHeader.P2C, count);
    }
}