HttpHeaderUtils.java

// Licensed to the Apache Software Foundation (ASF) under one
// or more contributor license agreements.  See the NOTICE file
// distributed with this work for additional information
// regarding copyright ownership.  The ASF licenses this file
// to you 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 org.apache.doris.httpv2.util;

import jakarta.servlet.http.HttpServletRequest;

/** Shared rendering of HTTP request headers for logs. */
public final class HttpHeaderUtils {
    private HttpHeaderUtils() {
    }

    /** Mask credentials without reading or changing the header used for authentication. */
    public static String getRedactedHeaderValueForLogging(HttpServletRequest request, String headerName) {
        return isSensitiveHeader(headerName) ? "***MASKED***" : request.getHeader(headerName);
    }

    private static boolean isSensitiveHeader(String headerName) {
        return "Authorization".equalsIgnoreCase(headerName)
                || "Proxy-Authorization".equalsIgnoreCase(headerName)
                || "Cookie".equalsIgnoreCase(headerName)
                || "Set-Cookie".equalsIgnoreCase(headerName)
                || "token".equalsIgnoreCase(headerName)
                || "Auth-Token".equalsIgnoreCase(headerName)
                || "auth_code".equalsIgnoreCase(headerName);
    }
}