junos-ez-srx 0.0.8

data/examples/srx_load_yaml.rb

@@ -0,0 +1,55 @@
+require 'yaml'
+require 'net/netconf/jnpr'
+require 'junos-ez/stdlib'
+require 'junos-ez/srx'
+
+login = {:target => 'vsrx', :username => 'jeremy', :password => 'jeremy1' }
+
+ndev = Netconf::SSH.new( login )
+ndev.open
+
+$stdout.puts "Connected to #{login[:target]}"
+
+Junos::Ez::Provider( ndev )
+Junos::Ez::SRX::Zones.Provider( ndev, :zones )
+Junos::Ez::SRX::Policies.Provider( ndev, :policies )
+
+### -----------------------------------------------------------------
+### Load all of the Zones YAML files
+### -----------------------------------------------------------------
+
+Dir["*_ZONE_IFS.yaml"].each do |file|
+  $stdout.puts "Loading Zone Interface YAML contents into Junos: #{file} ..."
+  ndev.zones.create_from_yaml! :filename=>file
+end
+
+Dir["*_ZONE_ADDRS.yaml"].each do |file|
+  $stdout.puts "Loading Zone address YAML contents into Junos: #{file} ..."
+  ndev.zones.addrs.create_from_yaml! :filename=>file
+end
+
+Dir["*_ZONE_SETS.yaml"].each do |file|
+  $stdout.puts "Loading Zone address-set YAML contents into Junos: #{file} ..."
+  ndev.zones.sets.create_from_yaml! :filename=>file
+end
+
+### -----------------------------------------------------------------
+### Load all of the Policy YAML files
+### -----------------------------------------------------------------
+
+Dir['POLICY_*.yaml'].each do |file|
+  $stdout.puts "Loading security policy YAML contents into Junos: #{file} ... "
+  ndev.policies.create_from_yaml! :filename => file
+end
+
+$stdout.puts "Committing configuration ... "
+ndev.rpc.commit_configuration
+
+ndev.close
+
+
+    
+
+
+
+

data/junos-ez-srx.gemspec

@@ -0,0 +1,20 @@
+$LOAD_PATH.unshift 'lib'
+require 'rake'
+require 'net/netconf'
+
+Gem::Specification.new do |s|
+
+  s.name = 'junos-ez-srx'
+  s.version = '0.0.8'
+  s.summary = "Junos NETCONF for SRX"
+  s.description = "Junos SRX gem for application development using NETCONF"
+  s.homepage = 'https://github.com/jeremyschulman/ruby-junos-ez-srx'
+  s.authors = ["Jeremy Schulman"]
+  s.email = 'jschulman@juniper.net'
+  s.files = FileList[ '*', 'lib/**/*.rb', 'examples/**/*.rb' ]
+
+  s.add_dependency('netconf')
+  s.add_dependency('ipaddress')
+  s.add_dependency('junos-ez-stdlib', '>= 0.1.0')
+
+end

data/lib/junos-ez/srx.rb

