/
kerberos.py
334 lines (224 loc) · 7.21 KB
/
kerberos.py
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
# -*- coding: utf-8 -*-
'''
Manage Kerberos KDC
:configuration:
In order to manage your KDC you will need to generate a keytab
that can authenticate without requiring a password.
For MIT Kerberos:
.. code-block:: bash
# ktadd -k /root/secure.keytab kadmin/admin kadmin/changepw
For Heimdal Kerberos:
.. code-block:: bash
# ext_keytab -k /root/secure.keytab kadmin/admin
On the KDC minion you will need to add the following to the minion
configuration file so Salt knows what keytab to use and what principal to
authenticate as. Optionally you can specify which kerberos flavor to use,
the default is MIT Kerberos if left unspecified.
.. code-block:: yaml
auth_keytab: /root/auth.keytab
auth_principal: kadmin/admin
krb_flavor: heimdal
'''
# Import Python libs
from __future__ import absolute_import, print_function, unicode_literals
import logging
# Import Salt libs
import salt.utils.path
log = logging.getLogger(__name__)
def __virtual__():
if salt.utils.path.which('kadmin'):
return True
return (False, 'The kerberos execution module not loaded: kadmin not in path')
def __execute_kadmin(cmd):
'''
Execute kadmin commands
'''
ret = {}
auth_keytab = __opts__.get('auth_keytab', None)
auth_principal = __opts__.get('auth_principal', None)
if __salt__['file.file_exists'](auth_keytab) and auth_principal:
krb_flavor = __opts__.get('krb_flavor', None)
if krb_flavor == "heimdal":
return __salt__['cmd.run_all'](
'kadmin -K {0} -p {1} {2}'.format(
auth_keytab, auth_principal, cmd
)
)
else:
return __salt__['cmd.run_all'](
'kadmin -k -t {0} -p {1} -q "{2}"'.format(
auth_keytab, auth_principal, cmd
)
)
else:
log.error('Unable to find kerberos keytab/principal')
ret['retcode'] = 1
ret['comment'] = 'Missing authentication keytab/principal'
return ret
def list_principals():
'''
Get all principals
CLI Example:
.. code-block:: bash
salt 'kde.example.com' kerberos.list_principals
'''
ret = {}
krb_flavor = __opts__.get('krb_flavor', None)
if krb_flavor == "heimdal":
krb_cmd = 'get -t "*"'
else:
krb_cmd = 'list_principals'
cmd = __execute_kadmin(krb_cmd)
if cmd['retcode'] != 0 or cmd['stderr']:
ret['comment'] = cmd['stderr'].splitlines()[-1]
ret['result'] = False
return ret
ret = {'principals': []}
for i in cmd['stdout'].splitlines()[1:]:
ret['principals'].append(i)
return ret
def get_principal(name):
'''
Get princial details
CLI Example:
.. code-block:: bash
salt 'kdc.example.com' kerberos.get_principal root/admin
'''
ret = {}
krb_flavor = __opts__.get('krb_flavor', None)
if krb_flavor == "heimdal":
krb_cmd = 'get'
else:
krb_cmd = 'get_principals'
cmd = __execute_kadmin(krb_cmd + ' {0}'.format(name))
if cmd['retcode'] != 0 or cmd['stderr']:
ret['comment'] = cmd['stderr'].splitlines()[-1]
ret['result'] = False
return ret
for i in cmd['stdout'].splitlines()[1:]:
(prop, val) = i.split(':', 1)
ret[prop] = val
return ret
def list_policies():
'''
List policies. Not supported by Heimdal backend.
CLI Example:
.. code-block:: bash
salt 'kdc.example.com' kerberos.list_policies
'''
ret = {}
cmd = __execute_kadmin('list_policies')
if cmd['retcode'] != 0 or cmd['stderr']:
ret['comment'] = cmd['stderr'].splitlines()[-1]
ret['result'] = False
return ret
ret = {'policies': []}
for i in cmd['stdout'].splitlines()[1:]:
ret['policies'].append(i)
return ret
def get_policy(name):
'''
Get policy details. Not supported by Heimdal backend.
CLI Example:
.. code-block:: bash
salt 'kdc.example.com' kerberos.get_policy my_policy
'''
ret = {}
cmd = __execute_kadmin('get_policy {0}'.format(name))
if cmd['retcode'] != 0 or cmd['stderr']:
ret['comment'] = cmd['stderr'].splitlines()[-1]
ret['result'] = False
return ret
for i in cmd['stdout'].splitlines()[1:]:
(prop, val) = i.split(':', 1)
ret[prop] = val
return ret
def get_privs():
'''
Current privileges
CLI Example:
.. code-block:: bash
salt 'kdc.example.com' kerberos.get_privs
'''
ret = {}
krb_flavor = __opts__.get('krb_flavor', None)
if krb_flavor == "heimdal":
krb_cmd = 'privileges'
else:
krb_cmd = 'get_privs'
cmd = __execute_kadmin(krb_cmd)
if cmd['retcode'] != 0 or cmd['stderr']:
ret['comment'] = cmd['stderr'].splitlines()[-1]
ret['result'] = False
return ret
if krb_flavor == "heimdal":
ret["privileges"] = [i.strip() for i in cmd['stdout'].split(',')]
else:
for i in cmd['stdout'].splitlines()[1:]:
(prop, val) = i.split(':', 1)
ret[prop] = [j for j in val.split()]
return ret
def create_principal(name, enctypes=None):
'''
Create Principal
CLI Example:
.. code-block:: bash
salt 'kdc.example.com' kerberos.create_principal host/example.com
'''
ret = {}
krb_flavor = __opts__.get('krb_flavor', None)
if krb_flavor == "heimdal":
krb_cmd = 'add --use-defaults --random-key'
else:
krb_cmd = 'addprinc -randkey'
if enctypes:
krb_cmd += ' -e {0}'.format(enctypes)
krb_cmd += ' {0}'.format(name)
cmd = __execute_kadmin(krb_cmd)
if cmd['retcode'] != 0 or cmd['stderr']:
if not cmd['stderr'].splitlines()[-1].startswith('WARNING:'):
ret['comment'] = cmd['stderr'].splitlines()[-1]
ret['result'] = False
return ret
return True
def delete_principal(name):
'''
Delete Principal
CLI Example:
.. code-block:: bash
salt 'kdc.example.com' kerberos.delete_principal host/example.com@EXAMPLE.COM
'''
ret = {}
krb_flavor = __opts__.get('krb_flavor', None)
if krb_flavor == "heimdal":
krb_cmd = 'delete'
else:
krb_cmd = 'delprinc -force'
cmd = __execute_kadmin(krb_cmd + ' {0}'.format(name))
if cmd['retcode'] != 0 or cmd['stderr']:
ret['comment'] = cmd['stderr'].splitlines()[-1]
ret['result'] = False
return ret
return True
def create_keytab(name, keytab, enctypes=None):
'''
Create keytab
CLI Example:
.. code-block:: bash
salt 'kdc.example.com' kerberos.create_keytab host/host1.example.com host1.example.com.keytab
'''
ret = {}
krb_flavor = __opts__.get('krb_flavor', None)
if krb_flavor == "heimdal":
krb_cmd = 'ext_keytab -k {0}'.format(keytab)
else:
krb_cmd = 'ktadd -k {0}'.format(keytab)
if enctypes:
krb_cmd += ' -e {0}'.format(enctypes)
krb_cmd += ' {0}'.format(name)
cmd = __execute_kadmin(krb_cmd)
if cmd['retcode'] != 0 or cmd['stderr']:
ret['comment'] = cmd['stderr'].splitlines()[-1]
ret['result'] = False
return ret
return True