shibkit-meta_meta 0.2.2

data/lib/shibkit/meta_meta/federation.rb

@@ -0,0 +1,161 @@
+## @author    Pete Birkinshaw (<pete@digitalidentitylabs.com>)
+## Copyright: Copyright (c) 2011 Digital Identity Ltd.
+## License:   Apache License, Version 2.0
+
+## Licensed under the Apache License, Version 2.0 (the "License");
+## you may not use this file except in compliance with the License.
+## You may obtain a copy of the License at
+## 
+##     http://www.apache.org/licenses/LICENSE-2.0
+## 
+## Unless required by applicable law or agreed to in writing, software
+## distributed under the License is distributed on an "AS IS" BASIS,
+## WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+## See the License for the specific language governing permissions and
+## limitations under the License.
+##
+
+module Shibkit
+  class MetaMeta
+
+    ## Class to represent a Shibboleth Federation or collection of local metadata
+    ## 
+    class Federation < MetadataItem
+      
+      require 'shibkit/meta_meta/metadata_item'
+      
+      
+      ## Element and attribute used to select XML for new objects
+      ROOT_ELEMENT = 'EntitiesDescriptor'
+      TARGET_ATTR  = 'Name'
+      REQUIRED_QUACKS = [:metadata_id, :federation_uri, :source_file]
+      
+      ## The unique ID of the federation document (probably time/version based)
+      attr_accessor :metadata_id
+      
+      ## @return [String] the full name of the federation or collection
+      attr_accessor :name
+      
+      ## The human-readable display name of the Federation or collection of metadata
+      attr_accessor :display_name
+      
+      ## The URI name of the federation (may be missing for local collections)
+      attr_accessor :federation_uri
+      alias :uri :federation_uri
+      
+      ## Expiry date of the published metadata file
+      attr_accessor :valid_until
+      
+      ## Source file for this federation
+      attr_accessor :source_file
+      
+      ## @return [String] :federation for proper federations, :collection for 
+      ##   simple collections of entities.
+      attr_accessor :type
+      
+      ## @return [Array] country codes for areas served by the federation 
+      attr_accessor :countries
+      
+      ## @return [String, nil] URL of the federation's Refeds wiki entry
+      attr_accessor :refeds_url
+      
+      ## @return [String] URL of the federation or collection's home page
+      attr_accessor :homepage_url
+      
+      ## @return [Array] Array of languages supported by the federation or collection
+      attr_accessor :languages
+      
+      ## @return [String] Main contact email address for the federation 
+      attr_accessor :support_email
+      
+      ## @return [String] Brief description of the federation or collection
+      attr_accessor :description
+
+      ## Array of entities within the federation or metadata collection
+      attr_accessor :entities  
+
+      attr_accessor :trustiness
+      
+      attr_accessor :groups
+
+      
+      ## Time the Federation metadata was parsed
+      attr_reader :read_at
+      
+      def to_s
+        
+        return uri
+        
+      end
+      
+      
+      def tags=(tags)
+        
+        @tags = [tags].flatten.uniq
+        
+        if entities and ::Shibkit::MetaMeta.config.auto_tag?
+          entities.each { |e| e.tags = e.tags << @tags } unless tags.empty?
+        end
+        
+      end
+      
+      def tags
+        
+        return @tags.nil? ? [] : @tags
+        
+      end
+      
+      def sps
+        
+        return entities.select { |e| e.sp? }
+        
+      end
+      
+      def idps
+        
+        return entities.select { |e| e.idp? }
+        
+      end
+      
+      private
+      
+      ## Special case for federation top-level nodes
+      def select_xml(target=nil, options={})
+      
+        raise "No suitable XML was selected" unless @noko and
+          @noko.kind_of?(Nokogiri::XML::Element) and
+          @noko.name == ROOT_ELEMENT 
+      
+      end
+      
+      ## Build a federation object out of metadata XML
+      def parse_xml
+        
+        self.metadata_id    = @noko['ID'].to_s.strip
+        self.federation_uri = @noko['Name'].to_s.strip
+        self.valid_until    = @noko['validUntil'].strip
+        self.entities       = Array.new
+        
+        ## Process XML chunk for each entity in turn
+        log.info "Building entities for federation (#{uri})..."
+        @noko.xpath("//xmlns:EntityDescriptor").each do |ex|
+        
+          entity = Entity.new(ex)
+          entity.primary_federation_uri = self.federation_uri
+          
+          entity.tags << self.tags
+          
+          ## Collect this entity in the federation object
+          self.entities << entity
+          
+        end
+
+        log.debug "Derived federation #{self.uri} from XML"
+
+      end
+      
+
+      
+    end
+  end
+end

