io.polyglotted.esjwt.JwtRealmExtension Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of esjwt-realm Show documentation
Elastic x-pack realm for authenticating generic json web tokens
There is a newer version: 6.2.4
/*
 * Licensed to Elasticsearch under one or more contributor
 * license agreements. See the NOTICE file distributed with
 * this work for additional information regarding copyright
 * ownership. Elasticsearch 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.polyglotted.esjwt;

import io.polyglotted.esjwt.realm.JwtAuthFailureHandler;
import io.polyglotted.esjwt.realm.JwtRealm;
import io.polyglotted.esjwt.realm.JwtRealmFactory;
import org.apache.http.HttpHeaders;
import org.elasticsearch.common.collect.MapBuilder;
import org.elasticsearch.watcher.ResourceWatcherService;
import org.elasticsearch.xpack.core.extensions.XPackExtension;
import org.elasticsearch.xpack.core.security.authc.AuthenticationFailureHandler;
import org.elasticsearch.xpack.core.security.authc.Realm;

import java.util.Collection;
import java.util.Collections;
import java.util.Map;

/**
 * The extension class that serves as the integration point between Elasticsearch, X-Pack, and any JWT provider
 */
public class JwtRealmExtension extends XPackExtension {

    @Override public String name() { return JwtRealm.TYPE; }

    @Override public String description() { return "JWT Realm Extension"; }

    /**
     * Returns a collection of header names that will be used by this extension. This is necessary to ensure the headers are copied from
     * the incoming request and made available to the realm.
     */
    @Override public Collection getRestHeaders() { return Collections.singleton(HttpHeaders.AUTHORIZATION); }

    /**
     * Returns a map of the custom realms provided by this extension. The first parameter is the string representation of the realm type;
     * this is the value that is specified when declaring a realm in the settings. Note, the realm type cannot be one of the types
     * defined by X-Pack. In order to avoid a conflict, you may wish to use some prefix to your realm types.
     * 
     * The second parameter is an instance of the {@link Realm.Factory} implementation. This factory class will be used to create realms of
     * this type that are defined in the elasticsearch settings.
     */
    @Override
    public Map getRealms(ResourceWatcherService resourceWatcherService) {
        return new MapBuilder().put(JwtRealm.TYPE, new JwtRealmFactory()).immutableMap();
    }

    /**
     * Returns the custom implementaion {@link JwtAuthFailureHandler}
     */
    @Override
    public AuthenticationFailureHandler getAuthenticationFailureHandler() { return new JwtAuthFailureHandler(); }
}