oca 3.0.1

data/lib/OpenNebula/Acl.rb

@@ -0,0 +1,266 @@
+# -------------------------------------------------------------------------- #
+# Copyright 2002-2011, OpenNebula Project Leads (OpenNebula.org)             #
+#                                                                            #
+# 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 OpenNebula
+    # Abstract rules of the type USER RESOURCE RIGHTS
+    # which are:
+    #     USER      -> #<num>
+    #                  @<num>
+    #                  ALL
+    #     RESOURCE  -> + separated list and "/{#,@}<num>|ALL"
+    #                  VM,
+    #                  HOST
+    #                  NET
+    #                  IMAGE
+    #                  USER
+    #                  TEMPLATE
+    #                  GROUP
+    #                  ACL
+    #     RIGHTS    -> + separated list
+    #                  CREATE
+    #                  DELETE
+    #                  USE
+    #                  MANAGE
+    #                  INFO
+    #                  INFO_POOL
+    #                  INFO_POOL_MINE
+    #                  INSTANTIATE
+    #                  CHOWN
+    #                  DEPLOY
+    class Acl < PoolElement
+
+        USERS = {
+            "UID"           => 0x100000000,
+            "GID"           => 0x200000000,
+            "ALL"           => 0x400000000
+        }
+
+        RESOURCES =
+        {
+            "VM"            => 0x1000000000,
+            "HOST"          => 0x2000000000,
+            "NET"           => 0x4000000000,
+            "IMAGE"         => 0x8000000000,
+            "USER"          => 0x10000000000,
+            "TEMPLATE"      => 0x20000000000,
+            "GROUP"         => 0x40000000000
+        }
+
+        RIGHTS =
+        {
+            "CREATE"        => 0x1,  # Auth. to create an object
+            "DELETE"        => 0x2,  # Auth. to delete an object
+            "USE"           => 0x4,  # Auth. to use an object
+            "MANAGE"        => 0x8,  # Auth. to manage an object
+            "INFO"          => 0x10, # Auth. to view an object
+            "INFO_POOL"     => 0x20, # Auth. to view any object in the pool
+            "INFO_POOL_MINE"=> 0x40, # Auth. to view user and/or group objects
+            "INSTANTIATE"   => 0x80, # Auth. to instantiate a VM from a TEMPLATE
+            "CHOWN"         => 0x100,# Auth. to change ownership of an object
+            "DEPLOY"        => 0x200 # Auth. to deploy a VM in a Host
+        }
+
+        # Constructor
+        #
+        # @param xml [String] must be an xml built with {#build_xml}
+        # @param client [Client] represents an XML-RPC connection
+        def initialize(xml, client)
+            super(xml,client)
+        end
+
+        # Creates an empty XML representation. It contains the id, if it is
+        # specified.
+        #
+        # @param pe_id [Integer] rule ID
+        # @param client [Client] represents an XML-RPC connection
+        #
+        # @return [String] an empty XML representation
+        def self.build_xml(pe_id=nil)
+            if pe_id
+                acl_xml = "<ACL><ID>#{pe_id}</ID></ACL>"
+            else
+                acl_xml = "<ACL></ACL>"
+            end
+
+            XMLElement.build_xml(acl_xml,'ACL')
+        end
+
+        # Creates a new ACL rule.
+        #
+        # @param user [String]
+        #   A string containing a hex number, e.g. 0x100000001
+        # @param resource [String]
+        #   A string containing a hex number, e.g. 0x2100000001
+        # @param rights [String]
+        #   A string containing a hex number, e.g. 0x10
+        #
+        # @return [nil, OpenNebula::Error] nil in case of success, Error
+        #   otherwise
+        def allocate(user, resource, rights)
+            return super( AclPool::ACL_POOL_METHODS[:addrule],
+                          user,
+                          resource,
+                          rights )
+        end
+
+        # Deletes the Acl rule
+        #
+        # @return [nil, OpenNebula::Error] nil in case of success, Error
+        #   otherwise
+        def delete()
+            super(AclPool::ACL_POOL_METHODS[:delrule])
+        end
+
+        # Does nothing, individual ACL rules info can't be retrieved from
+        # OpenNebula
+        #
+        # @return [nil] nil
+        def info()
+            return nil
+        end
+
+        # Parses a rule string, e.g. "#5 HOST+VM/@12 INFO+CREATE+DELETE"
+        #
+        # @param rule_str [String] an ACL rule in string format
+        #
+        # @return [Array] an Array containing 3 strings (hex 64b numbers),
+        # or OpenNebula::Error objects
+        def self.parse_rule(rule_str)
+            ret = Array.new
+
+            rule_str = rule_str.split(" ")
+
+            if rule_str.length != 3
+                return OpenNebula::Error.new(
+                    "String needs three components: User, Resource, Rights")
+            end
+
+            ret << parse_users(rule_str[0])
+            ret << parse_resources(rule_str[1])
+            ret << parse_rights(rule_str[2])
+
+            errors=ret.map do |arg|
+                if OpenNebula.is_error?(arg)
+                    arg.message
+                else
+                    nil
+                end
+            end
+
+            errors.compact!
+
+            if errors.length>0
+                return OpenNebula::Error.new(errors.join(', '))
+            end
+
+            return ret
+        end
+
+private
+
+        # Converts a string in the form [#<id>, @<id>, *] to a hex. number
+        #
+        # @param users [String] Users component string
+        #
+        # @return [String] A string containing a hex number
+        def self.parse_users(users)
+           begin
+               return calculate_ids(users).to_i.to_s(16)
+           rescue Exception  => e
+               return OpenNebula::Error.new(e.message)
+           end
+        end
+
+        # Converts a resources string to a hex. number
+        #
+        # @param resources [String] Resources component string
+        #
+        # @return [String] A string containing a hex number
+        def self.parse_resources(resources)
+            begin
+                ret = 0
+                resources = resources.split("/")
+
+                if resources.size != 2
+                    raise "Resource '#{resources}' malformed"
+                end
+
+                resources[0].split("+").each{ |resource|
+                    if !RESOURCES[resource.upcase]
+                        raise "Resource '#{resource}' does not exist"
+                    end
+                    ret += RESOURCES[resource.upcase]
+                }
+
+                ret += calculate_ids(resources[1])
+
+                return ret.to_i.to_s(16)
+            rescue Exception  => e
+                return OpenNebula::Error.new(e.message)
+            end
+        end
+
+        # Converts a rights string to a hex. number
+        #
+        # @param rights [String] Rights component string
+        #
+        # @return [String] A string containing a hex number
+        def self.parse_rights(rights)
+            begin
+                ret = 0
+                rights = rights.split("+")
+
+                rights.each{ |right|
+                    raise "Right '#{right}' does not exist" if !RIGHTS[right.upcase]
+
+                    ret += RIGHTS[right.upcase]
+                }
+
+                return ret.to_i.to_s(16)
+            rescue Exception  => e
+                return OpenNebula::Error.new(e.message)
+            end
+        end
+
+        # Calculates the numeric value for a String containing an individual
+        # (#<id>), group (@<id>) or all (*) ID component
+        #
+        # @param id_str [String] Rule Id string
+        #
+        # @return [Integer] the numeric value for the given id_str
+        def self.calculate_ids(id_str)
+            raise "ID string '#{id_str}' malformed" if
+                !id_str.match(/^([\#@]\d+|\*)$/)
+
+            value = 0
+
+            case id_str[0..0]
+                when "#"
+                    value = USERS["UID"]
+                    users_value = id_str[1..-1].to_i + value
+
+                when "@"
+                    value = USERS["GID"]
+                    users_value = id_str[1..-1].to_i + value
+
+                when "*"
+                    users_value = USERS["ALL"]
+            end
+
+            return users_value
+        end
+    end
+end

data/lib/OpenNebula/AclPool.rb

@@ -0,0 +1,52 @@
+# -------------------------------------------------------------------------- #
+# Copyright 2002-2011, OpenNebula Project Leads (OpenNebula.org)             #
+#                                                                            #
+# 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.                                             #
+#--------------------------------------------------------------------------- #
+
+require 'OpenNebula/Pool'
+
+module OpenNebula
+    class AclPool < Pool
+
+        #######################################################################
+        # Constants and Class Methods
+        #######################################################################
+        ACL_POOL_METHODS = {
+            :info       => "acl.info",
+            :addrule    => "acl.addrule",
+            :delrule    => "acl.delrule"
+        }
+
+        #######################################################################
+        # Class constructor
+        #######################################################################
+        def initialize(client)
+            super('ACL_POOL','ACL',client)
+        end
+
+        def factory(element_xml)
+            OpenNebula::Acl.new(element_xml, @client)
+        end
+
+        #######################################################################
+        # XML-RPC Methods
+        #######################################################################
+
+        # Retrieves the ACL Pool
+        def info()
+        # Retrieves all the Acls in the pool.
+            super(ACL_POOL_METHODS[:info])
+        end
+    end
+end

data/lib/OpenNebula/Group.rb

@@ -0,0 +1,148 @@
+# -------------------------------------------------------------------------- #
+# Copyright 2002-2011, OpenNebula Project Leads (OpenNebula.org)             #
+#                                                                            #
+# 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.                                             #
+#--------------------------------------------------------------------------- #
+
+require 'OpenNebula/Pool'
+
+module OpenNebula
+    class Group < PoolElement
+        # ---------------------------------------------------------------------
+        # Constants and Class Methods
+        # ---------------------------------------------------------------------
+        GROUP_METHODS = {
+            :info       => "group.info",
+            :allocate   => "group.allocate",
+            :delete     => "group.delete"
+        }
+
+        # Flag for requesting connected user's group info
+        SELF = -1
+
+        #Default location for group ACL's
+        if ENV['ONE_LOCATION']
+            GROUP_DEFAULT = ENV['ONE_LOCATION'] + "/etc/group.default"
+        else
+            GROUP_DEFAULT = "/etc/one/group.default"
+        end
+
+        # Creates a Group description with just its identifier
+        # this method should be used to create plain Group objects.
+        # +id+ the id of the user
+        #
+        # Example:
+        #   group = Group.new(Group.build_xml(3),rpc_client)
+        #
+        def Group.build_xml(pe_id=nil)
+            if pe_id
+                group_xml = "<GROUP><ID>#{pe_id}</ID></GROUP>"
+            else
+                group_xml = "<GROUP></GROUP>"
+            end
+
+            XMLElement.build_xml(group_xml,'GROUP')
+        end
+
+        # ---------------------------------------------------------------------
+        # Class constructor
+        # ---------------------------------------------------------------------
+        def initialize(xml, client)
+            super(xml,client)
+
+            @client = client
+        end
+        
+        # --------------------------------------------------------------------
+        # Group utils
+        # --------------------------------------------------------------------
+
+        # Creates ACLs for the group. The ACL rules are described in a file
+        def create_acls(filename = GROUP_DEFAULT)
+            if !File.readable?(filename)
+                return -1, "Can not read deafult ACL file for group"
+            end
+
+            msg = String.new
+            
+            File.open(filename).each_line{ |l|
+                next if l.match(/^#/)
+
+                rule  = "@#{@pe_id} #{l}"
+                parse = OpenNebula::Acl.parse_rule(rule)
+
+                if OpenNebula.is_error?(parse)
+                    return -1, "Error parsing rule #{rule}: #{parse.message}"
+                end
+
+                xml = OpenNebula::Acl.build_xml
+                acl = OpenNebula::Acl.new(xml, @client)
+
+                rc = acl.allocate(*parse)
+
+                if OpenNebula.is_error?(rc)
+                    return -1, "Error creating rule #{rule}: #{rc.message}"
+                else
+                    msg << "ACL_ID: #{acl.id}\n"
+                end
+            }
+
+            return 0, msg
+        end
+
+        # ---------------------------------------------------------------------
+        # XML-RPC Methods for the Group Object
+        # ---------------------------------------------------------------------
+
+        # Retrieves the information of the given Group.
+        def info()
+            super(GROUP_METHODS[:info], 'GROUP')
+        end
+
+        # Allocates a new Group in OpenNebula
+        #
+        # +groupname+ A string containing the name of the Group.
+        def allocate(groupname)
+            super(GROUP_METHODS[:allocate], groupname)
+        end
+
+        # Deletes the Group
+        def delete()
+            super(GROUP_METHODS[:delete])
+        end
+
+        # ---------------------------------------------------------------------
+        # Helpers to get information
+        # ---------------------------------------------------------------------
+
+        # Returns whether or not the user with id 'uid' is part of this group
+        def contains(uid)
+            # This doesn't work in ruby 1.8.5
+#            return self["USERS/ID[.=#{uid}]"] != nil
+
+            id_array = retrieve_elements('USERS/ID')
+            return id_array != nil && id_array.include?(uid.to_s)
+        end
+
+        # Returns an array with the numeric user ids
+        def user_ids
+            array = Array.new
+
+            self.each("USERS/ID") do |id|
+                array << id.text.to_i
+            end
+
+            return array
+        end
+    end
+end

data/lib/OpenNebula/GroupPool.rb

@@ -0,0 +1,52 @@
+# -------------------------------------------------------------------------- #
+# Copyright 2002-2011, OpenNebula Project Leads (OpenNebula.org)             #
+#                                                                            #
+# 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.                                             #
+#--------------------------------------------------------------------------- #
+
+require 'OpenNebula/Pool'
+
+module OpenNebula
+    class GroupPool < Pool
+        # ---------------------------------------------------------------------
+        # Constants and Class attribute accessors
+        # ---------------------------------------------------------------------
+
+        GROUP_POOL_METHODS = {
+            :info => "grouppool.info"
+        }
+
+        # ---------------------------------------------------------------------
+        # Class constructor & Pool Methods
+        # ---------------------------------------------------------------------
+
+        # +client+ a Client object that represents a XML-RPC connection
+        def initialize(client)
+            super('GROUP_POOL','GROUP',client)
+        end
+
+        # Factory method to create User objects
+        def factory(element_xml)
+            OpenNebula::Group.new(element_xml,@client)
+        end
+
+        # ---------------------------------------------------------------------
+        # XML-RPC Methods for the User Object
+        # ---------------------------------------------------------------------
+
+        # Retrieves all the Groups in the pool.
+        def info()
+            super(GROUP_POOL_METHODS[:info])
+        end
+    end
+end

data/lib/OpenNebula/Host.rb

@@ -0,0 +1,142 @@
+# -------------------------------------------------------------------------- #
+# Copyright 2002-2011, OpenNebula Project Leads (OpenNebula.org)             #
+#                                                                            #
+# 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.                                             #
+#--------------------------------------------------------------------------- #
+
+require 'OpenNebula/Pool'
+
+module OpenNebula
+    class Host < PoolElement
+        #######################################################################
+        # Constants and Class Methods
+        #######################################################################
+        HOST_METHODS = {
+            :info     => "host.info",
+            :allocate => "host.allocate",
+            :delete   => "host.delete",
+            :enable   => "host.enable",
+            :update   => "host.update"
+        }
+
+        HOST_STATES=%w{INIT MONITORING MONITORED ERROR DISABLED}
+
+        SHORT_HOST_STATES={
+            "INIT"          => "on",
+            "MONITORING"    => "on",
+            "MONITORED"     => "on",
+            "ERROR"         => "err",
+            "DISABLED"      => "off"
+        }
+
+        # Creates a Host description with just its identifier
+        # this method should be used to create plain Host objects.
+        # +id+ the id of the host
+        #
+        # Example:
+        #   host = Host.new(Host.build_xml(3),rpc_client)
+        #
+        def Host.build_xml(pe_id=nil)
+            if pe_id
+                host_xml = "<HOST><ID>#{pe_id}</ID></HOST>"
+            else
+                host_xml = "<HOST></HOST>"
+            end
+
+            XMLElement.build_xml(host_xml, 'HOST')
+        end
+
+        #######################################################################
+        # Class constructor
+        #######################################################################
+        def initialize(xml, client)
+            super(xml,client)
+
+            @client = client
+            @pe_id  = self['ID'].to_i if self['ID']
+        end
+
+        #######################################################################
+        # XML-RPC Methods for the Host
+        #######################################################################
+        
+        # Retrieves the information of the given Host.
+        def info()
+            super(HOST_METHODS[:info], 'HOST')
+        end
+
+        # Allocates a new Host in OpenNebula
+        #
+        # +hostname+ A string containing the name of the new Host.
+        #
+        # +im+ A string containing the name of the im_driver
+        #
+        # +vmm+ A string containing the name of the vmm_driver
+        #
+        # +tm+ A string containing the name of the tm_driver
+        def allocate(hostname,im,vmm,tm)
+            super(HOST_METHODS[:allocate],hostname,im,vmm,tm)
+        end
+
+        # Deletes the Host
+        def delete()
+            super(HOST_METHODS[:delete])
+        end
+
+        # Enables the Host
+        def enable()
+            set_enabled(true)
+        end
+
+        # Disables the Host
+        def disable()
+            set_enabled(false)
+        end
+
+        # Replaces the template contents
+        #
+        # +new_template+ New template contents
+        def update(new_template)
+            super(HOST_METHODS[:update], new_template)
+        end
+
+        #######################################################################
+        # Helpers to get Host information
+        #######################################################################
+
+        # Returns the state of the Host (numeric value)
+        def state
+            self['STATE'].to_i
+        end
+
+        # Returns the state of the Host (string value)
+        def state_str
+            HOST_STATES[state]
+        end
+
+        # Returns the state of the Host (string value)
+        def short_state_str
+            SHORT_HOST_STATES[state_str]
+        end
+
+    private
+        def set_enabled(enabled)
+            return Error.new('ID not defined') if !@pe_id
+
+            rc = @client.call(HOST_METHODS[:enable], @pe_id, enabled)
+            rc = nil if !OpenNebula.is_error?(rc)
+
+            return rc
+        end
+    end
+end