right_agent 0.5.1

data/lib/right_agent/core_payload_types/login_policy.rb

@@ -0,0 +1,72 @@
+#
+# Copyright (c) 2009-2011 RightScale Inc
+#
+# Permission is hereby granted, free of charge, to any person obtaining
+# a copy of this software and associated documentation files (the
+# "Software"), to deal in the Software without restriction, including
+# without limitation the rights to use, copy, modify, merge, publish,
+# distribute, sublicense, and/or sell copies of the Software, and to
+# permit persons to whom the Software is furnished to do so, subject to
+# the following conditions:
+#
+# The above copyright notice and this permission notice shall be
+# included in all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+# LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+# OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+# WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+#
+
+module RightScale
+
+  # List of authorized users for Managed Login feature
+  class LoginPolicy
+    PUBLIC_KEY_REGEXP      = /(.*)?(ssh-[a-z]{1,3})\s+(\S+)\s*(.*)?$/
+
+    include Serializable
+
+    attr_accessor :audit_id, :created_at, :exclusive, :users
+
+    # Initialize fields from given arguments
+    def initialize(*args)
+      @audit_id       = args[0]
+      @created_at     = Time.at( (args[1]||Time.now).to_i )
+      @exclusive      = args[2] || false
+      @users          = args[3] || []
+    end
+
+    # Array of serialized fields given to constructor
+    def serialized_members
+      [ @audit_id, @created_at.to_i, @exclusive, @users ]
+    end
+
+    # Utility method to parse an SSH2-format public key and return a 4-tuple consisting
+    # of its constituent parts:
+    #  * leading comment (optional)
+    #  * algorithm (ssh-rsa or ssh-dsa)
+    #  * public key material, as a base64 string
+    #  * trailing comment or email (optional)
+    #
+    # === Parameters
+    # str(String):: the unparsed public key
+    #
+    # === Return
+    # components (Array|nil):: a 4-tuple of key components, or nil if the key was not a valid public key
+    #
+    def self.parse_public_key(str)
+      match = PUBLIC_KEY_REGEXP.match(str)
+
+      if match
+        #Return a nice array of strings with no leading/trailing whitespace, and empty
+        #strings transformed into nil
+        return match[1..4].map { |x| x.strip! ; x.empty? ? nil : x }
+      else
+        return nil
+      end
+    end
+  end
+end

data/lib/right_agent/core_payload_types/login_user.rb

@@ -0,0 +1,62 @@
+#
+# Copyright (c) 2009-2011 RightScale Inc
+#
+# Permission is hereby granted, free of charge, to any person obtaining
+# a copy of this software and associated documentation files (the
+# "Software"), to deal in the Software without restriction, including
+# without limitation the rights to use, copy, modify, merge, publish,
+# distribute, sublicense, and/or sell copies of the Software, and to
+# permit persons to whom the Software is furnished to do so, subject to
+# the following conditions:
+#
+# The above copyright notice and this permission notice shall be
+# included in all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+# LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+# OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+# WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+#
+
+module RightScale
+
+  # Authorized user for the Managed Login feature
+  class LoginUser
+
+    include Serializable
+
+    attr_accessor :uuid, :username, :public_key, :public_keys, :common_name, :superuser, :expires_at
+
+    # Initialize fields from given arguments
+    def initialize(*args)
+      @uuid        = args[0]
+      @username    = args[1]
+      @public_key  = args[2]
+      @common_name = args[3] || ''
+      @superuser   = args[4] || false
+      @expires_at  = Time.at(args[5]) if args[5] && (args[5] != 0) # nil -> 0 because of expires_at.to_i below
+      @public_keys = args[6]
+
+      # we now expect an array of public_keys to be passed while supporting the
+      # singular public_key as a legacy member. when serialized back from a
+      # legacy LoginUser record, the singular value may be set while the plural
+      # is nil.
+      if @public_keys
+        raise ArgumentError, "Expected public_keys (seventh argument) to be an array" unless @public_keys.is_a?(Array)
+        @public_key = @public_keys.first
+      else
+        raise ArgumentError, "Expected public_key (third argument) to be a string" unless @public_key.is_a?(String)
+        @public_keys = [@public_key]
+      end
+    end
+
+    # Array of serialized fields given to constructor
+    def serialized_members
+      [ @uuid, @username, @public_key, @common_name, @superuser, @expires_at.to_i, @public_keys ]
+    end
+
+  end
+end

data/lib/right_agent/core_payload_types/planned_volume.rb

