ipsilon/tools/saml2metadata.py

   1 #!/usr/bin/python
   2 #
   3 # Copyright (C) 2014  Simo Sorce <simo@redhat.com>
   4 #
   5 # see file 'COPYING' for use and warranty information
   6 #
   7 # This program is free software; you can redistribute it and/or modify
   8 # it under the terms of the GNU General Public License as published by
   9 # the Free Software Foundation, either version 3 of the License, or
  10 # (at your option) any later version.
  11 #
  12 # This program is distributed in the hope that it will be useful,
  13 # but WITHOUT ANY WARRANTY; without even the implied warranty of
  14 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15 # GNU General Public License for more details.
  16 #
  17 # You should have received a copy of the GNU General Public License
  18 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
  19
  20 from ipsilon.tools.certs import Certificate
  21 from lxml import etree
  22 import lasso
  23
  24
  25 SAML2_NAMEID_MAP = {
  26     'email': lasso.SAML2_NAME_IDENTIFIER_FORMAT_EMAIL,
  27     'encrypted': lasso.SAML2_NAME_IDENTIFIER_FORMAT_ENCRYPTED,
  28     'entity': lasso.SAML2_NAME_IDENTIFIER_FORMAT_ENTITY,
  29     'kerberos': lasso.SAML2_NAME_IDENTIFIER_FORMAT_KERBEROS,
  30     'persistent': lasso.SAML2_NAME_IDENTIFIER_FORMAT_PERSISTENT,
  31     'transient': lasso.SAML2_NAME_IDENTIFIER_FORMAT_TRANSIENT,
  32     'unspecified': lasso.SAML2_NAME_IDENTIFIER_FORMAT_UNSPECIFIED,
  33     'windows': lasso.SAML2_NAME_IDENTIFIER_FORMAT_WINDOWS,
  34     'x509': lasso.SAML2_NAME_IDENTIFIER_FORMAT_X509,
  35 }
  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 SSO_SERVICE = 'SingleSignOnService'
  51 LOGOUT_SERVICE = 'SingleLogoutService'
  52 ASSERTION_SERVICE = 'AssertionConsumerService'
  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):
  68         self.root = etree.Element(EDESC, nsmap=NSMAP)
  69         self.entityid = None
  70         self.role = None
  71         self.set_role(role)
  72
  73     def set_entity_id(self, url):
  74         self.entityid = url
  75         self.root.set('entityID', url)
  76
  77     def set_role(self, role):
  78         if role is None:
  79             return
  80         elif role == IDP_ROLE:
  81             description = IDPDESC
  82         elif role == SP_ROLE:
  83             description = SPDESC
  84         else:
  85             raise ValueError('invalid role: %s' % role)
  86         self.role = mdElement(self.root, description)
  87         self.role.set('protocolSupportEnumeration', lasso.SAML2_PROTOCOL_HREF)
  88         return self.role
  89
  90     def add_cert(self, certdata, use):
  91         desc = mdElement(self.role, 'KeyDescriptor')
  92         desc.set('use', use)
  93         info = dsElement(desc, 'KeyInfo')
  94         data = dsElement(info, 'X509Data')
  95         cert = dsElement(data, 'X509Certificate')
  96         cert.text = certdata
  97
  98     def add_certs(self, signcert=None, enccert=None):
  99         if signcert:
 100             self.add_cert(signcert.get_cert(), 'signing')
 101         if enccert:
 102             self.add_cert(enccert.get_cert(), 'encryption')
 103
 104     def add_service(self, svctype, binding, location):
 105         svc = mdElement(self.role, svctype)
 106         svc.set('Binding', binding)
 107         svc.set('Location', location)
 108
 109     def add_allowed_name_format(self, name_format):
 110         nameidfmt = mdElement(self.role, 'NameIDFormat')
 111         nameidfmt.text = name_format
 112
 113     def output(self, path):
 114         data = etree.tostring(self.root, xml_declaration=True,
 115                               encoding='UTF-8', pretty_print=True)
 116         with open(path, 'w') as f:
 117             f.write(data)
 118
 119
 120 if __name__ == '__main__':
 121     import tempfile
 122     import shutil
 123     import os
 124
 125     tmpdir = tempfile.mkdtemp()
 126
 127     try:
 128         # Test IDP generation
 129         sign_cert = Certificate(tmpdir)
 130         sign_cert.generate('idp-signing-cert', 'idp.ipsilon.example.com')
 131         enc_cert = Certificate(tmpdir)
 132         enc_cert.generate('idp-encryption-cert', 'idp.ipsilon.example.com')
 133         idp = Metadata()
 134         idp.set_entity_id('https://ipsilon.example.com/idp/metadata')
 135         idp.set_role(IDP_ROLE)
 136         idp.add_certs(sign_cert, enc_cert)
 137         idp.add_service(SSO_SERVICE, lasso.SAML2_METADATA_BINDING_POST,
 138                         'https://ipsilon.example.com/idp/saml2/POST')
 139         idp.add_service(SSO_SERVICE, lasso.SAML2_METADATA_BINDING_REDIRECT,
 140                         'https://ipsilon.example.com/idp/saml2/Redirect')
 141         for k in SAML2_NAMEID_MAP:
 142             idp.add_allowed_name_format(SAML2_NAMEID_MAP[k])
 143         md_file = os.path.join(tmpdir, 'metadata.xml')
 144         idp.output(md_file)
 145         with open(md_file) as fd:
 146             text = fd.read()
 147         print '==================== IDP ===================='
 148         print text
 149         print '============================================='
 150
 151         # Test SP generation
 152         sign_cert = Certificate(tmpdir)
 153         sign_cert.generate('sp-signing-cert', 'sp.ipsilon.example.com')
 154         sp = Metadata()
 155         sp.set_entity_id('https://ipsilon.example.com/samlsp/metadata')
 156         sp.set_role(SP_ROLE)
 157         sp.add_certs(sign_cert)
 158         sp.add_service(LOGOUT_SERVICE, lasso.SAML2_METADATA_BINDING_REDIRECT,
 159                        'https://ipsilon.example.com/samlsp/logout')
 160         sp.add_service(ASSERTION_SERVICE, lasso.SAML2_METADATA_BINDING_POST,
 161                        'https://ipsilon.example.com/samlsp/postResponse')
 162         md_file = os.path.join(tmpdir, 'metadata.xml')
 163         sp.output(md_file)
 164         with open(md_file) as fd:
 165             text = fd.read()
 166         print '===================== SP ===================='
 167         print text
 168         print '============================================='
 169
 170     finally:
 171         shutil.rmtree(tmpdir)