Added XForwardedFor

Author: prearrangedchaos

QueueIT.QueueToken.Tests/EnqueueTokenTest.cs

@@ -83,13 +83,14 @@ public void Factory_WithEventId()
         public void Factory_WithIPAddress()
         {
             string expectedIpAddress = "1.5.8.9";
-
+            string expectedXForwardedFor = "45.67.2.4,34.56.3.2";
             IEnqueueToken token = Token
                 .Enqueue("ticketania")
-                .WithIpAddress(expectedIpAddress)
+                .WithIpAddress(expectedIpAddress, expectedXForwardedFor)
                 .Generate("5ebbf794-1665-4d48-80d6-21ac34be7faedf9e10b3-551a-4682-bb77-fee59d6355d6");
 
             Assert.Equal(expectedIpAddress, token.IpAddress);
+            Assert.Equal(expectedXForwardedFor, token.XForwardedFor);
         }
 
         [Fact]
@@ -151,6 +152,7 @@ public void GenerateToken_WithPayload()
                 new DateTime(2018, 08, 20, 0, 0, 0, DateTimeKind.Utc),
                 new DateTime(2018, 10, 10, 0, 0, 0, DateTimeKind.Utc),
                 null,
+                null,
                 payload);
             token.Generate("5ebbf794-1665-4d48-80d6-21ac34be7faedf9e10b3-551a-4682-bb77-fee59d6355d6", false);
 
@@ -163,7 +165,7 @@ public void GenerateToken_WithPayload()
         public void GenerateToken_WithoutPayload()
         {
             string expectedSignedToken =
-                "eyJ0eXAiOiJRVDEiLCJlbmMiOiJBRVMyNTYiLCJpc3MiOjE1MzQ3MjMyMDAwMDAsImV4cCI6MTUzOTEyOTYwMDAwMCwidGkiOiJhMjFkNDIzYS00M2ZkLTQ4MjEtODRmYS00MzkwZjZhMmZkM2UiLCJjIjoidGlja2V0YW5pYSIsImUiOiJteWV2ZW50IiwiaXAiOiI1LjcuOC42In0..rqQznIDybri70GrsJ-hd_Hzp98HUqcsBGnWaiyqjlvY";
+                "eyJ0eXAiOiJRVDEiLCJlbmMiOiJBRVMyNTYiLCJpc3MiOjE1MzQ3MjMyMDAwMDAsImV4cCI6MTUzOTEyOTYwMDAwMCwidGkiOiJhMjFkNDIzYS00M2ZkLTQ4MjEtODRmYS00MzkwZjZhMmZkM2UiLCJjIjoidGlja2V0YW5pYSIsImUiOiJteWV2ZW50IiwiaXAiOiI1LjcuOC42IiwieGZmIjoiNDUuNjcuMi40LDM0LjU2LjMuMiJ9..wUOdVDIKlrIqumpU33bShDPdvTkicRk3q4Z-Vs8epFc";
 
             EnqueueToken token = new EnqueueToken(
                 "a21d423a-43fd-4821-84fa-4390f6a2fd3e",
@@ -172,6 +174,7 @@ public void GenerateToken_WithoutPayload()
                 new DateTime(2018, 08, 20, 0, 0, 0, DateTimeKind.Utc),
                 new DateTime(2018, 10, 10, 0, 0, 0, DateTimeKind.Utc),
                 "5.7.8.6",
+                "45.67.2.4,34.56.3.2",
                 null);
             token.Generate("5ebbf794-1665-4d48-80d6-21ac34be7faedf9e10b3-551a-4682-bb77-fee59d6355d6", false);
 
@@ -193,6 +196,7 @@ public void GenerateToken_MinimalHeader()
                 new DateTime(2018, 08, 20, 0, 0, 0, DateTimeKind.Utc),
                 null,
                 null,
+                null,
                 null);
             token.Generate("5ebbf794-1665-4d48-80d6-21ac34be7faedf9e10b3-551a-4682-bb77-fee59d6355d6", false);
 
