Class: OpenNebula::Acl

Inherits:
PoolElement show all
Defined in:
lib/OpenNebula/Acl.rb

Overview

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

Constant Summary collapse

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
}

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from PoolElement

#id, #name, new_with_id, #to_str

Methods inherited from XMLElement

#[], #attr, #each, #each_xpath, #has_elements?, #initialize_xml, #name, #retrieve_elements, #template_like_str, #template_str, #text, #to_hash, #to_xml

Constructor Details

#initialize(xml, client) ⇒ Acl

Constructor

Parameters:

  • xml (String) —

    must be an xml built with #build_xml

  • client (Client) —

    represents an XML-RPC connection



80
81
82
 
# File 'lib/OpenNebula/Acl.rb', line 80

def initialize(xml, client)
    super(xml,client)
end

Class Method Details

.build_xml(pe_id = nil) ⇒ String

Creates an empty XML representation. It contains the id, if it is specified.

Parameters:

  • pe_id (Integer) (defaults to: nil) —

    rule ID

  • client (Client) —

    represents an XML-RPC connection

Returns:

  • (String) —

    an empty XML representation



91
92
93
94
95
96
97
98
99
 
# File 'lib/OpenNebula/Acl.rb', line 91

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

.parse_rule(rule_str) ⇒ Array

Parses a rule string, e.g. “#5 HOST+VM/@12 INFO+CREATE+DELETE”

or OpenNebula::Error objects

Parameters:

  • rule_str (String) —

    an ACL rule in string format

Returns:

  • (Array) —

    an Array containing 3 strings (hex 64b numbers),



141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
 
# File 'lib/OpenNebula/Acl.rb', line 141

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

Instance Method Details

#allocate(user, resource, rights) ⇒ nil, OpenNebula::Error

Creates a new ACL rule.

Parameters:

  • user (String) —

    A string containing a hex number, e.g. 0x100000001

  • resource (String) —

    A string containing a hex number, e.g. 0x2100000001

  • rights (String) —

    A string containing a hex number, e.g. 0x10

Returns:



112
113
114
115
116
117
 
# File 'lib/OpenNebula/Acl.rb', line 112

def allocate(user, resource, rights)
    return super( AclPool::ACL_POOL_METHODS[:addrule],
                  user,
                  resource,
                  rights )
end

#delete ⇒ nil, OpenNebula::Error

Deletes the Acl rule

Returns:



123
124
125
 
# File 'lib/OpenNebula/Acl.rb', line 123

def delete()
    super(AclPool::ACL_POOL_METHODS[:delrule])
end

#info ⇒ nil

Does nothing, individual ACL rules info can’t be retrieved from OpenNebula

Returns:

  • (nil) —

    nil



131
132
133
 
# File 'lib/OpenNebula/Acl.rb', line 131

def info()
    return nil
end