right_agent 2.0.7-x86-mingw32

data/lib/right_agent/core_payload_types/dev_repository.rb

@@ -0,0 +1,76 @@
+#--
+# Copyright: Copyright (c) 2010-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
+  # Sequence of cookbooks to be checked out on the instance.
+  class DevRepository
+    include Serializable
+
+    # (Symbol) Type of repository: one of :git, :svn, :download or :local
+    # * :git denotes a 'git' repository that should be retrieved via 'git clone'
+    # * :svn denotes a 'svn' repository that should be retrieved via 'svn checkout'
+    # * :download denotes a tar ball that should be retrieved via HTTP GET (HTTPS if uri starts with https://)
+    # * :local denotes cookbook that is already local and doesn't need to be retrieved
+    attr_accessor :repo_type
+    # (String) URL to repository (e.g. git://github.com/opscode/chef-repo.git)
+    attr_accessor :url
+    # (String) git commit or svn branch that should be used to retrieve repository
+    # Optional, use 'master' for git and 'trunk' for svn if tag is nil.
+    # Not used for raw repositories.
+    attr_accessor :tag
+    # (Array) Path to cookbooks inside repostory
+    # Optional (use location of repository as cookbook path if nil)
+    attr_accessor :cookbooks_path
+    # (String) Private SSH key used to retrieve git repositories
+    # Optional, not used for svn and raw repositories.
+    attr_accessor :ssh_key
+    # (String) Username used to retrieve svn and raw repositories
+    # Optional, not used for git repositories.
+    attr_accessor :username
+    # (String) Password used to retrieve svn and raw repositories
+    # Optional, not used for git repositories.
+    attr_accessor :password
+    # (String) hash of the CookbookSequence that corresponds to the repo
+    attr_accessor :repo_sha
+    # (Array) List of cookbook <name, position> pairs
+    attr_accessor :positions
+
+    # Initialize fields from given arguments
+    def initialize(*args)
+      @repo_type              = args[0]
+      @url                    = args[1] if args.size > 1
+      @tag                    = args[2] if args.size > 2
+      @cookbooks_path         = args[3] if args.size > 3
+      @ssh_key                = args[4] if args.size > 4
+      @username               = args[5] if args.size > 5
+      @password               = args[6] if args.size > 6
+      @repo_sha               = args[7] if args.size > 7
+      @positions              = args[8] if args.size > 8
+    end
+
+    # Array of serialized fields given to constructor
+    def serialized_members
+      [ @repo_type, @url, @tag, @cookbooks_path, @ssh_key, @username, @password, @repo_sha, @positions ]
+    end
+  end
+end

data/lib/right_agent/core_payload_types/event_categories.rb

@@ -0,0 +1,38 @@
+#
+# 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 event categories used by auditor
+  # For now only support generic and security categories
+  class EventCategories
+
+    NONE                  = 'None'.freeze         # No notification
+    CATEGORY_NOTIFICATION = 'Notification'.freeze # Generic notification
+    CATEGORY_SECURITY     = 'Security'.freeze     # Security topic notification
+    CATEGORY_ERROR        = 'Error'.freeze        # Error event
+
+    CATEGORIES            = [ NONE, CATEGORY_NOTIFICATION, CATEGORY_SECURITY, CATEGORY_ERROR ]
+
+  end
+end

data/lib/right_agent/core_payload_types/executable_bundle.rb

