source: TI12-security/trunk/python/Tests/Echo/wsSecurity.py @ 1747

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

server/SessionMgr/* - Session Manager server side WS interface - wsdl2dispatch
generated + Twisted .tac file.
www/html/sessionMgr.wsdl: updated to doc/lit style + added disconnect operation.
common/SessionMgr: common package for wsdl2py generated files required by
client and server.
Tests/Echo?/wsSecurity.py: include test for verify boolean in verify method!

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