@@ -0,0 +1,150 @@
+require "junos-ez/provider"
+
+module Junos::Ez::SRX; end
+  
+module Junos::Ez::SRX::Zones
+
+  PROPERTIES = [
+    :description,                 ## description for Zone
+    :host_inbound_services,       ## array of service names | nil
+    :host_inbound_protocols,      ## array of protocol names | nil
+    :interfaces                   ## R/O array of interface names, will not catalog deeply
+  ]  
+
+  def self.Provider( ndev, varsym, opts = {} )       
+    newbie = Junos::Ez::SRX::Zones::Provider.new( ndev, nil, opts )     
+    newbie.properties = Junos::Ez::Provider::PROPERTIES + PROPERTIES
+    Junos::Ez::Provider.attach_instance_variable( ndev, varsym, newbie )
+  end
+    
+end
+
+module Junos::Ez::SRX::Interfaces 
+  
+  PROPERTIES = [
+    :host_inbound_services,
+    :host_inbound_protocols,
+  ]  
+  
+  def self.Provider( on_obj, varsym, opts = {} )     
+    newbie = Junos::Ez::SRX::Interfaces::Provider.new( on_obj, nil, opts )     
+    newbie.properties = Junos::Ez::Provider::PROPERTIES + PROPERTIES
+    Junos::Ez::Provider.attach_instance_variable( on_obj, varsym, newbie )    
+  end
+  
+end
+
+module Junos::Ez::SRX::AddressBookEntries
+  
+  PROPERTIES = [
+    :description,       # string
+    :ip_prefix,         # address/pflen
+  ]
+  
+  def self.Provider( on_obj, varsym, opts = {} )     
+    newbie = Junos::Ez::SRX::AddressBookEntries::Provider.new( on_obj, nil, opts )     
+    newbie.properties = Junos::Ez::Provider::PROPERTIES + PROPERTIES
+    Junos::Ez::Provider.attach_instance_variable( on_obj, varsym, newbie )    
+  end
+  
+end
+
+module Junos::Ez::SRX::AddressBookSets
+  
+  PROPERTIES = [
+    :description,       # string
+    :addr_names,        # array of address-names
+    :addr_sets,         # array of address-sets, yo!
+  ]         
+  
+  def self.Provider( on_obj, varsym, opts = {} )     
+    newbie = Junos::Ez::SRX::AddressBookSets::Provider.new( on_obj, nil, opts )     
+    newbie.properties = Junos::Ez::Provider::PROPERTIES + PROPERTIES
+    Junos::Ez::Provider.attach_instance_variable( on_obj, varsym, newbie )    
+  end
+  
+end
+
+module Junos::Ez::SRX::Policies
+  
+  PROPERTIES = [
+    :rules_count,         # Number of rules in this policy context
+    :rules                # Provider to Junos::Ez::SRX::PolicyRules
+  ]
+  
+  def self.Provider( on_obj, varsym, opts = {} )     
+    newbie = Junos::Ez::SRX::Policies::Provider.new( on_obj, nil, opts )     
+    newbie.properties = Junos::Ez::Provider::PROPERTIES + PROPERTIES
+    Junos::Ez::Provider.attach_instance_variable( on_obj, varsym, newbie )    
+  end  
+  
+end
+
+module Junos::Ez::SRX::PolicyRules
+  
+  PROPERTIES = [
+    :description,           # string description
+    :match_srcs,            # array of sources
+    :match_dsts,            # array of destinations
+    :match_apps,            # array of apps
+    :action,                # [ :permit, :reject, :deny ]
+    :count,                 # true | nil
+    :log_init,              # true | nil
+    :log_close              # true | nil
+  ]  
+  
+  def self.Provider( on_obj, varsym, opts = {} )     
+    newbie = Junos::Ez::SRX::PolicyRules::Provider.new( on_obj, nil, opts )     
+    newbie.properties = Junos::Ez::Provider::PROPERTIES + PROPERTIES
+    Junos::Ez::Provider.attach_instance_variable( on_obj, varsym, newbie )    
+  end  
+  
+end
+
+module Junos::Ez::SRX::Apps
+  
+  PROPERTIES = [
+    :description,       # string
+    :proto,             # protocol, string | number
+    :timeout,           # inactivity timeout, number
+    :icmp_type,         # ICMP type, only for proto == 'icmp'
+    :icmp_code,         # ICMP code, only for proto == 'icmp'
+    :dst_ports,         # string-name | array [low, high] 
+    :terms,             # array of composite terms
+  ]
+  
+  def self.Provider( on_obj, varsym, opts = {} )     
+    newbie = Junos::Ez::SRX::Apps::Provider.new( on_obj, nil, opts )     
+    newbie.properties = Junos::Ez::Provider::PROPERTIES + PROPERTIES
+    Junos::Ez::Provider.attach_instance_variable( on_obj, varsym, newbie )    
+  end  
+  
+end
+
+module Junos::Ez::SRX::AppSets
+  
+  PROPERTIES = [
+    :description,       # string
+    :app_names,         # array of app-names
+    :app_sets,          # array of app-sets, yes, sets can include other sets, yo!
+  ]
+  
+  def self.Provider( on_obj, varsym, opts = {} )     
+    newbie = Junos::Ez::SRX::AppSets::Provider.new( on_obj, nil, opts )     
+    newbie.properties = Junos::Ez::Provider::PROPERTIES + PROPERTIES
+    Junos::Ez::Provider.attach_instance_variable( on_obj, varsym, newbie )    
+  end  
+  
+end
+
+require 'junos-ez/srx/policies'
+require 'junos-ez/srx/policyrules'
+require 'junos-ez/srx/abooke'
+require 'junos-ez/srx/abooks'
+require 'junos-ez/srx/interfaces'
+require 'junos-ez/srx/zones'
+require 'junos-ez/srx/apps'
+require 'junos-ez/srx/appsets'
+
+
+