@@ -0,0 +1,94 @@
+#
+# Copyright (c) 2011 RightScale Inc
+#
+# Permission is hereby granted, free of charge, to any person obtaining
+# a copy of this software and associated documentation files (the
+# "Software"), to deal in the Software without restriction, including
+# without limitation the rights to use, copy, modify, merge, publish,
+# distribute, sublicense, and/or sell copies of the Software, and to
+# permit persons to whom the Software is furnished to do so, subject to
+# the following conditions:
+#
+# The above copyright notice and this permission notice shall be
+# included in all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+# LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+# OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+# WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+#
+
+module RightScale
+
+  # Represents any details of a planned volume which are needed by the instance
+  # for volume management purposes. A planned volume is a blank, snapshotted or
+  # existing volume which is associated with a server at launch time. It could
+  # also represent a volume which is planned dynamically by the instance itself
+  # as part of a script and which is then guaranteed to be properly managed if
+  # the instance is stopped/started.
+  class PlannedVolume
+
+    include Serializable
+
+    # (String) cloud-specific unique identifier for volume (relative to account
+    # or global)
+    attr_accessor :volume_id
+
+    # (String) cloud-agnostic current known status of the volume. must be nil or
+    # else one of the following:
+    #  'pending', 'attached', 'attaching', 'detached', 'detaching', 'deleted'
+    attr_accessor :volume_status
+
+    # (String) cloud-specific device name for volume (relative to instance)
+    attr_accessor :device_name
+
+    # (Array of String) instance platform-specific mount point(s) for the
+    # physical or virtual disk (which could have multiple partitions) associated
+    # with the planned volume. not all partitions are formatted and/or have a
+    # file system which is compatible with the instance's platform so only valid
+    # partitions are associated with mount points.
+    attr_accessor :mount_points
+
+    def initialize(*args)
+      @volume_id     = args[0] if args.size > 0
+      @device_name   = args[1] if args.size > 1
+      @mount_points  = args[2] if args.size > 2
+      @volume_status = args[3] if args.size > 3
+    end
+
+    # Array of serialized fields given to constructor
+    def serialized_members
+      [ @volume_id, @device_name, @mount_points, @volume_status ]
+    end
+
+    # Determines if this object is valid.
+    #
+    # === Return
+    # result(Boolean):: true if this object is valid, false if required fields are nil or empty
+    def is_valid?
+      result = false == is_blank?(@volume_id) &&
+               false == is_blank?(@device_name) &&
+               false == is_blank?(@volume_status) &&
+               false == is_blank?(@mount_points) &&
+               nil == @mount_points.find { |mount_point| is_blank?(mount_point) }
+      return result
+    end
+
+    private
+
+    # Determines if the given value is nil or empty.
+    #
+    # === Parameters
+    # value(Object):: any value
+    #
+    # === Return
+    # true if value is nil or empty
+    def is_blank?(value)
+      value.nil? || value.empty?
+    end
+
+  end
+end

data/lib/right_agent/core_payload_types/recipe_instantiation.rb

@@ -0,0 +1,60 @@
+#
+# Copyright (c) 2009-2011 RightScale Inc
+#
+# Permission is hereby granted, free of charge, to any person obtaining
+# a copy of this software and associated documentation files (the
+# "Software"), to deal in the Software without restriction, including
+# without limitation the rights to use, copy, modify, merge, publish,
+# distribute, sublicense, and/or sell copies of the Software, and to
+# permit persons to whom the Software is furnished to do so, subject to
+# the following conditions:
+#
+# The above copyright notice and this permission notice shall be
+# included in all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+# LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+# OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+# WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+#
+
+module RightScale
+
+  # Recipe with json
+  class RecipeInstantiation
+
+    include Serializable
+
+    # (String) Recipe nickname
+    attr_accessor :nickname
+
+    # (Hash) Recipe override attributes (JSON string for RightLink v5.0)
+    attr_accessor :attributes
+
+    # (Integer) Recipe id
+    attr_accessor :id
+
+    # (Boolean) Whether recipe inputs are ready
+    attr_accessor :ready
+
+    # (Array of SecureDocumentLocation) attributes that must be resolved by the instance
+    attr_accessor :external_inputs
+
+    def initialize(*args)
+      @nickname        = args[0] if args.size > 0
+      @attributes      = args[1] if args.size > 1
+      @id              = args[2] if args.size > 2
+      @ready           = args[3] if args.size > 3
+      @external_inputs = args[4] if args.size > 4
+    end
+
+    # Array of serialized fields given to constructor
+    def serialized_members
+      [ @nickname, @attributes, @id, @ready, @external_inputs ]
+    end
+
+  end
+end

data/lib/right_agent/core_payload_types/repositories_bundle.rb

@@ -0,0 +1,50 @@
+#
+# Copyright (c) 2009-2011 RightScale Inc
+#
+# Permission is hereby granted, free of charge, to any person obtaining
+# a copy of this software and associated documentation files (the
+# "Software"), to deal in the Software without restriction, including
+# without limitation the rights to use, copy, modify, merge, publish,
+# distribute, sublicense, and/or sell copies of the Software, and to
+# permit persons to whom the Software is furnished to do so, subject to
+# the following conditions:
+#
+# The above copyright notice and this permission notice shall be
+# included in all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+# LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+# OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+# WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+#
+
+module RightScale
+  
+  # Software repositories together with audit id
+  # The instance agent can use the audit created by the core agent to audit messages
+  # associated with the processing of the software repositories
+  class RepositoriesBundle
+
+    include Serializable
+
+    # (Array) Repositories instantiations
+    attr_accessor :repositories
+
+    # (Integer) ID of corresponding audit entry
+    attr_accessor :audit_id
+
+    def initialize(*args)
+      @repositories = args[0]
+      @audit_id     = args[1]
+    end
+    
+    # Array of serialized fields given to constructor
+    def serialized_members
+      [ @repositories, @audit_id ]
+    end
+
+  end
+end

