source: TI12-security/trunk/python/Tests/SimpleCA/wsSecurity.py @ 2909

Subversion URL: http://proj.badc.rl.ac.uk/svn/ndg/TI12-security/trunk/python/Tests/SimpleCA/wsSecurity.py@2909
Revision 2909, 34.8 KB checked in by pjkersha, 12 years ago (diff)

Updated for epydoc: added double underscore vars module info

  • Property svn:executable set to *
RevLine 
[1532]1#!/bin/env python
2
3"""WS-Security test class includes digital signature handler
4
5NERC Data Grid Project
6
7P J Kershaw 01/09/06
8
[2909]9Copyright (C) 2006 STFC & NERC
[1532]10
11This software may be distributed under the terms of the Q Public License,
12version 1.0 or later.
13"""
14
[2270]15__revision__ = '$Id$'
[1532]16
17import re
18
19# Digest and signature/verify
20from sha import sha
21from M2Crypto import X509, BIO, RSA
22import base64
23
24# For shared key encryption
25from Crypto.Cipher import AES, DES3
26import os
27
28import ZSI
29from ZSI.wstools.Namespaces import DSIG, ENCRYPTION, OASIS, WSU, WSA200403, \
30                                   SOAP, SCHEMA # last included for xsi
31                                   
32from ZSI.TC import ElementDeclaration,TypeDefinition
33from ZSI.generate.pyclass import pyclass_type
34
35from ZSI.wstools.Utility import DOMException, SplitQName
36from ZSI.wstools.Utility import NamespaceError, MessageInterface, ElementProxy
37
38# XML Parsing
39from cStringIO import StringIO
40from Ft.Xml.Domlette import NonvalidatingReaderBase, NonvalidatingReader
41from Ft.Xml import XPath
42
43# Canonicalization
44from ZSI.wstools.c14n import Canonicalize
45from xml.dom import Node
46from xml.xpath.Context import Context
47from xml import xpath
48
49# Include for re-parsing doc ready for canonicalization in sign method - see
50# associated note
51from xml.dom.ext.reader.PyExpat import Reader
52
53
54class _ENCRYPTION(ENCRYPTION):
55    '''Derived from ENCRYPTION class to add in extra 'tripledes-cbc' - is this
56    any different to 'des-cbc'?  ENCRYPTION class implies that it is the same
57    because it's assigned to 'BLOCK_3DES' ??'''
58    BLOCK_TRIPLEDES = "http://www.w3.org/2001/04/xmlenc#tripledes-cbc"
59
[1618]60class _WSU(WSU):
61    '''Try different utility namespace for use with WebSphere'''
62    #UTILITY = "http://schemas.xmlsoap.org/ws/2003/06/utility"
63    UTILITY = "http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd"
64   
[1532]65def getElements(node, nameList):
66    '''DOM Helper function for getting child elements from a given node'''
67    # Avoid sub-string matches
68    nameList = isinstance(nameList, basestring) and [nameList] or nameList
69    return [n for n in node.childNodes if str(n.localName) in nameList]
70
71
72class VerifyError(Exception):
73    """Raised from SignatureHandler.verify if signature is invalid"""
74
75class SignatureError(Exception):
76    """Flag if an error occurs during signature generation"""
77       
78class SignatureHandler(object):
79   
80    def __init__(self,
81                 certFilePath=None, 
82                 priKeyFilePath=None, 
83                 priKeyPwd=None):
84       
85        self.__certFilePath = certFilePath
86        self.__priKeyFilePath = priKeyFilePath
87        self.__priKeyPwd = priKeyPwd
88
89
90    def sign(self, soapWriter):
91        '''Sign the message body and binary security token of a SOAP message
92        '''
93        # Add X.509 cert as binary security token
94        x509Cert = X509.load_cert(self.__certFilePath)
95       
96        x509CertPat = re.compile(\
97            '-----BEGIN CERTIFICATE-----\n?(.*?)\n?-----END CERTIFICATE-----',
98            re.S)
99        x509CertStr = x509CertPat.findall(x509Cert.as_pem())[0]
100
101        soapWriter._header.setNamespaceAttribute('wsse', OASIS.WSSE)
[1618]102        soapWriter._header.setNamespaceAttribute('wsu', _WSU.UTILITY)
[1532]103        soapWriter._header.setNamespaceAttribute('ds', DSIG.BASE)
[1663]104        soapWriter._header.setNamespaceAttribute('ec', DSIG.C14N_EXCL)
[1532]105       
106        # TODO: Put in a check to make sure <wsse:security> isn't already
107        # present in header
108        wsseElem = soapWriter._header.createAppendElement(OASIS.WSSE, 
109                                                         'Security')
110        wsseElem.setNamespaceAttribute('wsse', OASIS.WSSE)
111        wsseElem.node.setAttribute('SOAP-ENV:mustUnderstand', "1")
112       
113        binSecTokElem = wsseElem.createAppendElement(OASIS.WSSE, 
114                                                     'BinarySecurityToken')
[1618]115#        binSecTokElem.node.setAttribute('ValueType', "wsse:X509v3")
116        valueType = "http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-x509-token-profile-1.0#X509"
117        binSecTokElem.node.setAttribute('ValueType', valueType)
118#        binSecTokElem.node.setAttribute('EncodingType', "wsse:Base64Binary")
119        encodingType = "http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-soap-message-security-1.0#Base64Binary"
120        binSecTokElem.node.setAttribute('EncodingType', encodingType)
[1532]121       
122        # Add ID so that the binary token can be included in the signature
[1663]123        binSecTokElem.node.setAttribute('wsu:Id', "binaryToken")
[1532]124
125        binSecTokElem.createAppendTextNode(x509CertStr)
126
127       
128        # Signature
129        signatureElem = wsseElem.createAppendElement(DSIG.BASE, 'Signature')
130        signatureElem.setNamespaceAttribute('ds', DSIG.BASE)
131       
132        # Signature - Signed Info
133        signedInfoElem = signatureElem.createAppendElement(DSIG.BASE, 
134                                                           'SignedInfo')
135       
136        # Signed Info - Canonicalization method
[1663]137        signedInfoC14nKw = {}
138        signedInfoC14nKw['unsuppressedPrefixes'] = ['xsi', 'xsd', 'SOAP-ENV', 'ds', 'wsse']
[1532]139        c14nMethodElem = signedInfoElem.createAppendElement(DSIG.BASE,
140                                                    'CanonicalizationMethod')
[1663]141        c14nMethodElem.node.setAttribute('Algorithm', DSIG.C14N_EXCL)
142        c14nInclNamespacesElem = c14nMethodElem.createAppendElement(\
143                                                DSIG.C14N_EXCL,
144                                                'InclusiveNamespaces')
145        c14nInclNamespacesElem.node.setAttribute('PrefixList', 
146                        ' '.join(signedInfoC14nKw['unsuppressedPrefixes']))
[1532]147       
148        # Signed Info - Signature method
149        sigMethodElem = signedInfoElem.createAppendElement(DSIG.BASE,
150                                                    'SignatureMethod')
[1618]151        #sigMethodElem.node.setAttribute('Algorithm', DSIG.DIGEST_SHA1)
152        sigMethodElem.node.setAttribute('Algorithm', DSIG.SIG_RSA_SHA1)
[1532]153       
154        # Signature - Signature value
155        signatureValueElem = signatureElem.createAppendElement(DSIG.BASE, 
156                                                             'SignatureValue')
157       
158        # Key Info
159        KeyInfoElem = signatureElem.createAppendElement(DSIG.BASE, 'KeyInfo')
160        secTokRefElem = KeyInfoElem.createAppendElement(OASIS.WSSE, 
161                                                  'SecurityTokenReference')
162       
163        # Reference back to the binary token included earlier
164        wsseRefElem = secTokRefElem.createAppendElement(OASIS.WSSE, 
165                                                        'Reference')
166        wsseRefElem.node.setAttribute('URI', "#binaryToken")
167       
168        # Add Reference to body so that it can be included in the signature
169        soapWriter.body.node.setAttribute('wsu:Id', "body")
[1618]170        soapWriter.body.node.setAttribute('xmlns:wsu', _WSU.UTILITY)
[1532]171
172        # Serialize and re-parse prior to reference generation - calculating
173        # canonicalization based on soapWriter.dom.node seems to give an
174        # error: the order of wsu:Id attribute is not correct
175        docNode = Reader().fromString(str(soapWriter))
176       
177        # Namespaces for XPath searches
178        processorNss = \
179        {
180            'ds':     DSIG.BASE, 
[1618]181            'wsu':    _WSU.UTILITY, 
[1532]182            'wsse':   OASIS.WSSE, 
183            'soapenv':"http://schemas.xmlsoap.org/soap/envelope/" 
184        }
185        ctxt = Context(docNode, processorNss=processorNss)
186        idNodes = xpath.Evaluate('//*[@wsu:Id]', 
187                                 contextNode=docNode, 
188                                 context=ctxt)
[1663]189       
190        # Leave out token
191        idNodes = [idNodes[1]]
192
[1532]193        # 1) Reference Generation
194        #
195        # Find references
[1663]196        c14nKw = {}
197        c14nKw['unsuppressedPrefixes'] = ['xmlns', 'xsi', 'xsd', 'SOAP-ENV', 'wsu', 'wsse', 'ns1']
[1532]198        for idNode in idNodes:
199           
200            # Set URI attribute to point to reference to be signed
201            #uri = u"#" + idNode.getAttribute('wsu:Id')
[1618]202            uri = u"#" + idNode.attributes[(_WSU.UTILITY, 'Id')].value
[1532]203           
204            # Canonicalize reference
[1663]205            c14nRef = Canonicalize(idNode, **c14nKw)
[1532]206           
207            # Calculate digest for reference and base 64 encode
208            #
209            # Nb. encodestring adds a trailing newline char
210            digestValue = base64.encodestring(sha(c14nRef).digest()).strip()
211
212
213            # Add a new reference element to SignedInfo
214            refElem = signedInfoElem.createAppendElement(DSIG.BASE, 
215                                                         'Reference')
216            refElem.node.setAttribute('URI', uri)
217           
218            # Use ds:Transforms or wsse:TransformationParameters?
[1663]219            transformsElem = refElem.createAppendElement(DSIG.BASE, 
220                                                        'Transforms')
221            transformElem = transformsElem.createAppendElement(DSIG.BASE, 
222                                                               'Transform')
[1618]223#            transformElem.node.setAttribute('Algorithm', DSIG.C14N)
[1663]224            transformElem.node.setAttribute('Algorithm', DSIG.C14N_EXCL)
225
226            inclNamespacesElem = transformElem.createAppendElement(\
227                                                        DSIG.C14N_EXCL,
228                                                       'InclusiveNamespaces')
229            inclNamespacesElem.node.setAttribute('PrefixList',
230                                ' '.join(c14nKw['unsuppressedPrefixes']))
[1532]231           
232            # Digest Method
233            digestMethodElem = refElem.createAppendElement(DSIG.BASE, 
234                                                           'DigestMethod')
235            digestMethodElem.node.setAttribute('Algorithm', DSIG.DIGEST_SHA1)
236           
237            # Digest Value
238            digestValueElem = refElem.createAppendElement(DSIG.BASE, 
239                                                          'DigestValue')
240            digestValueElem.createAppendTextNode(digestValue)
241
242   
243        # 2) Signature Generation
244        #
245
246        # Test against signature generated by pyXMLSec version
247        #xmlTxt = open('./wsseSign-xmlsec-res.xml').read()
248        #dom = NonvalidatingReader.parseStream(StringIO(xmlTxt))
249       
250        # Canonicalize the signedInfo node
251        #
252        # Nb. When extracted the code adds the namespace attribute to the
253        # signedInfo!  This has important consequences for validation -
254        #
255        # 1) Do you strip the namespace attribute before taking the digest to
256        # ensure the text is exactly the same as what is displayed in the
257        # message?
258        #
259        # 2) Leave it in and assume the validation algorithm will expect to
260        # add in the namespace attribute?!
261        #
262        # http://www.w3.org/TR/xml-c14n#NoNSPrefixRewriting implies you need
263        # to include namespace declarations for namespaces referenced in a doc
264        # subset - yes to 2)
[1663]265        #c14nSignedInfo = signedInfoElem.canonicalize()
266        c14nSignedInfo = Canonicalize(signedInfoElem.node, **signedInfoC14nKw)
[1532]267
268        # Calculate digest of SignedInfo
269        signedInfoDigestValue = sha(c14nSignedInfo).digest().strip()
270       
271        # Read Private key to sign with   
272        priKeyFile = BIO.File(open(self.__priKeyFilePath))                                           
273        priKey = RSA.load_key_bio(priKeyFile, 
274                                  callback=lambda *ar, **kw: self.__priKeyPwd)
275       
276        # Sign using the private key and base 64 encode the result
277        signatureValue = priKey.sign(signedInfoDigestValue)
278        b64EncSignatureValue = base64.encodestring(signatureValue).strip()
279
280        # Add to <SignatureValue>
281        signatureValueElem.createAppendTextNode(b64EncSignatureValue)
282       
283        # Extract RSA public key from the cert
284        rsaPubKey = x509Cert.get_pubkey().get_rsa()
285       
286        # Check the signature
287#        verify = bool(rsaPubKey.verify(signedInfoDigestValue, signatureValue))
288#       
289#        open('soap.xml', 'w').write(str(soapWriter))
290#        import pdb;pdb.set_trace()
291        print "Signature Generated"
[1663]292        print str(soapWriter)
[1532]293
294
295    def verify(self, parsedSOAP):
296        """Verify signature"""
[1649]297       
[1532]298        processorNss = \
299        {
300            'ds':     DSIG.BASE, 
[1618]301            'wsu':    _WSU.UTILITY, 
[1532]302            'wsse':   OASIS.WSSE, 
303            'soapenv':"http://schemas.xmlsoap.org/soap/envelope/" 
304        }
305        ctxt = Context(parsedSOAP.dom, processorNss=processorNss)
306       
307
308        signatureNodes = xpath.Evaluate('//ds:Signature', 
309                                        contextNode=parsedSOAP.dom, 
310                                        context=ctxt)
311        if len(signatureNodes) > 1:
312            raise VerifyError, 'Multiple ds:Signature elements found'
313       
314        try:
315            signatureNodes = signatureNodes[0]
316        except:
317            # Message wasn't signed
318            return
319       
320        # Two stage process: reference validation followed by signature
321        # validation
322       
[1618]323        # 1) Reference Validation
324       
325        # Check for canonicalization set via ds:CanonicalizationMethod -
326        # Use this later as a back up in case no Canonicalization was set in
327        # the transforms elements
328        c14nMethodNode = xpath.Evaluate('//ds:CanonicalizationMethod', 
329                                  contextNode=parsedSOAP.dom, 
330                                  context=ctxt)[0]
331       
[1532]332        refNodes = xpath.Evaluate('//ds:Reference', 
333                                  contextNode=parsedSOAP.dom, 
334                                  context=ctxt)
335           
336        for refNode in refNodes:
337            # Get the URI for the reference
338            refURI = refNode.getAttributeNodeNS(None, 'URI').value
339                           
[1618]340            try:
341                transformsNode = getElements(refNode, "Transforms")[0]
342                transforms = getElements(transformsNode, "Transform")
[1532]343   
[1663]344                refAlgorithm = transforms[0].getAttributeNodeNS(None, 
[1532]345                                                         "Algorithm").value
[1618]346            except Exception, e:
[1663]347                raise VerifyError, \
348            'failed to get transform algorithm for <ds:Reference URI="%s">'%\
349                        (refURI, str(e))
[1618]350               
[1532]351            # Add extra keyword for Exclusive canonicalization method
[1649]352            c14nKw = {}
[1663]353            if refAlgorithm == DSIG.C14N_EXCL:
[1532]354                try:
[1649]355                    inclusiveNS = getElements(transforms[0], 
356                                              "InclusiveNamespaces")
357                   
358                    pfxListAttNode = inclusiveNS[0].getAttributeNodeNS(None, 
359                                                               'PrefixList')
360                    c14nKw['unsuppressedPrefixes'] = \
361                                                pfxListAttNode.value.split()
[1532]362                except:
363                    raise VerifyError, \
364                'failed to handle transform (%s) in <ds:Reference URI="%s">'%\
[1663]365                        (transforms[0], refURI)
[1532]366       
367            # Canonicalize the reference data and calculate the digest
368            if refURI[0] != "#":
369                raise VerifyError, \
370                    "Expecting # identifier for Reference URI \"%s\"" % refURI
371                   
372            # XPath reference
373            uriXPath = '//*[@wsu:Id="%s"]' % refURI[1:]
374            uriNode = xpath.Evaluate(uriXPath, 
375                                     contextNode=parsedSOAP.dom, 
376                                     context=ctxt)[0]
377
[1649]378            c14nRef = Canonicalize(uriNode, **c14nKw)
[1532]379            digestValue = base64.encodestring(sha(c14nRef).digest()).strip()
380           
381            # Extract the digest value that was stored           
382            digestNode = getElements(refNode, "DigestValue")[0]
383            nodeDigestValue = str(digestNode.childNodes[0].nodeValue).strip()   
384           
385            # Reference validates if the two digest values are the same
386            if digestValue != nodeDigestValue:
[1649]387                raise VerifyError, \
388                        'Digest Values do not match for URI: "%s"' % refURI
[1532]389               
390        # 2) Signature Validation
391        signedInfoNode = xpath.Evaluate('//ds:SignedInfo',
392                                        contextNode=parsedSOAP.dom, 
393                                        context=ctxt)[0]
394
[1663]395        import pdb;pdb.set_trace()
396        # Get algorithm used for canonicalization of the SignedInfo
397        # element.  Nb. This is NOT necessarily the same as that used to
398        # canonicalize the reference elements checked above!
399        signedInfoC14nAlg = c14nMethodNode.getAttributeNodeNS(None, 
400                                                         "Algorithm").value
401        signedInfoC14nKw = {}
402        if signedInfoC14nAlg == DSIG.C14N_EXCL:
403            try:
404                inclusiveNS = getElements(c14nMethodNode,
405                                          "InclusiveNamespaces")
[1532]406               
[1663]407                pfxListAttNode = inclusiveNS[0].getAttributeNodeNS(None, 
408                                                           'PrefixList')
409                signedInfoC14nKw['unsuppressedPrefixes'] = \
410                                            pfxListAttNode.value.split()
411            except Exception, e:
412                raise VerifyError, \
413            'failed to handle exclusive canonicalisation for SignedInfo: %s' %\
414                        str(e)
415
[1532]416        # Canonicalize the SignedInfo node and take digest
[1663]417        c14nSignedInfo = Canonicalize(signedInfoNode, **signedInfoC14nKw)       
[1532]418        signedInfoDigestValue = sha(c14nSignedInfo).digest()
419       
420        # Get the signature value in order to check against the digest just
421        # calculated
422        signatureValueNode = xpath.Evaluate('//ds:SignatureValue',
423                                            contextNode=parsedSOAP.dom, 
424                                            context=ctxt)[0]
425
426        # Remove base 64 encoding
427        b64EncSignatureValue = \
428                    str(signatureValueNode.childNodes[0].nodeValue).strip()
429                   
430        signatureValue = base64.decodestring(b64EncSignatureValue)
431
432
[1663]433        # Look for X.509 Cert in wsse:BinarySecurityToken node
434        try:
435            binSecTokNode = xpath.Evaluate('//wsse:BinarySecurityToken',
436                                           contextNode=parsedSOAP.dom,
437                                           context=ctxt)[0]
438            x509str = binSecTokNode.childNodes[0]._get_nodeValue()
439            x509strAlt = ''
440            i = 0
441            while i < len(x509str):
442                x509strAlt += "%s\n" % x509str[i:i+64]
443                i += 64
444   
445            raise Exception, "Try reading from file"
446            x509Cert = X509.load_cert_string(x509strAlt)
447        except:
448            # If not, check cert file   
449            x509Cert = X509.load_cert(self.__certFilePath)
[1532]450       
451        # Extract RSA public key from the cert
452        rsaPubKey = x509Cert.get_pubkey().get_rsa()
453       
454        # Apply the signature verification
455        try:
456            verify = bool(rsaPubKey.verify(signedInfoDigestValue, 
457                                           signatureValue))
458        except RSA.RSAError:
459            raise VerifyError, "Invalid Signature"
460       
[1618]461#        import pdb;pdb.set_trace()
[1532]462        print "Signature OK"
463
464
465class EncryptionError(Exception):
466    """Flags an error in the encryption process"""
467
468class DecryptionError(Exception):
469    """Raised from EncryptionHandler.decrypt if an error occurs with the
470    decryption process"""
471
472
473class EncryptionHandler(object):
474    """Encrypt/Decrypt SOAP messages using WS-Security""" 
475   
476    # Map namespace URIs to Crypto algorithm module and mode
477    cryptoAlg = \
478    {
479         _ENCRYPTION.WRAP_AES256:      {'module':       AES, 
480                                        'mode':         AES.MODE_ECB,
481                                        'blockSize':    16},
482         
483         # CBC (Cipher Block Chaining) modes
484         _ENCRYPTION.BLOCK_AES256:     {'module':       AES, 
485                                        'mode':         AES.MODE_CBC,
486                                        'blockSize':    16},
487                                       
488         _ENCRYPTION.BLOCK_TRIPLEDES:  {'module':       DES3, 
489                                        'mode':         DES3.MODE_CBC,
490                                        'blockSize':    8}   
491    }
492
493     
494    def __init__(self,
495                 certFilePath=None, 
496                 priKeyFilePath=None, 
497                 priKeyPwd=None,
498                 chkSecurityTokRef=False,
499                 encrNS=_ENCRYPTION.BLOCK_AES256):
500       
501        self.__certFilePath = certFilePath
502        self.__priKeyFilePath = priKeyFilePath
503        self.__priKeyPwd = priKeyPwd
504       
505        self.__chkSecurityTokRef = chkSecurityTokRef
506       
507        # Algorithm for shared key encryption
508        try:
509            self.__encrAlg = self.cryptoAlg[encrNS]
510           
511        except KeyError:
512            raise EncryptionError, \
513        'Input encryption algorithm namespace "%s" is not supported' % encrNS
514
515        self.__encrNS = encrNS
516       
517       
518    def encrypt(self, soapWriter):
519        """Encrypt an outbound SOAP message
520       
521        Use Key Wrapping - message is encrypted using a shared key which
522        itself is encrypted with the public key provided by the X.509 cert.
523        certFilePath"""
524       
525        # Use X.509 Cert to encrypt
526        x509Cert = X509.load_cert(self.__certFilePath)
527       
528        soapWriter.dom.setNamespaceAttribute('wsse', OASIS.WSSE)
529        soapWriter.dom.setNamespaceAttribute('xenc', _ENCRYPTION.BASE)
530        soapWriter.dom.setNamespaceAttribute('ds', DSIG.BASE)
531       
532        # TODO: Put in a check to make sure <wsse:security> isn't already
533        # present in header
534        wsseElem = soapWriter._header.createAppendElement(OASIS.WSSE, 
535                                                         'Security')
536        wsseElem.node.setAttribute('SOAP-ENV:mustUnderstand', "1")
537       
538        encrKeyElem = wsseElem.createAppendElement(_ENCRYPTION.BASE, 
539                                                   'EncryptedKey')
540       
541        # Encryption method used to encrypt the shared key
542        keyEncrMethodElem = encrKeyElem.createAppendElement(_ENCRYPTION.BASE, 
543                                                        'EncryptionMethod')
544       
545        keyEncrMethodElem.node.setAttribute('Algorithm', 
546                                            _ENCRYPTION.KT_RSA_1_5)
547
548
549        # Key Info
550        KeyInfoElem = encrKeyElem.createAppendElement(DSIG.BASE, 'KeyInfo')
551       
552        secTokRefElem = KeyInfoElem.createAppendElement(OASIS.WSSE, 
553                                                  'SecurityTokenReference')
554       
555        x509IssSerialElem = secTokRefElem.createAppendElement(DSIG.BASE, 
556                                                          'X509IssuerSerial')
557
558       
559        x509IssNameElem = x509IssSerialElem.createAppendElement(DSIG.BASE, 
560                                                          'X509IssuerName')
561        x509IssNameElem.createAppendTextNode(x509Cert.get_issuer().as_text())
562
563       
564        x509IssSerialNumElem = x509IssSerialElem.createAppendElement(
565                                                  DSIG.BASE, 
566                                                  'X509IssuerSerialNumber')
567       
568        x509IssSerialNumElem.createAppendTextNode(
569                                          str(x509Cert.get_serial_number()))
570
571        # References to what has been encrypted
572        encrKeyCiphDataElem = encrKeyElem.createAppendElement(
573                                                          _ENCRYPTION.BASE,
574                                                          'CipherData')
575       
576        encrKeyCiphValElem = encrKeyCiphDataElem.createAppendElement(
577                                                          _ENCRYPTION.BASE,
578                                                          'CipherValue')
579
580        # References to what has been encrypted
581        refListElem = encrKeyElem.createAppendElement(_ENCRYPTION.BASE,
582                                                      'ReferenceList')
583       
584        dataRefElem = refListElem.createAppendElement(_ENCRYPTION.BASE,
585                                                      'DataReference')
586        dataRefElem.node.setAttribute('URI', "#encrypted")
587
588                     
589        # Add Encrypted data to SOAP body
590        encrDataElem = soapWriter.body.createAppendElement(_ENCRYPTION.BASE, 
591                                                           'EncryptedData')
592        encrDataElem.node.setAttribute('Id', 'encrypted')
593        encrDataElem.node.setAttribute('Type', _ENCRYPTION.BASE) 
594             
595        # Encryption method used to encrypt the target data
596        dataEncrMethodElem = encrDataElem.createAppendElement(
597                                                      _ENCRYPTION.BASE, 
598                                                      'EncryptionMethod')
599       
600        dataEncrMethodElem.node.setAttribute('Algorithm', self.__encrNS)
601       
602        # Cipher data
603        ciphDataElem = encrDataElem.createAppendElement(_ENCRYPTION.BASE,
604                                                        'CipherData')
605       
606        ciphValueElem = ciphDataElem.createAppendElement(_ENCRYPTION.BASE,
607                                                         'CipherValue')
608
609
610        # Get elements from SOAP body for encryption
611        dataElem = soapWriter.body.node.childNodes[0]
612        data = dataElem.toxml()
613     
614        # Pad data to nearest multiple of encryption algorithm's block size   
615        modData = len(data) % self.__encrAlg['blockSize']
616        nPad = modData and self.__encrAlg['blockSize'] - modData or 0
617       
618        # PAd with random junk but ...
619        data += os.urandom(nPad-1)
620       
621        # Last byte should be number of padding bytes
622        # (http://www.w3.org/TR/xmlenc-core/#sec-Alg-Block)
623        data += chr(nPad)       
624       
625        # Generate shared key and input vector - for testing use hard-coded
626        # values to allow later comparison             
627        sharedKey = os.urandom(self.__encrAlg['blockSize'])
628        iv = os.urandom(self.__encrAlg['blockSize'])
629       
630        alg = self.__encrAlg['module'].new(sharedKey,
631                                           self.__encrAlg['mode'],
632                                           iv)
633 
634        # Encrypt required elements - prepend input vector
635        encryptedData = alg.encrypt(iv + data)
636        dataCiphValue = base64.encodestring(encryptedData).strip()
637
638        ciphValueElem.createAppendTextNode(dataCiphValue)
639       
640       
641        # ! Delete unencrypted message body elements !
642        soapWriter.body.node.removeChild(dataElem)
643
644       
645        # Use X.509 cert public key to encrypt the shared key - Extract key
646        # from the cert
647        rsaPubKey = x509Cert.get_pubkey().get_rsa()
648       
649        # Encrypt the shared key
650        encryptedSharedKey = rsaPubKey.public_encrypt(sharedKey, 
651                                                      RSA.pkcs1_padding)
652       
653        encrKeyCiphVal = base64.encodestring(encryptedSharedKey).strip()
654       
655        # Add the encrypted shared key to the EncryptedKey section in the SOAP
656        # header
657        encrKeyCiphValElem.createAppendTextNode(encrKeyCiphVal)
658
[1618]659#        print soapWriter.dom.node.toprettyxml()
660#        import pdb;pdb.set_trace()
[1532]661       
662       
663    def decrypt(self, parsedSOAP):
664        """Decrypt an inbound SOAP message"""
665       
666        processorNss = \
667        {
668            'xenc':   _ENCRYPTION.BASE,
669            'ds':     DSIG.BASE, 
[1618]670            'wsu':    _WSU.UTILITY, 
[1532]671            'wsse':   OASIS.WSSE, 
672            'soapenv':"http://schemas.xmlsoap.org/soap/envelope/" 
673        }
674        ctxt = Context(parsedSOAP.dom, processorNss=processorNss)
675       
676        refListNodes = xpath.Evaluate('//xenc:ReferenceList', 
677                                      contextNode=parsedSOAP.dom, 
678                                      context=ctxt)
679        if len(refListNodes) > 1:
680            raise DecryptionError, 'Expecting a single ReferenceList element'
681       
682        try:
683            refListNode = refListNodes[0]
684        except:
685            # Message wasn't encrypted - is this OK or is a check needed for
686            # encryption info in SOAP body - enveloped form?
687            return
688
689
690        # Check for wrapped key encryption
691        encrKeyNodes = xpath.Evaluate('//xenc:EncryptedKey', 
692                                      contextNode=parsedSOAP.dom, 
693                                      context=ctxt)
694        if len(encrKeyNodes) > 1:
695            raise DecryptionError, 'This implementation can only handle ' + \
696                                   'single EncryptedKey element'
697       
698        try:
699            encrKeyNode = encrKeyNodes[0]
700        except:
701            # Shared key encryption used - leave out for the moment
702            raise DecryptionError, 'This implementation can only handle ' + \
703                                   'wrapped key encryption'
704
705       
706        # Check encryption method
707        keyEncrMethodNode = getElements(encrKeyNode, 'EncryptionMethod')[0]     
708        keyAlgorithm = keyEncrMethodNode.getAttributeNodeNS(None, 
709                                                            "Algorithm").value
710        if keyAlgorithm != _ENCRYPTION.KT_RSA_1_5:
711            raise DecryptionError, \
712            'Encryption algorithm for wrapped key is "%s", expecting "%s"' % \
713                (keyAlgorithm, _ENCRYPTION.KT_RSA_1_5)
714
715                                                           
716        if self.__chkSecurityTokRef and self.__certFilePath:
717             
718            # Check input cert. against SecurityTokenReference
719            securityTokRefXPath = '/ds:KeyInfo/wsse:SecurityTokenReference'
720            securityTokRefNode = xpath.Evaluate(securityTokRefXPath, 
721                                                contextNode=encrKeyNode, 
722                                                context=ctxt)
723            # TODO: Look for ds:X509* elements to check against X.509 cert
724            # input
725
726
727        # Look for cipher data for wrapped key
728        keyCiphDataNode = getElements(encrKeyNode, 'CipherData')[0]
729        keyCiphValNode = getElements(keyCiphDataNode, 'CipherValue')[0]
730
731        keyCiphVal = str(keyCiphValNode.childNodes[0].nodeValue)
732        encryptedKey = base64.decodestring(keyCiphVal)
733
734        # Read RSA Private key in order to decrypt wrapped key 
735        priKeyFile = BIO.File(open(self.__priKeyFilePath))                                           
736        priKey = RSA.load_key_bio(priKeyFile, 
737                                  callback=lambda *ar, **kw: self.__priKeyPwd)
738       
739        sharedKey = priKey.private_decrypt(encryptedKey, RSA.pkcs1_padding)
740       
741
742        # Check list of data elements that have been encrypted
743        for dataRefNode in refListNode.childNodes:
744
745            # Get the URI for the reference
746            dataRefURI = dataRefNode.getAttributeNodeNS(None, 'URI').value                           
747            if dataRefURI[0] != "#":
748                raise VerifyError, \
749                    "Expecting # identifier for DataReference URI \"%s\"" % \
750                    dataRefURI
751
752            # XPath reference - need to check for wsu namespace qualified?
753            #encrNodeXPath = '//*[@wsu:Id="%s"]' % dataRefURI[1:]
754            encrNodeXPath = '//*[@Id="%s"]' % dataRefURI[1:]
755            encrNode = xpath.Evaluate(encrNodeXPath, 
756                                      contextNode=parsedSOAP.dom, 
757                                      context=ctxt)[0]
758               
759            dataEncrMethodNode = getElements(encrNode, 'EncryptionMethod')[0]     
760            dataAlgorithm = dataEncrMethodNode.getAttributeNodeNS(None, 
761                                                            "Algorithm").value
762            try:       
763                # Match algorithm name to Crypto module
764                CryptoAlg = self.cryptoAlg[dataAlgorithm]
765               
766            except KeyError:
767                raise DecryptionError, \
768'Encryption algorithm for data is "%s", supported algorithms are:\n "%s"' % \
769                    (keyAlgorithm, "\n".join(self.cryptoAlg.keys()))
770
771            # Get Data
772            dataCiphDataNode = getElements(encrNode, 'CipherData')[0]
773            dataCiphValNode = getElements(dataCiphDataNode, 'CipherValue')[0]
774       
775            dataCiphVal = str(dataCiphValNode.childNodes[0].nodeValue)
776            encryptedData = base64.decodestring(dataCiphVal)
777           
778            alg = CryptoAlg['module'].new(sharedKey, CryptoAlg['mode'])
779            decryptedData = alg.decrypt(encryptedData)
780           
781            # Strip prefix - assume is block size
782            decryptedData = decryptedData[CryptoAlg['blockSize']:]
783           
784            # Strip any padding suffix - Last byte should be number of padding
785            # bytes
786            # (http://www.w3.org/TR/xmlenc-core/#sec-Alg-Block)
787            lastChar = decryptedData[-1]
788            nPad = ord(lastChar)
789           
790            # Sanity check - there may be no padding at all - the last byte
791            # being the end of the encrypted XML?
792            #
793            # TODO: are there better sanity checks than this?!
794            if nPad < CryptoAlg['blockSize'] and nPad > 0 and \
795               lastChar != '\n' and lastChar != '>':
796               
797                # Follow http://www.w3.org/TR/xmlenc-core/#sec-Alg-Block -
798                # last byte gives number of padding bytes
799                decryptedData = decryptedData[:-nPad]
800
801
802            # Parse the encrypted data - inherit from Reader as a fudge to
803            # enable relevant namespaces to be added prior to parse
[1618]804            processorNss.update({'xsi': SCHEMA.XSI3, 'ns1': 'urn:ZSI:examples'})
[1532]805            class _Reader(Reader):
806                def initState(self, ownerDoc=None):
807                    Reader.initState(self, ownerDoc=ownerDoc)
808                    self._namespaces.update(processorNss)
809                   
810            rdr = _Reader()
811            dataNode = rdr.fromString(decryptedData, ownerDoc=parsedSOAP.dom)
812           
813            # Add decrypted element to parent and remove encrypted one
814            parentNode = encrNode._get_parentNode()
815            parentNode.appendChild(dataNode)
816            parentNode.removeChild(encrNode)
817           
818            from xml.dom.ext import ReleaseNode
819            ReleaseNode(encrNode)
820           
821            # Ensure body_root attribute is up to date in case it was
822            # previously encrypted
823            parsedSOAP.body_root = parsedSOAP.body.childNodes[0]
824            print decryptedData
[1618]825            #import pdb;pdb.set_trace()
[1532]826           
827
828
829       
830if __name__ == "__main__":
831    import sys
832    txt = None
833   
834    e = EncryptionHandler(certFilePath='../../Junk-cert.pem',
835                          priKeyFilePath='../../Junk-key.pem',
836                          priKeyPwd=open('../../tmp2').read().strip())
837   
838    encryptedData = e.encrypt(None)
839    print e.decrypt(None, encryptedData)
[1663]840   
Note: See TracBrowser for help on using the repository browser.