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

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

ndg-security-install.py: renamed from installServer.py to make it more clear what its
purpose is.

ndg.security.common/ndg/security/common/wsSecurity.py: SignatureHandler? verify method

  • hanlde case where no namespace prefixes are set for the exclusive c14n. Ignore

gracefully without throwing an exception. In the case, an error is likely to occur
later when comparing digest values or the signature value itself.

  • 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       
587        processorNss = \
588        {
589            'ds':     DSIG.BASE, 
590            'wsu':    _WSU.UTILITY, 
591            'wsse':   OASIS.WSSE, 
592            'soapenv':"http://schemas.xmlsoap.org/soap/envelope/" 
593        }
594        ctxt = Context(parsedSOAP.dom, processorNss=processorNss)
595       
596
597        signatureNodes = xpath.Evaluate('//ds:Signature', 
598                                        contextNode=parsedSOAP.dom, 
599                                        context=ctxt)
600        if len(signatureNodes) > 1:
601            raise VerifyError, 'Multiple ds:Signature elements found'
602       
603        try:
604            signatureNodes = signatureNodes[0]
605        except:
606            # Message wasn't signed
607            return
608       
609        # Two stage process: reference validation followed by signature
610        # validation
611       
612        # 1) Reference Validation
613       
614        # Check for canonicalization set via ds:CanonicalizationMethod -
615        # Use this later as a back up in case no Canonicalization was set in
616        # the transforms elements
617        c14nMethodNode = xpath.Evaluate('//ds:CanonicalizationMethod', 
618                                        contextNode=parsedSOAP.dom, 
619                                        context=ctxt)[0]
620       
621        refNodes = xpath.Evaluate('//ds:Reference', 
622                                  contextNode=parsedSOAP.dom, 
623                                  context=ctxt)
624
625        for refNode in refNodes:
626            # Get the URI for the reference
627            refURI = refNode.getAttributeNode('URI').value
628                         
629            try:
630                transformsNode = getElements(refNode, "Transforms")[0]
631                transforms = getElements(transformsNode, "Transform")
632   
633                refAlgorithm = \
634                            transforms[0].getAttributeNode("Algorithm").value
635            except Exception, e:
636                raise VerifyError, \
637            'failed to get transform algorithm for <ds:Reference URI="%s">'%\
638                        (refURI, str(e))
639               
640            # Add extra keyword for Exclusive canonicalization method
641            refC14nKw = {}
642            if refAlgorithm == DSIG.C14N_EXCL:
643                try:
644                    inclusiveNS = getElements(transforms[0], 
645                                              "InclusiveNamespaces")
646                   
647                    # Allow for no inclusive namespaces set - this is
648                    # not expected and is likely to cause problems with the
649                    # canonicalization later.
650                    if inclusiveNS:
651                        pfxListAttNode = \
652                                inclusiveNS[0].getAttributeNode('PrefixList')
653                           
654                        refC14nKw['unsuppressedPrefixes'] = \
655                                                pfxListAttNode.value.split()
656                except:
657                    raise VerifyError, \
658                'failed to handle transform (%s) in <ds:Reference URI="%s">'%\
659                        (transforms[0], refURI)
660       
661            # Canonicalize the reference data and calculate the digest
662            if refURI[0] != "#":
663                raise VerifyError, \
664                    "Expecting # identifier for Reference URI \"%s\"" % refURI
665                   
666            # XPath reference
667            uriXPath = '//*[@wsu:Id="%s"]' % refURI[1:]
668            uriNode = xpath.Evaluate(uriXPath, 
669                                     contextNode=parsedSOAP.dom, 
670                                     context=ctxt)[0]
671
672            refC14n = Canonicalize(uriNode, **refC14nKw)
673            digestValue = base64.encodestring(sha(refC14n).digest()).strip()
674           
675            # Extract the digest value that was stored           
676            digestNode = getElements(refNode, "DigestValue")[0]
677            nodeDigestValue = str(digestNode.childNodes[0].nodeValue).strip()   
678           
679            # Reference validates if the two digest values are the same
680            if digestValue != nodeDigestValue:
681                raise InvalidSignature, \
682                        'Digest Values do not match for URI: "%s"' % refURI
683               
684        # 2) Signature Validation
685        signedInfoNode = xpath.Evaluate('//ds:SignedInfo',
686                                        contextNode=parsedSOAP.dom, 
687                                        context=ctxt)[0]
688
689        # Get algorithm used for canonicalization of the SignedInfo
690        # element.  Nb. This is NOT necessarily the same as that used to
691        # canonicalize the reference elements checked above!
692        signedInfoC14nAlg = c14nMethodNode.getAttributeNode("Algorithm").value
693        signedInfoC14nKw = {}
694        if signedInfoC14nAlg == DSIG.C14N_EXCL:
695            try:
696                # Allow for no inclusive namespaces set - this is
697                # not expected and is likely to cause problems with the
698                # canonicalization later.
699                if inclusiveNS:
700                    inclusiveNS = getElements(c14nMethodNode,
701                                              "InclusiveNamespaces")
702                   
703                    pfxListAttNode = inclusiveNS[0].getAttributeNode(\
704                                                                 'PrefixList')
705                    signedInfoC14nKw['unsuppressedPrefixes'] = \
706                                                pfxListAttNode.value.split()
707                                                     
708            except Exception, e:
709                raise VerifyError, \
710            'failed to handle exclusive canonicalisation for SignedInfo: %s'%\
711                        str(e)
712
713        # Canonicalize the SignedInfo node and take digest
714        c14nSignedInfo = Canonicalize(signedInfoNode, **signedInfoC14nKw) 
715               
716        # TODO: strip() call? - almost certainly wrong - leave out!       
717        signedInfoDigestValue = sha(c14nSignedInfo).digest()#.strip()
718       
719        # Get the signature value in order to check against the digest just
720        # calculated
721        signatureValueNode = xpath.Evaluate('//ds:SignatureValue',
722                                            contextNode=parsedSOAP.dom, 
723                                            context=ctxt)[0]
724
725        # Remove base 64 encoding
726        b64EncSignatureValue = \
727                    str(signatureValueNode.childNodes[0].nodeValue).strip()
728       
729        signatureValue = base64.decodestring(b64EncSignatureValue)
730
731
732        # Look for X.509 Cert in wsse:BinarySecurityToken node
733        try:
734            binSecTokNode = xpath.Evaluate('//wsse:BinarySecurityToken',
735                                           contextNode=parsedSOAP.dom,
736                                           context=ctxt)[0]
737        except:
738            # Signature may not have included the Binary Security Token in
739            # which case the verifying cert will need to have been set
740            # elsewhere
741            binSecTokNode = None
742            pass 
743       
744        #import pdb;pdb.set_trace()       
745        if binSecTokNode:
746            try:
747                x509CertTxt=str(binSecTokNode.childNodes[0]._get_nodeValue())
748               
749                # Convert parsed cert text into form that can be read
750                # by X.509 string parser
751                if x509CertTxt[64] != "\n":
752                    # Expecting cert split into lines of length 64 bytes
753                    x509CertSpl = re.split('(.{64})', x509CertTxt)
754                    x509CertTxt = '\n'.join([i for i in x509CertSpl if i])
755                   
756                b64EncX509Cert = self.__class__.__beginCert + x509CertTxt + \
757                         self.__class__.__endCert
758                             
759                self.__setVerifyingCert(b64EncX509Cert)
760            except Exception, e:
761                raise VerifyError, "Error extracting BinarySecurityToken " + \
762                                   "from WSSE header: " + str(e)
763
764        if self.__verifyingCert is None:
765            raise VerifyError, "No certificate set for verification " + \
766                "of the signature"
767       
768        # Extract RSA public key from the cert
769        rsaPubKey = self.__verifyingCert.m2CryptoX509.get_pubkey().get_rsa()
770       
771        # Apply the signature verification
772        try:
773            verify = rsaPubKey.verify(signedInfoDigestValue, signatureValue)
774        except RSA.RSAError, e:
775            raise VerifyError, "Error in Signature: " + str(e)
776       
777        if not verify:
778            raise InvalidSignature, "Invalid signature"
779       
780        #print "Signature OK"
781
782
783class EncryptionError(Exception):
784    """Flags an error in the encryption process"""
785
786class DecryptionError(Exception):
787    """Raised from EncryptionHandler.decrypt if an error occurs with the
788    decryption process"""
789
790
791class EncryptionHandler(object):
792    """Encrypt/Decrypt SOAP messages using WS-Security""" 
793   
794    # Map namespace URIs to Crypto algorithm module and mode
795    cryptoAlg = \
796    {
797         _ENCRYPTION.WRAP_AES256:      {'module':       AES, 
798                                        'mode':         AES.MODE_ECB,
799                                        'blockSize':    16},
800         
801         # CBC (Cipher Block Chaining) modes
802         _ENCRYPTION.BLOCK_AES256:     {'module':       AES, 
803                                        'mode':         AES.MODE_CBC,
804                                        'blockSize':    16},
805                                       
806         _ENCRYPTION.BLOCK_TRIPLEDES:  {'module':       DES3, 
807                                        'mode':         DES3.MODE_CBC,
808                                        'blockSize':    8}   
809    }
810
811     
812    def __init__(self,
813                 signingCertFilePath=None, 
814                 signingPriKeyFilePath=None, 
815                 signingPriKeyPwd=None,
816                 chkSecurityTokRef=False,
817                 encrNS=_ENCRYPTION.BLOCK_AES256):
818       
819        self.__signingCertFilePath = signingCertFilePath
820        self.__signingPriKeyFilePath = signingPriKeyFilePath
821        self.__signingPriKeyPwd = signingPriKeyPwd
822       
823        self.__chkSecurityTokRef = chkSecurityTokRef
824       
825        # Algorithm for shared key encryption
826        try:
827            self.__encrAlg = self.cryptoAlg[encrNS]
828           
829        except KeyError:
830            raise EncryptionError, \
831        'Input encryption algorithm namespace "%s" is not supported' % encrNS
832
833        self.__encrNS = encrNS
834       
835       
836    def encrypt(self, soapWriter):
837        """Encrypt an outbound SOAP message
838       
839        Use Key Wrapping - message is encrypted using a shared key which
840        itself is encrypted with the public key provided by the X.509 cert.
841        signingCertFilePath"""
842       
843        # Use X.509 Cert to encrypt
844        x509Cert = X509.load_cert(self.__signingCertFilePath)
845       
846        soapWriter.dom.setNamespaceAttribute('wsse', OASIS.WSSE)
847        soapWriter.dom.setNamespaceAttribute('xenc', _ENCRYPTION.BASE)
848        soapWriter.dom.setNamespaceAttribute('ds', DSIG.BASE)
849       
850        # TODO: Put in a check to make sure <wsse:security> isn't already
851        # present in header
852        wsseElem = soapWriter._header.createAppendElement(OASIS.WSSE, 
853                                                         'Security')
854        wsseElem.node.setAttribute('SOAP-ENV:mustUnderstand', "1")
855       
856        encrKeyElem = wsseElem.createAppendElement(_ENCRYPTION.BASE, 
857                                                   'EncryptedKey')
858       
859        # Encryption method used to encrypt the shared key
860        keyEncrMethodElem = encrKeyElem.createAppendElement(_ENCRYPTION.BASE, 
861                                                        'EncryptionMethod')
862       
863        keyEncrMethodElem.node.setAttribute('Algorithm', 
864                                            _ENCRYPTION.KT_RSA_1_5)
865
866
867        # Key Info
868        KeyInfoElem = encrKeyElem.createAppendElement(DSIG.BASE, 'KeyInfo')
869       
870        secTokRefElem = KeyInfoElem.createAppendElement(OASIS.WSSE, 
871                                                  'SecurityTokenReference')
872       
873        x509IssSerialElem = secTokRefElem.createAppendElement(DSIG.BASE, 
874                                                          'X509IssuerSerial')
875
876       
877        x509IssNameElem = x509IssSerialElem.createAppendElement(DSIG.BASE, 
878                                                          'X509IssuerName')
879        x509IssNameElem.createAppendTextNode(x509Cert.get_issuer().as_text())
880
881       
882        x509IssSerialNumElem = x509IssSerialElem.createAppendElement(
883                                                  DSIG.BASE, 
884                                                  'X509IssuerSerialNumber')
885       
886        x509IssSerialNumElem.createAppendTextNode(
887                                          str(x509Cert.get_serial_number()))
888
889        # References to what has been encrypted
890        encrKeyCiphDataElem = encrKeyElem.createAppendElement(
891                                                          _ENCRYPTION.BASE,
892                                                          'CipherData')
893       
894        encrKeyCiphValElem = encrKeyCiphDataElem.createAppendElement(
895                                                          _ENCRYPTION.BASE,
896                                                          'CipherValue')
897
898        # References to what has been encrypted
899        refListElem = encrKeyElem.createAppendElement(_ENCRYPTION.BASE,
900                                                      'ReferenceList')
901       
902        dataRefElem = refListElem.createAppendElement(_ENCRYPTION.BASE,
903                                                      'DataReference')
904        dataRefElem.node.setAttribute('URI', "#encrypted")
905
906                     
907        # Add Encrypted data to SOAP body
908        encrDataElem = soapWriter.body.createAppendElement(_ENCRYPTION.BASE, 
909                                                           'EncryptedData')
910        encrDataElem.node.setAttribute('Id', 'encrypted')
911        encrDataElem.node.setAttribute('Type', _ENCRYPTION.BASE) 
912             
913        # Encryption method used to encrypt the target data
914        dataEncrMethodElem = encrDataElem.createAppendElement(
915                                                      _ENCRYPTION.BASE, 
916                                                      'EncryptionMethod')
917       
918        dataEncrMethodElem.node.setAttribute('Algorithm', self.__encrNS)
919       
920        # Cipher data
921        ciphDataElem = encrDataElem.createAppendElement(_ENCRYPTION.BASE,
922                                                        'CipherData')
923       
924        ciphValueElem = ciphDataElem.createAppendElement(_ENCRYPTION.BASE,
925                                                         'CipherValue')
926
927
928        # Get elements from SOAP body for encryption
929        dataElem = soapWriter.body.node.childNodes[0]
930        data = dataElem.toxml()
931     
932        # Pad data to nearest multiple of encryption algorithm's block size   
933        modData = len(data) % self.__encrAlg['blockSize']
934        nPad = modData and self.__encrAlg['blockSize'] - modData or 0
935       
936        # PAd with random junk but ...
937        data += os.urandom(nPad-1)
938       
939        # Last byte should be number of padding bytes
940        # (http://www.w3.org/TR/xmlenc-core/#sec-Alg-Block)
941        data += chr(nPad)       
942       
943        # Generate shared key and input vector - for testing use hard-coded
944        # values to allow later comparison             
945        sharedKey = os.urandom(self.__encrAlg['blockSize'])
946        iv = os.urandom(self.__encrAlg['blockSize'])
947       
948        alg = self.__encrAlg['module'].new(sharedKey,
949                                           self.__encrAlg['mode'],
950                                           iv)
951 
952        # Encrypt required elements - prepend input vector
953        encryptedData = alg.encrypt(iv + data)
954        dataCiphValue = base64.encodestring(encryptedData).strip()
955
956        ciphValueElem.createAppendTextNode(dataCiphValue)
957       
958       
959        # ! Delete unencrypted message body elements !
960        soapWriter.body.node.removeChild(dataElem)
961
962       
963        # Use X.509 cert public key to encrypt the shared key - Extract key
964        # from the cert
965        rsaPubKey = x509Cert.get_pubkey().get_rsa()
966       
967        # Encrypt the shared key
968        encryptedSharedKey = rsaPubKey.public_encrypt(sharedKey, 
969                                                      RSA.pkcs1_padding)
970       
971        encrKeyCiphVal = base64.encodestring(encryptedSharedKey).strip()
972       
973        # Add the encrypted shared key to the EncryptedKey section in the SOAP
974        # header
975        encrKeyCiphValElem.createAppendTextNode(encrKeyCiphVal)
976
977#        print soapWriter.dom.node.toprettyxml()
978#        import pdb;pdb.set_trace()
979       
980       
981    def decrypt(self, parsedSOAP):
982        """Decrypt an inbound SOAP message"""
983       
984        processorNss = \
985        {
986            'xenc':   _ENCRYPTION.BASE,
987            'ds':     DSIG.BASE, 
988            'wsu':    _WSU.UTILITY, 
989            'wsse':   OASIS.WSSE, 
990            'soapenv':"http://schemas.xmlsoap.org/soap/envelope/" 
991        }
992        ctxt = Context(parsedSOAP.dom, processorNss=processorNss)
993       
994        refListNodes = xpath.Evaluate('//xenc:ReferenceList', 
995                                      contextNode=parsedSOAP.dom, 
996                                      context=ctxt)
997        if len(refListNodes) > 1:
998            raise DecryptionError, 'Expecting a single ReferenceList element'
999       
1000        try:
1001            refListNode = refListNodes[0]
1002        except:
1003            # Message wasn't encrypted - is this OK or is a check needed for
1004            # encryption info in SOAP body - enveloped form?
1005            return
1006
1007
1008        # Check for wrapped key encryption
1009        encrKeyNodes = xpath.Evaluate('//xenc:EncryptedKey', 
1010                                      contextNode=parsedSOAP.dom, 
1011                                      context=ctxt)
1012        if len(encrKeyNodes) > 1:
1013            raise DecryptionError, 'This implementation can only handle ' + \
1014                                   'single EncryptedKey element'
1015       
1016        try:
1017            encrKeyNode = encrKeyNodes[0]
1018        except:
1019            # Shared key encryption used - leave out for the moment
1020            raise DecryptionError, 'This implementation can only handle ' + \
1021                                   'wrapped key encryption'
1022
1023       
1024        # Check encryption method
1025        keyEncrMethodNode = getElements(encrKeyNode, 'EncryptionMethod')[0]     
1026        keyAlgorithm = keyEncrMethodNode.getAttributeNode("Algorithm").value
1027        if keyAlgorithm != _ENCRYPTION.KT_RSA_1_5:
1028            raise DecryptionError, \
1029            'Encryption algorithm for wrapped key is "%s", expecting "%s"' % \
1030                (keyAlgorithm, _ENCRYPTION.KT_RSA_1_5)
1031
1032                                                           
1033        if self.__chkSecurityTokRef and self.__signingCertFilePath:
1034             
1035            # Check input cert. against SecurityTokenReference
1036            securityTokRefXPath = '/ds:KeyInfo/wsse:SecurityTokenReference'
1037            securityTokRefNode = xpath.Evaluate(securityTokRefXPath, 
1038                                                contextNode=encrKeyNode, 
1039                                                context=ctxt)
1040            # TODO: Look for ds:X509* elements to check against X.509 cert
1041            # input
1042
1043
1044        # Look for cipher data for wrapped key
1045        keyCiphDataNode = getElements(encrKeyNode, 'CipherData')[0]
1046        keyCiphValNode = getElements(keyCiphDataNode, 'CipherValue')[0]
1047
1048        keyCiphVal = str(keyCiphValNode.childNodes[0].nodeValue)
1049        encryptedKey = base64.decodestring(keyCiphVal)
1050
1051        # Read RSA Private key in order to decrypt wrapped key 
1052        priKeyFile = BIO.File(open(self.__signingPriKeyFilePath))         
1053        pwdCallback = lambda *ar, **kw: self.__signingPriKeyPwd                                       
1054        priKey = RSA.load_key_bio(priKeyFile, callback=pwdCallback)
1055       
1056        sharedKey = priKey.private_decrypt(encryptedKey, RSA.pkcs1_padding)
1057       
1058
1059        # Check list of data elements that have been encrypted
1060        for dataRefNode in refListNode.childNodes:
1061
1062            # Get the URI for the reference
1063            dataRefURI = dataRefNode.getAttributeNode('URI').value                           
1064            if dataRefURI[0] != "#":
1065                raise VerifyError, \
1066                    "Expecting # identifier for DataReference URI \"%s\"" % \
1067                    dataRefURI
1068
1069            # XPath reference - need to check for wsu namespace qualified?
1070            #encrNodeXPath = '//*[@wsu:Id="%s"]' % dataRefURI[1:]
1071            encrNodeXPath = '//*[@Id="%s"]' % dataRefURI[1:]
1072            encrNode = xpath.Evaluate(encrNodeXPath, 
1073                                      contextNode=parsedSOAP.dom, 
1074                                      context=ctxt)[0]
1075               
1076            dataEncrMethodNode = getElements(encrNode, 'EncryptionMethod')[0]     
1077            dataAlgorithm = \
1078                        dataEncrMethodNode.getAttributeNode("Algorithm").value
1079            try:       
1080                # Match algorithm name to Crypto module
1081                CryptoAlg = self.cryptoAlg[dataAlgorithm]
1082               
1083            except KeyError:
1084                raise DecryptionError, \
1085'Encryption algorithm for data is "%s", supported algorithms are:\n "%s"' % \
1086                    (keyAlgorithm, "\n".join(self.cryptoAlg.keys()))
1087
1088            # Get Data
1089            dataCiphDataNode = getElements(encrNode, 'CipherData')[0]
1090            dataCiphValNode = getElements(dataCiphDataNode, 'CipherValue')[0]
1091       
1092            dataCiphVal = str(dataCiphValNode.childNodes[0].nodeValue)
1093            encryptedData = base64.decodestring(dataCiphVal)
1094           
1095            alg = CryptoAlg['module'].new(sharedKey, CryptoAlg['mode'])
1096            decryptedData = alg.decrypt(encryptedData)
1097           
1098            # Strip prefix - assume is block size
1099            decryptedData = decryptedData[CryptoAlg['blockSize']:]
1100           
1101            # Strip any padding suffix - Last byte should be number of padding
1102            # bytes
1103            # (http://www.w3.org/TR/xmlenc-core/#sec-Alg-Block)
1104            lastChar = decryptedData[-1]
1105            nPad = ord(lastChar)
1106           
1107            # Sanity check - there may be no padding at all - the last byte
1108            # being the end of the encrypted XML?
1109            #
1110            # TODO: are there better sanity checks than this?!
1111            if nPad < CryptoAlg['blockSize'] and nPad > 0 and \
1112               lastChar != '\n' and lastChar != '>':
1113               
1114                # Follow http://www.w3.org/TR/xmlenc-core/#sec-Alg-Block -
1115                # last byte gives number of padding bytes
1116                decryptedData = decryptedData[:-nPad]
1117
1118
1119            # Parse the encrypted data - inherit from Reader as a fudge to
1120            # enable relevant namespaces to be added prior to parse
1121            processorNss.update({'xsi': SCHEMA.XSI3, 'ns1': 'urn:ZSI:examples'})
1122            class _Reader(Reader):
1123                def initState(self, ownerDoc=None):
1124                    Reader.initState(self, ownerDoc=ownerDoc)
1125                    self._namespaces.update(processorNss)
1126                   
1127            rdr = _Reader()
1128            dataNode = rdr.fromString(decryptedData, ownerDoc=parsedSOAP.dom)
1129           
1130            # Add decrypted element to parent and remove encrypted one
1131            parentNode = encrNode._get_parentNode()
1132            parentNode.appendChild(dataNode)
1133            parentNode.removeChild(encrNode)
1134           
1135            from xml.dom.ext import ReleaseNode
1136            ReleaseNode(encrNode)
1137           
1138            # Ensure body_root attribute is up to date in case it was
1139            # previously encrypted
1140            parsedSOAP.body_root = parsedSOAP.body.childNodes[0]
1141            #print decryptedData
1142            #import pdb;pdb.set_trace()
1143
1144
1145#_____________________________________________________________________________
1146from zope.interface import classProvides, implements, Interface
1147import twisted.web.http
1148from twisted.python import log, failure
1149
1150from ZSI.twisted.WSresource import DefaultHandlerChain, \
1151    DefaultCallbackHandler, CallbackChainInterface, HandlerChainInterface, \
1152    DataHandler
1153   
1154from ZSI import _get_element_nsuri_name, EvaluateException, ParseException
1155   
1156   
1157class WSSecurityHandlerChainFactory:
1158    protocol = DefaultHandlerChain
1159   
1160    @classmethod
1161    def newInstance(cls):
1162        return cls.protocol(DefaultCallbackHandler, 
1163                            DataHandler,
1164                            WSSecurityHandler)
1165   
1166
1167class WSSecurityHandler:
1168    classProvides(HandlerChainInterface)
1169
1170    signatureHandler = None
1171   
1172    @classmethod
1173    def processRequest(cls, ps, **kw):
1174        """invokes callback that should return a (request,response) tuple.
1175        representing the SOAP request and response respectively.
1176        ps -- ParsedSoap instance representing HTTP Body.
1177        request -- twisted.web.server.Request
1178        """
1179        if cls.signatureHandler:
1180            cls.signatureHandler.verify(ps)
1181           
1182        return ps
1183   
1184    @classmethod
1185    def processResponse(cls, sw, **kw):
1186       
1187        if cls.signatureHandler:
1188            cls.signatureHandler.sign(sw)
1189           
1190        return sw
Note: See TracBrowser for help on using the repository browser.