data/lib/right_agent/core_payload_types/right_script_attachment.rb

@@ -0,0 +1,95 @@
+#
+# Copyright (c) 2009-2011 RightScale Inc
+#
+# Permission is hereby granted, free of charge, to any person obtaining
+# a copy of this software and associated documentation files (the
+# "Software"), to deal in the Software without restriction, including
+# without limitation the rights to use, copy, modify, merge, publish,
+# distribute, sublicense, and/or sell copies of the Software, and to
+# permit persons to whom the Software is furnished to do so, subject to
+# the following conditions:
+#
+# The above copyright notice and this permission notice shall be
+# included in all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+# LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+# OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+# WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+#
+
+require 'digest/sha1'
+require 'uri'
+
+module RightScale
+
+  # RightScript attachment
+  class RightScriptAttachment
+
+    include Serializable
+
+    # (String) S3 attachment URL
+    attr_accessor :url
+
+    # (String) Attachment file name
+    attr_accessor :file_name
+
+    # (String) Cache identifier
+    attr_accessor :etag
+
+    # (Binary string) Repose token for attachment
+    attr_accessor :token
+
+    # (String) Content digest
+    attr_accessor :digest
+
+    def initialize(*args)
+      @url       = args[0] if args.size > 0
+      @file_name = args[1] if args.size > 1
+      @etag      = args[2] if args.size > 2
+      @token     = args[3] if args.size > 3
+      @digest    = args[4] if args.size > 4
+    end
+
+    # Array of serialized fields given to constructor
+    def serialized_members
+      [ @url, @file_name, @etag, @token, @digest ]
+    end
+
+    # Return the Repose hash for this attachment.
+    def to_hash
+      RightScriptAttachment.hash_for(@url, @file_name, @etag)
+    end
+
+    # Fill out the session cookie appropriately for this attachment.
+    def fill_out(session)
+      session['scope'] = "attachments"
+      if @digest
+        session['resource'] = @digest
+      else
+        session['resource'] = to_hash
+        session['url'] = @url
+        session['etag'] = @etag
+      end
+      @token = session.to_s
+    end
+
+    # Return the Repose hash for the given URL/filename/ETag triple.
+    #
+    # === Parameters
+    # url(String):: URL to request
+    # filename(String):: local filename
+    # etag(String):: expected ETag
+    #
+    # === Return
+    # String:: hashed token suitable for communicating to Repose
+    def self.hash_for(url, filename, etag)
+      uri = URI::parse(url).dup
+      uri.query = nil
+      Digest::SHA1.hexdigest("#{uri}\000#{etag}")
+    end
+  end
+end

data/lib/right_agent/core_payload_types/right_script_instantiation.rb

@@ -0,0 +1,73 @@
+#
+# Copyright (c) 2009-2011 RightScale Inc
+#
+# Permission is hereby granted, free of charge, to any person obtaining
+# a copy of this software and associated documentation files (the
+# "Software"), to deal in the Software without restriction, including
+# without limitation the rights to use, copy, modify, merge, publish,
+# distribute, sublicense, and/or sell copies of the Software, and to
+# permit persons to whom the Software is furnished to do so, subject to
+# the following conditions:
+#
+# The above copyright notice and this permission notice shall be
+# included in all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+# LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+# OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+# WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+#
+
+module RightScale
+  
+  # RightScript with parameters and attachments
+  class RightScriptInstantiation
+
+    include Serializable  
+
+    # (String) RightScript name
+    attr_accessor :nickname
+
+    # (String) RightScript source
+    attr_accessor :source
+
+    # (Hash) RightScript parameters
+    # Hash of parameters names with associated value
+    attr_accessor :parameters  
+    
+    # (Array) RightScript attachments URLs, array of RightScriptAttachment
+    attr_accessor :attachments
+    
+    # (Array) RightScripts required packages
+    attr_accessor :packages
+
+    # (Integer) RightScript id
+    attr_accessor :id
+
+    # (Boolean) Whether script inputs are ready
+    attr_accessor :ready
+
+    # (Array of SecureDocumentLocation) attributes that must be resolved by the instance
+    attr_accessor :external_inputs
+
+    def initialize(*args)
+      @nickname        = args[0] if args.size > 0
+      @source          = args[1] if args.size > 1
+      @parameters      = args[2] if args.size > 2
+      @attachments     = args[3] if args.size > 3
+      @packages        = args[4] if args.size > 4
+      @id              = args[5] if args.size > 5
+      @ready           = args[6] if args.size > 6
+      @external_inputs = args[7] if args.size > 7
+    end
+    
+    # Array of serialized fields given to constructor
+    def serialized_members
+      [ @nickname, @source, @parameters, @attachments, @packages, @id, @ready, @external_inputs ]
+    end
+    
+  end
+end