Class: Aerospike::AdminCommand

Inherits:
Object
  • Object
show all
Defined in:
lib/aerospike/command/admin_command.rb

Overview

:nodoc:

Constant Summary collapse

SALT = 
'$2a$10$7EqJtq98hPqEX7fNZaFWoO'

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ AdminCommand

Returns a new instance of AdminCommand.



52
53
54
55
 
# File 'lib/aerospike/command/admin_command.rb', line 52

def initialize
  @data_buffer = Buffer.get
  @data_offset =  8
end

Class Method Details

.hash_password(password) ⇒ Object 



340
341
342
343
 
# File 'lib/aerospike/command/admin_command.rb', line 340

def self.hash_password(password)
  # Hashing the password with the cost of 10, with a static salt
  return BCrypt::Engine.hash_secret(password, SALT, :cost => 10)
end

Instance Method Details

#authenticate(conn, user, password) ⇒ Object 



57
58
59
60
61
62
63
64
65
66
67
68
 
# File 'lib/aerospike/command/admin_command.rb', line 57

def authenticate(conn, user, password)
  begin
    set_authenticate(user, password)
    conn.write(@data_buffer, @data_offset)
    conn.read(@data_buffer, HEADER_SIZE)

    result = @data_buffer.read(RESULT_CODE)
    raise Exceptions::Aerospike.new(result, "Authentication failed") if result != 0
  ensure
    Buffer.put(@data_buffer)
  end
end

#change_password(cluster, policy, user, password) ⇒ Object 



100
101
102
103
104
105
106
 
# File 'lib/aerospike/command/admin_command.rb', line 100

def change_password(cluster, policy, user, password)
  write_header(CHANGE_PASSWORD, 3)
  write_field_str(USER, user)
  write_field_bytes(OLD_PASSWORD, cluster.password)
  write_field_bytes(PASSWORD, password)
  execute_command(cluster, policy)
end

#create_user(cluster, policy, user, password, roles) ⇒ Object 



79
80
81
82
83
84
85
 
# File 'lib/aerospike/command/admin_command.rb', line 79

def create_user(cluster, policy, user, password, roles)
  write_header(CREATE_USER, 3)
  write_field_str(USER, user)
  write_field_bytes(PASSWORD, password)
  write_roles(roles)
  execute_command(cluster, policy)
end

#drop_user(cluster, policy, user) ⇒ Object 



87
88
89
90
91
 
# File 'lib/aerospike/command/admin_command.rb', line 87

def drop_user(cluster, policy, user)
  write_header(DROP_USER, 1)
  write_field_str(USER, user)
  execute_command(cluster, policy)
end

#execute_command(cluster, policy) ⇒ Object

Raises:



201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
 
# File 'lib/aerospike/command/admin_command.rb', line 201

def execute_command(cluster, policy)
  # TODO: Remove the workaround in the future
  sleep(0.010)

  write_size
  node = cluster.random_node

  timeout = 1
  timeout = policy.timeout if policy && policy.timeout > 0

  conn = node.get_connection(timeout)

  begin
    conn.write(@data_buffer, @data_offset)
    conn.read(@data_buffer, HEADER_SIZE)
    node.put_connection(conn)
  rescue => e
    conn.close if conn
    raise e
  end

  result = @data_buffer.read(RESULT_CODE)
  raise Exceptions::Aerospike.new(result) if result != 0

  Buffer.put(@data_buffer)
end

#grant_roles(cluster, policy, user, roles) ⇒ Object 



108
109
110
111
112
113
 
# File 'lib/aerospike/command/admin_command.rb', line 108

def grant_roles(cluster, policy, user, roles)
  write_header(GRANT_ROLES, 2)
  write_field_str(USER, user)
  write_roles(roles)
  execute_command(cluster, policy)
end

#parse_roles(userRoles) ⇒ Object 



322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
 
# File 'lib/aerospike/command/admin_command.rb', line 322

def parse_roles(userRoles)
  size = @data_buffer.read(@data_offset)
  @data_offset += 1
  userRoles.roles = []

  i = 0
  while i < size
    len = @data_buffer.read(@data_offset)
    @data_offset += 1
    role = @data_buffer.read(@data_offset, len)
    @data_offset += len
    userRoles.roles << role

    i = i.succ
  end
end

#parse_users(receive_size) ⇒ Object 



277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
 
# File 'lib/aerospike/command/admin_command.rb', line 277

def parse_users(receive_size)
  @data_offset = 0
  list = []

  while @data_offset < receive_size
    result_code = @data_buffer.read(@data_offset+1)

    if result_code != 0
      return (result_code == QUERY_END ? -1 : result_code)
    end

    userRoles = UserRoles.new
    field_count = @data_buffer.read(@data_offset+3)
    @data_offset += HEADER_REMAINING

    i = 0
    while i  < field_count
      len = @data_buffer.read_int32(@data_offset)
      @data_offset += 4
      id = @data_buffer.read(@data_offset)
      @data_offset += 1
      len -= 1

      case id
      when USER
        userRoles.user = @data_buffer.read(@data_offset, len)
        @data_offset += len
      when ROLES
        parse_roles(userRoles)
      else
        @data_offset += len
      end

      i = i.succ
    end

    next if userRoles.user == "" && userRoles.roles == nil

    userRoles.roles = [] if userRoles.roles == nil
    list << userRoles
  end

  return 0, list
end

#query_user(cluster, policy, user) ⇒ Object 



122
123
124
125
126
127
128
129
130
131
132
133
134
135
 
# File 'lib/aerospike/command/admin_command.rb', line 122

