rightscale-nanite 0.4.1 → 0.4.1.1

data/lib/nanite/security/certificate_cache.rb

@@ -0,0 +1,66 @@
+module Nanite
+
+  # Implements a simple LRU cache: items that are the least accessed are
+  # deleted first.
+  class CertificateCache
+
+    # Max number of items to keep in memory
+    DEFAULT_CACHE_MAX_COUNT = 100
+
+    # Initialize cache
+    def initialize(max_count = DEFAULT_CACHE_MAX_COUNT)
+      @items = {}
+      @list = []
+      @max_count = max_count
+    end
+    
+    # Add item to cache
+    def put(key, item)
+      if @items.include?(key)
+        delete(key)
+      end
+      if @list.size == @max_count
+        delete(@list.first)
+      end
+      @items[key] = item
+      @list.push(key)
+      item
+    end
+    alias :[]= :put
+    
+    # Retrieve item from cache
+    # Store item returned by given block if any
+    def get(key)
+      if @items.include?(key)
+        @list.each_index do |i|
+          if @list[i] == key
+            @list.delete_at(i)
+            break
+          end
+        end
+        @list.push(key)
+        @items[key]
+      else
+        return nil unless block_given?
+         self[key] = yield
+      end
+    end
+    alias :[] :get
+    
+    # Delete item from cache
+    def delete(key)
+      c = @items[key]
+      if c
+        @items.delete(key)
+        @list.each_index do |i|
+  	      if @list[i] == key
+  	        @list.delete_at(i)
+  	        break
+  	      end
+        end
+        c
+      end
+    end
+
+  end
+end

data/lib/nanite/security/distinguished_name.rb

@@ -0,0 +1,34 @@
+module Nanite
+
+  # Build X.509 compliant distinguished names
+  # Distinghuished names are used to desccribe both a certificate issuer and
+  # subject.
+  class DistinguishedName
+    
+    # Initialize distinguished name from hash
+    # e.g.:
+    #   { 'C'  => 'US',
+    #     'ST' => 'California',
+    #     'L'  => 'Santa Barbara',
+    #     'O'  => 'RightScale',
+    #     'OU' => 'Certification Services',
+    #     'CN' => 'rightscale.com/emailAddress=cert@rightscale.com' }
+    #
+    def initialize(hash)
+      @value = hash
+    end
+    
+    # Conversion to OpenSSL X509 DN
+    def to_x509
+      if @value
+        OpenSSL::X509::Name.new(@value.to_a, OpenSSL::X509::Name::OBJECT_TYPE_TEMPLATE)
+      end
+    end
+
+    # Human readable form
+    def to_s
+      '/' + @value.to_a.collect { |p| p.join('=') }.join('/') if @value
+    end
+    
+  end
+end

data/lib/nanite/security/encrypted_document.rb

@@ -0,0 +1,46 @@
+module Nanite
+
+  # Represents a signed an encrypted document that can be later decrypted using
+  # the right private key and whose signature can be verified using the right
+  # cert.
+  # This class can be used both to encrypt and sign data and to then check the
+  # signature and decrypt an encrypted document.
+  class EncryptedDocument
+  
+    # Encrypt and sign data using certificate and key pair.
+    #
+    # Arguments:
+    #  - 'data':   Data to be encrypted
+    #  - 'certs':  Recipient certificates (certificates corresponding to private
+    #              keys that may be used to decrypt data)
+    #  - 'cipher': Cipher used for encryption, AES 256 CBC by default
+    #
+    def initialize(data, certs, cipher = 'AES-256-CBC')
+      cipher = OpenSSL::Cipher::Cipher.new(cipher)
+      certs = [ certs ] unless certs.respond_to?(:collect)
+      raw_certs = certs.collect { |c| c.raw_cert }
+      @pkcs7 = OpenSSL::PKCS7.encrypt(raw_certs, data, cipher, OpenSSL::PKCS7::BINARY)
+    end
+
+    # Initialize from encrypted data.
+    def self.from_data(encrypted_data)
+      doc = EncryptedDocument.allocate
+      doc.instance_variable_set(:@pkcs7, OpenSSL::PKCS7::PKCS7.new(encrypted_data))
+      doc
+    end
+    
+    # Encrypted data using DER format
+    def encrypted_data
+      @pkcs7.to_pem
+    end
+    
+    # Decrypted data
+    #
+    # Arguments:
+    #   - 'key':  Key used for decryption
+    #   - 'cert': Certificate to use for decryption
+    def decrypted_data(key, cert)
+      @pkcs7.decrypt(key.raw_key, cert.raw_cert)
+    end
+  end
+end

data/lib/nanite/security/rsa_key_pair.rb

