ipsilon/tools/saml2metadata.py

   1 #!/usr/bin/python
   2 #
   3 # Copyright (C) 2014 Ipsilon project Contributors, for license see COPYING
   4
   5 import datetime
   6 from ipsilon.tools.certs import Certificate
   7 from lxml import etree
   8 import lasso
   9
  10
  11 SAML2_NAMEID_MAP = {
  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,
  21 }
  22
  23 SAML2_SERVICE_MAP = {
  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     'slo-soap': ('SingleLogoutService',
  33                  lasso.SAML2_METADATA_BINDING_SOAP),
  34     'response-post': ('AssertionConsumerService',
  35                       lasso.SAML2_METADATA_BINDING_POST)
  36 }
  37
  38 EDESC = '{%s}EntityDescriptor' % lasso.SAML2_METADATA_HREF
  39 NSMAP = {
  40     'md': lasso.SAML2_METADATA_HREF,
  41     'ds': lasso.DS_HREF
  42 }
  43
  44 IDPDESC = 'IDPSSODescriptor'
  45 SPDESC = 'SPSSODescriptor'
  46
  47 IDP_ROLE = 'idp'
  48 SP_ROLE = 'sp'
  49
  50
  51 # Expire metadata weekly by default
  52 MIN_EXP_DEFAULT = 7
  53
  54
  55 def mdElement(_parent, _tag, **kwargs):
  56     tag = '{%s}%s' % (lasso.SAML2_METADATA_HREF, _tag)
  57     return etree.SubElement(_parent, tag, **kwargs)
  58
  59
  60 def dsElement(_parent, _tag, **kwargs):
  61     tag = '{%s}%s' % (lasso.DS_HREF, _tag)
  62     return etree.SubElement(_parent, tag, **kwargs)
  63
  64
  65 class Metadata(object):
  66
  67     def __init__(self, role=None, expiration=None):
  68         self.root = etree.Element(EDESC, nsmap=NSMAP)
  69         self.entityid = None
  70         self.role = None
  71         self.set_role(role)
  72         self.set_expiration(expiration)
  73
  74     def set_entity_id(self, url):
  75         self.entityid = url
  76         self.root.set('entityID', url)
  77
  78     def set_role(self, role):
  79         if role is None:
  80             return
  81         elif role == IDP_ROLE:
  82             description = IDPDESC
  83         elif role == SP_ROLE:
  84             description = SPDESC
  85         else:
  86             raise ValueError('invalid role: %s' % role)
  87         self.role = mdElement(self.root, description)
  88         self.role.set('protocolSupportEnumeration', lasso.SAML2_PROTOCOL_HREF)
  89         return self.role
  90
  91     def set_expiration(self, exp):
  92         if exp is None:
  93             self.root.set('cacheDuration', "P%dD" % (MIN_EXP_DEFAULT))
  94             return
  95         elif isinstance(exp, datetime.date):
  96             d = datetime.datetime.combine(exp, datetime.date.min.time())
  97         elif isinstance(exp, datetime.datetime):
  98             d = exp
  99         elif isinstance(exp, datetime.timedelta):
 100             d = datetime.datetime.utcnow() + exp
 101         else:
 102             raise TypeError('Invalid expiration date type')
 103
 104         self.root.set('validUntil', d.isoformat() + 'Z')
 105
 106     def add_cert(self, certdata, use):
 107         desc = mdElement(self.role, 'KeyDescriptor')
 108         desc.set('use', use)
 109         info = dsElement(desc, 'KeyInfo')
 110         data = dsElement(info, 'X509Data')
 111         cert = dsElement(data, 'X509Certificate')
 112         cert.text = certdata
 113
 114     def add_certs(self, signcert=None, enccert=None):
 115         if signcert:
 116             self.add_cert(signcert.get_cert(), 'signing')
 117         if enccert:
 118             self.add_cert(enccert.get_cert(), 'encryption')
 119
 120     def add_service(self, service, location, **kwargs):
 121         svc = mdElement(self.role, service[0])
 122         svc.set('Binding', service[1])
 123         svc.set('Location', location)
 124         for key, value in kwargs.iteritems():
 125             svc.set(key, value)
 126
 127     def add_allowed_name_format(self, name_format):
 128         nameidfmt = mdElement(self.role, 'NameIDFormat')
 129         nameidfmt.text = name_format
 130
 131     def output(self, path=None):
 132         data = etree.tostring(self.root, xml_declaration=True,
 133                               encoding='UTF-8', pretty_print=True)
 134         if path is None:
 135             return data
 136         else:
 137             with open(path, 'w') as f:
 138                 f.write(data)
 139
 140
 141 if __name__ == '__main__':
 142     import tempfile
 143     import shutil
 144     import os
 145
 146     tmpdir = tempfile.mkdtemp()
 147
 148     try:
 149         # Test IDP generation
 150         sign_cert = Certificate(tmpdir)
 151         sign_cert.generate('idp-signing-cert', 'idp.ipsilon.example.com')
 152         enc_cert = Certificate(tmpdir)
 153         enc_cert.generate('idp-encryption-cert', 'idp.ipsilon.example.com')
 154         idp = Metadata()
 155         idp.set_entity_id('https://ipsilon.example.com/idp/metadata')
 156         idp.set_role(IDP_ROLE)
 157         idp.add_certs(sign_cert, enc_cert)
 158         idp.add_service(SAML2_SERVICE_MAP['sso-post'],
 159                         'https://ipsilon.example.com/idp/saml2/POST')
 160         idp.add_service(SAML2_SERVICE_MAP['sso-redirect'],
 161                         'https://ipsilon.example.com/idp/saml2/Redirect')
 162         for k in SAML2_NAMEID_MAP:
 163             idp.add_allowed_name_format(SAML2_NAMEID_MAP[k])
 164         md_file = os.path.join(tmpdir, 'metadata.xml')
 165         idp.output(md_file)
 166         with open(md_file) as fd:
 167             text = fd.read()
 168         print '==================== IDP ===================='
 169         print text
 170         print '============================================='
 171
 172         # Test SP generation
 173         sign_cert = Certificate(tmpdir)
 174         sign_cert.generate('sp-signing-cert', 'sp.ipsilon.example.com')
 175         sp = Metadata()
 176         sp.set_entity_id('https://ipsilon.example.com/samlsp/metadata')
 177         sp.set_role(SP_ROLE)
 178         sp.add_certs(sign_cert)
 179         sp.add_service(SAML2_SERVICE_MAP['logout-redirect'],
 180                        'https://ipsilon.example.com/samlsp/logout')
 181         sp.add_service(SAML2_SERVICE_MAP['response-post'],
 182                        'https://ipsilon.example.com/samlsp/postResponse')
 183         md_file = os.path.join(tmpdir, 'metadata.xml')
 184         sp.output(md_file)
 185         with open(md_file) as fd:
 186             text = fd.read()
 187         print '===================== SP ===================='
 188         print text
 189         print '============================================='
 190
 191     finally:
 192         shutil.rmtree(tmpdir)