IuCallerAttributes.java

/*
 * Copyright © 2026 Indiana University
 * All rights reserved.
 *
 * BSD 3-Clause License
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 * 
 * - Redistributions of source code must retain the above copyright notice, this
 *   list of conditions and the following disclaimer.
 * 
 * - Redistributions in binary form must reproduce the above copyright notice,
 *   this list of conditions and the following disclaimer in the documentation
 *   and/or other materials provided with the distribution.
 * 
 * - Neither the name of the copyright holder nor the names of its
 *   contributors may be used to endorse or promote products derived from
 *   this software without specific prior written permission.
 * 
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */
package edu.iu.auth.oauth;

import java.net.URI;

/**
 * Caller client identification and authentication details for authorizing
 * remote invocation.
 */
public interface IuCallerAttributes extends IuAuthorizationDetails {

	/**
	 * Authorization details type value to match.
	 */
	static String TYPE = "iu:caller_attributes";

	@Override
	default String getType() {
		return TYPE;
	}

	/**
	 * Gets the full request URI to the resource that issued the token.
	 * 
	 * @return Request URI
	 */
	URI getRequestUri();

	/**
	 * Gets the remote client IP address.
	 * 
	 * @return IP address
	 */
	String getRemoteAddr();

	/**
	 * Gets the caller's user agent.
	 * 
	 * @return User-Agent header value
	 */
	String getUserAgent();

	/**
	 * Gets the principal name of the authenticated user.
	 * 
	 * @return Principal name
	 */
	String getAuthnPrincipal();

	/**
	 * Gets the principal name of the impersonated user.
	 * 
	 * @return Principal name; null (default) if impersonation is not in use, SHOULD
	 *         be null in production environments
	 */
	default String getImpersonatedPrincipal() {
		return null;
	}

}