1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
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
169
170
171
172
173
174
175
176
177
178
179
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
212
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
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
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
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
|
#!/usr/bin/python3
from __future__ import print_function
import subprocess
import shlex
import errno
import sys
import os
import io
import re
from ceph_argparse import * # noqa
keyring_base = '/tmp/cephtest-caps.keyring'
class UnexpectedReturn(Exception):
def __init__(self, cmd, ret, expected, msg):
if isinstance(cmd, list):
self.cmd = ' '.join(cmd)
else:
assert isinstance(cmd, str), 'cmd needs to be either a list or a str'
self.cmd = cmd
self.cmd = str(self.cmd)
self.ret = int(ret)
self.expected = int(expected)
self.msg = str(msg)
def __str__(self):
return repr('{c}: expected return {e}, got {r} ({o})'.format(
c=self.cmd, e=self.expected, r=self.ret, o=self.msg))
def call(cmd):
if isinstance(cmd, list):
args = cmd
elif isinstance(cmd, str):
args = shlex.split(cmd)
else:
assert False, 'cmd is not a string/unicode nor a list!'
print('call: {0}'.format(args))
proc = subprocess.Popen(args, stdout=subprocess.PIPE, stderr=subprocess.PIPE)
ret = proc.wait()
return (ret, proc)
def expect(cmd, expected_ret):
try:
(r, p) = call(cmd)
except ValueError as e:
print('unable to run {c}: {err}'.format(c=repr(cmd), err=e.message),
file=sys.stderr)
return errno.EINVAL
assert r == p.returncode, \
'wth? r was supposed to match returncode!'
if r != expected_ret:
raise UnexpectedReturn(repr(cmd), r, expected_ret, str(p.stderr.read()))
return p
def expect_to_file(cmd, expected_ret, out_file):
# Let the exception be propagated to the caller
p = expect(cmd, expected_ret)
assert p.returncode == expected_ret, \
'expected result doesn\'t match and no exception was thrown!'
with io.open(out_file, 'ab') as file:
file.write(p.stdout.read())
return p
class Command:
def __init__(self, cid, j):
self.cid = cid[3:]
self.perms = j['perm']
self.module = j['module']
self.sig = ''
self.args = []
for s in j['sig']:
if not isinstance(s, dict):
assert isinstance(s, str), \
'malformatted signature cid {0}: {1}\n{2}'.format(cid,s,j)
if len(self.sig) > 0:
self.sig += ' '
self.sig += s
else:
self.args.append(s)
def __str__(self):
return repr('command {0}: {1} (requires \'{2}\')'.format(self.cid,\
self.sig, self.perms))
def destroy_keyring(path):
if not os.path.exists(path):
raise Exception('oops! cannot remove inexistent keyring {0}'.format(path))
# grab all client entities from the keyring
entities = [m.group(1) for m in [re.match(r'\[client\.(.*)\]', l)
for l in [str(line.strip())
for line in io.open(path,'r')]] if m is not None]
# clean up and make sure each entity is gone
for e in entities:
expect('ceph auth del client.{0}'.format(e), 0)
expect('ceph auth get client.{0}'.format(e), errno.ENOENT)
# remove keyring
os.unlink(path)
return True
def test_basic_auth():
# make sure we can successfully add/del entities, change their caps
# and import/export keyrings.
expect('ceph auth add client.basicauth', 0)
expect('ceph auth caps client.basicauth mon \'allow *\'', 0)
# entity exists and caps do not match
expect('ceph auth add client.basicauth', errno.EINVAL)
# this command attempts to change an existing state and will fail
expect('ceph auth add client.basicauth mon \'allow w\'', errno.EINVAL)
expect('ceph auth get-or-create client.basicauth', 0)
expect('ceph auth get-key client.basicauth', 0)
expect('ceph auth get-or-create client.basicauth2', 0)
# cleanup
expect('ceph auth del client.basicauth', 0)
expect('ceph auth del client.basicauth2', 0)
return True
def gen_module_keyring(module):
module_caps = [
('all', '{t} \'allow service {s} rwx\'', 0),
('none', '', errno.EACCES),
('wrong', '{t} \'allow service foobar rwx\'', errno.EACCES),
('right', '{t} \'allow service {s} {p}\'', 0),
('no-execute', '{t} \'allow service {s} x\'', errno.EACCES)
]
keyring = '{0}.service-{1}'.format(keyring_base,module)
for perms in 'r rw x'.split():
for (n,p,r) in module_caps:
c = p.format(t='mon', s=module, p=perms)
expect_to_file(
'ceph auth get-or-create client.{cn}-{cp} {caps}'.format(
cn=n,cp=perms,caps=c), 0, keyring)
return keyring
def test_all():
perms = {
'good': {
'broad':[
('rwx', 'allow *'),
('r', 'allow r'),
('rw', 'allow rw'),
('x', 'allow x'),
],
'service':[
('rwx', 'allow service {s} rwx'),
('r', 'allow service {s} r'),
('rw', 'allow service {s} rw'),
('x', 'allow service {s} x'),
],
'command':[
('rwx', 'allow command "{c}"'),
],
'command-with':[
('rwx', 'allow command "{c}" with {kv}')
],
'command-with-prefix':[
('rwx', 'allow command "{c}" with {key} prefix {val}')
]
},
'bad': {
'broad':[
('none', ''),
],
'service':[
('none1', 'allow service foo rwx'),
('none2', 'allow service foo r'),
('none3', 'allow service foo rw'),
('none4', 'allow service foo x'),
],
'command':[
('none', 'allow command foo'),
],
'command-with':[
('none', 'allow command "{c}" with foo=bar'),
],
'command-with-prefix':[
('none', 'allow command "{c}" with foo prefix bar'),
],
}
}
cmds = {
'':[
{
'cmd':('status', '', 'r')
},
{
'pre':'heap start_profiler',
'cmd':('heap', 'heapcmd=stats', 'rw'),
'post':'heap stop_profiler'
}
],
'auth':[
{
'pre':'',
'cmd':('auth ls', '', 'r'),
'post':''
},
{
'pre':'auth get-or-create client.foo mon \'allow *\'',
'cmd':('auth caps', 'entity="client.foo"', 'rw'),
'post':'auth del client.foo'
}
],
'pg':[
{
'cmd':('pg getmap', '', 'r'),
},
],
'mds':[
{
'cmd':('mds getmap', '', 'r'),
},
],
'mon':[
{
'cmd':('mon getmap', '', 'r')
},
{
'cmd':('mon remove', 'name=a', 'rw')
}
],
'osd':[
{
'cmd':('osd getmap', '', 'r'),
},
{
'cmd':('osd pause', '', 'rw'),
'post':'osd unpause'
},
{
'cmd':('osd crush dump', '', 'r')
},
],
'config-key':[
{
'pre':'config-key set foo bar',
'cmd':('config-key get', 'key=foo', 'r')
},
{
'pre':'config-key set foo bar',
'cmd':('config-key del', 'key=foo', 'rw')
}
]
}
for (module,cmd_lst) in cmds.items():
k = keyring_base + '.' + module
for cmd in cmd_lst:
(cmd_cmd, cmd_args, cmd_perm) = cmd['cmd']
cmd_args_key = ''
cmd_args_val = ''
if len(cmd_args) > 0:
(cmd_args_key, cmd_args_val) = cmd_args.split('=')
print('generating keyring for {m}/{c}'.format(m=module,c=cmd_cmd))
# gen keyring
for (good_or_bad,kind_map) in perms.items():
for (kind,lst) in kind_map.items():
for (perm, cap) in lst:
cap_formatted = cap.format(
s=module,
c=cmd_cmd,
kv=cmd_args,
key=cmd_args_key,
val=cmd_args_val)
if len(cap_formatted) == 0:
run_cap = ''
else:
run_cap = 'mon \'{fc}\''.format(fc=cap_formatted)
cname = 'client.{gb}-{kind}-{p}'.format(
gb=good_or_bad,kind=kind,p=perm)
expect_to_file(
'ceph auth get-or-create {n} {c}'.format(
n=cname,c=run_cap), 0, k)
# keyring generated
print('testing {m}/{c}'.format(m=module,c=cmd_cmd))
# test
for good_bad in perms.keys():
for (kind,lst) in perms[good_bad].items():
for (perm,_) in lst:
cname = 'client.{gb}-{k}-{p}'.format(gb=good_bad,k=kind,p=perm)
if good_bad == 'good':
expect_ret = 0
else:
expect_ret = errno.EACCES
if ( cmd_perm not in perm ):
expect_ret = errno.EACCES
if 'with' in kind and len(cmd_args) == 0:
expect_ret = errno.EACCES
if 'service' in kind and len(module) == 0:
expect_ret = errno.EACCES
if 'pre' in cmd and len(cmd['pre']) > 0:
expect('ceph {0}'.format(cmd['pre']), 0)
expect('ceph -n {cn} -k {k} {c} {arg_val}'.format(
cn=cname,k=k,c=cmd_cmd,arg_val=cmd_args_val), expect_ret)
if 'post' in cmd and len(cmd['post']) > 0:
expect('ceph {0}'.format(cmd['post']), 0)
# finish testing
destroy_keyring(k)
return True
def test_misc():
k = keyring_base + '.misc'
expect_to_file(
'ceph auth get-or-create client.caps mon \'allow command "auth caps"' \
' with entity="client.caps"\'', 0, k)
expect('ceph -n client.caps -k {kf} quorum_status'.format(kf=k), errno.EACCES)
expect('ceph -n client.caps -k {kf} auth caps client.caps mon \'allow *\''.format(kf=k), 0)
expect('ceph -n client.caps -k {kf} quorum_status'.format(kf=k), 0)
destroy_keyring(k)
def main():
test_basic_auth()
test_all()
test_misc()
print('OK')
return 0
if __name__ == '__main__':
main()
|