aboutsummaryrefslogtreecommitdiffstats
path: root/controller-server/src/main/java/com/yahoo/vespa/hosted/controller/athenz/filter/AthenzPrincipalFilter.java
blob: 5166f53c6d220a887f6ce562b3947a92d8077fcb (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
// Copyright 2017 Yahoo Holdings. Licensed under the terms of the Apache 2.0 license. See LICENSE in the project root.
package com.yahoo.vespa.hosted.controller.athenz.filter;

import com.google.inject.Inject;
import com.yahoo.jdisc.Response;
import com.yahoo.jdisc.http.filter.DiscFilterRequest;
import com.yahoo.jdisc.http.filter.security.cors.CorsFilterConfig;
import com.yahoo.jdisc.http.filter.security.cors.CorsRequestFilterBase;
import com.yahoo.vespa.athenz.api.AthenzPrincipal;
import com.yahoo.vespa.athenz.api.NToken;
import com.yahoo.vespa.athenz.utils.AthenzIdentities;
import com.yahoo.vespa.hosted.controller.api.integration.athenz.ZmsKeystore;
import com.yahoo.vespa.hosted.controller.athenz.config.AthenzConfig;

import java.security.cert.X509Certificate;
import java.util.HashSet;
import java.util.List;
import java.util.Optional;
import java.util.Set;
import java.util.concurrent.Executor;


/**
 * Authenticates Athenz principal, either through:
 *  1. TLS client authentication (based on Athenz x509 identity certficiate).
 *  2. The principal token (NToken) header.
 * The TLS authentication is based on the following assumptions:
 *  - The underlying connector is configured with 'clientAuth' set to either WANT_AUTH or NEED_AUTH.
 *  - The trust store is configured with the Athenz CA certificates only.
 *
 * @author bjorncs
 */
// TODO bjorncs: Move this class to vespa-athenz bundle
public class AthenzPrincipalFilter extends CorsRequestFilterBase {

    private final NTokenValidator validator;
    private final String principalTokenHeader;

    /**
     * @param executor to preload the ZMS public keys with
     */
    @Inject
    public AthenzPrincipalFilter(ZmsKeystore zmsKeystore,
                                 Executor executor,
                                 AthenzConfig athenzConfig,
                                 CorsFilterConfig corsConfig) {
        this(new NTokenValidator(zmsKeystore), executor, athenzConfig.principalHeaderName(), new HashSet<>(corsConfig.allowedUrls()));
    }

    AthenzPrincipalFilter(NTokenValidator validator,
                          Executor executor,
                          String principalTokenHeader,
                          Set<String> corsAllowedUrls) {
        super(corsAllowedUrls);
        this.validator = validator;
        this.principalTokenHeader = principalTokenHeader;
        executor.execute(validator::preloadPublicKeys);
    }

    @Override
    public Optional<ErrorResponse> filterRequest(DiscFilterRequest request) {
        try {
            Optional<AthenzPrincipal> certificatePrincipal = getClientCertificate(request)
                    .map(AthenzIdentities::from)
                    .map(AthenzPrincipal::new);
            Optional<AthenzPrincipal> nTokenPrincipal = getPrincipalToken(request, principalTokenHeader)
                    .map(validator::validate);

            if (!certificatePrincipal.isPresent() && !nTokenPrincipal.isPresent()) {
                String errorMessage = "Unable to authenticate Athenz identity. " +
                        "Either client certificate or principal token is required.";
                return Optional.of(new ErrorResponse(Response.Status.UNAUTHORIZED, errorMessage));
            }
            if (certificatePrincipal.isPresent() && nTokenPrincipal.isPresent()
                    && !certificatePrincipal.get().getIdentity().equals(nTokenPrincipal.get().getIdentity())) {
                String errorMessage = String.format(
                        "Identity in principal token does not match x509 CN: token-identity=%s, cert-identity=%s",
                        nTokenPrincipal.get().getIdentity().getFullName(),
                        certificatePrincipal.get().getIdentity().getFullName());
                return Optional.of(new ErrorResponse(Response.Status.UNAUTHORIZED, errorMessage));
            }
            AthenzPrincipal principal = nTokenPrincipal.orElseGet(certificatePrincipal::get);
            request.setUserPrincipal(principal);
            request.setRemoteUser(principal.getName());
            return Optional.empty();
        } catch (Exception e) {
            return Optional.of(new ErrorResponse(Response.Status.UNAUTHORIZED, e.getMessage()));
        }
    }

    private static Optional<X509Certificate> getClientCertificate(DiscFilterRequest request) {
        List<X509Certificate> chain = request.getClientCertificateChain();
        if (chain.isEmpty()) return Optional.empty();
        return Optional.of(chain.get(0));
    }

    private static Optional<NToken> getPrincipalToken(DiscFilterRequest request, String principalTokenHeaderName) {
        return Optional.ofNullable(request.getHeader(principalTokenHeaderName))
                .filter(token -> !token.isEmpty())
                .map(NToken::new);
    }

}