io.micronaut.http.util.HttpHeadersUtil Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of micronaut-http Show documentation
Natively Cloud Native
The newest version!
/*
 * Copyright 2017-2022 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.http.util;

import io.micronaut.core.annotation.Internal;
import io.micronaut.core.annotation.NonNull;
import io.micronaut.core.annotation.Nullable;
import io.micronaut.core.util.SupplierUtil;
import io.micronaut.http.HttpHeaders;
import io.micronaut.http.MediaType;
import org.slf4j.Logger;

import java.nio.charset.Charset;
import java.nio.charset.StandardCharsets;
import java.nio.charset.UnsupportedCharsetException;
import java.util.List;
import java.util.Optional;
import java.util.Set;
import java.util.function.Function;
import java.util.function.Supplier;
import java.util.regex.Pattern;

/**
 * Utility class to work with {@link io.micronaut.http.HttpHeaders} or HTTP Headers.
 * @author Sergio del Amo
 * @since 3.8.0
 */
public final class HttpHeadersUtil {
    private final static Charset DEFAULT_CHARSET = StandardCharsets.UTF_8;
    private static final Supplier HEADER_MASK_PATTERNS = SupplierUtil.memoized(() ->
        Pattern.compile(".*(password|cred|cert|key|secret|token|auth|signat).*", Pattern.CASE_INSENSITIVE)
    );

    private HttpHeadersUtil() {

    }

    /**
     * Trace HTTP Headers.
     * @param log Logger
     * @param httpHeaders HTTP Headers
     */
    public static void trace(@NonNull Logger log,
                             @NonNull HttpHeaders httpHeaders) {
        if (log.isTraceEnabled()) {
            trace(log, httpHeaders.names(), httpHeaders::getAll);
        }
    }

    /**
     * Trace HTTP Headers.
     * @param log Logger
     * @param names HTTP Header names
     * @param getAllHeaders Function to get all the header values for a particular header name
     */
    public static void trace(@NonNull Logger log,
                             @NonNull Set names,
                             @NonNull Function> getAllHeaders) {
        if (log.isTraceEnabled()) {
            names.forEach(name -> trace(log, name, getAllHeaders));
        }
    }

    /**
     * Trace HTTP Headers.
     * @param log Logger
     * @param namesSupplier HTTP Header names Provider
     * @param getAllHeaders Function to get all the header values for a particular header name
     */
    public static void trace(@NonNull Logger log,
                             @NonNull Supplier> namesSupplier,
                             @NonNull Function> getAllHeaders) {
        if (log.isTraceEnabled()) {
            trace(log, namesSupplier.get(), getAllHeaders);
        }
    }

    /**
     * Trace HTTP Headers.
     * @param log Logger
     * @param name HTTP Header name
     * @param getAllHeaders Function to get all the header values for a particular header name
     */
    public static void trace(@NonNull Logger log,
                             @NonNull String name,
                             @NonNull Function> getAllHeaders) {
        boolean isMasked = HEADER_MASK_PATTERNS.get().matcher(name).matches();
        List all = getAllHeaders.apply(name);
        if (all.size() > 1) {
            for (String value : all) {
                String maskedValue = isMasked ? mask(value) : value;
                log.trace("{}: {}", name, maskedValue);
            }
        } else if (!all.isEmpty()) {
            String maskedValue = isMasked ? mask(all.get(0)) : all.get(0);
            log.trace("{}: {}", name, maskedValue);
        }
    }

    @Nullable
    private static String mask(@Nullable String value) {
        if (value == null) {
            return null;
        }
        return "*MASKED*";
    }

    /**
     * Split an accept-x header and get the first component. If the header is {@code *}, return
     * null.
     *
     * @param text The input header
     * @return The first part of the header, or {@code null} if the header is {@code *}
     * @since 4.0.0
     */
    @Internal
    @Nullable
    public static String splitAcceptHeader(@NonNull String text) {
        int len = text.length();
        if (len == 0 || (len == 1 && text.charAt(0) == '*')) {
            return null;
        }
        if (text.indexOf(';') > -1) {
            text = text.split(";")[0];
        }
        if (text.indexOf(',') > -1) {
            text = text.split(",")[0];
        }
        return text;
    }

    /**
     * Resolve the {@link Charset} to use for request identified by the Content-Type HTTP Header value and the Accept-Charset HTTP Header value.
     *
     * @param contentTypeHeaderValue Content-Type HTTP Header Value
     * @param acceptCharsetHeaderValue Accept-Charset HTTP Header Value
     * @return A {@link Charset}
     * @since 4.8.8
     */
    @NonNull
    public static Charset parseCharacterEncoding(@Nullable String contentTypeHeaderValue, @Nullable String acceptCharsetHeaderValue) {
        MediaType contentType = contentTypeHeaderValue == null ? null : MediaType.of(contentTypeHeaderValue);
        Charset charset = acceptCharsetHeaderValue != null ? parseAcceptCharset(acceptCharsetHeaderValue) : StandardCharsets.UTF_8;
        return parseCharacterEncoding(contentType, charset);
    }

    /**
     * Resolve the {@link Charset} to use for the request.
     *
     * @param contentType ContenType
     * @param acceptCharset Accept Charset
     * @return An {@link Optional} of {@link Charset}
     * @since 4.8.8
     */
    @NonNull
    public static Charset parseCharacterEncoding(@Nullable MediaType contentType,
                                                 @NonNull Charset acceptCharset) {
        try {

            if (contentType != null) {
                String charset = contentType.getParametersMap().get(MediaType.CHARSET_PARAMETER);
                if (charset != null) {
                    try {
                        return Charset.forName(charset);
                    } catch (Exception e) {
                        return DEFAULT_CHARSET;
                    }
                }
            }
        } catch (UnsupportedCharsetException e) {
            return DEFAULT_CHARSET;
        }
        return acceptCharset;
    }

    /**
     *
     * @param acceptCharsetHeaderValue Accept-Charset HeaderValue
     * @return Accept Charset
     * @since 4.8.8
     */
    @NonNull
    public static Charset parseAcceptCharset(@NonNull String acceptCharsetHeaderValue) {
        String text = HttpHeadersUtil.splitAcceptHeader(acceptCharsetHeaderValue);
        if (text != null) {
            try {
                return Charset.forName(text);
            } catch (Exception ignored) {
            }
        }
        return DEFAULT_CHARSET;
    }
}