TrustedRequestAttributeAuthModule.java revision ac3d0527956d93d93c68e3cd2d70d15ee1e654f6
/*
* The contents of this file are subject to the terms of the Common Development and
* Distribution License (the License). You may not use this file except in compliance with the
* License.
*
* You can obtain a copy of the License at legal/CDDLv1.0.txt. See the License for the
* specific language governing permission and limitations under the License.
*
* When distributing Covered Software, include this CDDL Header Notice in each file and include
* the License file at legal/CDDLv1.0.txt. If applicable, add the following below the CDDL
* Header, with the fields enclosed by brackets [] replaced by your own identifying
* information: "Portions copyright [year] [name of copyright owner]".
*
* Copyright 2015 ForgeRock AS.
*/
/**
* An AsyncServerAuthModule that trusts an attribute present in the Servlet Request as the authenticationId.
* This attribute is likely set by a servlet filter that implements its own
*/
public class TrustedRequestAttributeAuthModule implements AsyncServerAuthModule {
private final static Logger logger = LoggerFactory.getLogger(TrustedRequestAttributeAuthModule.class);
private String authenticationIdAttribute;
public String getModuleId() {
return "TrustedAttribute";
}
/**
* Initialises the TrustedServletFilterAuthModule.
*
* @param requestPolicy {@inheritDoc}
* @param responsePolicy {@inheritDoc}
* @param handler {@inheritDoc}
* @param options {@inheritDoc}
* @return {@inheritDoc}
*/
public Promise<Void, AuthenticationException> initialize(MessagePolicy requestPolicy, MessagePolicy responsePolicy,
return newResultPromise(null);
}
/**
* {@inheritDoc}
*/
}
/**
* Validates the request by checking for the presence of a pre-configured attribute in the ServletRequest.
*
* @param messageInfo {@inheritDoc}
* @param clientSubject {@inheritDoc}
* @param serviceSubject {@inheritDoc}
* @return {@inheritDoc}
*/
return authenticationId;
}
});
return newResultPromise(SUCCESS);
} else {
return newResultPromise(SEND_FAILURE);
}
}
/**
* No work to do here so always returns AuthStatus.SEND_SUCCESS.
*
* @param messageInfo {@inheritDoc}
* @param serviceSubject {@inheritDoc}
* @return {@inheritDoc}
*/
return newResultPromise(SEND_SUCCESS);
}
/**
* Nothing to clean up.
*
* @param messageInfo {@inheritDoc}
* @param subject {@inheritDoc}
* @return {@inheritDoc}
*/
public Promise<Void, AuthenticationException> cleanSubject(MessageInfoContext messageInfo, Subject subject) {
return newResultPromise(null);
}
}