io.vertx.ext.auth.mtls.impl.MutualTlsAuthenticationImpl Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of sidecar-vertx-auth-mtls Show documentation
The newest version!
/*
 * 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 io.vertx.ext.auth.mtls.impl;

import java.util.List;

import io.vertx.core.AsyncResult;
import io.vertx.core.Future;
import io.vertx.core.Handler;
import io.vertx.core.Vertx;
import io.vertx.core.json.JsonObject;
import io.vertx.ext.auth.User;
import io.vertx.ext.auth.authentication.AuthenticationProvider;
import io.vertx.ext.auth.authentication.CertificateCredentials;
import io.vertx.ext.auth.authentication.Credentials;
import io.vertx.ext.auth.mtls.CertificateIdentityExtractor;
import io.vertx.ext.auth.mtls.CertificateValidator;
import io.vertx.ext.auth.mtls.MutualTlsAuthentication;

/**
 * {@link AuthenticationProvider} implementation for mTLS (MutualTLS) authentication. With mTLS authentication
 * both server and client exchange certificates and validates each other's certificates.
 */
public class MutualTlsAuthenticationImpl implements MutualTlsAuthentication
{
    private final Vertx vertx;
    private final CertificateValidator certificateValidator;
    private final CertificateIdentityExtractor identityExtractor;

    public MutualTlsAuthenticationImpl(Vertx vertx,
                                       CertificateValidator certificateValidator,
                                       CertificateIdentityExtractor identityExtractor)
    {
        this.vertx = vertx;
        this.certificateValidator = certificateValidator;
        this.identityExtractor = identityExtractor;
    }

    @Override
    public Future authenticate(Credentials credentials)
    {
        if (!(credentials instanceof CertificateCredentials))
        {
            return Future.failedFuture("CertificateCredentials expected for mTLS authentication");
        }

        CertificateCredentials certificateCredentials = (CertificateCredentials) credentials;
        return vertx.executeBlocking(() -> {
            certificateCredentials.checkValid();
            certificateValidator.verifyCertificate(certificateCredentials);
            List identities = identityExtractor.validIdentities(certificateCredentials);
            return MutualTlsUser.fromIdentities(identities);
        });
    }

    /**
     * Use {@code authenticate(Credentials credentials, Handler> resultHandler)} instead
     */
    @Deprecated
    @Override
    public void authenticate(JsonObject credentials, Handler> resultHandler)
    {
        throw new UnsupportedOperationException("Deprecated authentication method");
    }
}