@@ -204,9 +208,9 @@ public void GenerateToken_MinimalHeader()
         [Fact]
         public void Parse_WithoutPayload()
         {
-            string hash = "rqQznIDybri70GrsJ-hd_Hzp98HUqcsBGnWaiyqjlvY";
+            string hash = "wUOdVDIKlrIqumpU33bShDPdvTkicRk3q4Z-Vs8epFc";
             string token =
-                "eyJ0eXAiOiJRVDEiLCJlbmMiOiJBRVMyNTYiLCJpc3MiOjE1MzQ3MjMyMDAwMDAsImV4cCI6MTUzOTEyOTYwMDAwMCwidGkiOiJhMjFkNDIzYS00M2ZkLTQ4MjEtODRmYS00MzkwZjZhMmZkM2UiLCJjIjoidGlja2V0YW5pYSIsImUiOiJteWV2ZW50IiwiaXAiOiI1LjcuOC42In0.";
+                "eyJ0eXAiOiJRVDEiLCJlbmMiOiJBRVMyNTYiLCJpc3MiOjE1MzQ3MjMyMDAwMDAsImV4cCI6MTUzOTEyOTYwMDAwMCwidGkiOiJhMjFkNDIzYS00M2ZkLTQ4MjEtODRmYS00MzkwZjZhMmZkM2UiLCJjIjoidGlja2V0YW5pYSIsImUiOiJteWV2ZW50IiwiaXAiOiI1LjcuOC42IiwieGZmIjoiNDUuNjcuMi40LDM0LjU2LjMuMiJ9.";
             string tokenString = token + "." + hash;
 
             var enqueueToken = Token.Parse(tokenString, "5ebbf794-1665-4d48-80d6-21ac34be7faedf9e10b3-551a-4682-bb77-fee59d6355d6");
@@ -215,6 +219,7 @@ public void Parse_WithoutPayload()
             Assert.Equal("ticketania", enqueueToken.CustomerId);
             Assert.Equal("myevent", enqueueToken.EventId);
             Assert.Equal("5.7.8.6", enqueueToken.IpAddress);
+            Assert.Equal("45.67.2.4,34.56.3.2", enqueueToken.XForwardedFor);
             Assert.Equal(new DateTime(2018, 10, 10, 0, 0, 0, DateTimeKind.Utc), enqueueToken.Expires);
             Assert.Equal(new DateTime(2018, 08, 20, 0, 0, 0, DateTimeKind.Utc), enqueueToken.Issued);
             Assert.Equal(hash, enqueueToken.HashCode);

QueueIT.QueueToken/Model/HeaderDto.cs

@@ -24,6 +24,8 @@ public class HeaderDto
         public string EventId { get; set; }
         [DataMember(Name = "ip", Order = 8, EmitDefaultValue = false)]
         public string IpAddress { get; set; }
+        [DataMember(Name = "xff", Order = 9, EmitDefaultValue = false)]
+        public string XForwardedFor { get; set; }
 
         internal static HeaderDto DeserializeHeader(string input)
         {

QueueIT.QueueToken/Token.cs

@@ -61,9 +61,9 @@ public IEnqueueToken Generate(string secretKey)
             return _token;
         }
 
-        public EnqueueTokenGenerator WithIpAddress(string ipAddress)
+        public EnqueueTokenGenerator WithIpAddress(string ipAddress, string xForwardedFor)
         {
-            this._token = EnqueueToken.AddIPAddress(this._token, ipAddress);
+            this._token = EnqueueToken.AddIPAddress(this._token, ipAddress, xForwardedFor);
 
             return this;
         }
@@ -79,6 +79,7 @@ public interface IEnqueueToken
         string CustomerId { get; }
         string EventId { get; }
         string IpAddress { get; }
+        string XForwardedFor { get; }
         IEnqueueTokenPayload Payload { get; }
         string TokenWithoutHash { get; }
         string Token { get; }
@@ -91,6 +92,7 @@ internal class EnqueueToken : IEnqueueToken
         public string CustomerId { get; }
         public string EventId { get; }
         public string IpAddress { get; }
+        public string XForwardedFor { get; }
         public DateTime Issued { get; }
         public string TokenIdentifier { get; private set; }
         public TokenVersion TokenVersion => TokenVersion.QT1;
@@ -117,7 +119,7 @@ private static string GetTokenIdentifier(string tokenIdentifierPrefix)
                 : $"{tokenIdentifierPrefix}~{Guid.NewGuid()}";
         }
 
