io.micronaut.security.csrf.validator.RepositoryCsrfTokenValidator Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of micronaut-security-csrf Show documentation
Official Security Solution for Micronaut
The newest version!
/*
 * Copyright 2017-2024 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.csrf.validator;

import io.micronaut.context.annotation.Requires;
import io.micronaut.core.annotation.Internal;
import io.micronaut.security.csrf.generator.CsrfHmacTokenGenerator;
import io.micronaut.security.csrf.repository.CsrfTokenRepository;
import jakarta.inject.Singleton;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import java.nio.charset.StandardCharsets;
import java.util.List;
import java.util.Optional;
import java.security.MessageDigest;

/**
 * {@link CsrfTokenValidator} implementation that uses a {@link CsrfTokenRepository}.
 * First attempts to retrieve a token from a {@link CsrfTokenRepository} and if found validates it against the supplied token.
 * @param  Request
 * @since 4.11.0
 * @author Sergio del Amo
 */
@Requires(beans = { CsrfTokenRepository.class, CsrfHmacTokenGenerator.class})
@Internal
@Singleton
class RepositoryCsrfTokenValidator implements CsrfTokenValidator {
    private static final Logger LOG = LoggerFactory.getLogger(RepositoryCsrfTokenValidator.class);
    private final List> repositories;
    private final CsrfHmacTokenGenerator defaultCsrfTokenGenerator;

    /**
     *
     * @param repositories CSRF Token Repositories
     * @param defaultCsrfTokenGenerator Default CSRF Token Generator
     */
    public RepositoryCsrfTokenValidator(List> repositories,
                                        CsrfHmacTokenGenerator defaultCsrfTokenGenerator) {
        this.repositories = repositories;
        this.defaultCsrfTokenGenerator = defaultCsrfTokenGenerator;
    }

    @Override
    public boolean validateCsrfToken(T request, String csrfTokenInRequest) {
        for (CsrfTokenRepository repo : repositories) {
            Optional csrfTokenOptional = repo.findCsrfToken(request);
            if (csrfTokenOptional.isPresent()) {
                String csrfTokenInRepository = csrfTokenOptional.get();
                if (csrfTokenInRepository.equals(csrfTokenInRequest) && validateHmac(request, csrfTokenInRequest)) {
                    return true;
                }
            }
        }
        return false;
    }

    private boolean validateHmac(T request, String csrfTokenInRequest) {
        String[] arr = csrfTokenInRequest.split("\\" + CsrfHmacTokenGenerator.HMAC_RANDOM_SEPARATOR);
        if (arr.length != 2) {
            if (LOG.isWarnEnabled()) {
                LOG.warn("Invalid CSRF token: {}", csrfTokenInRequest);
            }
            return false;
        }
        String hmac = arr[0];
        String randomValue = arr[1];
        String expectedHmac = defaultCsrfTokenGenerator.hmac(request, randomValue);
        return MessageDigest.isEqual(expectedHmac.getBytes(StandardCharsets.UTF_8), hmac.getBytes(StandardCharsets.UTF_8));
    }
}