io.micronaut.security.token.jwt.encryption.secret.SecretEncryption Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of micronaut-security-jwt Show documentation
Official Security Solution for Micronaut
There is a newer version: 4.11.1
Show newest version
/*
 * 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.encryption.secret;

import static java.nio.charset.StandardCharsets.UTF_8;

import com.nimbusds.jose.EncryptionMethod;
import com.nimbusds.jose.JWEAlgorithm;
import com.nimbusds.jose.JWEDecrypter;
import com.nimbusds.jose.JWEEncrypter;
import com.nimbusds.jose.KeyLengthException;
import com.nimbusds.jose.crypto.AESDecrypter;
import com.nimbusds.jose.crypto.AESEncrypter;
import com.nimbusds.jose.crypto.DirectDecrypter;
import com.nimbusds.jose.crypto.DirectEncrypter;
import com.nimbusds.jose.crypto.impl.AESCryptoProvider;
import com.nimbusds.jose.crypto.impl.DirectCryptoProvider;
import io.micronaut.context.exceptions.ConfigurationException;
import io.micronaut.security.token.jwt.encryption.AbstractEncryptionConfiguration;

/**
 * Secret encryption configuration.
 *
 * @author Sergio del Amo
 * @since 1.0
 */
public class SecretEncryption extends AbstractEncryptionConfiguration {

    private byte[] secret;

    /**
     *
     * @param secretEncryptionConfiguration Instance of {@link SecretEncryptionConfiguration}
     */
    public SecretEncryption(SecretEncryptionConfiguration secretEncryptionConfiguration) {

        if (secretEncryptionConfiguration.getSecret() == null) {
            throw new ConfigurationException("Secret encryption Configuration 'secret' is required");
        }
        if (!supports(secretEncryptionConfiguration.getJweAlgorithm(), secretEncryptionConfiguration.getEncryptionMethod())) {
            StringBuilder sb = new StringBuilder();
            sb.append("Encryption Method: ");
            sb.append(secretEncryptionConfiguration.getEncryptionMethod().toString());
            sb.append("JWE Algorithm: ");
            sb.append(secretEncryptionConfiguration.getJweAlgorithm().getName());
            sb.append(" not supported for Secret encryption");
            throw new ConfigurationException(sb.toString());
        }
        this.secret = secretEncryptionConfiguration.getSecret().getBytes(UTF_8);
        this.method = secretEncryptionConfiguration.getEncryptionMethod();
        this.algorithm = secretEncryptionConfiguration.getJweAlgorithm();
    }

    @Override
    public boolean supports(final JWEAlgorithm algorithm, final EncryptionMethod method) {
        if (algorithm != null && method != null) {
            final boolean isDirect = DirectCryptoProvider.SUPPORTED_ALGORITHMS.contains(algorithm)
                    && DirectCryptoProvider.SUPPORTED_ENCRYPTION_METHODS.contains(method);
            final boolean isAes = AESCryptoProvider.SUPPORTED_ALGORITHMS.contains(algorithm)
                    && AESCryptoProvider.SUPPORTED_ENCRYPTION_METHODS.contains(method);
            return isDirect || isAes;
        }
        return false;
    }

    /**
     *
     * @return message explaining the supported algorithms
     */
    @Override
    public String supportedAlgorithmsMessage() {
        return "Only the direct and AES algorithms are supported with the appropriate encryption method";
    }

    @Override
    protected JWEEncrypter buildEncrypter() throws KeyLengthException {
        if (DirectCryptoProvider.SUPPORTED_ALGORITHMS.contains(algorithm)) {
            return new DirectEncrypter(this.secret);
        } else {
            return new AESEncrypter(this.secret);
        }
    }

    @Override
    protected JWEDecrypter buildDecrypter() throws KeyLengthException {
        if (DirectCryptoProvider.SUPPORTED_ALGORITHMS.contains(algorithm)) {
            return new DirectDecrypter(this.secret);
        } else {
            return new AESDecrypter(this.secret);
        }
    }

    /**
     *
     * @return a string build the secret byte[] and UTF_8 charset
     */
    public String getSecret() {
        return new String(secret, UTF_8);
    }

    /**
     * Sets secret byte[] with a string with UTF_8 charset.
     * @param secret UTF_8 string
     */
    public void setSecret(final String secret) {
        this.secret = secret.getBytes(UTF_8);
    }
}