3 # Copyright (C) 2014 Ipsilon project Contributors, for license see COPYING
6 from ipsilon.tools.certs import Certificate
12 'email': lasso.SAML2_NAME_IDENTIFIER_FORMAT_EMAIL,
13 'encrypted': lasso.SAML2_NAME_IDENTIFIER_FORMAT_ENCRYPTED,
14 'entity': lasso.SAML2_NAME_IDENTIFIER_FORMAT_ENTITY,
15 'kerberos': lasso.SAML2_NAME_IDENTIFIER_FORMAT_KERBEROS,
16 'persistent': lasso.SAML2_NAME_IDENTIFIER_FORMAT_PERSISTENT,
17 'transient': lasso.SAML2_NAME_IDENTIFIER_FORMAT_TRANSIENT,
18 'unspecified': lasso.SAML2_NAME_IDENTIFIER_FORMAT_UNSPECIFIED,
19 'windows': lasso.SAML2_NAME_IDENTIFIER_FORMAT_WINDOWS,
20 'x509': lasso.SAML2_NAME_IDENTIFIER_FORMAT_X509,
24 'sso-post': ('SingleSignOnService',
25 lasso.SAML2_METADATA_BINDING_POST),
26 'sso-redirect': ('SingleSignOnService',
27 lasso.SAML2_METADATA_BINDING_REDIRECT),
28 'sso-soap': ('SingleSignOnService',
29 lasso.SAML2_METADATA_BINDING_SOAP),
30 'logout-redirect': ('SingleLogoutService',
31 lasso.SAML2_METADATA_BINDING_REDIRECT),
32 'response-post': ('AssertionConsumerService',
33 lasso.SAML2_METADATA_BINDING_POST)
36 EDESC = '{%s}EntityDescriptor' % lasso.SAML2_METADATA_HREF
38 'md': lasso.SAML2_METADATA_HREF,
42 IDPDESC = 'IDPSSODescriptor'
43 SPDESC = 'SPSSODescriptor'
49 # Expire metadata weekly by default
53 def mdElement(_parent, _tag, **kwargs):
54 tag = '{%s}%s' % (lasso.SAML2_METADATA_HREF, _tag)
55 return etree.SubElement(_parent, tag, **kwargs)
58 def dsElement(_parent, _tag, **kwargs):
59 tag = '{%s}%s' % (lasso.DS_HREF, _tag)
60 return etree.SubElement(_parent, tag, **kwargs)
63 class Metadata(object):
65 def __init__(self, role=None, expiration=None):
66 self.root = etree.Element(EDESC, nsmap=NSMAP)
70 self.set_expiration(expiration)
72 def set_entity_id(self, url):
74 self.root.set('entityID', url)
76 def set_role(self, role):
79 elif role == IDP_ROLE:
84 raise ValueError('invalid role: %s' % role)
85 self.role = mdElement(self.root, description)
86 self.role.set('protocolSupportEnumeration', lasso.SAML2_PROTOCOL_HREF)
89 def set_expiration(self, exp):
91 self.root.set('cacheDuration', "P%dD" % (MIN_EXP_DEFAULT))
93 elif isinstance(exp, datetime.date):
94 d = datetime.datetime.combine(exp, datetime.date.min.time())
95 elif isinstance(exp, datetime.datetime):
97 elif isinstance(exp, datetime.timedelta):
98 d = datetime.datetime.now() + exp
100 raise TypeError('Invalid expiration date type')
102 self.root.set('validUntil', d.isoformat())
104 def add_cert(self, certdata, use):
105 desc = mdElement(self.role, 'KeyDescriptor')
107 info = dsElement(desc, 'KeyInfo')
108 data = dsElement(info, 'X509Data')
109 cert = dsElement(data, 'X509Certificate')
112 def add_certs(self, signcert=None, enccert=None):
114 self.add_cert(signcert.get_cert(), 'signing')
116 self.add_cert(enccert.get_cert(), 'encryption')
118 def add_service(self, service, location, **kwargs):
119 svc = mdElement(self.role, service[0])
120 svc.set('Binding', service[1])
121 svc.set('Location', location)
122 for key, value in kwargs.iteritems():
125 def add_allowed_name_format(self, name_format):
126 nameidfmt = mdElement(self.role, 'NameIDFormat')
127 nameidfmt.text = name_format
129 def output(self, path=None):
130 data = etree.tostring(self.root, xml_declaration=True,
131 encoding='UTF-8', pretty_print=True)
135 with open(path, 'w') as f:
139 if __name__ == '__main__':
144 tmpdir = tempfile.mkdtemp()
147 # Test IDP generation
148 sign_cert = Certificate(tmpdir)
149 sign_cert.generate('idp-signing-cert', 'idp.ipsilon.example.com')
150 enc_cert = Certificate(tmpdir)
151 enc_cert.generate('idp-encryption-cert', 'idp.ipsilon.example.com')
153 idp.set_entity_id('https://ipsilon.example.com/idp/metadata')
154 idp.set_role(IDP_ROLE)
155 idp.add_certs(sign_cert, enc_cert)
156 idp.add_service(SAML2_SERVICE_MAP['sso-post'],
157 'https://ipsilon.example.com/idp/saml2/POST')
158 idp.add_service(SAML2_SERVICE_MAP['sso-redirect'],
159 'https://ipsilon.example.com/idp/saml2/Redirect')
160 for k in SAML2_NAMEID_MAP:
161 idp.add_allowed_name_format(SAML2_NAMEID_MAP[k])
162 md_file = os.path.join(tmpdir, 'metadata.xml')
164 with open(md_file) as fd:
166 print '==================== IDP ===================='
168 print '============================================='
171 sign_cert = Certificate(tmpdir)
172 sign_cert.generate('sp-signing-cert', 'sp.ipsilon.example.com')
174 sp.set_entity_id('https://ipsilon.example.com/samlsp/metadata')
176 sp.add_certs(sign_cert)
177 sp.add_service(SAML2_SERVICE_MAP['logout-redirect'],
178 'https://ipsilon.example.com/samlsp/logout')
179 sp.add_service(SAML2_SERVICE_MAP['response-post'],
180 'https://ipsilon.example.com/samlsp/postResponse')
181 md_file = os.path.join(tmpdir, 'metadata.xml')
183 with open(md_file) as fd:
185 print '===================== SP ===================='
187 print '============================================='
190 shutil.rmtree(tmpdir)