Module: Fog::OpenStack

Extended by:
Provider
Defined in:
lib/fog/openstack/core.rb

Defined Under Namespace

Modules: Errors

Class Method Summary (collapse)

Class Method Details

+ (Object) authenticate(options, connection_options = {})



54
55
56
57
58
59
60
61
# File 'lib/fog/openstack/core.rb', line 54

def self.authenticate(options, connection_options = {})
  case options[:openstack_auth_uri].path
  when /v1(\.\d+)?/
    authenticate_v1(options, connection_options)
  else
    authenticate_v2(options, connection_options)
  end
end

+ (Object) authenticate_v1(options, connection_options = {})

legacy v1.0 style auth



64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
# File 'lib/fog/openstack/core.rb', line 64

def self.authenticate_v1(options, connection_options = {})
  uri = options[:openstack_auth_uri]
  connection = Fog::Core::Connection.new(uri.to_s, false, connection_options)
  @openstack_api_key  = options[:openstack_api_key]
  @openstack_username = options[:openstack_username]

  response = connection.request({
    :expects  => [200, 204],
    :headers  => {
      'X-Auth-Key'  => @openstack_api_key,
      'X-Auth-User' => @openstack_username
    },
    :method   => 'GET',
    :path     =>  (uri.path and not uri.path.empty?) ? uri.path : 'v1.0'
  })

  return {
    :token => response.headers['X-Auth-Token'],
    :server_management_url => response.headers['X-Server-Management-Url'] || response.headers['X-Storage-Url'],
    :identity_public_endpoint => response.headers['X-Keystone']
  }
end

+ (Object) authenticate_v2(options, connection_options = {})

Keystone Style Auth



88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
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
# File 'lib/fog/openstack/core.rb', line 88

def self.authenticate_v2(options, connection_options = {})
  uri                   = options[:openstack_auth_uri]
  tenant_name           = options[:openstack_tenant]
  service_type          = options[:openstack_service_type]
  service_name          = options[:openstack_service_name]
  identity_service_type = options[:openstack_identity_service_type]
  endpoint_type         = (options[:openstack_endpoint_type] || 'publicURL').to_s
  openstack_region      = options[:openstack_region]

  body = retrieve_tokens_v2(options, connection_options)
  service = get_service(body, service_type, service_name)

  options[:unscoped_token] = body['access']['token']['id']

  unless service
    unless tenant_name
      response = Fog::Core::Connection.new(
        "#{uri.scheme}://#{uri.host}:#{uri.port}/v2.0/tenants", false, connection_options).request({
        :expects => [200, 204],
        :headers => {'Content-Type' => 'application/json',
                     'Accept' => 'application/json',
                     'X-Auth-Token' => body['access']['token']['id']},
        :method  => 'GET'
      })

      body = Fog::JSON.decode(response.body)
      if body['tenants'].empty?
        raise Fog::Errors::NotFound.new('No Tenant Found')
      else
        options[:openstack_tenant] = body['tenants'].first['name']
      end
    end

    body = retrieve_tokens_v2(options, connection_options)
    service = get_service(body, service_type, service_name)

  end

  service['endpoints'] = service['endpoints'].select do |endpoint|
    endpoint['region'] == openstack_region
  end if openstack_region

  if service['endpoints'].empty?
    raise Fog::Errors::NotFound.new("No endpoints available for region '#{openstack_region}'")
  end if openstack_region

  unless service
    available = body['access']['serviceCatalog'].map { |endpoint|
      endpoint['type']
    }.sort.join ', '

    missing = service_type.join ', '

    message = "Could not find service #{missing}.  Have #{available}"

    raise Fog::Errors::NotFound, message
  end

  if service['endpoints'].count > 1
    regions = service["endpoints"].map{ |e| e['region'] }.uniq.join(',')
    raise Fog::Errors::NotFound.new("Multiple regions available choose one of these '#{regions}'")
  end

  identity_service = get_service(body, identity_service_type) if identity_service_type
  tenant = body['access']['token']['tenant']
  user = body['access']['user']

  management_url = service['endpoints'].find{|s| s[endpoint_type]}[endpoint_type]
  identity_url   = identity_service['endpoints'].find{|s| s['publicURL']}['publicURL'] if identity_service

  {
    :user                     => user,
    :tenant                   => tenant,
    :identity_public_endpoint => identity_url,
    :server_management_url    => management_url,
    :token                    => body['access']['token']['id'],
    :expires                  => body['access']['token']['expires'],
    :current_user_id          => body['access']['user']['id'],
    :unscoped_token           => options[:unscoped_token]
  }
