/// <summary>
/// Returns a copy of the URL supplied modified to remove CAS protocol-specific
/// URL parameters.
/// </summary>
/// <param name="url">The URL to remove CAS artifacts from</param>
/// <returns>The URL supplied without CAS artifacts</returns>
public string RemoveCasArtifactsFromUrl(string url)
{
Argument.ThrowIfNullOrEmpty(url, "url", "url parameter can not be null or empty.");
EnhancedUriBuilder ub = new EnhancedUriBuilder(url);
ub.QueryItems.Remove(_ticketValidatorFactory.Value.TicketValidator.ArtifactParameterName);
ub.QueryItems.Remove(_ticketValidatorFactory.Value.TicketValidator.ServiceParameterName);
ub.QueryItems.Remove(Settings.GatewayParameterName);
ub.QueryItems.Remove(Settings.ProxyCallbackParameterName);
// ++ NETC-28
Uri uriServerName;
if (SiteSettings.BaseUrl.StartsWith("http://", StringComparison.InvariantCultureIgnoreCase) ||
SiteSettings.BaseUrl.StartsWith("https://", StringComparison.InvariantCultureIgnoreCase))
{
uriServerName = new Uri(SiteSettings.BaseUrl);
}
else
{
// .NET URIs require scheme
uriServerName = new Uri("https://" + SiteSettings.BaseUrl);
}
ub.Scheme = uriServerName.Scheme;
ub.Host = uriServerName.Host;
ub.Port = uriServerName.Port;
return(ub.Uri.AbsoluteUri);
}
/// <summary>
/// Constructs a service URL using configured values in the following order:
/// 1. if not empty, the value configured for Service is used
/// - otherwise -
/// 2. the value configured for ServerName is used together with HttpRequest
/// data
/// </summary>
/// <remarks>
/// The server name is not parsed from the request for security reasons, which
/// is why the service and server name configuration parameters exist, per Jasig
/// website.
/// </remarks>
/// <returns>the service URL to use, not encoded</returns>
public string ConstructServiceUrl(bool gateway)
{
HttpContext context = HttpContext.Current;
HttpRequest request = context.Request;
StringBuilder buffer = new StringBuilder();
if (!(SiteSettings.BaseUrl.StartsWith("https://") || SiteSettings.BaseUrl.StartsWith("http://")))
{
buffer.Append(request.IsSecureConnection ? "https://" : "http://");
}
buffer.Append(SiteSettings.BaseUrl);
EnhancedUriBuilder ub = new EnhancedUriBuilder(buffer.ToString());
ub.Path = request.Url.AbsolutePath;
ub.QueryItems.Add(request.QueryString);
ub.QueryItems.Remove(_ticketValidatorFactory.Value.TicketValidator.ServiceParameterName);
ub.QueryItems.Remove(_ticketValidatorFactory.Value.TicketValidator.ArtifactParameterName);
if (gateway)
{
ub.QueryItems.Set(Settings.GatewayParameterName, "true");
}
else
{
ub.QueryItems.Remove(Settings.GatewayParameterName);
}
return(ub.Uri.AbsoluteUri);
}
/// <summary>
/// Constructs a URL used to check the validitiy of a service ticket, with or without a proxy
/// callback URL, and with or without requiring renewed credentials.
/// </summary>
/// <remarks>See CAS Protocol specification, section 2.5</remarks>
/// <param name="serviceTicket">The service ticket to validate.</param>
/// <param name="renew">
/// Whether or not renewed credentials are required. If True, ticket validation
/// will fail for Single Sign On credentials.
/// </param>
/// <param name="gateway">
/// whether or not to include gatewayResponse=true in the request (client specific).
/// </param>
/// <param name="customParameters">custom parameters to add to the validation URL</param>
/// <returns>The service ticket validation URL to use</returns>
public string ConstructValidateUrl(string serviceTicket, bool gateway, bool renew, NameValueCollection customParameters)
{
if (gateway && renew)
{
throw new ArgumentException("Gateway and Renew parameters are mutually exclusive and cannot both be True");
}
EnhancedUriBuilder ub = new EnhancedUriBuilder(EnhancedUriBuilder.Combine(Settings.CasServerUrlPrefix, _ticketValidatorFactory.Value.TicketValidator.UrlSuffix));
ub.QueryItems.Add(_ticketValidatorFactory.Value.TicketValidator.ServiceParameterName, HttpUtility.UrlEncode(ConstructServiceUrl(gateway)));
ub.QueryItems.Add(_ticketValidatorFactory.Value.TicketValidator.ArtifactParameterName, HttpUtility.UrlEncode(serviceTicket));
if (renew)
{
ub.QueryItems.Set("renew", "true");
}
if (customParameters != null)
{
for (int i = 0; i < customParameters.Count; i++)
{
string key = customParameters.AllKeys[i];
string value = customParameters[i];
ub.QueryItems.Add(key, value);
}
}
return(ub.Uri.AbsoluteUri);
}
/// <summary>
/// Constructs a proxy callback URL containing a ProxyCallbackParameter
/// (proxyResponse by default). This URL is sent to the CAS server during a proxy
/// ticket request and is then connected to by the CAS server. If the CAS server
/// cannot successfully connect (generally due to SSL configuration issues), the
/// CAS server will refuse to send a proxy ticket.
/// </summary>
/// <remarks>
/// This is a .NET implementation specific method used to eliminate the need for
/// a special HTTP Handler. Essentially, if the client detects an incoming request
/// with the ProxyCallbackParameter in the URL (i.e., proxyResponse), that request
/// is treated specially and behaves as if it were handled by an HTTP Handler. In
/// other words, this behavior may or may not short circuit the request event
/// processing and will not allow the underlying page to execute and transmit back to
/// the client. If your application does coincidentally make use of the key
/// 'proxyResponse' as a URL parameter, you will need to configure a custom
/// proxyCallbackParameter value which does not conflict with the URL parameters in
/// your application.
/// </remarks>
/// <returns>the proxy callback URL to use</returns>
public string ConstructProxyCallbackUrl()
{
EnhancedUriBuilder ub = new EnhancedUriBuilder(ConstructServiceUrl(false));
ub.QueryItems.Set(Settings.ProxyCallbackParameterName, "true");
return(ub.Uri.AbsoluteUri);
}
/// <summary>
/// Constructs the URL to use for redirection to the CAS server for single
/// signout. The CAS server will invalidate the ticket granting ticket and
/// redirect back to the current page. The web application must then call
/// ClearAuthCookie and revoke the ticket from the ServiceTicketManager to sign
/// the client out.
/// </summary>
/// <returns>the redirection URL to use, not encoded</returns>
public string ConstructSingleSignOutRedirectUrl()
{
// TODO: Make "logout" configurable
EnhancedUriBuilder ub = new EnhancedUriBuilder(EnhancedUriBuilder.Combine(Settings.CasServerUrlPrefix, "logout"));
ub.QueryItems.Set(_ticketValidatorFactory.Value.TicketValidator.ServiceParameterName, HttpUtility.UrlEncode(ConstructServiceUrl(false)));
return(ub.Uri.AbsoluteUri);
}
/// <summary>
/// Constructs a proxy ticket request URL containing both a proxy granting
/// ticket and a URL Encoded targetServiceUrl. The URL returned will generally only
/// be executed by the CAS client as a part of a proxy redirection in
/// CasAuthentication.ProxyRedirect(...) or CasAuthentication.GetProxyTicketIdFor(...)
/// but may also be used by applications which require low-level access to the proxy
/// ticket request functionality.
/// </summary>
/// <param name="proxyGrantingTicketId">
/// The proxy granting ticket used to authorize the request for a proxy ticket on the
/// CAS server
/// </param>
/// <param name="targetService">
/// The target service URL to request a proxy ticket request URL for
/// </param>
/// <returns>The URL to use to request a proxy ticket for the targetService specified</returns>
public string ConstructProxyTicketRequestUrl(string proxyGrantingTicketId, string targetService)
{
// TODO: Make "proxy" configurable.
EnhancedUriBuilder ub = new EnhancedUriBuilder(EnhancedUriBuilder.Combine(Settings.CasServerUrlPrefix, "proxy"));
ub.QueryItems.Add("pgt", proxyGrantingTicketId);
ub.QueryItems.Add("targetService", HttpUtility.UrlEncode(targetService));
return(ub.Uri.AbsoluteUri);
}
/// <summary>
/// Attempts to request a proxy ticket for the targetService specified and
/// returns a URL appropriate for redirection to the targetService containing
/// a ticket.
/// </summary>
/// <param name="targetService">The target service for proxy authentication</param>
/// <param name="proxyTicketUrlParameter">
/// The name of the ticket URL parameter expected by the target service (ticket by
/// default)
/// </param>
/// <returns>The URL of the target service with a proxy ticket included</returns>
public string GetProxyRedirectUrl(string targetService, string proxyTicketUrlParameter, Func <string, string> getProxyTicket)
{
// Todo: Is ResolveUrl(...) appropriate/necessary? If the URL starts with ~, it shouldn't require proxy authentication
string resolvedUrl = ResolveUrl(targetService);
string proxyTicket = getProxyTicket(resolvedUrl);
EnhancedUriBuilder ub = new EnhancedUriBuilder(resolvedUrl);
ub.QueryItems[proxyTicketUrlParameter] = proxyTicket;
return(ub.Uri.AbsoluteUri);
}
/// <summary>
/// Constructs the URL to use for redirection to the CAS server for login
/// </summary>
/// <remarks>
/// The server name is not parsed from the request for security reasons, which
/// is why the service and server name configuration parameters exist.
/// </remarks>
/// <returns>The redirection URL to use</returns>
public string ConstructLoginRedirectUrl(bool gateway, bool renew, bool gatewayCheck)
{
if (gateway && renew)
{
throw new ArgumentException("Gateway and Renew parameters are mutually exclusive and cannot both be True");
}
EnhancedUriBuilder ub = new EnhancedUriBuilder(Settings.FormsLoginUrl);
ub.QueryItems.Set(_ticketValidatorFactory.Value.TicketValidator.ServiceParameterName, HttpUtility.UrlEncode(ConstructServiceUrl(gateway)));
if (renew)
{
ub.QueryItems.Add("renew", "true");
}
else if (gatewayCheck)
{
ub.QueryItems.Add("gateway", "true");
}
string url = ub.Uri.AbsoluteUri;
return(url);
}
/// <summary>
/// Returns a copy of the URL supplied modified to remove CAS protocol-specific
/// URL parameters.
/// </summary>
/// <param name="url">The URL to remove CAS artifacts from</param>
/// <returns>The URL supplied without CAS artifacts</returns>
public string RemoveCasArtifactsFromUrl(string url) {
Argument.ThrowIfNullOrEmpty(url, "url", "url parameter can not be null or empty.");
EnhancedUriBuilder ub = new EnhancedUriBuilder(url);
ub.QueryItems.Remove(_ticketValidatorFactory.Value.TicketValidator.ArtifactParameterName);
ub.QueryItems.Remove(_ticketValidatorFactory.Value.TicketValidator.ServiceParameterName);
ub.QueryItems.Remove(Settings.GatewayParameterName);
ub.QueryItems.Remove(Settings.ProxyCallbackParameterName);
// ++ NETC-28
Uri uriServerName;
if (SiteSettings.BaseUrl.StartsWith("http://", StringComparison.InvariantCultureIgnoreCase) ||
SiteSettings.BaseUrl.StartsWith("https://", StringComparison.InvariantCultureIgnoreCase)) {
uriServerName = new Uri(SiteSettings.BaseUrl);
}
else {
// .NET URIs require scheme
uriServerName = new Uri("https://" + SiteSettings.BaseUrl);
}
ub.Scheme = uriServerName.Scheme;
ub.Host = uriServerName.Host;
ub.Port = uriServerName.Port;
return ub.Uri.AbsoluteUri;
}
/// <summary>
/// Attempts to request a proxy ticket for the targetService specified and
/// returns a URL appropriate for redirection to the targetService containing
/// a ticket.
/// </summary>
/// <param name="targetService">The target service for proxy authentication</param>
/// <param name="proxyTicketUrlParameter">
/// The name of the ticket URL parameter expected by the target service (ticket by
/// default)
/// </param>
/// <returns>The URL of the target service with a proxy ticket included</returns>
public string GetProxyRedirectUrl(string targetService, string proxyTicketUrlParameter, Func<string, string> getProxyTicket) {
// Todo: Is ResolveUrl(...) appropriate/necessary? If the URL starts with ~, it shouldn't require proxy authentication
string resolvedUrl = ResolveUrl(targetService);
string proxyTicket = getProxyTicket(resolvedUrl);
EnhancedUriBuilder ub = new EnhancedUriBuilder(resolvedUrl);
ub.QueryItems[proxyTicketUrlParameter] = proxyTicket;
return ub.Uri.AbsoluteUri;
}
/// <summary>
/// Constructs the URL to use for redirection to the CAS server for single
/// signout. The CAS server will invalidate the ticket granting ticket and
/// redirect back to the current page. The web application must then call
/// ClearAuthCookie and revoke the ticket from the ServiceTicketManager to sign
/// the client out.
/// </summary>
/// <returns>the redirection URL to use, not encoded</returns>
public string ConstructSingleSignOutRedirectUrl() {
// TODO: Make "logout" configurable
EnhancedUriBuilder ub = new EnhancedUriBuilder(EnhancedUriBuilder.Combine(Settings.CasServerUrlPrefix, "logout"));
ub.QueryItems.Set(_ticketValidatorFactory.Value.TicketValidator.ServiceParameterName, HttpUtility.UrlEncode(ConstructServiceUrl(false)));
return ub.Uri.AbsoluteUri;
}
/// <summary>
/// Constructs a proxy ticket request URL containing both a proxy granting
/// ticket and a URL Encoded targetServiceUrl. The URL returned will generally only
/// be executed by the CAS client as a part of a proxy redirection in
/// CasAuthentication.ProxyRedirect(...) or CasAuthentication.GetProxyTicketIdFor(...)
/// but may also be used by applications which require low-level access to the proxy
/// ticket request functionality.
/// </summary>
/// <param name="proxyGrantingTicketId">
/// The proxy granting ticket used to authorize the request for a proxy ticket on the
/// CAS server
/// </param>
/// <param name="targetService">
/// The target service URL to request a proxy ticket request URL for
/// </param>
/// <returns>The URL to use to request a proxy ticket for the targetService specified</returns>
public string ConstructProxyTicketRequestUrl(string proxyGrantingTicketId, string targetService) {
// TODO: Make "proxy" configurable.
EnhancedUriBuilder ub = new EnhancedUriBuilder(EnhancedUriBuilder.Combine(Settings.CasServerUrlPrefix, "proxy"));
ub.QueryItems.Add("pgt", proxyGrantingTicketId);
ub.QueryItems.Add("targetService", HttpUtility.UrlEncode(targetService));
return ub.Uri.AbsoluteUri;
}
/// <summary>
/// Constructs a proxy callback URL containing a ProxyCallbackParameter
/// (proxyResponse by default). This URL is sent to the CAS server during a proxy
/// ticket request and is then connected to by the CAS server. If the CAS server
/// cannot successfully connect (generally due to SSL configuration issues), the
/// CAS server will refuse to send a proxy ticket.
/// </summary>
/// <remarks>
/// This is a .NET implementation specific method used to eliminate the need for
/// a special HTTP Handler. Essentially, if the client detects an incoming request
/// with the ProxyCallbackParameter in the URL (i.e., proxyResponse), that request
/// is treated specially and behaves as if it were handled by an HTTP Handler. In
/// other words, this behavior may or may not short circuit the request event
/// processing and will not allow the underlying page to execute and transmit back to
/// the client. If your application does coincidentally make use of the key
/// 'proxyResponse' as a URL parameter, you will need to configure a custom
/// proxyCallbackParameter value which does not conflict with the URL parameters in
/// your application.
/// </remarks>
/// <returns>the proxy callback URL to use</returns>
public string ConstructProxyCallbackUrl() {
EnhancedUriBuilder ub = new EnhancedUriBuilder(ConstructServiceUrl(false));
ub.QueryItems.Set(Settings.ProxyCallbackParameterName, "true");
return ub.Uri.AbsoluteUri;
}
/// <summary>
/// Constructs a URL used to check the validitiy of a service ticket, with or without a proxy
/// callback URL, and with or without requiring renewed credentials.
/// </summary>
/// <remarks>See CAS Protocol specification, section 2.5</remarks>
/// <param name="serviceTicket">The service ticket to validate.</param>
/// <param name="renew">
/// Whether or not renewed credentials are required. If True, ticket validation
/// will fail for Single Sign On credentials.
/// </param>
/// <param name="gateway">
/// whether or not to include gatewayResponse=true in the request (client specific).
/// </param>
/// <param name="customParameters">custom parameters to add to the validation URL</param>
/// <returns>The service ticket validation URL to use</returns>
public string ConstructValidateUrl(string serviceTicket, bool gateway, bool renew, NameValueCollection customParameters) {
if (gateway && renew) {
throw new ArgumentException("Gateway and Renew parameters are mutually exclusive and cannot both be True");
}
EnhancedUriBuilder ub = new EnhancedUriBuilder(EnhancedUriBuilder.Combine(Settings.CasServerUrlPrefix, _ticketValidatorFactory.Value.TicketValidator.UrlSuffix));
ub.QueryItems.Add(_ticketValidatorFactory.Value.TicketValidator.ServiceParameterName, HttpUtility.UrlEncode(ConstructServiceUrl(gateway)));
ub.QueryItems.Add(_ticketValidatorFactory.Value.TicketValidator.ArtifactParameterName, HttpUtility.UrlEncode(serviceTicket));
if (renew) {
ub.QueryItems.Set("renew", "true");
}
if (customParameters != null) {
for (int i = 0; i < customParameters.Count; i++) {
string key = customParameters.AllKeys[i];
string value = customParameters[i];
ub.QueryItems.Add(key, value);
}
}
return ub.Uri.AbsoluteUri;
}
/// <summary>
/// Constructs a service URL using configured values in the following order:
/// 1. if not empty, the value configured for Service is used
/// - otherwise -
/// 2. the value configured for ServerName is used together with HttpRequest
/// data
/// </summary>
/// <remarks>
/// The server name is not parsed from the request for security reasons, which
/// is why the service and server name configuration parameters exist, per Jasig
/// website.
/// </remarks>
/// <returns>the service URL to use, not encoded</returns>
public string ConstructServiceUrl(bool gateway) {
HttpContext context = HttpContext.Current;
HttpRequest request = context.Request;
StringBuilder buffer = new StringBuilder();
if (!(SiteSettings.BaseUrl.StartsWith("https://") || SiteSettings.BaseUrl.StartsWith("http://"))) {
buffer.Append(request.IsSecureConnection ? "https://" : "http://");
}
buffer.Append(SiteSettings.BaseUrl);
EnhancedUriBuilder ub = new EnhancedUriBuilder(buffer.ToString());
ub.Path = request.Url.AbsolutePath;
ub.QueryItems.Add(request.QueryString);
ub.QueryItems.Remove(_ticketValidatorFactory.Value.TicketValidator.ServiceParameterName);
ub.QueryItems.Remove(_ticketValidatorFactory.Value.TicketValidator.ArtifactParameterName);
if (gateway) {
ub.QueryItems.Set(Settings.GatewayParameterName, "true");
}
else {
ub.QueryItems.Remove(Settings.GatewayParameterName);
}
return ub.Uri.AbsoluteUri;
}
/// <summary>
/// Constructs the URL to use for redirection to the CAS server for login
/// </summary>
/// <remarks>
/// The server name is not parsed from the request for security reasons, which
/// is why the service and server name configuration parameters exist.
/// </remarks>
/// <returns>The redirection URL to use</returns>
public string ConstructLoginRedirectUrl(bool gateway, bool renew, bool gatewayCheck)
{
if (gateway && renew) {
throw new ArgumentException("Gateway and Renew parameters are mutually exclusive and cannot both be True");
}
EnhancedUriBuilder ub = new EnhancedUriBuilder(Settings.FormsLoginUrl);
ub.QueryItems.Set(_ticketValidatorFactory.Value.TicketValidator.ServiceParameterName, HttpUtility.UrlEncode(ConstructServiceUrl(gateway)));
if (renew) {
ub.QueryItems.Add("renew", "true");
}
else if (gatewayCheck)
{
ub.QueryItems.Add("gateway", "true");
}
string url = ub.Uri.AbsoluteUri;
return url;
}