net.sf.michaelo.tomcat.realm.GSSRealmBase Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of tomcat-authnz-spnego-ad Show documentation

A fully featured, first-class SPNEGO/Kerberos Authenticator and Active Directory Realm for the Apache Tomcat servlet container.

There is a newer version: 4.2.4

Show newest version

/*
 * Copyright 2013–2019 Michael Osipov
 *
 * 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
 *
 *     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 net.sf.michaelo.tomcat.realm;

import java.security.Principal;

import org.apache.catalina.realm.RealmBase;
import org.apache.juli.logging.Log;
import org.apache.juli.logging.LogFactory;
import org.apache.tomcat.util.res.StringManager;
import org.ietf.jgss.GSSContext;
import org.ietf.jgss.GSSCredential;
import org.ietf.jgss.GSSName;

/**
 * Base realm which is able to retrieve principals from {@link GSSName GSS names} or fully
 * established {@link GSSContext GSS contexts}.
 *
 * @version $Id: GSSRealmBase.java 317 2019-03-09 21:26:28Z michael-o $
 */
public abstract class GSSRealmBase extends RealmBase implements GSSRealm {

	protected final Log logger = LogFactory.getLog(getClass());
	protected final StringManager sm = StringManager.getManager(getClass());

	/**
	 * @throws UnsupportedOperationException
	 *             always throws because not implemented
	 */
	@Override
	protected String getPassword(String username) {
		throw new UnsupportedOperationException(
				"getPassword(String) is not supported by this realm");
	}

	/**
	 * @throws UnsupportedOperationException
	 *             always throws because not implemented
	 */
	@Override
	protected Principal getPrincipal(String username) {
		throw new UnsupportedOperationException(
				"getPrincipal(String) is not supported by this realm");
	}

	/**
	 * Get the principal associated with the specified GSS name.
	 *
	 * @param gssName
	 *            The GSS name
	 * @return the principal associated with the given GSS name
	 */
	protected Principal getPrincipal(GSSName gssName) {
		return getPrincipal(gssName, null);
	}

	/**
	 * Get the principal associated with the specified GSS name.
	 *
	 * @param gssName
	 *            The GSS name
	 * @param gssCredential
	 *            the GSS credential corresponding to the GSS name
	 * @return the principal associated with the given GSS name
	 */
	protected abstract Principal getPrincipal(GSSName gssName, GSSCredential gssCredential);
}