end

+ (Object) escape(str, extra_exclude_chars = '')

CGI.escape, but without special treatment on spaces



241
242
243
244
245
# File 'lib/fog/openstack/core.rb', line 241

def self.escape(str,extra_exclude_chars = '')
  str.gsub(/([^a-zA-Z0-9_.-#{extra_exclude_chars}]+)/) do
    '%' + $1.unpack('H2' * $1.bytesize).join('%').upcase
  end
end

+ (Object) get_service(body, service_type = [], service_name = nil)



170
171
172
173
174
175
176
177
178
# File 'lib/fog/openstack/core.rb', line 170

def self.get_service(body, service_type=[], service_name=nil)
  body['access']['serviceCatalog'].find do |s|
    if service_name.nil? or service_name.empty?
      service_type.include?(s['type'])
    else
      service_type.include?(s['type']) and s['name'] == service_name
    end
  end
end

+ (Object) get_supported_version(supported_versions, uri, auth_token, connection_options = {})



213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
# File 'lib/fog/openstack/core.rb', line 213

def self.get_supported_version(supported_versions, uri, auth_token, connection_options = {})
  connection = Fog::Core::Connection.new("#{uri.scheme}://#{uri.host}:#{uri.port}", false, connection_options)
  response = connection.request({
    :expects => [200, 204, 300],
    :headers => {'Content-Type' => 'application/json',
                 'Accept' => 'application/json',
                 'X-Auth-Token' => auth_token},
    :method  => 'GET'
  })

  body = Fog::JSON.decode(response.body)
  version = nil
  unless body['versions'].empty?
    supported_version = body['versions'].find do |x|
      x["id"].match(supported_versions) &&
      (x["status"] == "CURRENT" || x["status"] == "SUPPORTED")
    end
    version = supported_version["id"] if supported_version
  end
  if version.nil?
    raise Fog::OpenStack::Errors::ServiceUnavailable.new(
              "OpenStack service only supports API versions #{supported_versions.inspect}")
  end

  version
end

+ (Object) retrieve_tokens_v2(options, connection_options = {})



180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
# File 'lib/fog/openstack/core.rb', line 180

def self.retrieve_tokens_v2(options, connection_options = {})
  api_key     = options[:openstack_api_key].to_s
  username    = options[:openstack_username].to_s
  tenant_name = options[:openstack_tenant].to_s
  auth_token  = options[:openstack_auth_token] || options[:unscoped_token]
  uri         = options[:openstack_auth_uri]

  connection = Fog::Core::Connection.new(uri.to_s, false, connection_options)
  request_body = {:auth => Hash.new}

  if auth_token
    request_body[:auth][:token] = {
      :id => auth_token
    }
  else
    request_body[:auth][:passwordCredentials] = {
      :username => username,
      :password => api_key
    }
  end
  request_body[:auth][:tenantName] = tenant_name if tenant_name

  response = connection.request({
    :expects  => [200, 204],
    :headers  => {'Content-Type' => 'application/json'},
    :body     => Fog::JSON.encode(request_body),
    :method   => 'POST',
    :path     => (uri.path and not uri.path.empty?) ? uri.path : 'v2.0'
  })

  Fog::JSON.decode(response.body)
end