source: TI12-security/trunk/python/ndg.security.common/ndg/security/common/wsSecurity.py @ 2322

Subversion URL: http://proj.badc.rl.ac.uk/svn/ndg/TI12-security/trunk/python/ndg.security.common/ndg/security/common/wsSecurity.py@2322
Revision 2322, 49.6 KB checked in by pjkersha, 14 years ago (diff)

Tests/SecurityCGItest.py moved to unittest package ndg.security.test/ndg/security/test

Tests/dewsBinaryDataGet/binaryDataGet.py and Tests/dewsBinaryDataGet/binaryDataServe.py: tests for DEWS trying
out digital signature of a GET URI to authenticate a client for transfer of large binary data sets.

  • 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
7@author P J Kershaw 01/09/06
8
9@copyright (C) 2006 CCLRC & NERC
10
11@license This software may be distributed under the terms of the Q Public
12License, version 1.0 or later.
13"""
14
15__revision__ = '$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
36from ZSI.wstools.Utility import NamespaceError, MessageInterface, ElementProxy
37
38# Canonicalization
39from ZSI.wstools.c14n import Canonicalize
40
41from xml.dom import Node
42from xml.xpath.Context import Context
43from xml import xpath
44
45# Include for re-parsing doc ready for canonicalization in sign method - see
46# associated note
47from xml.dom.ext.reader.PyExpat import Reader
48
49
50from ndg.security.common.X509 import X509Cert, X509CertParse, X509CertRead
51
52
53class _ENCRYPTION(ENCRYPTION):
54    '''Derived from ENCRYPTION class to add in extra 'tripledes-cbc' - is this
55    any different to 'des-cbc'?  ENCRYPTION class implies that it is the same
56    because it's assigned to 'BLOCK_3DES' ??'''
57    BLOCK_TRIPLEDES = "http://www.w3.org/2001/04/xmlenc#tripledes-cbc"
58
59class _WSU(WSU):
60    '''Try different utility namespace for use with WebSphere'''
61    #UTILITY = "http://schemas.xmlsoap.org/ws/2003/06/utility"
62    UTILITY = "http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd"
63   
64def getElements(node, nameList):
65    '''DOM Helper function for getting child elements from a given node'''
66    # Avoid sub-string matches
67    nameList = isinstance(nameList, basestring) and [nameList] or nameList
68    return [n for n in node.childNodes if str(n.localName) in nameList]
69
70
71class VerifyError(Exception):
72    """Raised from SignatureHandler.verify if an error occurs in the signature
73    verification"""
74   
75class InvalidSignature(Exception):
76    """Raised from verify method for an invalid signature"""
77
78class SignatureError(Exception):
79    """Flag if an error occurs during signature generation"""
80       
81class SignatureHandler(object):
82    """class to handle signature and verification of signature with
83    WS-Security
84   
85    @type __beginCert: string
86    @param __beginCert: delimiter for beginning of base64 encoded portion of
87    a PEM encoded X.509 certificate
88    @type __endCert: string
89    @cvar: __endCert: equivalent end delimiter
90   
91    @type __x509CertPat: regular expression pattern object
92    @cvar __x509CertPat: regular expression for extracting the base64 encoded
93    portion of a PEM encoded X.509 certificate"""
94   
95    __beginCert = '-----BEGIN CERTIFICATE-----\n'
96    __endCert = '\n-----END CERTIFICATE-----'
97    __x509CertPat = re.compile(__beginCert + \
98                               '?(.*?)\n?-----END CERTIFICATE-----',
99                               re.S)
100   
101   
102    #_________________________________________________________________________
103    def __init__(self,
104                 verifyingCert=None,
105                 verifyingCertFilePath=None,
106                 signingCert=None,
107                 signingCertFilePath=None, 
108                 signingPriKey=None,
109                 signingPriKeyFilePath=None, 
110                 signingPriKeyPwd=None,
111                 refC14nKw={'unsuppressedPrefixes': ['xmlns', 
112                                                  'xsi', 
113                                                  'xsd', 
114                                                  'SOAP-ENV', 
115                                                  'wsu', 
116                                                  'wsse', 
117                                                  'ns1']},
118                # Added 'ec' to list P J Kershaw 01/02/07
119                signedInfoC14nKw = {'unsuppressedPrefixes': ['xsi', 
120                                                             'xsd', 
121                                                             'SOAP-ENV', 
122                                                             'ds', 
123                                                             'wsse', 
124                                                             'ec']}):
125
126        # Set keywords for canonicalization of SignedInfo and reference
127        # elements
128        self.__setRefC14nKw(refC14nKw)
129        self.__setSignedInfoC14nKw(signedInfoC14nKw)
130           
131
132        self.__setVerifyingCert(verifyingCert)
133        self.__setVerifyingCertFilePath(verifyingCertFilePath)
134       
135        self.__setSigningCert(signingCert)
136        self.__setSigningCertFilePath(signingCertFilePath)
137
138        # MUST be set before __setSigningPriKeyFilePath / __setSigningPriKey
139        # are called
140        self.__setSigningPriKeyPwd(signingPriKeyPwd)
141       
142        if signingPriKey is not None:
143            # Don't allow None for private key setting
144            self.__setSigningPriKey(signingPriKey)
145           
146        self.__setSigningPriKeyFilePath(signingPriKeyFilePath)
147       
148
149    #_________________________________________________________________________
150    def __checkC14nKw(self, Kw):
151        """Check keywords for canonicalization in signing process - generic
152        method for setting keywords for reference element and SignedInfo
153        element c14n"""
154       
155        # Check for dict/None - Set to None in order to use inclusive
156        # canonicalization
157        if Kw is not None and not isinstance(Kw, dict):
158            # Otherwise keywords must be a dictionary
159            raise AttributeError, \
160                "Expecting dictionary type for reference c14n keywords"
161               
162        elif Kw.get('unsuppressedPrefixes') and \
163             not isinstance(Kw['unsuppressedPrefixes'], list) and \
164             not isinstance(Kw['unsuppressedPrefixes'], tuple):
165            raise AttributeError, \
166                'Expecting list or tuple of prefix names for "%s" keyword' % \
167                'unsuppressedPrefixes'
168       
169               
170    #_________________________________________________________________________
171    def __setRefC14nKw(self, Kw):
172        """Set keywords for canonicalization of reference elements in the
173        signing process"""
174        self.__checkC14nKw(Kw)                   
175        self.__refC14nKw = Kw
176       
177    refC14nKw = property(fset=__setRefC14nKw,
178                         doc="Keywords for c14n of reference elements")
179       
180               
181    #_________________________________________________________________________
182    def __setSignedInfoC14nKw(self, Kw):
183        """Set keywords for canonicalization of SignedInfo element in the
184        signing process"""
185        self.__checkC14nKw(Kw)                   
186        self.__signedInfoC14nKw = Kw
187       
188    signedInfoC14nKw = property(fset=__setSignedInfoC14nKw,
189                                doc="Keywords for c14n of SignedInfo element")
190
191
192    #_________________________________________________________________________
193    def __refC14nIsExcl(self):
194        return isinstance(self.__refC14nKw, dict) and \
195               self.__refC14nKw.get('unsuppressedPrefixes') and \
196               len(self.__refC14nKw['unsuppressedPrefixes']) > 0
197               
198    refC14nIsExcl = property(fget=__refC14nIsExcl,
199    doc="Return True/False c14n for reference elements set to exclusive type")
200     
201
202    #_________________________________________________________________________
203    def __signedInfoC14nIsExcl(self):
204        return isinstance(self.__signedInfoC14nKw, dict) and \
205               self.__signedInfoC14nKw.get('unsuppressedPrefixes') and \
206               len(self.__signedInfoC14nKw['unsuppressedPrefixes']) > 0
207               
208    signedInfoC14nIsExcl = property(fget=__signedInfoC14nIsExcl,
209    doc="Return True/False c14n for SignedInfo element set to exclusive type")
210   
211   
212    #_________________________________________________________________________
213    def __setCert(self, cert):
214        """filter and convert input cert to signing verifying cert set
215        property methods.  For signingCert, set to None if it is not to be
216        included in the SOAP header.  For verifyingCert, set to None if this
217        cert can be expected to be retrieved from the SOAP header of the
218        message to be verified
219       
220        @type: ndg.security.common.X509.X509Cert / M2Crypto.X509.X509 /
221        string or None
222        @param cert: X.509 certificate. 
223       
224        @rtype ndg.security.common.X509.X509Cert
225        @return X.509 certificate object"""
226       
227        if cert is None or isinstance(cert, X509Cert):
228            # ndg.security.common.X509.X509Cert type / None
229            return cert
230           
231        elif isinstance(cert, X509.X509):
232            # M2Crypto.X509.X509 type
233            return X509Cert(m2CryptoX509=cert)
234           
235        elif isinstance(cert, basestring):
236            return X509CertParse(cert)
237       
238        else:
239            raise AttributeError, "X.509 Cert. must be type: " + \
240                "ndg.security.common.X509.X509Cert, M2Crypto.X509.X509 or " +\
241                "a base64 encoded string"
242
243   
244    #_________________________________________________________________________
245    def __getVerifyingCert(self):
246        '''Return X.509 cert object corresponding to cert used to verify the
247        signature in the last call to verify
248       
249         * Cert will correspond to one used in the LATEST call to verify, on
250         the next call it will be replaced
251         * if verify hasn't been called, the cert will be None
252       
253        @rtype: M2Crypto.X509.X509
254        @return: certificate object
255        '''
256        return self.__verifyingCert
257
258
259    #_________________________________________________________________________
260    def __setVerifyingCert(self, verifyingCert):
261        "Set property method for X.509 cert. used to verify a signature"
262        self.__verifyingCert = self.__setCert(verifyingCert)
263   
264        # Reset file path as it may no longer apply
265        self.__verifyingCertFilePath = None
266       
267    verifyingCert = property(fset=__setVerifyingCert,
268                             fget=__getVerifyingCert,
269                             doc="Set X.509 Cert. for verifying signature")
270
271
272    #_________________________________________________________________________
273    def __setVerifyingCertFilePath(self, verifyingCertFilePath):
274        "Set method for Service X.509 cert. file path property"
275       
276        if isinstance(verifyingCertFilePath, basestring):
277            self.__verifyingCert = X509CertRead(verifyingCertFilePath)
278           
279        elif verifyingCertFilePath is not None:
280            raise AttributeError, \
281            "Verifying X.509 Cert. file path must be None or a valid string"
282       
283        self.__verifyingCertFilePath = verifyingCertFilePath
284       
285    verifyingCertFilePath = property(fset=__setVerifyingCertFilePath,
286                    doc="file path of X.509 Cert. for verifying signature")
287
288
289    #_________________________________________________________________________
290    def __setSigningCert(self, signingCert):
291        "Set property method for X.509 cert. to be included with signature"
292        self.__signingCert = self.__setCert(signingCert)
293   
294        # Reset file path as it may no longer apply
295        self.__signingCertFilePath = None
296       
297    signingCert = property(fset=__setSigningCert,
298                             doc="Set X.509 Cert. to include signature")
299
300 
301    #_________________________________________________________________________
302    def __setSigningCertFilePath(self, signingCertFilePath):
303        "Set signature X.509 cert property method"
304       
305        if isinstance(signingCertFilePath, basestring):
306            self.__signingCert = X509CertRead(signingCertFilePath)
307           
308        elif signingCertFilePath is not None:
309            raise AttributeError, \
310                "Signature X.509 cert. file path must be a valid string"
311       
312        self.__signingCertFilePath = signingCertFilePath
313       
314       
315    signingCertFilePath = property(fset=__setSigningCertFilePath,
316                   doc="File path X.509 cert. to include with signed message")
317
318 
319    #_________________________________________________________________________
320    def __setSigningPriKeyPwd(self, signingPriKeyPwd):
321        "Set method for private key file password used to sign message"
322        if signingPriKeyPwd is not None and \
323           not isinstance(signingPriKeyPwd, basestring):
324            raise AttributeError, \
325                "Signing private key password must be None or a valid string"
326       
327        self.__signingPriKeyPwd = signingPriKeyPwd
328       
329    signingPriKeyPwd = property(fset=__setSigningPriKeyPwd,
330             doc="Password protecting private key file used to sign message")
331
332 
333    #_________________________________________________________________________
334    def __setSigningPriKey(self, signingPriKey):
335        """Set method for client private key
336       
337        Nb. if input is a string, signingPriKeyPwd will need to be set if
338        the key is password protected.
339       
340        @type signingPriKey: M2Crypto.RSA.RSA / string
341        @param signingPriKey: private key used to sign message"""
342       
343        if isinstance(signingPriKey, basestring):
344            pwdCallback = lambda *ar, **kw: self.__signingPriKeyPwd
345            self.__signingPriKey = RSA.load_key_string(signingPriKey,
346                                                       callback=pwdCallback)
347
348        elif isinstance(signingPriKey, RSA.RSA):
349            self.__signingPriKey = signingPriKey
350                   
351        else:
352            raise AttributeError, "Signing private key must be a valid " + \
353                                  "M2Crypto.RSA.RSA type or a string"
354               
355    signingPriKey = property(fset=__setSigningPriKey,
356                             doc="Private key used to sign outbound message")
357
358 
359    #_________________________________________________________________________
360    def __setSigningPriKeyFilePath(self, signingPriKeyFilePath):
361        """Set method for client private key file path
362       
363        signingPriKeyPwd MUST be set prior to a call to this method"""
364        if isinstance(signingPriKeyFilePath, basestring):                           
365            try:
366                # Read Private key to sign with   
367                priKeyFile = BIO.File(open(signingPriKeyFilePath)) 
368                pwdCallback = lambda *ar, **kw: self.__signingPriKeyPwd                                           
369                self.__signingPriKey = RSA.load_key_bio(priKeyFile, 
370                                                        callback=pwdCallback)           
371            except Exception, e:
372                raise AttributeError, \
373                                "Setting private key for signature: %s" % e
374       
375        elif signingPriKeyFilePath is not None:
376            raise AttributeError, \
377                        "Private key file path must be a valid string or None"
378       
379        self.__signingPriKeyFilePath = signingPriKeyFilePath
380       
381    signingPriKeyFilePath = property(fset=__setSigningPriKeyFilePath,
382                      doc="File path for private key used to sign message")
383
384
385    #_________________________________________________________________________
386    def sign(self, soapWriter):
387        '''Sign the message body and binary security token of a SOAP message
388       
389        @type soapWriter: ZSI.writer.SoapWriter
390        @param soapWriter: ZSI object to write SOAP message
391        '''
392       
393        # Namespaces for XPath searches
394        processorNss = \
395        {
396            'ds':     DSIG.BASE, 
397            'wsu':    _WSU.UTILITY, 
398            'wsse':   OASIS.WSSE, 
399            'soapenv':"http://schemas.xmlsoap.org/soap/envelope/" 
400        }
401
402        # Add X.509 cert as binary security token stripping BEGIN CERT and
403        # END CERT delimiters
404        x509CertStr = self.__class__.__x509CertPat.findall(\
405                                           self.__signingCert.toString())[0]
406
407        soapWriter._header.setNamespaceAttribute('wsse', OASIS.WSSE)
408        soapWriter._header.setNamespaceAttribute('wsu', _WSU.UTILITY)
409        soapWriter._header.setNamespaceAttribute('ds', DSIG.BASE)
410       
411        if self.refC14nIsExcl or self.signedInfoC14nIsExcl:
412            soapWriter._header.setNamespaceAttribute('ec', DSIG.C14N_EXCL)
413       
414        # Check <wsse:security> isn't already present in header
415        ctxt = Context(soapWriter.dom.node, processorNss=processorNss)
416        wsseNodes = xpath.Evaluate('//wsse:security', 
417                                   contextNode=soapWriter.dom.node, 
418                                   context=ctxt)
419        if len(wsseNodes) > 1:
420            raise SignatureError, 'wsse:Security element is already present'
421
422        # Add WSSE element
423        wsseElem = soapWriter._header.createAppendElement(OASIS.WSSE, 
424                                                         'Security')
425        wsseElem.setNamespaceAttribute('wsse', OASIS.WSSE)
426       
427        # Recipient MUST parse and check this signature
428        wsseElem.node.setAttribute('SOAP-ENV:mustUnderstand', "1")
429       
430        # Binary Security Token element will contain the X.509 cert
431        # corresponding to the private key used to sing the message
432        binSecTokElem = wsseElem.createAppendElement(OASIS.WSSE, 
433                                                     'BinarySecurityToken')
434       
435        # Value and encoding types to suite WebSphere WSSE implementation
436        valueType = \
437"http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-x509-token-profile-1.0#X509"
438        binSecTokElem.node.setAttribute('ValueType', valueType)
439
440        encodingType = \
441"http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-soap-message-security-1.0#Base64Binary"
442        binSecTokElem.node.setAttribute('EncodingType', encodingType)
443       
444        # Add ID so that the binary token can be included in the signature
445        binSecTokElem.node.setAttribute('wsu:Id', "binaryToken")
446
447        binSecTokElem.createAppendTextNode(x509CertStr)
448
449       
450        # Signature
451        signatureElem = wsseElem.createAppendElement(DSIG.BASE, 'Signature')
452        signatureElem.setNamespaceAttribute('ds', DSIG.BASE)
453       
454        # Signature - Signed Info
455        signedInfoElem = signatureElem.createAppendElement(DSIG.BASE, 
456                                                           'SignedInfo')
457       
458        # Signed Info - Canonicalization method
459        c14nMethodElem = signedInfoElem.createAppendElement(DSIG.BASE,
460                                                    'CanonicalizationMethod')
461       
462        # Set based on 'signedInfoIsExcl' property
463        c14nAlgOpt = (DSIG.C14N, DSIG.C14N_EXCL)
464        signedInfoC14nAlg = c14nAlgOpt[self.signedInfoC14nIsExcl]
465       
466        c14nMethodElem.node.setAttribute('Algorithm', signedInfoC14nAlg)
467       
468        if self.signedInfoC14nIsExcl:
469            c14nInclNamespacesElem = c14nMethodElem.createAppendElement(\
470                                                    signedInfoC14nAlg,
471                                                    'InclusiveNamespaces')
472            c14nInclNamespacesElem.node.setAttribute('PrefixList', 
473                            ' '.join(self.__signedInfoC14nKw['unsuppressedPrefixes']))
474       
475        # Signed Info - Signature method
476        sigMethodElem = signedInfoElem.createAppendElement(DSIG.BASE,
477                                                           'SignatureMethod')
478        sigMethodElem.node.setAttribute('Algorithm', DSIG.SIG_RSA_SHA1)
479       
480        # Signature - Signature value
481        signatureValueElem = signatureElem.createAppendElement(DSIG.BASE, 
482                                                             'SignatureValue')
483       
484        # Key Info
485        KeyInfoElem = signatureElem.createAppendElement(DSIG.BASE, 'KeyInfo')
486        secTokRefElem = KeyInfoElem.createAppendElement(OASIS.WSSE, 
487                                                  'SecurityTokenReference')
488       
489        # Reference back to the binary token included earlier
490        wsseRefElem = secTokRefElem.createAppendElement(OASIS.WSSE, 
491                                                        'Reference')
492        wsseRefElem.node.setAttribute('URI', "#binaryToken")
493       
494        # Add Reference to body so that it can be included in the signature
495        soapWriter.body.node.setAttribute('wsu:Id', "body")
496        soapWriter.body.node.setAttribute('xmlns:wsu', _WSU.UTILITY)
497
498        # Serialize and re-parse prior to reference generation - calculating
499        # canonicalization based on soapWriter.dom.node seems to give an
500        # error: the order of wsu:Id attribute is not correct
501        docNode = Reader().fromString(str(soapWriter))
502        ctxt = Context(docNode, processorNss=processorNss)
503        refNodes = xpath.Evaluate('//*[@wsu:Id]', 
504                                  contextNode=docNode, 
505                                  context=ctxt)
506       
507        # Set based on 'signedInfoIsExcl' property
508        refC14nAlg = c14nAlgOpt[self.refC14nIsExcl]
509       
510        # 1) Reference Generation
511        #
512        # Find references
513        for refNode in refNodes:
514           
515            # Set URI attribute to point to reference to be signed
516            #uri = u"#" + refNode.getAttribute('wsu:Id')
517            uri = u"#" + refNode.attributes[(_WSU.UTILITY, 'Id')].value
518           
519            # Canonicalize reference
520            refC14n = Canonicalize(refNode, **self.__refC14nKw)
521           
522            # Calculate digest for reference and base 64 encode
523            #
524            # Nb. encodestring adds a trailing newline char
525            digestValue = base64.encodestring(sha(refC14n).digest()).strip()
526
527
528            # Add a new reference element to SignedInfo
529            refElem = signedInfoElem.createAppendElement(DSIG.BASE, 
530                                                         'Reference')
531            refElem.node.setAttribute('URI', uri)
532           
533            # Use ds:Transforms or wsse:TransformationParameters?
534            transformsElem = refElem.createAppendElement(DSIG.BASE, 
535                                                        'Transforms')
536            transformElem = transformsElem.createAppendElement(DSIG.BASE, 
537                                                               'Transform')
538
539            # Set Canonicalization algorithm type
540            transformElem.node.setAttribute('Algorithm', refC14nAlg)
541            if self.refC14nIsExcl:
542                # Exclusive C14N requires inclusive namespace elements
543                inclNamespacesElem = transformElem.createAppendElement(\
544                                                                                   refC14nAlg,
545                                                       'InclusiveNamespaces')
546                inclNamespacesElem.node.setAttribute('PrefixList',
547                                        ' '.join(self.__refC14nKw['unsuppressedPrefixes']))
548           
549            # Digest Method
550            digestMethodElem = refElem.createAppendElement(DSIG.BASE, 
551                                                           'DigestMethod')
552            digestMethodElem.node.setAttribute('Algorithm', DSIG.DIGEST_SHA1)
553           
554            # Digest Value
555            digestValueElem = refElem.createAppendElement(DSIG.BASE, 
556                                                          'DigestValue')
557            digestValueElem.createAppendTextNode(digestValue)
558
559   
560        # 2) Signature Generation
561        #       
562        # Canonicalize the signedInfo node
563        c14nSignedInfo = Canonicalize(signedInfoElem.node, 
564                                      **self.__signedInfoC14nKw)
565
566        # Calculate digest of SignedInfo
567        #
568        # TODO: check status for strip call - almost certainly wrong and not
569        # needed
570        signedInfoDigestValue = sha(c14nSignedInfo).digest()#.strip()
571       
572        # Sign using the private key and base 64 encode the result
573        signatureValue = self.__signingPriKey.sign(signedInfoDigestValue)
574        b64EncSignatureValue = base64.encodestring(signatureValue).strip()
575
576        # Add to <SignatureValue>
577        signatureValueElem.createAppendTextNode(b64EncSignatureValue)
578
579
580    def verify(self, parsedSOAP):
581        """Verify signature
582       
583        @type parsedSOAP: ZSI.parse.ParsedSoap
584        @param parsedSOAP: object contain parsed SOAP message received from
585        sender"""
586#        import pdb;pdb.set_trace()
587#        import xml.dom.expatbuilder
588#        parsedSOAP.dom = xml.dom.expatbuilder.parse(\
589#'/home/pjkersha/Development/security/python/Tests/bmtTests/SOAPMessage_21-Mar-2007.txt')
590        processorNss = \
591        {
592            'ds':     DSIG.BASE, 
593            'wsu':    _WSU.UTILITY, 
594            'wsse':   OASIS.WSSE, 
595            'soapenv':"http://schemas.xmlsoap.org/soap/envelope/" 
596        }
597        ctxt = Context(parsedSOAP.dom, processorNss=processorNss)
598       
599
600        signatureNodes = xpath.Evaluate('//ds:Signature', 
601                                        contextNode=parsedSOAP.dom, 
602                                        context=ctxt)
603        if len(signatureNodes) > 1:
604            raise VerifyError, 'Multiple ds:Signature elements found'
605       
606        try:
607            signatureNodes = signatureNodes[0]
608        except:
609            # Message wasn't signed
610            return
611       
612        # Two stage process: reference validation followed by signature
613        # validation
614       
615        # 1) Reference Validation
616       
617        # Check for canonicalization set via ds:CanonicalizationMethod -
618        # Use this later as a back up in case no Canonicalization was set in
619        # the transforms elements
620        c14nMethodNode = xpath.Evaluate('//ds:CanonicalizationMethod', 
621                                        contextNode=parsedSOAP.dom, 
622                                        context=ctxt)[0]
623       
624        refNodes = xpath.Evaluate('//ds:Reference', 
625                                  contextNode=parsedSOAP.dom, 
626                                  context=ctxt)
627
628        for refNode in refNodes:
629            # Get the URI for the reference
630            refURI = refNode.getAttributeNode('URI').value
631                         
632            try:
633                transformsNode = getElements(refNode, "Transforms")[0]
634                transforms = getElements(transformsNode, "Transform")
635   
636                refAlgorithm = \
637                            transforms[0].getAttributeNode("Algorithm").value
638            except Exception, e:
639                raise VerifyError, \
640            'failed to get transform algorithm for <ds:Reference URI="%s">'%\
641                        (refURI, str(e))
642               
643            # Add extra keyword for Exclusive canonicalization method
644            refC14nKw = {}
645            if refAlgorithm == DSIG.C14N_EXCL:
646                try:
647                    inclusiveNS = getElements(transforms[0], 
648                                              "InclusiveNamespaces")
649                   
650                    # Allow for no inclusive namespaces set - this is
651                    # not expected and is likely to cause problems with the
652                    # canonicalization later.
653                    if inclusiveNS:
654                        pfxListAttNode = \
655                                inclusiveNS[0].getAttributeNode('PrefixList')
656                           
657                        refC14nKw['unsuppressedPrefixes'] = \
658                                                pfxListAttNode.value.split()
659                except:
660                    raise VerifyError, \
661                'failed to handle transform (%s) in <ds:Reference URI="%s">'%\
662                        (transforms[0], refURI)
663       
664            # Canonicalize the reference data and calculate the digest
665            if refURI[0] != "#":
666                raise VerifyError, \
667                    "Expecting # identifier for Reference URI \"%s\"" % refURI
668                   
669            # XPath reference
670            uriXPath = '//*[@wsu:Id="%s"]' % refURI[1:]
671            uriNode = xpath.Evaluate(uriXPath, 
672                                     contextNode=parsedSOAP.dom, 
673                                     context=ctxt)[0]
674
675            refC14n = Canonicalize(uriNode, **refC14nKw)
676            digestValue = base64.encodestring(sha(refC14n).digest()).strip()
677           
678            # Extract the digest value that was stored           
679            digestNode = getElements(refNode, "DigestValue")[0]
680            nodeDigestValue = str(digestNode.childNodes[0].nodeValue).strip()   
681           
682            # Reference validates if the two digest values are the same
683            if digestValue != nodeDigestValue:
684                raise InvalidSignature, \
685                        'Digest Values do not match for URI: "%s"' % refURI
686               
687        # 2) Signature Validation
688        signedInfoNode = xpath.Evaluate('//ds:SignedInfo',
689                                        contextNode=parsedSOAP.dom, 
690                                        context=ctxt)[0]
691
692        # Get algorithm used for canonicalization of the SignedInfo
693        # element.  Nb. This is NOT necessarily the same as that used to
694        # canonicalize the reference elements checked above!
695        signedInfoC14nAlg = c14nMethodNode.getAttributeNode("Algorithm").value
696        signedInfoC14nKw = {}
697        if signedInfoC14nAlg == DSIG.C14N_EXCL:
698            try:
699                # Allow for no inclusive namespaces set - this is
700                # not expected and is likely to cause problems with the
701                # canonicalization later.
702                if inclusiveNS:
703                    inclusiveNS = getElements(c14nMethodNode,
704                                              "InclusiveNamespaces")
705                   
706                    pfxListAttNode = inclusiveNS[0].getAttributeNode(\
707                                                                 'PrefixList')
708                    signedInfoC14nKw['unsuppressedPrefixes'] = \
709                                                pfxListAttNode.value.split()
710                                                     
711            except Exception, e:
712                raise VerifyError, \
713            'failed to handle exclusive canonicalisation for SignedInfo: %s'%\
714                        str(e)
715
716        # Canonicalize the SignedInfo node and take digest
717        c14nSignedInfo = Canonicalize(signedInfoNode, **signedInfoC14nKw) 
718               
719        # TODO: strip() call? - almost certainly wrong - leave out!       
720        signedInfoDigestValue = sha(c14nSignedInfo).digest()#.strip()
721       
722        # Get the signature value in order to check against the digest just
723        # calculated
724        signatureValueNode = xpath.Evaluate('//ds:SignatureValue',
725                                            contextNode=parsedSOAP.dom, 
726                                            context=ctxt)[0]
727
728        # Remove base 64 encoding
729        b64EncSignatureValue = \
730                    str(signatureValueNode.childNodes[0].nodeValue).strip()
731       
732        signatureValue = base64.decodestring(b64EncSignatureValue)
733
734
735        # Look for X.509 Cert in wsse:BinarySecurityToken node
736        try:
737            binSecTokNode = xpath.Evaluate('//wsse:BinarySecurityToken',
738                                           contextNode=parsedSOAP.dom,
739                                           context=ctxt)[0]
740        except:
741            # Signature may not have included the Binary Security Token in
742            # which case the verifying cert will need to have been set
743            # elsewhere
744            binSecTokNode = None
745            pass 
746       
747        #import pdb;pdb.set_trace()       
748        if binSecTokNode:
749            try:
750                x509CertTxt=str(binSecTokNode.childNodes[0]._get_nodeValue())
751               
752                # Convert parsed cert text into form that can be read
753                # by X.509 string parser
754                if x509CertTxt[64] != "\n":
755                    # Expecting cert split into lines of length 64 bytes
756                    x509CertSpl = re.split('(.{64})', x509CertTxt)
757                    x509CertTxt = '\n'.join([i for i in x509CertSpl if i])
758                   
759                b64EncX509Cert = self.__class__.__beginCert + x509CertTxt + \
760                         self.__class__.__endCert
761                             
762                self.__setVerifyingCert(b64EncX509Cert)
763            except Exception, e:
764                raise VerifyError, "Error extracting BinarySecurityToken " + \
765                                   "from WSSE header: " + str(e)
766
767        if self.__verifyingCert is None:
768            raise VerifyError, "No certificate set for verification " + \
769                "of the signature"
770       
771        # Extract RSA public key from the cert
772        rsaPubKey = self.__verifyingCert.m2CryptoX509.get_pubkey().get_rsa()
773       
774        # Apply the signature verification
775        try:
776            verify = rsaPubKey.verify(signedInfoDigestValue, signatureValue)
777        except RSA.RSAError, e:
778            raise VerifyError, "Error in Signature: " + str(e)
779       
780        if not verify:
781            raise InvalidSignature, "Invalid signature"
782       
783        #print "Signature OK"
784
785
786class EncryptionError(Exception):
787    """Flags an error in the encryption process"""
788
789class DecryptionError(Exception):
790    """Raised from EncryptionHandler.decrypt if an error occurs with the
791    decryption process"""
792
793
794class EncryptionHandler(object):
795    """Encrypt/Decrypt SOAP messages using WS-Security""" 
796   
797    # Map namespace URIs to Crypto algorithm module and mode
798    cryptoAlg = \
799    {
800         _ENCRYPTION.WRAP_AES256:      {'module':       AES, 
801                                        'mode':         AES.MODE_ECB,
802                                        'blockSize':    16},
803         
804         # CBC (Cipher Block Chaining) modes
805         _ENCRYPTION.BLOCK_AES256:     {'module':       AES, 
806                                        'mode':         AES.MODE_CBC,
807                                        'blockSize':    16},
808                                       
809         _ENCRYPTION.BLOCK_TRIPLEDES:  {'module':       DES3, 
810                                        'mode':         DES3.MODE_CBC,
811                                        'blockSize':    8}   
812    }
813
814     
815    def __init__(self,
816                 signingCertFilePath=None, 
817                 signingPriKeyFilePath=None, 
818                 signingPriKeyPwd=None,
819                 chkSecurityTokRef=False,
820                 encrNS=_ENCRYPTION.BLOCK_AES256):
821       
822        self.__signingCertFilePath = signingCertFilePath
823        self.__signingPriKeyFilePath = signingPriKeyFilePath
824        self.__signingPriKeyPwd = signingPriKeyPwd
825       
826        self.__chkSecurityTokRef = chkSecurityTokRef
827       
828        # Algorithm for shared key encryption
829        try:
830            self.__encrAlg = self.cryptoAlg[encrNS]
831           
832        except KeyError:
833            raise EncryptionError, \
834        'Input encryption algorithm namespace "%s" is not supported' % encrNS
835
836        self.__encrNS = encrNS
837       
838       
839    def encrypt(self, soapWriter):
840        """Encrypt an outbound SOAP message
841       
842        Use Key Wrapping - message is encrypted using a shared key which
843        itself is encrypted with the public key provided by the X.509 cert.
844        signingCertFilePath"""
845       
846        # Use X.509 Cert to encrypt
847        x509Cert = X509.load_cert(self.__signingCertFilePath)
848       
849        soapWriter.dom.setNamespaceAttribute('wsse', OASIS.WSSE)
850        soapWriter.dom.setNamespaceAttribute('xenc', _ENCRYPTION.BASE)
851        soapWriter.dom.setNamespaceAttribute('ds', DSIG.BASE)
852       
853        # TODO: Put in a check to make sure <wsse:security> isn't already
854        # present in header
855        wsseElem = soapWriter._header.createAppendElement(OASIS.WSSE, 
856                                                         'Security')
857        wsseElem.node.setAttribute('SOAP-ENV:mustUnderstand', "1")
858       
859        encrKeyElem = wsseElem.createAppendElement(_ENCRYPTION.BASE, 
860                                                   'EncryptedKey')
861       
862        # Encryption method used to encrypt the shared key
863        keyEncrMethodElem = encrKeyElem.createAppendElement(_ENCRYPTION.BASE, 
864                                                        'EncryptionMethod')
865       
866        keyEncrMethodElem.node.setAttribute('Algorithm', 
867                                            _ENCRYPTION.KT_RSA_1_5)
868
869
870        # Key Info
871        KeyInfoElem = encrKeyElem.createAppendElement(DSIG.BASE, 'KeyInfo')
872       
873        secTokRefElem = KeyInfoElem.createAppendElement(OASIS.WSSE, 
874                                                  'SecurityTokenReference')
875       
876        x509IssSerialElem = secTokRefElem.createAppendElement(DSIG.BASE, 
877                                                          'X509IssuerSerial')
878
879       
880        x509IssNameElem = x509IssSerialElem.createAppendElement(DSIG.BASE, 
881                                                          'X509IssuerName')
882        x509IssNameElem.createAppendTextNode(x509Cert.get_issuer().as_text())
883
884       
885        x509IssSerialNumElem = x509IssSerialElem.createAppendElement(
886                                                  DSIG.BASE, 
887                                                  'X509IssuerSerialNumber')
888       
889        x509IssSerialNumElem.createAppendTextNode(
890                                          str(x509Cert.get_serial_number()))
891
892        # References to what has been encrypted
893        encrKeyCiphDataElem = encrKeyElem.createAppendElement(
894                                                          _ENCRYPTION.BASE,
895                                                          'CipherData')
896       
897        encrKeyCiphValElem = encrKeyCiphDataElem.createAppendElement(
898                                                          _ENCRYPTION.BASE,
899                                                          'CipherValue')
900
901        # References to what has been encrypted
902        refListElem = encrKeyElem.createAppendElement(_ENCRYPTION.BASE,
903                                                      'ReferenceList')
904       
905        dataRefElem = refListElem.createAppendElement(_ENCRYPTION.BASE,
906                                                      'DataReference')
907        dataRefElem.node.setAttribute('URI', "#encrypted")
908
909                     
910        # Add Encrypted data to SOAP body
911        encrDataElem = soapWriter.body.createAppendElement(_ENCRYPTION.BASE, 
912                                                           'EncryptedData')
913        encrDataElem.node.setAttribute('Id', 'encrypted')
914        encrDataElem.node.setAttribute('Type', _ENCRYPTION.BASE) 
915             
916        # Encryption method used to encrypt the target data
917        dataEncrMethodElem = encrDataElem.createAppendElement(
918                                                      _ENCRYPTION.BASE, 
919                                                      'EncryptionMethod')
920       
921        dataEncrMethodElem.node.setAttribute('Algorithm', self.__encrNS)
922       
923        # Cipher data
924        ciphDataElem = encrDataElem.createAppendElement(_ENCRYPTION.BASE,
925                                                        'CipherData')
926       
927        ciphValueElem = ciphDataElem.createAppendElement(_ENCRYPTION.BASE,
928                                                         'CipherValue')
929
930
931        # Get elements from SOAP body for encryption
932        dataElem = soapWriter.body.node.childNodes[0]
933        data = dataElem.toxml()
934     
935        # Pad data to nearest multiple of encryption algorithm's block size   
936        modData = len(data) % self.__encrAlg['blockSize']
937        nPad = modData and self.__encrAlg['blockSize'] - modData or 0
938       
939        # PAd with random junk but ...
940        data += os.urandom(nPad-1)
941       
942        # Last byte should be number of padding bytes
943        # (http://www.w3.org/TR/xmlenc-core/#sec-Alg-Block)
944        data += chr(nPad)       
945       
946        # Generate shared key and input vector - for testing use hard-coded
947        # values to allow later comparison             
948        sharedKey = os.urandom(self.__encrAlg['blockSize'])
949        iv = os.urandom(self.__encrAlg['blockSize'])
950       
951        alg = self.__encrAlg['module'].new(sharedKey,
952                                           self.__encrAlg['mode'],
953                                           iv)
954 
955        # Encrypt required elements - prepend input vector
956        encryptedData = alg.encrypt(iv + data)
957        dataCiphValue = base64.encodestring(encryptedData).strip()
958
959        ciphValueElem.createAppendTextNode(dataCiphValue)
960       
961       
962        # ! Delete unencrypted message body elements !
963        soapWriter.body.node.removeChild(dataElem)
964
965       
966        # Use X.509 cert public key to encrypt the shared key - Extract key
967        # from the cert
968        rsaPubKey = x509Cert.get_pubkey().get_rsa()
969       
970        # Encrypt the shared key
971        encryptedSharedKey = rsaPubKey.public_encrypt(sharedKey, 
972                                                      RSA.pkcs1_padding)
973       
974        encrKeyCiphVal = base64.encodestring(encryptedSharedKey).strip()
975       
976        # Add the encrypted shared key to the EncryptedKey section in the SOAP
977        # header
978        encrKeyCiphValElem.createAppendTextNode(encrKeyCiphVal)
979
980#        print soapWriter.dom.node.toprettyxml()
981#        import pdb;pdb.set_trace()
982       
983       
984    def decrypt(self, parsedSOAP):
985        """Decrypt an inbound SOAP message"""
986       
987        processorNss = \
988        {
989            'xenc':   _ENCRYPTION.BASE,
990            'ds':     DSIG.BASE, 
991            'wsu':    _WSU.UTILITY, 
992            'wsse':   OASIS.WSSE, 
993            'soapenv':"http://schemas.xmlsoap.org/soap/envelope/" 
994        }
995        ctxt = Context(parsedSOAP.dom, processorNss=processorNss)
996       
997        refListNodes = xpath.Evaluate('//xenc:ReferenceList', 
998                                      contextNode=parsedSOAP.dom, 
999                                      context=ctxt)
1000        if len(refListNodes) > 1:
1001            raise DecryptionError, 'Expecting a single ReferenceList element'
1002       
1003        try:
1004            refListNode = refListNodes[0]
1005        except:
1006            # Message wasn't encrypted - is this OK or is a check needed for
1007            # encryption info in SOAP body - enveloped form?
1008            return
1009
1010
1011        # Check for wrapped key encryption
1012        encrKeyNodes = xpath.Evaluate('//xenc:EncryptedKey', 
1013                                      contextNode=parsedSOAP.dom, 
1014                                      context=ctxt)
1015        if len(encrKeyNodes) > 1:
1016            raise DecryptionError, 'This implementation can only handle ' + \
1017                                   'single EncryptedKey element'
1018       
1019        try:
1020            encrKeyNode = encrKeyNodes[0]
1021        except:
1022            # Shared key encryption used - leave out for the moment
1023            raise DecryptionError, 'This implementation can only handle ' + \
1024                                   'wrapped key encryption'
1025
1026       
1027        # Check encryption method
1028        keyEncrMethodNode = getElements(encrKeyNode, 'EncryptionMethod')[0]     
1029        keyAlgorithm = keyEncrMethodNode.getAttributeNode("Algorithm").value
1030        if keyAlgorithm != _ENCRYPTION.KT_RSA_1_5:
1031            raise DecryptionError, \
1032            'Encryption algorithm for wrapped key is "%s", expecting "%s"' % \
1033                (keyAlgorithm, _ENCRYPTION.KT_RSA_1_5)
1034
1035                                                           
1036        if self.__chkSecurityTokRef and self.__signingCertFilePath:
1037             
1038            # Check input cert. against SecurityTokenReference
1039            securityTokRefXPath = '/ds:KeyInfo/wsse:SecurityTokenReference'
1040            securityTokRefNode = xpath.Evaluate(securityTokRefXPath, 
1041                                                contextNode=encrKeyNode, 
1042                                                context=ctxt)
1043            # TODO: Look for ds:X509* elements to check against X.509 cert
1044            # input
1045
1046
1047        # Look for cipher data for wrapped key
1048        keyCiphDataNode = getElements(encrKeyNode, 'CipherData')[0]
1049        keyCiphValNode = getElements(keyCiphDataNode, 'CipherValue')[0]
1050
1051        keyCiphVal = str(keyCiphValNode.childNodes[0].nodeValue)
1052        encryptedKey = base64.decodestring(keyCiphVal)
1053
1054        # Read RSA Private key in order to decrypt wrapped key 
1055        priKeyFile = BIO.File(open(self.__signingPriKeyFilePath))         
1056        pwdCallback = lambda *ar, **kw: self.__signingPriKeyPwd                                       
1057        priKey = RSA.load_key_bio(priKeyFile, callback=pwdCallback)
1058       
1059        sharedKey = priKey.private_decrypt(encryptedKey, RSA.pkcs1_padding)
1060       
1061
1062        # Check list of data elements that have been encrypted
1063        for dataRefNode in refListNode.childNodes:
1064
1065            # Get the URI for the reference
1066            dataRefURI = dataRefNode.getAttributeNode('URI').value                           
1067            if dataRefURI[0] != "#":
1068                raise VerifyError, \
1069                    "Expecting # identifier for DataReference URI \"%s\"" % \
1070                    dataRefURI
1071
1072            # XPath reference - need to check for wsu namespace qualified?
1073            #encrNodeXPath = '//*[@wsu:Id="%s"]' % dataRefURI[1:]
1074            encrNodeXPath = '//*[@Id="%s"]' % dataRefURI[1:]
1075            encrNode = xpath.Evaluate(encrNodeXPath, 
1076                                      contextNode=parsedSOAP.dom, 
1077                                      context=ctxt)[0]
1078               
1079            dataEncrMethodNode = getElements(encrNode, 'EncryptionMethod')[0]     
1080            dataAlgorithm = \
1081                        dataEncrMethodNode.getAttributeNode("Algorithm").value
1082            try:       
1083                # Match algorithm name to Crypto module
1084                CryptoAlg = self.cryptoAlg[dataAlgorithm]
1085               
1086            except KeyError:
1087                raise DecryptionError, \
1088'Encryption algorithm for data is "%s", supported algorithms are:\n "%s"' % \
1089                    (keyAlgorithm, "\n".join(self.cryptoAlg.keys()))
1090
1091            # Get Data
1092            dataCiphDataNode = getElements(encrNode, 'CipherData')[0]
1093            dataCiphValNode = getElements(dataCiphDataNode, 'CipherValue')[0]
1094       
1095            dataCiphVal = str(dataCiphValNode.childNodes[0].nodeValue)
1096            encryptedData = base64.decodestring(dataCiphVal)
1097           
1098            alg = CryptoAlg['module'].new(sharedKey, CryptoAlg['mode'])
1099            decryptedData = alg.decrypt(encryptedData)
1100           
1101            # Strip prefix - assume is block size
1102            decryptedData = decryptedData[CryptoAlg['blockSize']:]
1103           
1104            # Strip any padding suffix - Last byte should be number of padding
1105            # bytes
1106            # (http://www.w3.org/TR/xmlenc-core/#sec-Alg-Block)
1107            lastChar = decryptedData[-1]
1108            nPad = ord(lastChar)
1109           
1110            # Sanity check - there may be no padding at all - the last byte
1111            # being the end of the encrypted XML?
1112            #
1113            # TODO: are there better sanity checks than this?!
1114            if nPad < CryptoAlg['blockSize'] and nPad > 0 and \
1115               lastChar != '\n' and lastChar != '>':
1116               
1117                # Follow http://www.w3.org/TR/xmlenc-core/#sec-Alg-Block -
1118                # last byte gives number of padding bytes
1119                decryptedData = decryptedData[:-nPad]
1120
1121
1122            # Parse the encrypted data - inherit from Reader as a fudge to
1123            # enable relevant namespaces to be added prior to parse
1124            processorNss.update({'xsi': SCHEMA.XSI3, 'ns1': 'urn:ZSI:examples'})
1125            class _Reader(Reader):
1126                def initState(self, ownerDoc=None):
1127                    Reader.initState(self, ownerDoc=ownerDoc)
1128                    self._namespaces.update(processorNss)
1129                   
1130            rdr = _Reader()
1131            dataNode = rdr.fromString(decryptedData, ownerDoc=parsedSOAP.dom)
1132           
1133            # Add decrypted element to parent and remove encrypted one
1134            parentNode = encrNode._get_parentNode()
1135            parentNode.appendChild(dataNode)
1136            parentNode.removeChild(encrNode)
1137           
1138            from xml.dom.ext import ReleaseNode
1139            ReleaseNode(encrNode)
1140           
1141            # Ensure body_root attribute is up to date in case it was
1142            # previously encrypted
1143            parsedSOAP.body_root = parsedSOAP.body.childNodes[0]
1144            #print decryptedData
1145            #import pdb;pdb.set_trace()
1146
1147
1148#_____________________________________________________________________________
1149from zope.interface import classProvides, implements, Interface
1150import twisted.web.http
1151from twisted.python import log, failure
1152
1153from ZSI.twisted.WSresource import DefaultHandlerChain, \
1154    DefaultCallbackHandler, CallbackChainInterface, HandlerChainInterface, \
1155    DataHandler
1156   
1157from ZSI import _get_element_nsuri_name, EvaluateException, ParseException
1158   
1159   
1160class WSSecurityHandlerChainFactory:
1161    protocol = DefaultHandlerChain
1162   
1163    @classmethod
1164    def newInstance(cls):
1165        return cls.protocol(DefaultCallbackHandler, 
1166                            DataHandler,
1167                            WSSecurityHandler)
1168   
1169
1170class WSSecurityHandler:
1171    classProvides(HandlerChainInterface)
1172
1173    signatureHandler = None
1174   
1175    @classmethod
1176    def processRequest(cls, ps, **kw):
1177        """invokes callback that should return a (request,response) tuple.
1178        representing the SOAP request and response respectively.
1179        ps -- ParsedSoap instance representing HTTP Body.
1180        request -- twisted.web.server.Request
1181        """
1182        if cls.signatureHandler:
1183            cls.signatureHandler.verify(ps)
1184           
1185        return ps
1186   
1187    @classmethod
1188    def processResponse(cls, sw, **kw):
1189       
1190        if cls.signatureHandler:
1191            cls.signatureHandler.sign(sw)
1192           
1193        return sw
Note: See TracBrowser for help on using the repository browser.