Merge pull request #619 from carolynvs/layer3-security-groups

Layer 3 Security Groups

Author: carolynvs

src/corelib/Compute/v2_1/IPProtocol.cs

@@ -1,30 +1,8 @@
-using OpenStack.Serialization;
-
 namespace OpenStack.Compute.v2_1
 {
     /// <summary>
     /// Internet Protocols.
     /// </summary>
-    public class IPProtocol : StringEnumeration
-    {
-        /// <summary />
-        protected IPProtocol(string displayName)
-            : base(displayName)
-        { }
-
-        /// <summary>
-        /// ICMP
-        /// </summary>
-        public static readonly IPProtocol ICMP = new IPProtocol("icmp");
-
-        /// <summary>
-        /// TCP
-        /// </summary>
-        public static readonly IPProtocol TCP = new IPProtocol("tcp");
-
-        /// <summary>
-        /// UDP
-        /// </summary>
-        public static readonly IPProtocol UDP = new IPProtocol("udp");
-    }
+    public class IPProtocol : Networking.v2.Serialization.IPProtocol<IPProtocol>
+    { }
 }

src/corelib/Networking/v2/IPProtocol.cs

@@ -0,0 +1,8 @@
+using OpenStack.Networking.v2.Serialization;
+
+namespace OpenStack.Networking.v2
+{
+    /// <inheritdoc />
+    public class IPProtocol : IPProtocol<IPProtocol>
+    { }
+}

src/corelib/Networking/v2/Layer3/NetworkingService_Layer3_Extensions.cs

@@ -6,6 +6,8 @@
 using OpenStack.Networking.v2.Serialization;
 using OpenStack.Serialization;
 using OpenStack.Synchronous.Extensions;
+using Flurl.Extensions;
+using Flurl.Http;
 
 namespace OpenStack.Networking.v2.Layer3
 {
@@ -102,6 +104,20 @@ public static class NetworkingService_Layer3_Extensions
             return service._networkingApiBuilder.DeleteFloatingIPAsync(floatingIPId, cancellationToken);
         }
         #endregion
+
+        #region Security Groups
+        /// <inheritdoc cref="NetworkingApiBuilder.ListSecurityGroupsAsync{T}" />
+        public static async Task<IEnumerable<SecurityGroup>> ListSecurityGroupsAsync(this NetworkingService service, SecurityGroupListOptions options = null, CancellationToken cancellationToken = default(CancellationToken))
+        {
+            return await service._networkingApiBuilder.ListSecurityGroupsAsync<SecurityGroupCollection>(options, cancellationToken).ConfigureAwait(false);
+        }
+
+        /// <inheritdoc cref="NetworkingApiBuilder.ListSecurityGroupRulesAsync{T}" />
+        public static async Task<IEnumerable<SecurityGroupRule>> ListSecurityGroupRulesAsync(this NetworkingService service, SecurityGroupRuleListOptions options = null, CancellationToken cancellationToken = default(CancellationToken))
+        {
+            return await service._networkingApiBuilder.ListSecurityGroupRulesAsync<SecurityGroupRuleCollection>(options, cancellationToken).ConfigureAwait(false);
+        }
+        #endregion
     }
 }
 
@@ -200,5 +216,19 @@ public static void DeleteFloatingIP(this NetworkingService service, Identifier f
             service._networkingApiBuilder.DeleteFloatingIPAsync(floatingIPId).ForceSynchronous();
         }
         #endregion
+
+        #region Security Groups
+        /// <inheritdoc cref="NetworkingService_Layer3_Extensions.ListSecurityGroupsAsync" />
+        public static IEnumerable<SecurityGroup> ListSecurityGroups(this NetworkingService service, SecurityGroupListOptions options = null)
+        {
+            return service.ListSecurityGroupsAsync(options).ForceSynchronous();
+        }
+        /// <inheritdoc cref="NetworkingService_Layer3_Extensions.ListSecurityGroupRulesAsync" />
+        public static IEnumerable<SecurityGroupRule> ListSecurityGroupRules(this NetworkingService service, SecurityGroupRuleListOptions options = null)
+        {
+            return service.ListSecurityGroupRulesAsync(options).ForceSynchronous();
+        }
+        #endregion
+
     }
 }

src/corelib/Networking/v2/Layer3/SecurityGroup.cs

@@ -0,0 +1,43 @@
+using System.Collections.Generic;
+using Newtonsoft.Json;
+using Newtonsoft.Json.Linq;
+using OpenStack.Serialization;
+
+namespace OpenStack.Networking.v2.Layer3
+{
+    /// <summary>
+    /// Represents the security group of the <see cref="NetworkingService"/> 
+    /// </summary>
+    [JsonConverterWithConstructor(typeof(RootWrapperConverter), "security_group")]
+    public class SecurityGroup : IHaveExtraData, IServiceResource
+    {
+        /// <summary>
+        /// The security group description
+        /// </summary>
+        [JsonProperty("description")]
+        public string Description;
+
+        /// <summary>
+        /// The UUID of security group
+        /// </summary>
+        [JsonProperty("id")]
+        public Identifier Id;
+
+        /// <summary>
+        /// The security group name
+        /// </summary>
+        [JsonProperty("name")]
+        public string Name;
+
+        /// <summary>
+        /// A list of <see cref="SecurityGroup"/> objects.
+        /// </summary>
+        [JsonProperty("security_group_rules")]
+        public IList<SecurityGroupRule> SecurityGroupRules;
+
+        [JsonExtensionData]
+        IDictionary<string, JToken> IHaveExtraData.Data { get; set; } = new Dictionary<string, JToken>();
+
+        object IServiceResource.Owner { get; set; }
+    }
+}