@@ -0,0 +1,130 @@
+#
+# 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
+
+  # Boot, operation or decommission executable bundle, includes:
+  # * RightScripts with associated packages, parameters and attachments
+  # * Recipes with associated JSON
+  # * Cookbook repositories with associated attributes
+  # * Audit id
+  # Recipes and RightScripts instantiations are interspersed and ordered into one collection
+  # The instance agent can use the audit created by the core agent to audit messages
+  # associated with the processing of the software repositories
+  class ExecutableBundle
+
+    include Serializable
+
+    # (Array) Collection of RightScripts and chef recipes instantiations
+    attr_accessor :executables
+
+    # (Array) Chef cookbook repositories
+    attr_accessor :cookbook_repositories
+
+    # (Integer) ID of corresponding audit entry
+    attr_accessor :audit_id
+
+    # (Boolean) Whether a full or partial converge should be done
+    # Note: Obsolete as of r_s_version 8, kept for backwards compatibility
+    attr_accessor :full_converge
+
+    # (Array) Chef cookbooks
+    attr_accessor :cookbooks
+
+    # (String) Repose server to use
+    attr_accessor :repose_servers
+
+    # (Hash):: collection of repos to be checked out on the instance
+    #   :key (String):: the hash id (SHA) of the repository
+    #  :value (Hash):: repo and cookbook detail
+    #    :repo (Hash):: repo details
+    #     {
+    #       <Symbol> Type of repository: one of :git, :svn, :download or :local
+    #         * :git denotes a 'git' repository that should be retrieved via 'git clone'
+    #         * :svn denotes a 'svn' repository that should be retrieved via 'svn checkout'
+    #         * :download denotes a tar ball that should be retrieved via HTTP GET (HTTPS if uri starts with https://)
+    #         * :local denotes cookbook that is already local and doesn't need to be retrieved
+    #       :repo_type => <Symbol>,
+    #       <String> URL to repository (e.g. git://github.com/opscode/chef-repo.git)
+    #       :url => <String>,
+    #       <String> git commit or svn branch that should be used to retrieve repository
+    #         Optional, use 'master' for git and 'trunk' for svn if tag is nil.
+    #         Not used for raw repositories.
+    #       :tag => <String>,
+    #       <Array> Path to cookbooks inside repostory
+    #         Optional (use location of repository as cookbook path if nil)
+    #       :cookbooks_path => <Array>,
+    #       <String> Private SSH key used to retrieve git repositories
+    #         Optional, not used for svn and raw repositories.
+    #       :ssh_key => <String>,
+    #       <String> Username used to retrieve svn and raw repositories
+    #         Optional, not used for git repositories.
+    #       :username => <String>,
+    #       <String> Password used to retrieve svn and raw repositories
+    #         Optional, not used for git repositories.
+    #       :password => <String>
+    #     }
+    #    :positions (Array):: List of CookbookPositions to be developed.  Represents the subset of cookbooks identified as the "dev cookbooks"
+    attr_accessor :dev_cookbooks
+    
+    # (RunlistPolicy) The RightLink policy this bundle belongs to
+    attr_accessor :runlist_policy
+
+    # (String) The secret for any instance of the server that generated this bundle.
+    attr_accessor :server_secret
+
+    def initialize(*args)
+      @executables           = args[0]
+      @cookbook_repositories = args[1] if args.size > 1
+      @audit_id              = args[2] if args.size > 2
+      @full_converge         = args[3] if args.size > 3
+      @cookbooks             = args[4] if args.size > 4
+      @repose_servers        = args[5] if args.size > 5
+      @dev_cookbooks         = args[6] if args.size > 6
+      @runlist_policy        = args[7] if args.size > 7
+      @server_secret         = args[8] if args.size > 8
+    end
+
+    # Array of serialized fields given to constructor
+    def serialized_members
+      [ @executables,
+        @cookbook_repositories,
+        @audit_id,
+        @full_converge,
+        @cookbooks,
+        @repose_servers,
+        @dev_cookbooks,
+        @runlist_policy,
+        @server_secret ]
+    end
+
+    # Human readable representation
+    #
+    # === Return
+    # desc(String):: Auditable description
+    def to_s
+      desc = @executables.collect { |e| e.title }.join(', ') if @executables
+      desc ||= 'empty bundle'
+    end
+  end
+end

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,79 @@
+#
+# 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 'net/ssh'
+
+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, :profile_data, :public_key_fingerprints
+
+    # 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]
+      @profile_data = args[7]
+      @public_key_fingerprints = args[8]
+
+      # 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
+
+      # The number of fingerprints must match the number of public keys
+      if @public_key_fingerprints && @public_key_fingerprints.size != @public_keys.size
+        raise ArgumentError, "Expected public_keys (seventh argument) array length (#{@public_keys.size}) is not " +
+                             "the same as the public_key_fingerprints (eighth argument) (#{@public_key_fingerprints.size})"
+      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, @profile_data,
+        @public_key_fingerprints ]
+    end
+
+    # Create fingerprint for public key
+    def self.fingerprint(public_key)
+      Digest::SHA1.hexdigest(::Net::SSH::KeyFactory.load_data_public_key(public_key).to_der)
+    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