MultiFactorAuthenticationRequestResolver.java

package net.unicon.cas.mfa.authentication;

import org.jasig.cas.authentication.Authentication;
import org.jasig.cas.authentication.principal.Response.ResponseType;
import org.jasig.cas.authentication.principal.WebApplicationService;

import java.util.List;

/**
 * A strategy interface for resolving requests for multifactor authentication from existing primary authentication data.
 *
 * Example implementations might use primary authenticated principal's attribute or some other piece of contextual data
 * available in passed in <code>Authentication</code> object instance. Implementations may choose to return multiple contexts.
 *
 * @author Dmitriy Kopylenko
 * @author Unicon inc.
 */
public interface MultiFactorAuthenticationRequestResolver {


    /**
     * Default attribute name for retrieving requested mfa authentication method.
     */
    String DEFAULT_MFA_METHOD_ATTRIBUTE_NAME = "authn_method";


    /**
     * Resolve potential {@link net.unicon.cas.mfa.authentication.MultiFactorAuthenticationRequestContext} from passed in primary
     * authentication instance, for a passed in target service.
     *
     * @param authentication primary authentication instance
     * @param targetService target service
     * @param responseType response type required by the service
     *
     * @return list instance of <code>MultiFactorAuthenticationRequestContext</code> or null if no mfa request can be resolved
     */
    List<MultiFactorAuthenticationRequestContext> resolve(Authentication authentication, WebApplicationService targetService,
                                                          ResponseType responseType);
}