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
|
# -*- coding: utf-8 -*-
# pylint: disable=too-many-return-statements,too-many-branches
from __future__ import absolute_import
import errno
import json
import logging
import os
import threading
import warnings
from urllib import parse
from .. import mgr
from ..tools import prepare_url_prefix
logger = logging.getLogger('sso')
try:
from onelogin.saml2.errors import OneLogin_Saml2_Error as Saml2Error
from onelogin.saml2.idp_metadata_parser import OneLogin_Saml2_IdPMetadataParser as Saml2Parser
from onelogin.saml2.settings import OneLogin_Saml2_Settings as Saml2Settings
python_saml_imported = True
except ImportError:
python_saml_imported = False
class Saml2(object):
def __init__(self, onelogin_settings):
self.onelogin_settings = onelogin_settings
def get_username_attribute(self):
return self.onelogin_settings['sp']['attributeConsumingService']['requestedAttributes'][0][
'name']
def to_dict(self):
return {
'onelogin_settings': self.onelogin_settings
}
@classmethod
def from_dict(cls, s_dict):
return Saml2(s_dict['onelogin_settings'])
class SsoDB(object):
VERSION = 1
SSODB_CONFIG_KEY = "ssodb_v"
def __init__(self, version, protocol, saml2):
self.version = version
self.protocol = protocol
self.saml2 = saml2
self.lock = threading.RLock()
def save(self):
with self.lock:
db = {
'protocol': self.protocol,
'saml2': self.saml2.to_dict(),
'version': self.version
}
mgr.set_store(self.ssodb_config_key(), json.dumps(db))
@classmethod
def ssodb_config_key(cls, version=None):
if version is None:
version = cls.VERSION
return "{}{}".format(cls.SSODB_CONFIG_KEY, version)
def check_and_update_db(self):
logger.debug("Checking for previous DB versions")
if self.VERSION != 1:
raise NotImplementedError()
@classmethod
def load(cls):
logger.info("Loading SSO DB version=%s", cls.VERSION)
json_db = mgr.get_store(cls.ssodb_config_key(), None)
if json_db is None:
logger.debug("No DB v%s found, creating new...", cls.VERSION)
db = cls(cls.VERSION, '', Saml2({}))
# check if we can update from a previous version database
db.check_and_update_db()
return db
dict_db = json.loads(json_db) # type: dict
return cls(dict_db['version'], dict_db.get('protocol'),
Saml2.from_dict(dict_db.get('saml2')))
def load_sso_db():
mgr.SSO_DB = SsoDB.load()
SSO_COMMANDS = [
{
'cmd': 'dashboard sso enable saml2',
'desc': 'Enable SAML2 Single Sign-On',
'perm': 'w'
},
{
'cmd': 'dashboard sso disable',
'desc': 'Disable Single Sign-On',
'perm': 'w'
},
{
'cmd': 'dashboard sso status',
'desc': 'Get Single Sign-On status',
'perm': 'r'
},
{
'cmd': 'dashboard sso show saml2',
'desc': 'Show SAML2 configuration',
'perm': 'r'
},
{
'cmd': 'dashboard sso setup saml2 '
'name=ceph_dashboard_base_url,type=CephString '
'name=idp_metadata,type=CephString '
'name=idp_username_attribute,type=CephString,req=false '
'name=idp_entity_id,type=CephString,req=false '
'name=sp_x_509_cert,type=CephFilepath,req=false '
'name=sp_private_key,type=CephFilepath,req=false',
'desc': 'Setup SAML2 Single Sign-On',
'perm': 'w'
}
]
def _get_optional_attr(cmd, attr, default):
if attr in cmd:
if cmd[attr] != '':
return cmd[attr]
return default
def handle_sso_command(cmd):
if cmd['prefix'] not in ['dashboard sso enable saml2',
'dashboard sso disable',
'dashboard sso status',
'dashboard sso show saml2',
'dashboard sso setup saml2']:
return -errno.ENOSYS, '', ''
if cmd['prefix'] == 'dashboard sso disable':
mgr.SSO_DB.protocol = ''
mgr.SSO_DB.save()
return 0, 'SSO is "disabled".', ''
if not python_saml_imported:
return -errno.EPERM, '', 'Required library not found: `python3-saml`'
if cmd['prefix'] == 'dashboard sso enable saml2':
try:
Saml2Settings(mgr.SSO_DB.saml2.onelogin_settings)
except Saml2Error:
return -errno.EPERM, '', 'Single Sign-On is not configured: ' \
'use `ceph dashboard sso setup saml2`'
mgr.SSO_DB.protocol = 'saml2'
mgr.SSO_DB.save()
return 0, 'SSO is "enabled" with "SAML2" protocol.', ''
if cmd['prefix'] == 'dashboard sso status':
if mgr.SSO_DB.protocol == 'saml2':
return 0, 'SSO is "enabled" with "SAML2" protocol.', ''
return 0, 'SSO is "disabled".', ''
if cmd['prefix'] == 'dashboard sso show saml2':
return 0, json.dumps(mgr.SSO_DB.saml2.to_dict()), ''
if cmd['prefix'] == 'dashboard sso setup saml2':
ceph_dashboard_base_url = cmd['ceph_dashboard_base_url']
idp_metadata = cmd['idp_metadata']
idp_username_attribute = _get_optional_attr(cmd, 'idp_username_attribute', 'uid')
idp_entity_id = _get_optional_attr(cmd, 'idp_entity_id', None)
sp_x_509_cert_path = _get_optional_attr(cmd, 'sp_x_509_cert', '')
sp_private_key_path = _get_optional_attr(cmd, 'sp_private_key', '')
if sp_x_509_cert_path and not sp_private_key_path:
return -errno.EINVAL, '', 'Missing parameter `sp_private_key`.'
if not sp_x_509_cert_path and sp_private_key_path:
return -errno.EINVAL, '', 'Missing parameter `sp_x_509_cert`.'
has_sp_cert = sp_x_509_cert_path != "" and sp_private_key_path != ""
if has_sp_cert:
try:
with open(sp_x_509_cert_path, 'r', encoding='utf-8') as f:
sp_x_509_cert = f.read()
except FileNotFoundError:
return -errno.EINVAL, '', '`{}` not found.'.format(sp_x_509_cert_path)
try:
with open(sp_private_key_path, 'r', encoding='utf-8') as f:
sp_private_key = f.read()
except FileNotFoundError:
return -errno.EINVAL, '', '`{}` not found.'.format(sp_private_key_path)
else:
sp_x_509_cert = ''
sp_private_key = ''
if os.path.isfile(idp_metadata):
warnings.warn(
"Please prepend 'file://' to indicate a local SAML2 IdP file", DeprecationWarning)
with open(idp_metadata, 'r', encoding='utf-8') as f:
idp_settings = Saml2Parser.parse(f.read(), entity_id=idp_entity_id)
elif parse.urlparse(idp_metadata)[0] in ('http', 'https', 'file'):
idp_settings = Saml2Parser.parse_remote(
url=idp_metadata, validate_cert=False, entity_id=idp_entity_id)
else:
idp_settings = Saml2Parser.parse(idp_metadata, entity_id=idp_entity_id)
url_prefix = prepare_url_prefix(mgr.get_module_option('url_prefix', default=''))
settings = {
'sp': {
'entityId': '{}{}/auth/saml2/metadata'.format(ceph_dashboard_base_url, url_prefix),
'assertionConsumerService': {
'url': '{}{}/auth/saml2'.format(ceph_dashboard_base_url, url_prefix),
'binding': "urn:oasis:names:tc:SAML:2.0:bindings:HTTP-POST"
},
'attributeConsumingService': {
'serviceName': "Ceph Dashboard",
"serviceDescription": "Ceph Dashboard Service",
"requestedAttributes": [
{
"name": idp_username_attribute,
"isRequired": True
}
]
},
'singleLogoutService': {
'url': '{}{}/auth/saml2/logout'.format(ceph_dashboard_base_url, url_prefix),
'binding': 'urn:oasis:names:tc:SAML:2.0:bindings:HTTP-Redirect'
},
"x509cert": sp_x_509_cert,
"privateKey": sp_private_key
},
'security': {
"nameIdEncrypted": has_sp_cert,
"authnRequestsSigned": has_sp_cert,
"logoutRequestSigned": has_sp_cert,
"logoutResponseSigned": has_sp_cert,
"signMetadata": has_sp_cert,
"wantMessagesSigned": has_sp_cert,
"wantAssertionsSigned": has_sp_cert,
"wantAssertionsEncrypted": has_sp_cert,
"wantNameIdEncrypted": False, # Not all Identity Providers support this.
"metadataValidUntil": '',
"wantAttributeStatement": False
}
}
settings = Saml2Parser.merge_settings(settings, idp_settings)
mgr.SSO_DB.saml2.onelogin_settings = settings
mgr.SSO_DB.protocol = 'saml2'
mgr.SSO_DB.save()
return 0, json.dumps(mgr.SSO_DB.saml2.onelogin_settings), ''
return -errno.ENOSYS, '', ''
|
