com.yahoo.security.tls.TransportSecurityUtils Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of security-utils Show documentation
There is a newer version: 8.411.13
// Copyright Vespa.ai. Licensed under the terms of the Apache 2.0 license. See LICENSE in the project root.
package com.yahoo.security.tls;

import javax.net.ssl.SSLEngine;
import javax.net.ssl.SSLSession;
import javax.net.ssl.SSLSocket;
import java.nio.file.Path;
import java.nio.file.Paths;
import java.util.Map;
import java.util.Optional;

/**
 * Utility class for retrieving {@link TransportSecurityOptions} from the system.
 *
 * @author bjorncs
 */
public class TransportSecurityUtils {

    private static ConfigFileBasedTlsContext systemTlsContext;

    public static final String CONFIG_FILE_ENVIRONMENT_VARIABLE = "VESPA_TLS_CONFIG_FILE";
    public static final String INSECURE_MIXED_MODE_ENVIRONMENT_VARIABLE = "VESPA_TLS_INSECURE_MIXED_MODE";
    public static final String INSECURE_AUTHORIZATION_MODE_ENVIRONMENT_VARIABLE = "VESPA_TLS_INSECURE_AUTHORIZATION_MODE";
    public static final String CAPABILITIES_ENV_VAR = "VESPA_TLS_CAPABILITIES_ENFORCEMENT_MODE";

    private TransportSecurityUtils() {}

    public static boolean isTransportSecurityEnabled() {
        return isTransportSecurityEnabled(System.getenv());
    }

    public static boolean isTransportSecurityEnabled(Map envVariables) {
        return getConfigFile(envVariables).isPresent();
    }

    public static MixedMode getInsecureMixedMode() {
        return getInsecureMixedMode(System.getenv());
    }

    public static MixedMode getInsecureMixedMode(Map envVariables) {
        return getEnvironmentVariable(envVariables, INSECURE_MIXED_MODE_ENVIRONMENT_VARIABLE)
                .map(MixedMode::fromConfigValue)
                .orElse(MixedMode.defaultValue());
    }

    public static AuthorizationMode getInsecureAuthorizationMode() {
        return getInsecureAuthorizationMode(System.getenv());
    }

    public static AuthorizationMode getInsecureAuthorizationMode(Map envVariables) {
        return getEnvironmentVariable(envVariables, INSECURE_AUTHORIZATION_MODE_ENVIRONMENT_VARIABLE)
                .map(AuthorizationMode::fromConfigValue)
                .orElse(AuthorizationMode.defaultValue());
    }

    public static CapabilityMode getCapabilityMode() {
        return getEnvironmentVariable(System.getenv(), CAPABILITIES_ENV_VAR)
                .map(CapabilityMode::fromConfigValue)
                .orElse(CapabilityMode.defaultValue());
    }

    public static Optional getConfigFile() {
        return getConfigFile(System.getenv());
    }

    public static Optional getConfigFile(Map envVariables) {
        return getEnvironmentVariable(envVariables, CONFIG_FILE_ENVIRONMENT_VARIABLE).map(Paths::get);
    }

    public static Optional getOptions() {
        return getOptions(System.getenv());
    }

    public static Optional getOptions(Map envVariables) {
        return getConfigFile(envVariables)
                .map(TransportSecurityOptions::fromJsonFile);
    }

    /**
     * @return The shared {@link TlsContext} for the Vespa system environment
     */
    public static Optional getSystemTlsContext() {
        synchronized (TransportSecurityUtils.class) {
            Path configFile = getConfigFile().orElse(null);
            if (configFile == null) return Optional.empty();
            if (systemTlsContext == null) {
                systemTlsContext = new SystemTlsContext(configFile);
            }
            return Optional.of(systemTlsContext);
        }
    }

    /**
     * @return {@link ConnectionAuthContext} instance if {@link SSLEngine} was constructed by a {@link TlsContext}.
     *         Only available after TLS handshake is completed.
     */
    public static Optional getConnectionAuthContext(SSLSession s) {
        return Optional.ofNullable((ConnectionAuthContext) s.getValue(PeerAuthorizerTrustManager.AUTH_CONTEXT_PROPERTY));
    }

    /** @see #getConnectionAuthContext(SSLSession) */
    public static Optional getConnectionAuthContext(SSLEngine e) {
        return getConnectionAuthContext(e.getSession());
    }

    /** @see #getConnectionAuthContext(SSLSession) */
    public static Optional getConnectionAuthContext(SSLSocket s) {
        return getConnectionAuthContext(s.getSession());
    }

    private static Optional getEnvironmentVariable(Map environmentVariables, String variableName) {
        return Optional.ofNullable(environmentVariables.get(variableName))
                .filter(var -> !var.isEmpty());
    }

    private static class SystemTlsContext extends ConfigFileBasedTlsContext {
        SystemTlsContext(Path tlsOptionsConfigFile) {
            super(tlsOptionsConfigFile, getInsecureAuthorizationMode());
        }
        @Override public void close() {}
    }
}