data/lib/junos-ez/srx/abooke.rb

@@ -0,0 +1,194 @@
+##### ---------------------------------------------------------------
+##### Provider resource methods
+##### ---------------------------------------------------------------
+
+require 'ipaddress'
+
+class Junos::Ez::SRX::AddressBookEntries::Provider < Junos::Ez::Provider::Parent
+  
+  ### ---------------------------------------------------------------
+  ### XML top placement
+  ### ---------------------------------------------------------------
+    
+  def xml_at_top    
+    Nokogiri::XML::Builder.new{ |x| x.configuration{ 
+      x.security { x.zones {
+        x.send(:'security-zone') { x.name @parent.name
+          x.send(:'address-book') {
+            x.address { x.name @name 
+              return x
+            }
+          }
+        }
+      }}
+    }}
+  end
+  
+  def xml_element_top( xml, name )
+    xml.address { xml.name @name 
+      return xml
+    }    
+  end
+    
+  ### ---------------------------------------------------------------
+  ### XML readers
+  ### ---------------------------------------------------------------
+
+  def xml_get_has_xml( xml )
+    xml.xpath('//address')[0]
+  end  
+  
+  def xml_read_parser( as_xml, as_hash )
+    set_has_status( as_xml, as_hash )  
+    xml_when_item( as_xml.xpath('description')){|i| as_hash[:description] = i.text }
+    as_hash[:ip_prefix] = as_xml.xpath('ip-prefix').text
+    true    
+  end   
+  
+  ### ---------------------------------------------------------------
+  ### XML writers
+  ### ---------------------------------------------------------------
+  
+  def xml_change_ip_prefix( xml )
+    xml_set_or_delete( xml, 'ip-prefix', @should[:ip_prefix] )
+  end
+    
+end
+
+##### ---------------------------------------------------------------
+##### Provider collection methods
+##### ---------------------------------------------------------------
+
+class Junos::Ez::SRX::AddressBookEntries::Provider
+  
+  def build_list
+    @ndev.rpc.get_configuration{ |x|
+      x.security { x.zones {
+        x.send(:'security-zone') { x.name @parent.name
+          x.send(:'address-book') {
+            x.address({:recurse => 'false' })
+          }
+        }
+      }}
+    }.xpath('//address/name').collect{ |adr_name| 
+      adr_name.text
+    }
+  end
+  
+  def build_catalog
+    @catalog = {}
+    
+    @ndev.rpc.get_configuration{ |x|
+      x.security { x.zones {
+        x.send(:'security-zone') { x.name @parent.name
+          x.send(:'address-book') {
+            x.address
+          }
+        }
+      }}
+    }.xpath('//address').each{ |adr|       
+      name = adr.xpath('name').text
+      @catalog[name] = {}
+      xml_read_parser( adr, @catalog[name] )      
+    }    
+    @catalog
+  end
+  
+end
+
+##### ---------------------------------------------------------------
+##### Provider EXPANDED methods
+##### ---------------------------------------------------------------
+
+class Junos::Ez::SRX::AddressBookEntries::Provider
+  
+  ## -----------------------------------------------------
+  ## create a Hash from the existing provider information
+  ## -----------------------------------------------------
+  
+  def to_h_expanded( opts = {} )           
+    { :name => @parent.name,      # zone name
+      :addrs => catalog
+    }     
+  end    
+    
+  ## ----------------------------------------------------------------
+  ## create the XML for a complete policy rules set given a Hash
+  ## structure the mimics the provider and properties for the 
+  ## Policy and associated PolicyRules
+  ## ----------------------------------------------------------------
+  
+  def xml_from_h_expanded( from_hash, opts = {} )    
+    zone_name = from_hash[:name]    
+    raise ArgumentError, "zone-name as :name not provided in hash" unless zone_name
+
+    ## handle the case where 'self' is either a provider or a specific instance. 
+    
+    zone_pvd = self.is_provider? ? Junos::Ez::SRX::Zones::Provider.new( @ndev, zone_name ) : @parent    
+    xml_top = zone_pvd.xml_at_top    
+    xml_top.send(:'address-book')
+    xml_add_here = xml_top.parent.at('address-book')
+    
+    ## now create objects and process the hash data accordingly
+    
+    from_hash[:addrs].each do |name, hash|
+      Nokogiri::XML::Builder.with( xml_add_here ) do |xml|      
+        # create the new object so we can generate XML on it
+        adr = self.class.new( @ndev, name, :parent => zone_pvd )                    
+        # generate the object specific XML inside
+        adr.should = hash
+        adr_xml = adr.xml_element_top( xml, name )    
+        adr.xml_build_change( adr_xml )            
+      end
+    end
+    
+    xml_top.doc.root
+  end
+
+end
+
+##### ---------------------------------------------------------------
+##### Provider operational methods
+##### ---------------------------------------------------------------
+
+class Junos::Ez::SRX::AddressBookEntries::Provider
+  
+  def find( addr )
+    lpm_cache_create!
+        
+    # turn the given string into a searchable IPAddress object
+    find_addr = IPAddress( addr )
+  
+    # search the cache for a matching item
+    found = @zab_lpm_cache.select{ |name, ab_addr, ipadr|
+      ipadr.include? find_addr
+    }
+    
+    return nil if found.empty?    
+    
+    # return a sorted result with highest prefix first
+    found.sort_by{ |n,a,ip| ip.prefix }.reverse!    
+  end  
+  
+  def lpm_find( addr )
+    return nil unless found = find( addr )
+    found[0]
+  end
+  
+  private
+  
+  def lpm_cache_create!
+    # cache is an array-of-arrays
+    # [0] = address-book name
+    # [1] = address-book address (string)
+    # [2] = IPAddress of [1] for searching
+    @zab_lpm_cache ||= catalog!.collect{ |name, hash| 
+      adr = hash[:ip_prefix]
+      [ name, adr, IPAddress.parse( adr ) ]
+    }
+  end
+
+  def lpm_cache_clear!; @zab_lpm_cache = nil end
+
+end
+

