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
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
|
# Authors:
# Rob Crittenden <rcritten@redhat.com>
#
# Copyright (C) 2014 Red Hat
# see file 'COPYING' for use and warranty information
#
# This program is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program. If not, see <http://www.gnu.org/licenses/>.
import sys
sys.stdout = sys.stderr
import cherrypy
import os
import json
from functools import wraps
import traceback as tb_internal
from cherrypy import response
from ipalib import api
from ipalib import errors
from ipaplatform.paths import paths
from ipalib.request import context
from ipalib.rpc import json_encode_binary
from ipapython.version import VERSION, API_VERSION
from ipapython.ipa_log_manager import root_logger
def jsonout(func):
'''JSON output decorator'''
@wraps(func)
def wrapper(*args, **kw):
value = func(*args, **kw)
response.headers["Content-Type"] = "application/json;charset=utf-8"
data = json_encode_binary(value, version=API_VERSION)
return json.dumps(data, sort_keys=True, indent=2)
return wrapper
def handle_error(status, message, traceback, version):
"""
Return basic messages to user and log backtrace in case of 500
error.
"""
if status.startswith('500'):
root_logger.error(message)
root_logger.error(tb_internal.format_exc())
resp = cherrypy.response
resp.headers['Content-Type'] = 'application/json'
return json.dumps({'status': status, 'message': message})
def convert_unicode(value):
"""
IPA requires all incoming values to be unicode. Recursively
convert the values.
"""
if not isinstance(value, basestring):
return value
if value is not None:
return unicode(value)
else:
return None
def raise_rest_exception(e):
"""
Raise a REST-specific exception.
"""
try:
raise e
except (errors.DuplicateEntry, errors.DNSNotARecordError,
errors.ValidationError, errors.ConversionError,) as e:
raise IPAError(
status=400,
message=e
)
except errors.ACIError as e:
raise IPAError(
status=401,
message=e
)
except errors.NotFound as e:
raise IPAError(
status=404,
message=e
)
except Exception as e:
raise IPAError(
status=500,
message=e
)
def popifnone(params, option):
"""
If option, a string, exists in params, a dict, and is None then
remove it from the dict.
No return value. The dict is updated in-place if necessary.
"""
if params.get(option) is None:
params.pop(option, None)
def Command(command, *args, **options):
"""
Execute an IPA command with the given arguments and options.
This doesn't care what the options are, it passes them along to
the IPA API. The exceptions are:
:param nomaskexceptions: boolean to decide if we raise the real IPA
exception or a REST-specific exceptioon.
"""
if (cherrypy.request.config.get('local_only', False) and
cherrypy.request.remote.ip not in ['::1', '127.0.0.1']):
raise IPAError(
status=401,
message="Not a local request"
)
try:
if not api.Backend.rpcclient.isconnected():
api.Backend.rpcclient.connect()
except errors.CCacheError as e:
root_logger.info('Connection failed: %s', e)
raise IPAError(
status=401,
message=e
)
# IPA wants all its strings as unicode
args = map(lambda v: convert_unicode(v), args)
options = dict(zip(options, map(convert_unicode, options.values())))
nomaskexception = options.pop('nomaskexception', False)
api.Command[command].args_options_2_params(*args, **options)
try:
return api.Command[command](*args, **options)['result']
except Exception as e:
if not nomaskexception:
raise_rest_exception(e)
else:
# The caller needs to be able to handle IPA-specific
# exceptions.
raise e
@jsonout
def GET(command, *args, **options):
return Command(command, *args, **options)
@jsonout
def POST(status, command, *args, **options):
cherrypy.response.status = status
return Command(command, *args, **options)
@jsonout
def DELETE(command, *args, **options):
return Command(command, *args, **options)
class IPAError(cherrypy.HTTPError):
"""
Return errors in IPA-style json.
Local errors are treated as strings so do not include the code and
name attributes within the error dict.
This is not padded for IE.
"""
def set_response(self):
response = cherrypy.serving.response
cherrypy._cperror.clean_headers(self.code)
# In all cases, finalize will be called after this method,
# so don't bother cleaning up response values here.
response.status = self.status
if isinstance(self._message, Exception):
try:
code = self._message.errno
except AttributeError:
code = 0
error = {'code': code,
'message': self._message.message,
'name': self._message.__class__.__name__}
elif isinstance(self._message, basestring):
error = {'message': self._message}
else:
error = {'message':
'Unable to handle error message type %s' %
type(self._message)}
principal = getattr(context, 'principal', None)
response.headers["Content-Type"] = "application/json;charset=utf-8"
response.body = json.dumps({'error': error,
'id': 0,
'principal': principal,
'result': None,
'version': VERSION},
sort_keys=True, indent=2)
class Host(object):
"""
Manage IPA host objects
"""
exposed = True
def GET(self, fqdn=None):
if fqdn is None:
command = 'host_find'
else:
command = 'host_show'
return GET(command, fqdn)
def POST(self, hostname, description=None,
macaddress=None, userclass=None, ip_address=None,
password=None, rebuild=None):
cmd = 'host_add'
if password is None:
random = True
else:
random = False
params = {'description' : description,
'random' : random,
'macaddress' : macaddress,
'userclass' : userclass,
'userpassword' : password}
# If the host is being rebuilt, disable it in order to revoke
# existing certs, keytabs, etc.
try:
Command('host_show', hostname, nomaskexception=True)
except errors.NotFound:
# Adding a new host
status = 201
params['ip_address'] = ip_address
params['force'] = True
except Exception as e:
raise_rest_exception(e)
else:
if ip_address is not None:
raise IPAError(
status=400,
message='IP address must be changed in DNS'
)
cmd = 'host_mod'
# Foreman doesn't pass these in on update so drop them otherwise
# IPA will consider these as being set to None which deletes them.
popifnone(params, 'description')
popifnone(params, 'macaddress')
popifnone(params, 'userclass')
popifnone(params, 'userpassword')
status = 200
if rebuild:
root_logger.info("Attempting to disable %s", hostname)
try:
Command('host_disable', hostname, nomaskexception=True)
except errors.AlreadyInactive as e:
pass
else:
raise e
return POST(status, cmd, hostname, **params)
def DELETE(self, fqdn):
# The host-del behavior is a bit off due to
# https://fedorahosted.org/freeipa/ticket/4329
# A NotFound is returned if the user can't read DNS.
# Do a GET to see if the host exists, then we can more blindly
# try the delete.
# If the GET is ok then we know there is a host, though this is a
# bit racy.
GET('host_show', fqdn)
remove_dns = cherrypy.request.config.get('remove_dns', False)
return DELETE('host_del', fqdn, updatedns=remove_dns)
class Hostgroup(object):
"""
Manage IPA hostgroup objects
"""
exposed = True
def GET(self, name=None):
if name is None:
command = 'hostgroup_find'
else:
command = 'hostgroup_show'
return GET(command, name)
def POST(self, name=None, description=None):
cherrypy.response.status = 201
return POST(201, 'hostgroup_add', name,
description=description,)
def DELETE(self, name):
return DELETE('hostgroup_del', name)
class Features(object):
exposed = True
def GET(self):
return '["realm"]'
def start(config=None):
# Set the umask so only the owner can read the log files
old_umask = os.umask(077)
cherrypy.tree.mount(
Features(), '/features',
{'/':
{'request.dispatch': cherrypy.dispatch.MethodDispatcher()}
}
)
cherrypy.tree.mount(
Host(), '/ipa/smartproxy/host',
{'/':
{'request.dispatch': cherrypy.dispatch.MethodDispatcher()}
}
)
cherrypy.tree.mount(
Hostgroup(), '/ipa/smartproxy/hostgroup',
{'/':
{'request.dispatch': cherrypy.dispatch.MethodDispatcher()}
}
)
# Register the realm for requests from Foreman
root_logger.info("Mounting /realm/%s", api.env.realm)
cherrypy.tree.mount(
Host(), '/realm/%s' % api.env.realm,
{'/':
{'request.dispatch': cherrypy.dispatch.MethodDispatcher()}
}
)
for c in config or []:
try:
cherrypy.config.update(c)
except (IOError, OSError) as e:
root_logger.error("Exception trying to load %s: %s", c, e)
return 1
# Log files are created, reset umask
os.umask(old_umask)
cherrypy.config.update({'error_page.500': handle_error})
return 0
def application(environ, start_response):
root_logger.info("IPA smartproxy WSGI start")
return cherrypy.tree(environ, start_response)
wsgi_config = {'environment': 'embedded',
'log.screen': False,
'show_tracebacks': False,
'engine.autoreload_on': False
}
api.bootstrap(context='ipasmartproxy', log=paths.DEV_NULL)
api.finalize()
cherrypy.config.update(wsgi_config)
start([paths.IPA_SMARTPROXY_CONF])
|