def query_user(cluster, policy, user)
  # TODO: Remove the workaround in the future
  sleep(0.010)

  list = []
  begin
    write_header(QUERY_USERS, 1)
    write_field_str(USER, user)
    list = read_users(cluster, policy)
    return (list.is_a?(Array) && list.length > 0 ? list.first : nil)
  ensure
    Buffer.put(@data_buffer)
  end
end

#query_users(cluster, policy) ⇒ Object 



137
138
139
140
141
142
143
144
145
146
 
# File 'lib/aerospike/command/admin_command.rb', line 137

def query_users(cluster, policy)
  # TODO: Remove the workaround in the future
  sleep(0.010)
  begin
    write_header(QUERY_USERS, 0)
    return read_users(cluster, policy)
  ensure
    Buffer.put(@data_buffer)
  end
end

#read_user_blocks(conn) ⇒ Object 



252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
 
# File 'lib/aerospike/command/admin_command.rb', line 252

def read_user_blocks(conn)
  rlist = []
  status = 0
  begin
    while status == 0
      conn.read(@data_buffer, 8)
      size = @data_buffer.read_int64(0)
      receive_size = (size & 0xFFFFFFFFFFFF)

      if receive_size > 0
        @data_buffer.resize(receive_size) if receive_size > @data_buffer.size

        conn.read(@data_buffer, receive_size)
        status, list = parse_users(receive_size)
        rlist.concat(list.to_a)
      else
        break
      end
    end
    return status, rlist
  rescue
    return -1, []
  end
end

#read_users(cluster, policy) ⇒ Object

Raises:



228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
 
# File 'lib/aerospike/command/admin_command.rb', line 228

def read_users(cluster, policy)
  write_size
  node = cluster.random_node

  timeout = 1
  timeout = policy.timeout if policy != nil && policy.timeout > 0

  status = -1
  list = []
  begin
    conn = node.get_connection(timeout)
    conn.write(@data_buffer, @data_offset)
    status, list = read_user_blocks(conn)
    node.put_connection(conn)
  rescue => e
    conn.close if conn
    raise e
  end

  raise Exceptions::Aerospike.new(result) if status > 0

  return list
end

#revoke_roles(cluster, policy, user, roles) ⇒ Object 



115
116
117
118
119
120
 
# File 'lib/aerospike/command/admin_command.rb', line 115

def revoke_roles(cluster, policy, user, roles)
  write_header(REVOKE_ROLES, 2)
  write_field_str(USER, user)
  write_roles(roles)
  execute_command(cluster, policy)
end

#set_authenticate(user, password) ⇒ Object 



70
71
72
73
74
75
76
77
 
# File 'lib/aerospike/command/admin_command.rb', line 70

def set_authenticate(user, password)
  write_header(AUTHENTICATE, 2)
  write_field_str(USER, user)
  write_field_bytes(CREDENTIAL, password)
  write_size

  return @data_offset
end

#set_password(cluster, policy, user, password) ⇒ Object 



93
94
95
96
97
98
 
# File 'lib/aerospike/command/admin_command.rb', line 93

def set_password(cluster, policy, user, password)
  write_header(SET_PASSWORD, 2)
  write_field_str(USER, user)
  write_field_bytes(PASSWORD, password)
  execute_command(cluster, policy)
end

#write_field_bytes(id, bytes) ⇒ Object 



188
189
190
191
192
 
# File 'lib/aerospike/command/admin_command.rb', line 188

def write_field_bytes(id, bytes)
  @data_buffer.write_binary(bytes, @data_offset+FIELD_HEADER_SIZE)
  write_field_header(id, bytes.bytesize)
  @data_offset += bytes.bytesize
end

#write_field_header(id, size) ⇒ Object 



194
195
196
197
198
199
 
# File 'lib/aerospike/command/admin_command.rb', line 194

def write_field_header(id, size)
  @data_buffer.write_int32(size+1, @data_offset)
  @data_offset += 4
  @data_buffer.write_byte(id, @data_offset)
  @data_offset += 1
end

#write_field_str(id, str) ⇒ Object 



182
183
184
185
186
 
# File 'lib/aerospike/command/admin_command.rb', line 182

def write_field_str(id, str)
  len = @data_buffer.write_binary(str, @data_offset+FIELD_HEADER_SIZE)
  write_field_header(id, len)
  @data_offset += len
end

#write_header(command, field_count) ⇒ Object 



170
171
172
173
174
175
176
177
178
179
180
 
# File 'lib/aerospike/command/admin_command.rb', line 170

def write_header(command, field_count)
  # Authenticate header is almost all zeros
  i = @data_offset
  while i < @data_offset+16
    @data_buffer.write_byte(0, i)
    i = i.succ
  end
  @data_buffer.write_byte(command, @data_offset+2)
  @data_buffer.write_byte(field_count, @data_offset+3)
  @data_offset += 16
end

#write_roles(roles) ⇒ Object 



148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
 
# File 'lib/aerospike/command/admin_command.rb', line 148

def write_roles(roles)
  offset = @data_offset + FIELD_HEADER_SIZE
  @data_buffer.write_byte(roles.length.ord, offset)
  offset += 1

  roles.each do |role|
    len = @data_buffer.write_binary(role, offset+1)
    @data_buffer.write_byte(len, offset)
    offset += len + 1
  end

  size = offset - @data_offset - FIELD_HEADER_SIZE
  write_field_header(ROLES, size)
  @data_offset = offset
end

#write_size ⇒ Object 



164
165
166
167
168
 
# File 'lib/aerospike/command/admin_command.rb', line 164

def write_size
  # Write total size of message which is the current offset.
  size = Integer(@data_offset-8) | Integer(MSG_VERSION << 56) | Integer(MSG_TYPE << 48)
  @data_buffer.write_int64(size, 0)
end