Created
March 13, 2012 13:45
-
-
Save rdingwall/2028849 to your computer and use it in GitHub Desktop.
FilterIPAttribute for ASP.NET Web API (IIS only, port of MVC version from http://stackoverflow.com/a/4605086/91551)
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
using System; | |
using System.Configuration; | |
using System.Web; | |
using System.Web.Http; | |
using System.Web.Http.Controllers; | |
namespace Miscellaneous.Attributes.Controller | |
{ | |
/// <summary> | |
/// Filter by IP address (ASP.NET Web API version) | |
/// Originally from http://stackoverflow.com/a/4605086/91551 | |
/// </summary> | |
public class FilterIPAttribute : AuthorizeAttribute | |
{ | |
#region Allowed | |
/// <summary> | |
/// Comma seperated string of allowable IPs. Example "10.2.5.41,192.168.0.22" | |
/// </summary> | |
/// <value></value> | |
public string AllowedSingleIPs { get; set; } | |
/// <summary> | |
/// Comma seperated string of allowable IPs with masks. Example "10.2.0.0;255.255.0.0,10.3.0.0;255.255.0.0" | |
/// </summary> | |
/// <value>The masked I ps.</value> | |
public string AllowedMaskedIPs { get; set; } | |
/// <summary> | |
/// Gets or sets the configuration key for allowed single IPs | |
/// </summary> | |
/// <value>The configuration key single I ps.</value> | |
public string ConfigurationKeyAllowedSingleIPs { get; set; } | |
/// <summary> | |
/// Gets or sets the configuration key allowed mmasked IPs | |
/// </summary> | |
/// <value>The configuration key masked I ps.</value> | |
public string ConfigurationKeyAllowedMaskedIPs { get; set; } | |
/// <summary> | |
/// List of allowed IPs | |
/// </summary> | |
IPList allowedIPListToCheck = new IPList(); | |
#endregion | |
#region Denied | |
/// <summary> | |
/// Comma seperated string of denied IPs. Example "10.2.5.41,192.168.0.22" | |
/// </summary> | |
/// <value></value> | |
public string DeniedSingleIPs { get; set; } | |
/// <summary> | |
/// Comma seperated string of denied IPs with masks. Example "10.2.0.0;255.255.0.0,10.3.0.0;255.255.0.0" | |
/// </summary> | |
/// <value>The masked I ps.</value> | |
public string DeniedMaskedIPs { get; set; } | |
/// <summary> | |
/// Gets or sets the configuration key for denied single IPs | |
/// </summary> | |
/// <value>The configuration key single I ps.</value> | |
public string ConfigurationKeyDeniedSingleIPs { get; set; } | |
/// <summary> | |
/// Gets or sets the configuration key for denied masked IPs | |
/// </summary> | |
/// <value>The configuration key masked I ps.</value> | |
public string ConfigurationKeyDeniedMaskedIPs { get; set; } | |
/// <summary> | |
/// List of denied IPs | |
/// </summary> | |
IPList deniedIPListToCheck = new IPList(); | |
#endregion | |
private bool AuthorizeCore(HttpContextBase httpContext) | |
{ | |
if (httpContext == null) | |
throw new ArgumentNullException("httpContext"); | |
string userIpAddress = httpContext.Request.UserHostAddress; | |
try | |
{ | |
// Check that the IP is allowed to access | |
bool ipAllowed = CheckAllowedIPs(userIpAddress); | |
// Check that the IP is not denied to access | |
bool ipDenied = CheckDeniedIPs(userIpAddress); | |
// Only allowed if allowed and not denied | |
bool finallyAllowed = ipAllowed && !ipDenied; | |
return finallyAllowed; | |
} | |
catch (Exception e) | |
{ | |
// Log the exception, probably something wrong with the configuration | |
} | |
return true; // if there was an exception, then we return true | |
} | |
/// <summary> | |
/// Checks the allowed IPs. | |
/// </summary> | |
/// <param name="userIpAddress">The user ip address.</param> | |
/// <returns></returns> | |
private bool CheckAllowedIPs(string userIpAddress) | |
{ | |
// Populate the IPList with the Single IPs | |
if (!string.IsNullOrEmpty(AllowedSingleIPs)) | |
{ | |
SplitAndAddSingleIPs(AllowedSingleIPs, allowedIPListToCheck); | |
} | |
// Populate the IPList with the Masked IPs | |
if (!string.IsNullOrEmpty(AllowedMaskedIPs)) | |
{ | |
SplitAndAddMaskedIPs(AllowedMaskedIPs, allowedIPListToCheck); | |
} | |
// Check if there are more settings from the configuration (Web.config) | |
if (!string.IsNullOrEmpty(ConfigurationKeyAllowedSingleIPs)) | |
{ | |
string configurationAllowedAdminSingleIPs = ConfigurationManager.AppSettings[ConfigurationKeyAllowedSingleIPs]; | |
if (!string.IsNullOrEmpty(configurationAllowedAdminSingleIPs)) | |
{ | |
SplitAndAddSingleIPs(configurationAllowedAdminSingleIPs, allowedIPListToCheck); | |
} | |
} | |
if (!string.IsNullOrEmpty(ConfigurationKeyAllowedMaskedIPs)) | |
{ | |
string configurationAllowedAdminMaskedIPs = ConfigurationManager.AppSettings[ConfigurationKeyAllowedMaskedIPs]; | |
if (!string.IsNullOrEmpty(configurationAllowedAdminMaskedIPs)) | |
{ | |
SplitAndAddMaskedIPs(configurationAllowedAdminMaskedIPs, allowedIPListToCheck); | |
} | |
} | |
return allowedIPListToCheck.CheckNumber(userIpAddress); | |
} | |
/// <summary> | |
/// Checks the denied IPs. | |
/// </summary> | |
/// <param name="userIpAddress">The user ip address.</param> | |
/// <returns></returns> | |
private bool CheckDeniedIPs(string userIpAddress) | |
{ | |
// Populate the IPList with the Single IPs | |
if (!string.IsNullOrEmpty(DeniedSingleIPs)) | |
{ | |
SplitAndAddSingleIPs(DeniedSingleIPs, deniedIPListToCheck); | |
} | |
// Populate the IPList with the Masked IPs | |
if (!string.IsNullOrEmpty(DeniedMaskedIPs)) | |
{ | |
SplitAndAddMaskedIPs(DeniedMaskedIPs, deniedIPListToCheck); | |
} | |
// Check if there are more settings from the configuration (Web.config) | |
if (!string.IsNullOrEmpty(ConfigurationKeyDeniedSingleIPs)) | |
{ | |
string configurationDeniedAdminSingleIPs = ConfigurationManager.AppSettings[ConfigurationKeyDeniedSingleIPs]; | |
if (!string.IsNullOrEmpty(configurationDeniedAdminSingleIPs)) | |
{ | |
SplitAndAddSingleIPs(configurationDeniedAdminSingleIPs, deniedIPListToCheck); | |
} | |
} | |
if (!string.IsNullOrEmpty(ConfigurationKeyDeniedMaskedIPs)) | |
{ | |
string configurationDeniedAdminMaskedIPs = ConfigurationManager.AppSettings[ConfigurationKeyDeniedMaskedIPs]; | |
if (!string.IsNullOrEmpty(configurationDeniedAdminMaskedIPs)) | |
{ | |
SplitAndAddMaskedIPs(configurationDeniedAdminMaskedIPs, deniedIPListToCheck); | |
} | |
} | |
return deniedIPListToCheck.CheckNumber(userIpAddress); | |
} | |
/// <summary> | |
/// Splits the incoming ip string of the format "IP,IP" example "10.2.0.0,10.3.0.0" and adds the result to the IPList | |
/// </summary> | |
/// <param name="ips">The ips.</param> | |
/// <param name="list">The list.</param> | |
private void SplitAndAddSingleIPs(string ips, IPList list) | |
{ | |
var splitSingleIPs = ips.Split(','); | |
foreach (string ip in splitSingleIPs) | |
list.Add(ip); | |
} | |
/// <summary> | |
/// Splits the incoming ip string of the format "IP;MASK,IP;MASK" example "10.2.0.0;255.255.0.0,10.3.0.0;255.255.0.0" and adds the result to the IPList | |
/// </summary> | |
/// <param name="ips">The ips.</param> | |
/// <param name="list">The list.</param> | |
private void SplitAndAddMaskedIPs(string ips, IPList list) | |
{ | |
var splitMaskedIPs = ips.Split(','); | |
foreach (string maskedIp in splitMaskedIPs) | |
{ | |
var ipAndMask = maskedIp.Split(';'); | |
list.Add(ipAndMask[0], ipAndMask[1]); // IP;MASK | |
} | |
} | |
public override void OnAuthorization(HttpActionContext actionContext) | |
{ | |
if (AuthorizeCore((HttpContextBase)actionContext.Request.Properties["MS_HttpContext"])) | |
return; | |
base.HandleUnauthorizedRequest(actionContext); | |
} | |
} | |
} |
Thanks for the code. Need to make a correction. Code bellow is not accurate when site is on load balancer or proxy.
string userIpAddress = httpContext.Request.UserHostAddress;
Below is an extension I created and used instead.
public static string GetRealIp(this HttpRequestBase request)
{
var ip = request["HTTP_X_FORWARDED_FOR"];
if (!string.IsNullOrWhiteSpace(ip))
{
ip = ip.Split(',').Last().Trim();
}
if (string.IsNullOrWhiteSpace(ip))
{
ip = request.UserHostAddress;
}
return ip;
}
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Nice!