data/lib/shibkit/meta_meta/idp.rb

@@ -0,0 +1,81 @@
+## @author    Pete Birkinshaw (<pete@digitalidentitylabs.com>)
+## Copyright: Copyright (c) 2011 Digital Identity Ltd.
+## License:   Apache License, Version 2.0
+
+## Licensed under the Apache License, Version 2.0 (the "License");
+## you may not use this file except in compliance with the License.
+## You may obtain a copy of the License at
+## 
+##     http://www.apache.org/licenses/LICENSE-2.0
+## 
+## Unless required by applicable law or agreed to in writing, software
+## distributed under the License is distributed on an "AS IS" BASIS,
+## WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+## See the License for the specific language governing permissions and
+## limitations under the License.
+##
+
+module Shibkit
+  class MetaMeta
+    
+    require 'shibkit/meta_meta/provider'
+    
+    ## Class to represent an IDP 
+    class IDP < Provider
+      
+      require 'shibkit/meta_meta/attribute'
+      
+      ## Element and attribute used to select XML for new objects
+      ROOT_ELEMENT = 'EntityDescriptor'
+      TARGET_ATTR  = 'entityID'
+      REQUIRED_QUACKS = [:scopes, :valid?]
+      
+      MDUI_ROOT = 'IDPSSODescriptor'
+
+      ## Scopes used by the entity (if an IDP)
+      attr_accessor  :scopes
+      attr_accessor  :protocols
+      attr_accessor  :nameid_formats
+      attr_accessor  :attributes
+      
+      private
+      
+      def parse_xml
+        
+        super
+        
+        @scopes = @noko.xpath('xmlns:IDPSSODescriptor/xmlns:Extensions/shibmd:Scope').collect do |sx|
+        
+         sx['regexp'] == 'true' ? Regexp.new(sx.text) : sx.text  
+          
+        end 
+       
+        
+        @valid = @noko.xpath('xmlns:IDPSSODescriptor[1]').empty? ? false : true
+        
+        proto_set = @noko.xpath('xmlns:IDPSSODescriptor/@protocolSupportEnumeration')[0]
+        @protocols = proto_set.value.split(' ') if proto_set 
+        
+        @nameid_formats ||= Array.new
+        @noko.xpath('xmlns:IDPSSODescriptor/xmlns:NameIDFormat').each do |nx|
+          
+          @nameid_formats << nx.content
+          
+        end
+        
+        @attributes ||= Array.new
+        @noko.xpath('xmlns:IDPSSODescriptor/saml:Attribute').each do |ax|
+          
+          @attributes << Shibkit::MetaMeta::Attribute.new(ax).filter
+          
+        end
+        
+        log.debug "  Derived IdP from XML" if filter
+        
+      end
+      
+    end
+
+
+  end
+end

data/lib/shibkit/meta_meta/logo.rb

