io.micronaut.security.x509.X509Authentication Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of micronaut-security Show documentation

Official Security Solution for Micronaut

There is a newer version: 4.10.1

/*
 * 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.security.x509;

import io.micronaut.core.annotation.NonNull;
import io.micronaut.core.annotation.Nullable;
import io.micronaut.security.authentication.ServerAuthentication;
import java.security.cert.X509Certificate;
import java.util.Collection;
import java.util.Map;

/**
 * An Authentication derived from an X509Certificate.
 *
 * @author Burt Beckwith
 * @since 3.3
 */
public class X509Authentication extends ServerAuthentication {

    @NonNull
    private final X509Certificate certificate;

    /**
     *
     * @param name The name of this principal
     * @param certificate X509 certification
     */
    public X509Authentication(@NonNull String name, @NonNull X509Certificate certificate) {
        this(name, certificate, null, null);
    }

    /**
     *
     * @param name The name of this principal name

     * @param certificate X509 certification
     * @param roles Roles of the authenticated user
     * @param attributes Attributes of the authenticated user
     */
    public X509Authentication(@NonNull String name,
                              @NonNull X509Certificate certificate,
                              @Nullable Collection roles,
                              @Nullable Map attributes) {
        super(name, roles, attributes);
        this.certificate = certificate;
    }

    /**
     * @return the X.509 certificate
     */
    @NonNull
    public X509Certificate getCertificate() {
        return certificate;
    }
}