-        internal EnqueueToken(string tokenIdentifier, string customerId, string eventId, DateTime issued, DateTime? expires, string ipAddress, IEnqueueTokenPayload payload)
+        internal EnqueueToken(string tokenIdentifier, string customerId, string eventId, DateTime issued, DateTime? expires, string ipAddress, string xForwardedFor, IEnqueueTokenPayload payload)
         {
             TokenIdentifier = tokenIdentifier;
             CustomerId = customerId;
@@ -126,6 +128,7 @@ internal EnqueueToken(string tokenIdentifier, string customerId, string eventId,
             Expires = expires ?? DateTime.MaxValue;
             Payload = payload;
             IpAddress = ipAddress;
+            XForwardedFor = xForwardedFor;
         }
 
         internal void Generate(string secretKey, bool resetTokenIdentifier = true)
@@ -144,7 +147,8 @@ internal void Generate(string secretKey, bool resetTokenIdentifier = true)
                     Expires = Expires == DateTime.MaxValue ? null : (long?)(new DateTimeOffset(Expires)).ToUnixTimeMilliseconds(),
                     Encryption = EncryptionType.AES256.ToString(),
                     TokenVersion = TokenVersion.QT1.ToString(),
-                    IpAddress = IpAddress
+                    IpAddress = IpAddress,
+                    XForwardedFor = XForwardedFor
                 };
 
                 string serialized = dto.Serialize() + ".";
@@ -206,6 +210,7 @@ public static IEnqueueToken Parse(string tokenString, string secretKey)
                         ? new DateTime?(DateTimeOffset.FromUnixTimeMilliseconds(headerModel.Expires.Value).DateTime)
                         : null,
                     headerModel.IpAddress,
+                    headerModel.XForwardedFor,
                     payload)
                 {
                     TokenWithoutHash = token,
@@ -218,21 +223,21 @@ public static IEnqueueToken Parse(string tokenString, string secretKey)
             }
         }
 
-        internal static EnqueueToken AddIPAddress(EnqueueToken token, string ipAddress)
+        internal static EnqueueToken AddIPAddress(EnqueueToken token, string ipAddress, string xForwardedFor)
         {
-            return new EnqueueToken(token.TokenIdentifier, token.CustomerId, token.EventId, token.Issued, token.Expires, ipAddress, token.Payload);
+            return new EnqueueToken(token.TokenIdentifier, token.CustomerId, token.EventId, token.Issued, token.Expires, ipAddress, xForwardedFor, token.Payload);
         }
         internal static EnqueueToken AddEventId(EnqueueToken token, string eventId)
         {
-            return new EnqueueToken(token.TokenIdentifier, token.CustomerId, eventId, token.Issued, token.Expires, token.IpAddress, token.Payload);
+            return new EnqueueToken(token.TokenIdentifier, token.CustomerId, eventId, token.Issued, token.Expires, token.IpAddress, token.XForwardedFor, token.Payload);
         }
         internal static EnqueueToken AddExpires(EnqueueToken token, DateTime expires)
         {
-            return new EnqueueToken(token.TokenIdentifier, token.CustomerId, token.EventId, token.Issued, expires, token.IpAddress, token.Payload);
+            return new EnqueueToken(token.TokenIdentifier, token.CustomerId, token.EventId, token.Issued, expires, token.IpAddress, token.XForwardedFor, token.Payload);
         }
         internal static EnqueueToken AddPayload(EnqueueToken token, IEnqueueTokenPayload payload)
         {
-            return new EnqueueToken(token.TokenIdentifier, token.CustomerId, token.EventId, token.Issued, token.Expires, token.IpAddress, payload);
+            return new EnqueueToken(token.TokenIdentifier, token.CustomerId, token.EventId, token.Issued, token.Expires, token.IpAddress, token.XForwardedFor, payload);
         }
     }
 

README.md

@@ -13,7 +13,8 @@ The token consists of two parts. Firstly, a header containing non-sensitive meta
   "ti": "159aba3e-55e1-4f54-b6ee-e5b943d7e885”,
   "c": "ticketania", 
   "e": "demoevent”,
-  "ip": "75.86.129.4"
+  "ip": "75.86.129.4",
+  "xff": "45.67.2.4,34.56.3.2"
 }
 ```
 - `typ`: The type of the token. Value must be “QFT1”. Required.
@@ -23,7 +24,8 @@ The token consists of two parts. Firstly, a header containing non-sensitive meta
 - `ti`: Unique Token ID (e.g. uuid). Used to uniquely identify tokens and restrict replay attacks. Required.
 - `c`: The Customer ID of the issuer. Token will only be valid on events on this account. Required.
 - `e`: The Event ID. If provided, token will only be valid on this event. Optional.
-- `ip`: The IP address the user the token is issued to. If provided, token will only be valid for this IP address. Optional.
+- `ip`: The IP address the user the token is issued to. If provided, the IP address is validated before issuing the token. Optional.
+- `xff`: The X-Forwarded-For headerof the request when the token is issued. If provided, the X-Forwarded-For header is validated before issuing the token. Optional.
 
 ### Token Payload
 ```