data/lib/junos-ez/srx/abooks.rb

@@ -0,0 +1,164 @@
+##### ---------------------------------------------------------------
+##### Provider resource methods
+##### ---------------------------------------------------------------
+
+class Junos::Ez::SRX::AddressBookSets::Provider < Junos::Ez::Provider::Parent
+  
+  ### ---------------------------------------------------------------
+  ### XML top placement
+  ### ---------------------------------------------------------------
+    
+  def xml_at_top    
+    Nokogiri::XML::Builder.new{ |x| x.configuration{ 
+      x.security { x.zones {
+        x.send(:'security-zone') { x.name @parent.name
+          x.send(:'address-book') {
+            return xml_element_top( x, @name )           
+          }
+        }
+      }}
+    }}
+  end
+  
+  def xml_element_top( xml, name )
+    xml.send(:'address-set') { 
+      xml.name name 
+      return xml
+    }    
+  end
+    
+  ### ---------------------------------------------------------------
+  ### XML readers
+  ### ---------------------------------------------------------------
+
+  def xml_get_has_xml( xml )
+    xml.xpath('//address-set')[0]
+  end  
+  
+  def xml_read_parser( as_xml, as_hash )
+    set_has_status( as_xml, as_hash )  
+    
+    xml_when_item(as_xml.xpath('description')){|i| as_hash[:description] = i.text }
+    as_hash[:addr_names] = as_xml.xpath('address/name').collect{ |i| i.text }
+    as_hash[:addr_sets] = as_xml.xpath('address-set/name').collect{ |i| i.text }
+    
+    true
+  end   
+  
+  ### ---------------------------------------------------------------
+  ### XML writers
+  ### ---------------------------------------------------------------
+  
+  def xml_change_addr_names( xml )
+    add, del = diff_property_array( :addr_names )       
+    return false if add.empty? and del.empty?
+    
+    add.each{ |item| xml.address { xml.name item } }
+    del.each{ |item| xml.address( Netconf::JunosConfig::DELETE ) { xml.name item }}
+  end
+  
+  def xml_change_addr_sets( xml )
+    add, del = diff_property_array( :addr_sets )       
+    return false if add.empty? and del.empty?
+    
+    add.each{ |item| xml.send(:'address-set') { xml.name item } }
+    del.each{ |item| xml.send(:'address-set', Netconf::JunosConfig::DELETE ) {  xml.name item  }}
+  end
+  
+end
+
+##### ---------------------------------------------------------------
+##### Provider collection methods
+##### ---------------------------------------------------------------
+
+class Junos::Ez::SRX::AddressBookSets::Provider
+  
+  def build_list   
+    @ndev.rpc.get_configuration{ |x|
+      x.security { x.zones {
+        x.send(:'security-zone') { x.name @parent.name
+          x.send(:'address-book') {
+            x.send(:'address-set', {:recurse => 'false' })
+          }
+        }
+      }}
+    }.xpath('//address-set/name').collect{ |this| 
+      this.text
+    }
+  end
+  
+  def build_catalog    
+    
+    @catalog = {}
+    
+    @ndev.rpc.get_configuration{ |x|
+      x.security { x.zones {
+        x.send(:'security-zone') { x.name @parent.name
+          x.send(:'address-book') {
+            x.send(:'address-set')
+          }
+        }
+      }}
+    }.xpath('//address-set').each{ |set| 
+      name = set.xpath('name').text
+      @catalog[name] = {}
+      xml_read_parser( set, @catalog[name] )      
+    }
+    
+    return @catalog  
+  end
+  
+end
+
+##### ---------------------------------------------------------------
+##### Provider EXPANDED methods
+##### ---------------------------------------------------------------
+
+class Junos::Ez::SRX::AddressBookSets::Provider
+  
+  ## -----------------------------------------------------
+  ## create a Hash from the existing provider information
+  ## -----------------------------------------------------
+  
+  def to_h_expanded( opts = {} )   
+    { :name => @parent.name,      # zone name
+      :sets => catalog
+    } 
+  end    
+    
+  ## ----------------------------------------------------------------
+  ## create the XML for a complete policy rules set given a Hash
+  ## structure the mimics the provider and properties for the 
+  ## Policy and associated PolicyRules
+  ## ----------------------------------------------------------------
+  
+  def xml_from_h_expanded( from_hash, opts = {} )    
+    zone_name = from_hash[:name]    
+    raise ArgumentError, ":name not provided in hash" unless from_hash[:name]
+    
+    ## Need to set the Nokogiri xml_add_here (Element) to the address-book element
+    ## for provider zone (@parent)
+    
+    zone_pvd = self.is_provider? ? Junos::Ez::SRX::Zones::Provider.new( @ndev, zone_name ) : @parent    
+    xml_top = zone_pvd.xml_at_top    
+    xml_top.send(:'address-book')
+    xml_add_here = xml_top.parent.at('address-book')
+    
+    ## now create objects and process the hash data accordingly
+    
+    from_hash[:sets].each do |name, hash|
+      Nokogiri::XML::Builder.with( xml_add_here ) do |xml|      
+        # create the new object so we can generate XML on it
+        obj = self.class.new( @ndev, name, :parent => zone_pvd )                    
+        # generate the object specific XML inside
+        obj.should = hash
+        obj_xml = obj.xml_element_top( xml, name )    
+        obj.xml_build_change( obj_xml )            
+      end
+    end
+    
+    xml_top.doc.root        
+  end
+
+end
+