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     'response-post': ('AssertionConsumerService',
  33                       lasso.SAML2_METADATA_BINDING_POST)
  34 }
  35
  36 EDESC = '{%s}EntityDescriptor' % lasso.SAML2_METADATA_HREF
  37 NSMAP = {
  38     'md': lasso.SAML2_METADATA_HREF,
  39     'ds': lasso.DS_HREF
  40 }
  41
  42 IDPDESC = 'IDPSSODescriptor'
  43 SPDESC = 'SPSSODescriptor'
  44
  45 IDP_ROLE = 'idp'
  46 SP_ROLE = 'sp'
  47
  48
  49 # Expire metadata weekly by default
  50 MIN_EXP_DEFAULT = 7
  51
  52
  53 def mdElement(_parent, _tag, **kwargs):
  54     tag = '{%s}%s' % (lasso.SAML2_METADATA_HREF, _tag)
  55     return etree.SubElement(_parent, tag, **kwargs)
  56
  57
  58 def dsElement(_parent, _tag, **kwargs):
  59     tag = '{%s}%s' % (lasso.DS_HREF, _tag)
  60     return etree.SubElement(_parent, tag, **kwargs)
  61
  62
  63 class Metadata(object):
  64
  65     def __init__(self, role=None, expiration=None):
  66         self.root = etree.Element(EDESC, nsmap=NSMAP)
  67         self.entityid = None
  68         self.role = None
  69         self.set_role(role)
  70         self.set_expiration(expiration)
  71
  72     def set_entity_id(self, url):
  73         self.entityid = url
  74         self.root.set('entityID', url)
  75
  76     def set_role(self, role):
  77         if role is None:
  78             return
  79         elif role == IDP_ROLE:
  80             description = IDPDESC
  81         elif role == SP_ROLE:
  82             description = SPDESC
  83         else:
  84             raise ValueError('invalid role: %s' % role)
  85         self.role = mdElement(self.root, description)
  86         self.role.set('protocolSupportEnumeration', lasso.SAML2_PROTOCOL_HREF)
  87         return self.role
  88
  89     def set_expiration(self, exp):
  90         if exp is None:
  91             self.root.set('cacheDuration', "P%dD" % (MIN_EXP_DEFAULT))
  92             return
  93         elif isinstance(exp, datetime.date):
  94             d = datetime.datetime.combine(exp, datetime.date.min.time())
  95         elif isinstance(exp, datetime.datetime):
  96             d = exp
  97         elif isinstance(exp, datetime.timedelta):
  98             d = datetime.datetime.now() + exp
  99         else:
 100             raise TypeError('Invalid expiration date type')
 101
 102         self.root.set('validUntil', d.isoformat())
 103
 104     def add_cert(self, certdata, use):
 105         desc = mdElement(self.role, 'KeyDescriptor')
 106         desc.set('use', use)
 107         info = dsElement(desc, 'KeyInfo')
 108         data = dsElement(info, 'X509Data')
 109         cert = dsElement(data, 'X509Certificate')
 110         cert.text = certdata
 111
 112     def add_certs(self, signcert=None, enccert=None):
 113         if signcert:
 114             self.add_cert(signcert.get_cert(), 'signing')
 115         if enccert:
 116             self.add_cert(enccert.get_cert(), 'encryption')
 117
 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():
 123             svc.set(key, value)
 124
 125     def add_allowed_name_format(self, name_format):
 126         nameidfmt = mdElement(self.role, 'NameIDFormat')
 127         nameidfmt.text = name_format
 128
 129     def output(self, path=None):
 130         data = etree.tostring(self.root, xml_declaration=True,
 131                               encoding='UTF-8', pretty_print=True)
 132         if path is None:
 133             return data
 134         else:
 135             with open(path, 'w') as f:
 136                 f.write(data)
 137
 138
 139 if __name__ == '__main__':
 140     import tempfile
 141     import shutil
 142     import os
 143
 144     tmpdir = tempfile.mkdtemp()
 145
 146     try:
 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')
 152         idp = Metadata()
 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')
 163         idp.output(md_file)
 164         with open(md_file) as fd:
 165             text = fd.read()
 166         print '==================== IDP ===================='
 167         print text
 168         print '============================================='
 169
 170         # Test SP generation
 171         sign_cert = Certificate(tmpdir)
 172         sign_cert.generate('sp-signing-cert', 'sp.ipsilon.example.com')
 173         sp = Metadata()
 174         sp.set_entity_id('https://ipsilon.example.com/samlsp/metadata')
 175         sp.set_role(SP_ROLE)
 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')
 182         sp.output(md_file)
 183         with open(md_file) as fd:
 184             text = fd.read()
 185         print '===================== SP ===================='
 186         print text
 187         print '============================================='
 188
 189     finally:
 190         shutil.rmtree(tmpdir)