src/corelib/Networking/v2/Layer3/SecurityGroupListOptions.cs

@@ -0,0 +1,26 @@
+using System.Collections.Generic;
+
+namespace OpenStack.Networking.v2.Layer3
+{
+    /// <summary>
+    /// Optional filter and paging options when listing security groups.
+    /// </summary>
+    public class SecurityGroupListOptions : FilterOptions
+    {
+        /// <summary>
+        /// Filter by the group name.
+        /// </summary>
+        public string Name { get; set; }
+
+        /// <summary />
+        protected override IDictionary<string, object> BuildQueryString()
+        {
+            var queryString = new Dictionary<string, object>
+            {
+                ["name"] = Name
+            };
+
+            return queryString;
+        }
+    }
+}

src/corelib/Networking/v2/Layer3/SecurityGroupRule.cs

@@ -0,0 +1,82 @@
+using System.Collections.Generic;
+using Newtonsoft.Json;
+using Newtonsoft.Json.Linq;
+using OpenStack.Serialization;
+
+namespace OpenStack.Networking.v2.Layer3
+{
+    /// <summary>
+    /// 
+    /// </summary>
+    [JsonConverterWithConstructor(typeof(RootWrapperConverter), "security_group_rule")]
+    public class SecurityGroupRule : IHaveExtraData, IServiceResource
+    {
+        /// <summary>
+        /// ingress or egress: the direction in which the security group rule is applied.
+        /// For a compute instance, an ingress security group rule is applied to incoming (ingress) traffic for that instance. 
+        /// An egress rule is applied to traffic leaving the instance.
+        /// </summary>
+        [JsonProperty("direction")]
+        public TrafficDirection Direction;
+
+        /// <summary>
+        /// The internet protocol version. Addresses represented in CIDR must match the ingress or egress rules. 
+        /// </summary>
+        [JsonProperty("ethertype")]
+        public IPVersion Ethertype;
+
+        /// <summary>
+        /// The UUID of the security group rule.
+        /// </summary>
+        [JsonProperty("id")]
+        public Identifier Id;
+
+        /// <summary>
+        /// The minimum port number in the range that is matched by the security group rule.
+        /// If the protocol is TCP or UDP, this value must be less than or equal to the port_range_max attribute value.
+        /// If the protocol is ICMP, this value must be an ICMP type.
+        /// </summary>
+        [JsonProperty("port_range_min")]
+        public int MinPort { get; set; }
+
+        /// <summary>
+        /// The maximum port number in the range that is matched by the security group rule. 
+        /// The port_range_min attribute constrains the port_range_max attribute.
+        /// If the protocol is ICMP, this value must be an ICMP type. 
+        /// </summary>
+        [JsonProperty("port_range_max")]
+        public int MaxPort { get; set; }
+
+        /// <summary>
+        /// The protocol that is matched by the security group rule.
+        /// </summary>
+        [JsonProperty("protocol")]
+        public IPProtocol Protocol;
+
+        /// <summary>
+        /// The remote group UUID to associate with this security group rule.
+        /// You can specify either the remote_group_id or remote_ip_prefix attribute in the request body. 
+        /// </summary>
+        [JsonProperty("remote_group_id")]
+        public Identifier RemoteGroupId;
+
+        /// <summary>
+        /// The remote IP prefix or CIDR to associate with this security group rule.
+        /// You can specify either the remote_group_id or remote_ip_prefix attribute in the request body.
+        /// This attribute value matches the IP prefix as the source IP address of the IP packet. 
+        /// </summary>
+        [JsonProperty("remote_ip_prefix")]
+        public string RemoteCIDR;
+
+        /// <summary>
+        /// The UUId of security group 
+        /// </summary>
+        [JsonProperty("security_group_id")]
+        public Identifier SecurityGroupId;
+
+        [JsonExtensionData]
+        IDictionary<string, JToken> IHaveExtraData.Data { get; set; } = new Dictionary<string, JToken>();
+
+        object IServiceResource.Owner { get; set; }
+    }
+}

src/corelib/Networking/v2/Layer3/SecurityGroupRuleListOptions.cs

@@ -0,0 +1,26 @@
+using System.Collections.Generic;
+
+namespace OpenStack.Networking.v2.Layer3
+{
+    /// <summary>
+    /// Optional filter and paging options when listing security group rules.
+    /// </summary>
+    public class SecurityGroupRuleListOptions : FilterOptions
+    {
+        /// <summary>
+        /// Filter by the group name.
+        /// </summary>
+        public TrafficDirection Direction { get; set; }
+
+        /// <summary />
+        protected override IDictionary<string, object> BuildQueryString()
+        {
+            var queryString = new Dictionary<string, object>
+            {
+                ["direction"] = Direction
+            };
+
+            return queryString;
+        }
+    }
+}