@@ -0,0 +1,53 @@
+module Nanite
+
+  # Allows generating RSA key pairs and extracting public key component
+  # Note: Creating a RSA key pair can take a fair amount of time (seconds)
+  class RsaKeyPair
+    
+    DEFAULT_LENGTH = 2048
+
+    # Underlying OpenSSL keys
+    attr_reader :raw_key
+
+    # Create new RSA key pair using 'length' bits
+    def initialize(length = DEFAULT_LENGTH)
+      @raw_key = OpenSSL::PKey::RSA.generate(length)
+    end
+
+    # Does key pair include private key?
+    def has_private?
+      raw_key.private?
+    end
+    
+    # New RsaKeyPair instance with identical public key but no private key
+    def to_public
+      RsaKeyPair.from_data(raw_key.public_key.to_pem)
+    end
+    
+    # Key material in PEM format
+    def data
+      raw_key.to_pem
+    end
+    alias :to_s :data
+    
+    # Load key pair previously serialized via 'data'    
+    def self.from_data(data)
+      res = RsaKeyPair.allocate
+      res.instance_variable_set(:@raw_key, OpenSSL::PKey::RSA.new(data)) 
+      res
+    end
+
+    # Load key from file
+    def self.load(file)
+      from_data(File.read(file))
+    end
+    
+    # Save key to file in PEM format
+    def save(file)
+      File.open(file, "w") do |f|
+        f.write(@raw_key.to_pem)
+      end
+    end
+
+  end
+end

data/lib/nanite/security/secure_serializer.rb

@@ -0,0 +1,67 @@
+module Nanite
+  
+  # Serializer implementation which secures messages by using
+  # X.509 certificate sigining.
+  class SecureSerializer
+    
+    # Initialize serializer, must be called prior to using it.
+    #
+    #  - 'identity':   Identity associated with serialized messages
+    #  - 'cert':       Certificate used to sign and decrypt serialized messages
+    #  - 'key':        Private key corresponding to 'cert'
+    #  - 'store':      Certificate store. Exposes certificates used for
+    #                  encryption and signature validation.
+    #  - 'encrypt':    Whether data should be signed and encrypted ('true')
+    #                  or just signed ('false'), 'true' by default.
+    #
+    def self.init(identity, cert, key, store, encrypt = true)
+      @identity = identity
+      @cert = cert
+      @key = key
+      @store = store
+      @encrypt = encrypt
+    end
+    
+    # Was serializer initialized?
+    def self.initialized?
+      @identity && @cert && @key && @store
+    end
+
+    # Serialize message and sign it using X.509 certificate
+    def self.dump(obj)
+      raise "Missing certificate identity" unless @identity
+      raise "Missing certificate" unless @cert
+      raise "Missing certificate key" unless @key
+      raise "Missing certificate store" unless @store || !@encrypt
+      json = obj.to_json
+      if @encrypt
+        certs = @store.get_recipients(obj)
+        json = EncryptedDocument.new(json, certs).encrypted_data if certs
+      end
+      sig = Signature.new(json, @cert, @key)
+      { 'id' => @identity, 'data' => json, 'signature' => sig.data, 'encrypted' => !certs.nil? }.to_json
+    end
+    
+    # Unserialize data using certificate store
+    def self.load(json)
+      begin
+        raise "Missing certificate store" unless @store
+        raise "Missing certificate" unless @cert || !@encrypt
+        raise "Missing certificate key" unless @key || !@encrypt
+        data = JSON.load(json)
+        sig = Signature.from_data(data['signature'])
+        certs = @store.get_signer(data['id'])
+        certs = [ certs ] unless certs.respond_to?(:each)
+        jsn = data['data'] if certs.any? { |c| sig.match?(c) }
+        if jsn && @encrypt && data['encrypted']
+          jsn = EncryptedDocument.from_data(jsn).decrypted_data(@key, @cert)
+        end
+        JSON.load(jsn) if jsn
+      rescue Exception => e
+        Nanite::Log.error("Loading of secure packet failed: #{e.message}\n#{e.backtrace.join("\n")}")
+        raise
+      end
+    end
+       
+  end
+end

data/lib/nanite/security/signature.rb

@@ -0,0 +1,40 @@
+module Nanite
+
+  # Signature that can be validated against certificates
+  class Signature
+    
+    FLAGS = OpenSSL::PKCS7::NOCERTS || OpenSSL::PKCS7::BINARY || OpenSSL::PKCS7::NOATTR || OpenSSL::PKCS7::NOSMIMECAP || OpenSSL::PKCS7::DETACH
+
+    # Create signature using certificate and key pair.
+    #
+    # Arguments:
+    #  - 'data': Data to be signed
+    #  - 'cert': Certificate used for signature
+    #  - 'key':  RsaKeyPair used for signature
+    #
+    def initialize(data, cert, key)
+      @p7 = OpenSSL::PKCS7.sign(cert.raw_cert, key.raw_key, data, [], FLAGS)
+      @store = OpenSSL::X509::Store.new
+    end
+    
+    # Load signature previously serialized via 'data'
+    def self.from_data(data)
+      sig = Signature.allocate
+      sig.instance_variable_set(:@p7, OpenSSL::PKCS7::PKCS7.new(data))
+      sig.instance_variable_set(:@store, OpenSSL::X509::Store.new)
+      sig
+    end
+
+    # 'true' if signature was created using given cert, 'false' otherwise
+    def match?(cert)
+      @p7.verify([cert.raw_cert], @store, nil, OpenSSL::PKCS7::NOVERIFY)
+    end
+
+    # Signature in PEM format
+    def data
+      @p7.to_pem
+    end
+    alias :to_s :data
+
+  end
+end