@@ -0,0 +1,216 @@
+## @author    Pete Birkinshaw (<pete@digitalidentitylabs.com>)
+## Copyright: Copyright (c) 2011 Digital Identity Ltd.
+## License:   Apache License, Version 2.0
+
+## Licensed under the Apache License, Version 2.0 (the "License");
+## you may not use this file except in compliance with the License.
+## You may obtain a copy of the License at
+## 
+##     http://www.apache.org/licenses/LICENSE-2.0
+## 
+## Unless required by applicable law or agreed to in writing, software
+## distributed under the License is distributed on an "AS IS" BASIS,
+## WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+## See the License for the specific language governing permissions and
+## limitations under the License.
+##
+
+
+module Shibkit
+  class MetaMeta
+
+    ## Class to represent technical or suppor contact details for an entity
+    class Logo < MetadataItem
+      
+      require 'chunky_png'
+      require 'dimensions'
+      
+      require 'shibkit/meta_meta/metadata_item'
+      
+      require 'shibkit/meta_meta/mixin/cached_downloads'
+      include Shibkit::MetaMeta::Mixin::CachedDownloads
+      
+      ## Element and attribute used to select XML for new objects
+      ROOT_ELEMENT = 'Logo'
+      TARGET_ATTR  = 'width'
+      REQUIRED_QUACKS = [:location]
+      
+      ## URI of the entity this logo is associated with
+      attr_accessor :entity
+      
+      ## Height of the image as declared in XML
+      attr_accessor :height
+      
+      ## Width of the image as declared in XML
+      attr_accessor :width
+      
+      ## URL of the image
+      attr_accessor :location   
+      alias :url    :location
+      
+      
+      ## Language of the logo
+      attr_accessor :language
+      
+      attr_reader   :metadata_pixels
+      
+      def to_s
+        
+        return location
+        
+      end
+      
+      ## Calculated size of the image (:tiny :small :medium :large, etc)
+      ## I'm not sure about these.
+      def size
+        
+        return case 
+        when pixels <= (16*16)
+          :tiny
+        when pixels <= (32*32)
+          :small
+        when pixels <= (64*64)
+          :icon
+        when pixels <= (4200..6200)
+          :default
+        when pixels <= (128*128)
+          :medium
+        when pixels <= (256*256)
+          :large
+        when pixels <= (512*512)
+          :huge
+        else
+          :silly
+        end
+        
+      end
+      
+      ## Returns number of pixels
+      def pixels
+        
+        return width.to_i * height.to_i
+        
+      end
+      
+      ## Returns :square, :portrait or :landscape
+      def shape
+        
+        return :default   if (75..85).include(width) and (55..65).include(height)
+        return :square    if width == height ## TODO: Needs a bit of tolerance for small differences
+        return :portrait  if height > width
+        return :landscape if width > height
+        
+        ## Possibly running in the nightmare corpse-city of R'lyeh
+        raise "Geometry of logo is abnormal, non-Euclidean, and loathsomely redolent of spheres and dimensions apart from ours."
+        
+      end
+      
+      ## HTTPS resource? 
+      def ssl?
+        
+        return location =~ /^https/ ? true : false
+        
+      end
+      
+      ## PNG image? Convenience method since these are probably a better choice than JPEGs
+      ## Not accurate...
+      def png?
+        
+        if @tmpfile 
+          begin
+            image = ChunkyPNG::Image.from_file(@tmpfile.path)
+            return true if image
+          rescue
+            return false
+          end
+        end
+        
+        return @png  if @png
+        return false if location.empty?
+
+        # # ... 
+
+        return true if location =~ /[.]png$/
+        
+        begin
+          response = RestClient.head(location)
+          return true if response.headers['content-type'] == 'image/png'
+        rescue
+          return false
+        end
+        
+        return false
+        
+      end
+      
+      ## Logo is within recommended size range?
+      def acceptable_size?
+        
+        return true if width > 50 and
+          width < 100 and
+          height > 50 and
+          height < 100
+        
+      end
+      
+      ## Download and cache the image, returning a filehandle
+      def download
+      
+        @tmpfile = fetch_remote(location)
+         
+        @fetched_at = Time.new
+         
+        return @tmpfile
+        
+      end
+      
+      ## Filehandle for the local, downloaded file. Will download.
+      def tmpfile
+      
+        unless @tmpfile
+          
+          return download
+          
+        end
+        
+        return @tmpfile
+      
+      end
+    
+      ## Download the file and update this object based on real characteristics
+      def confirm_attribs?
+
+        #begin
+          
+          width, height = Dimensions.dimensions(tmpfile.path)  
+          return pixels == metadata_pixels ? true : false 
+            
+        #rescue
+          return nil   
+        #end
+          
+        return true
+       
+      end
+      
+      private
+      
+      ## Build the logo object from a suitable chunk of XML
+      def parse_xml
+        
+        if @noko and @noko.content
+          
+          self.location = @noko.content.to_s.strip || nil
+          self.height   = @noko['height'] ? @noko['height'].to_i : 0 
+          self.width    = @noko['width']  ? @noko['width'].to_i  : 0
+          lang          = @noko['xml:lang'] || :en
+          
+          @metadata_pixels = height * width
+          
+          log.debug "   Derived logo #{url} from XML"
+          
+        end
+      end
+    end
+  end
+end