src/corelib/Networking/v2/NetworkingApiBuilder.cs

@@ -384,7 +384,7 @@ public NetworkingApiBuilder(IServiceType serviceType, IAuthenticationProvider au
         }
         #endregion
 
-        #region Level 3 Extension
+        #region Layer 3 Extension
 
         #region Routers
         /// <summary>
@@ -667,6 +667,80 @@ public NetworkingApiBuilder(IServiceType serviceType, IAuthenticationProvider au
         }
         #endregion
 
+        #region SecurityGroup
+        /// <summary>
+        /// Lists all network security groups associated with the account.
+        /// </summary>
+        /// <param name="queryString">Options for filtering.</param>
+        /// <param name="cancellationToken">A cancellation token that can be used by other objects or threads to receive notice of cancellation.</param>
+        /// <returns>
+        /// A collection of network security group resources associated with the account.
+        /// </returns>
+        public async Task<T> ListSecurityGroupsAsync<T>(IQueryStringBuilder queryString, CancellationToken cancellationToken = default(CancellationToken))
+            where T : IEnumerable<IServiceResource>
+        {
+            return await BuildListSecurityGroupsRequest(queryString, cancellationToken)
+                .SendAsync()
+                .ReceiveJson<T>()
+                .PropogateOwnerToChildren(this).ConfigureAwait(false);
+        }
+
+        /// <summary>
+        /// Builds a <see cref="ListSecurityGroupsAsync{T}"/> request.
+        /// </summary>
+        /// <param name="queryString">Options for filtering.</param>
+        /// <param name="cancellationToken">A cancellation token that can be used by other objects or threads to receive notice of cancellation.</param>
+        public async Task<PreparedRequest> BuildListSecurityGroupsRequest(IQueryStringBuilder queryString, CancellationToken cancellationToken = default(CancellationToken))
+        {
+            Url endpoint = await Endpoint.GetEndpoint(cancellationToken).ConfigureAwait(false);
+
+            var request = endpoint
+                .AppendPathSegments("security-groups")
+                .Authenticate(AuthenticationProvider)
+                .PrepareGet(cancellationToken);
+
+            request.Url.SetQueryParams(queryString?.Build());
+
+            return request;
+        }
+
+        /// <summary>
+        /// Lists all network security group rules associated with the account.
+        /// </summary>
+        /// <param name="queryString">Options for filtering.</param>
+        /// <param name="cancellationToken">A cancellation token that can be used by other objects or threads to receive notice of cancellation.</param>
+        /// <returns>
+        /// A collection of network security group rule resources associated with the account.
+        /// </returns>
+        public async Task<T> ListSecurityGroupRulesAsync<T>(IQueryStringBuilder queryString, CancellationToken cancellationToken = default(CancellationToken))
+            where T : IEnumerable<IServiceResource>
+        {
+            return await BuildListSecurityGroupRulesRequest(queryString, cancellationToken)
+                .SendAsync()
+                .ReceiveJson<T>()
+                .PropogateOwnerToChildren(this).ConfigureAwait(false);
+        }
+
+        /// <summary>
+        /// Builds a <see cref="ListSecurityGroupRulesAsync{T}"/> request.
+        /// </summary>
+        /// <param name="queryString">Options for filtering.</param>
+        /// <param name="cancellationToken">A cancellation token that can be used by other objects or threads to receive notice of cancellation.</param>
+        public async Task<PreparedRequest> BuildListSecurityGroupRulesRequest(IQueryStringBuilder queryString, CancellationToken cancellationToken = default(CancellationToken))
+        {
+            Url endpoint = await Endpoint.GetEndpoint(cancellationToken).ConfigureAwait(false);
+
+            var request = endpoint
+                .AppendPathSegments("security-group-rules")
+                .Authenticate(AuthenticationProvider)
+                .PrepareGet(cancellationToken);
+
+            request.Url.SetQueryParams(queryString?.Build());
+
+            return request;
+        }
+        #endregion
+
         #region Floating IPs
         /// <summary>
         /// Shows details for a server group.

src/corelib/Networking/v2/Serialization/IPProtocol.cs

@@ -0,0 +1,27 @@
+using OpenStack.Serialization;
+
+namespace OpenStack.Networking.v2.Serialization
+{
+    /// <summary>
+    /// Internet Protocols.
+    /// </summary>
+    /// <exclude />
+    public class IPProtocol<T> : StringEnumeration
+        where T : IPProtocol<T>, new()
+    {
+        /// <summary>
+        /// ICMP
+        /// </summary>
+        public static readonly T ICMP = new T {DisplayName = "icmp"};
+
+        /// <summary>
+        /// TCP
+        /// </summary>
+        public static readonly T TCP = new T {DisplayName = "tcp"};
+
+        /// <summary>
+        /// UDP
+        /// </summary>
+        public static readonly T UDP = new T {DisplayName = "udp"};
+    }
+}