opennebula 3.9.80.beta

data/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   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.

data/NOTICE

@@ -0,0 +1,47 @@
+OpenNebula Open Source Project
+--------------------------------------------------------------------------------
+Copyright 2002-2013, OpenNebula Project (OpenNebula.org), C12G Labs
+--------------------------------------------------------------------------------
+
+You can find  more information about the project, release notes and
+documentation at www.OpenNebula.org
+
+AUTHORS
+
+- Ruben Santiago Montero (rsmontero@opennebula.org)
+- Ignacio Martin Llorente (imllorente@opennebula.org)
+
+ACKNOWLEDGEMENTS
+
+The following people have contributed to the development of the technology
+- Javier Fontan Muiños (jfontan@opennebula.org)
+- Constantino Vazquez Blanco (tinova@opennebula.org)
+- Jaime Melis Bayo (jmelis@opennebula.org)
+- Carlos Martin Sanchez (cmartin@opennebula.org)
+- Daniel Molina Aranda (dmolina@opennebula.org)
+- Hector Sanjuan Redondo (hsanjuan@opennebula.org)
+
+OpenNebula Project also acknowledges the contributions of C12G Labs developers.
+
+LICENSE
+
+OpenNebula is licensed under the Apache License, Version 2.0 (the
+"License"); you may not use this software 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 Apache License.
+
+THIRD-PARTY SOFTWARE
+
+OpenNebula distribution includes third-party software under fully compatible
+open-source licenses. See the following directories and the NOTICE files
+they contain for more information:
+
+- src/sunstone/public/vendor
+- src/oca/java/lib

data/lib/opennebula.rb

@@ -0,0 +1,58 @@
+# -------------------------------------------------------------------------- #
+# Copyright 2002-2013, OpenNebula Project (OpenNebula.org), C12G Labs        #
+#                                                                            #
+# 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.                                             #
+#--------------------------------------------------------------------------- #
+
+
+begin # require 'rubygems'
+    require 'rubygems'
+rescue Exception
+end
+
+require 'digest/sha1'
+require 'rexml/document'
+require 'pp'
+
+require 'opennebula/xml_utils'
+require 'opennebula/client'
+require 'opennebula/error'
+require 'opennebula/virtual_machine'
+require 'opennebula/virtual_machine_pool'
+require 'opennebula/virtual_network'
+require 'opennebula/virtual_network_pool'
+require 'opennebula/image'
+require 'opennebula/image_pool'
+require 'opennebula/user'
+require 'opennebula/user_pool'
+require 'opennebula/host'
+require 'opennebula/host_pool'
+require 'opennebula/template'
+require 'opennebula/template_pool'
+require 'opennebula/group'
+require 'opennebula/group_pool'
+require 'opennebula/acl'
+require 'opennebula/acl_pool'
+require 'opennebula/datastore'
+require 'opennebula/datastore_pool'
+require 'opennebula/cluster'
+require 'opennebula/cluster_pool'
+require 'opennebula/document'
+require 'opennebula/document_pool'
+require 'opennebula/system'
+
+module OpenNebula
+
+    # OpenNebula version
+    VERSION = '3.9.80'
+end

data/lib/opennebula/acl.rb

@@ -0,0 +1,266 @@
+# -------------------------------------------------------------------------- #
+# Copyright 2002-2013, OpenNebula Project (OpenNebula.org), C12G Labs        #
+#                                                                            #
+# 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
+    #                  USE
+    #                  MANAGE
+    #                  ADMIN
+    #                  CREATE
+    class Acl < PoolElement
+
+        USERS = {
+            "UID"           => 0x100000000,
+            "GID"           => 0x200000000,
+            "ALL"           => 0x400000000,
+            "CLUSTER"       => 0x800000000
+        }
+
+        RESOURCES =
+        {
+            "VM"            => 0x1000000000,
+            "HOST"          => 0x2000000000,
+            "NET"           => 0x4000000000,
+            "IMAGE"         => 0x8000000000,
+            "USER"          => 0x10000000000,
+            "TEMPLATE"      => 0x20000000000,
+            "GROUP"         => 0x40000000000,
+            "DATASTORE"     => 0x100000000000,
+            "CLUSTER"       => 0x200000000000,
+            "DOCUMENT"      => 0x400000000000
+        }
+
+        RIGHTS =
+        {
+            "USE"           => 0x1,  # Auth. to use an object
+            "MANAGE"        => 0x2,  # Auth. to perform management actions
+            "ADMIN"         => 0x4,  # Auth. to perform administrative actions
+            "CREATE"        => 0x8   # Auth. to create an object
+        }
+
+        # 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
+
+        alias_method :info!, :info
+
+        # 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"]
+
+                when "%"
+                    value = USERS["CLUSTER"]
+                    users_value = id_str[1..-1].to_i + value
+            end
+
+            return users_value
+        end
+    end
+end