data/lib/nanite/security/static_certificate_store.rb

@@ -0,0 +1,35 @@
+module Nanite
+
+  # Simple certificate store, serves a static set of certificates.
+  class StaticCertificateStore
+    
+    # Initialize store:
+    #
+    #  - Signer certificates are used when loading data to check the digital
+    #    signature. The signature associated with the serialized data needs
+    #    to match with one of the signer certificates for loading to succeed.
+    #
+    #  - Recipient certificates are used when serializing data for encryption.
+    #    Loading the data can only be done through serializers that have been
+    #    initialized with a certificate that's in the recipient certificates if
+    #    encryption is enabled.
+    #
+    def initialize(signer_certs, recipients_certs)
+      signer_certs = [ signer_certs ] unless signer_certs.respond_to?(:each)
+      @signer_certs = signer_certs 
+      recipients_certs = [ recipients_certs ] unless recipients_certs.respond_to?(:each)
+      @recipients_certs = recipients_certs
+    end
+    
+    # Retrieve signer certificate for given id
+    def get_signer(identity)
+      @signer_certs
+    end
+
+    # Recipient certificate(s) that will be able to decrypt the serialized data
+    def get_recipients(obj)
+      @recipients_certs
+    end
+    
+  end  
+end

data/lib/nanite/security_provider.rb

@@ -0,0 +1,47 @@
+module Nanite
+  # This class is used to interface the nanite mapper with an external security
+  # module.
+  # There are two points of integration:
+  #  1. When an agent registers with a mapper
+  #  2. When an agent sends a request to another agent 
+  #
+  # In both these cases the security module is called back and can deny the 
+  # operation.
+  # Note: it's the responsability of the module to do any logging or
+  # notification that is required.
+  class SecurityProvider
+    
+    # Register an external security module
+    # This module should expose the 'authorize_registration' and 
+    # 'authorize_request' methods.
+    def self.register(mod)
+      @security_module = mod
+    end
+    
+    # Used internally by nanite to retrieve the current security module
+    def self.get
+      @security_module || default_security_module
+    end
+    
+    # Default security module, authorizes all operations
+    def self.default_security_module
+      @default_sec_mod ||= DefaultSecurityModule.new
+    end
+    
+  end
+  
+  # Default security module
+  class DefaultSecurityModule
+    
+    # Authorize registration of agent (registration is an instance of Register)
+    def authorize_registration(registration)
+      true
+    end
+    
+    # Authorize given inter-agent request (request is an instance of Request)
+    def authorize_request(request)
+      true
+    end
+    
+  end
+end

data/lib/nanite/serializer.rb

@@ -0,0 +1,52 @@
+module Nanite
+  class Serializer
+
+    class SerializationError < StandardError
+      attr_accessor :action, :packet
+      def initialize(action, packet, serializers, msg = nil)
+        @action, @packet = action, packet
+        msg = ":\n#{msg}" if msg && !msg.empty?
+        super("Could not #{action} #{packet.inspect} using #{serializers.inspect}#{msg}")
+      end
+    end # SerializationError
+
+    # The secure serializer should not be part of the cascading
+    def initialize(preferred_format = :marshal)
+      preferred_format ||= :marshal
+      if preferred_format.to_s == 'secure'
+        @serializers = [ SecureSerializer ]
+      else
+        preferred_serializer = SERIALIZERS[preferred_format.to_sym]
+        @serializers = SERIALIZERS.values.clone
+        @serializers.unshift(@serializers.delete(preferred_serializer)) if preferred_serializer
+      end
+    end
+
+    def dump(packet)
+      cascade_serializers(:dump, packet)
+    end
+
+    def load(packet)
+      cascade_serializers(:load, packet)
+    end
+
+    private
+
+    SERIALIZERS = {:json => JSON, :marshal => Marshal, :yaml => YAML}.freeze
+
+    def cascade_serializers(action, packet)
+      errors = []
+      @serializers.map do |serializer|
+        begin
+          o = serializer.send(action, packet)
+        rescue Exception => e
+          o = nil
+          errors << "#{e.message}\n\t#{e.backtrace[0]}"
+        end
+        return o if o
+      end
+      raise SerializationError.new(action, packet, @serializers, errors.join("\n"))
+    end
+
+  end # Serializer
+end # Nanite