Module org.apache.santuario.xmlsec

Package org.apache.xml.security.stax.impl.processor.input

Class AbstractSignatureReferenceVerifyInputProcessor

java.lang.Object

org.apache.xml.security.stax.ext.AbstractInputProcessor

org.apache.xml.security.stax.impl.processor.input.AbstractSignatureReferenceVerifyInputProcessor

All Implemented Interfaces:

InputProcessor

Direct Known Subclasses:

XMLSignatureReferenceVerifyInputProcessor

public abstract class AbstractSignatureReferenceVerifyInputProcessor
extends AbstractInputProcessor

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
class	AbstractSignatureReferenceVerifyInputProcessor.InternalSignatureReferenceVerifier

Field Summary

Fields

Modifier and Type	Field	Description
protected static final Boolean	allowNotSameDocumentReferences
protected static final Boolean	doNotThrowExceptionForManifests
private final List<KeyValue<ResourceResolver,ReferenceType>>	externalReferences
private final InboundSecurityToken	inboundSecurityToken
private static final System.Logger	LOG
protected static final Integer	maximumAllowedReferencesPerManifest
protected static final Integer	maximumAllowedTransformsPerReference
private final List<ReferenceType>	processedReferences
private final List<KeyValue<ResourceResolver,ReferenceType>>	sameDocumentReferences
private final SignatureType	signatureType

Constructor Summary

Constructors

Constructor	Description
AbstractSignatureReferenceVerifyInputProcessor(InputProcessorChain inputProcessorChain, SignatureType signatureType, InboundSecurityToken inboundSecurityToken, XMLSecurityProperties securityProperties)

Method Summary

Modifier and Type	Method	Description
protected Transformer	buildTransformerChain(ReferenceType referenceType, OutputStream outputStream, InputProcessorChain inputProcessorChain, AbstractSignatureReferenceVerifyInputProcessor.InternalSignatureReferenceVerifier internalSignatureReferenceVerifier)
protected void	compareDigest(byte[] calculatedDigest, ReferenceType referenceType)
protected DigestOutputStream	createMessageDigestOutputStream(ReferenceType referenceType, InboundSecurityContext inboundSecurityContext)
void	doFinal(InputProcessorChain inputProcessorChain)	Will be called when the whole document is processed.
InboundSecurityToken	getInboundSecurityToken()
List<ReferenceType>	getProcessedReferences()
protected AbstractSignatureReferenceVerifyInputProcessor.InternalSignatureReferenceVerifier	getSignatureReferenceVerifier(XMLSecurityProperties securityProperties, InputProcessorChain inputProcessorChain, ReferenceType referenceType, XMLSecStartElement startElement)
SignatureType	getSignatureType()
protected abstract void	processElementPath(List<QName> elementPath, InputProcessorChain inputProcessorChain, XMLSecEvent xmlSecEvent, ReferenceType referenceType)
XMLSecEvent	processEvent(InputProcessorChain inputProcessorChain)	Will be called from the framework when the next XMLEvent is requested
XMLSecEvent	processHeaderEvent(InputProcessorChain inputProcessorChain)	Will be called from the framework when the next security-header XMLEvent is requested
protected List<ReferenceType>	resolvesResource(XMLSecStartElement xmlSecStartElement)
protected void	verifyExternalReference(InputProcessorChain inputProcessorChain, InputStream inputStream, ReferenceType referenceType)

Methods inherited from class org.apache.xml.security.stax.ext.AbstractInputProcessor

addAfterProcessor, addBeforeProcessor, getAfterProcessors, getBeforeProcessors, getPhase, getReferenceIDAttribute, getSecurityProperties, setPhase

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

LOG

private static final System.Logger LOG

maximumAllowedReferencesPerManifest

protected static final Integer maximumAllowedReferencesPerManifest

maximumAllowedTransformsPerReference

protected static final Integer maximumAllowedTransformsPerReference

doNotThrowExceptionForManifests

protected static final Boolean doNotThrowExceptionForManifests

allowNotSameDocumentReferences

protected static final Boolean allowNotSameDocumentReferences

signatureType

private final SignatureType signatureType

inboundSecurityToken

private final InboundSecurityToken inboundSecurityToken

sameDocumentReferences

private final List<KeyValue<ResourceResolver,ReferenceType>> sameDocumentReferences

externalReferences

private final List<KeyValue<ResourceResolver,ReferenceType>> externalReferences

processedReferences

private final List<ReferenceType> processedReferences

Constructor Details

AbstractSignatureReferenceVerifyInputProcessor

public AbstractSignatureReferenceVerifyInputProcessor(InputProcessorChain inputProcessorChain,
 SignatureType signatureType,
 InboundSecurityToken inboundSecurityToken,
 XMLSecurityProperties securityProperties)
                                               throws XMLSecurityException

Throws:

XMLSecurityException

Method Details

getSignatureType

public SignatureType getSignatureType()

getProcessedReferences

public List<ReferenceType> getProcessedReferences()

getInboundSecurityToken

public InboundSecurityToken getInboundSecurityToken()

processHeaderEvent

public XMLSecEvent processHeaderEvent(InputProcessorChain inputProcessorChain)
                               throws XMLStreamException,
XMLSecurityException

Description copied from interface: InputProcessor

Will be called from the framework when the next security-header XMLEvent is requested

Returns:

The next XMLSecEvent

Throws:

XMLStreamException - thrown when a streaming error occurs

XMLSecurityException - thrown when a Security failure occurs

processEvent

public XMLSecEvent processEvent(InputProcessorChain inputProcessorChain)
                         throws XMLStreamException,
XMLSecurityException

Description copied from interface: InputProcessor

Will be called from the framework when the next XMLEvent is requested

Returns:

The next XMLSecEvent

Throws:

XMLStreamException - thrown when a streaming error occurs

XMLSecurityException - thrown when a Security failure occurs

processElementPath

protected abstract void processElementPath(List<QName> elementPath,
 InputProcessorChain inputProcessorChain,
 XMLSecEvent xmlSecEvent,
 ReferenceType referenceType)
                                    throws XMLSecurityException

Throws:

XMLSecurityException

resolvesResource

protected List<ReferenceType> resolvesResource(XMLSecStartElement xmlSecStartElement)

doFinal

public void doFinal(InputProcessorChain inputProcessorChain)
             throws XMLStreamException,
XMLSecurityException

Description copied from interface: InputProcessor

Will be called when the whole document is processed.

Specified by:

doFinal in interface InputProcessor

Overrides:

doFinal in class AbstractInputProcessor

Throws:

XMLStreamException - thrown when a streaming error occurs

XMLSecurityException - thrown when a Security failure occurs

getSignatureReferenceVerifier

protected AbstractSignatureReferenceVerifyInputProcessor.InternalSignatureReferenceVerifier getSignatureReferenceVerifier(XMLSecurityProperties securityProperties,
 InputProcessorChain inputProcessorChain,
 ReferenceType referenceType,
 XMLSecStartElement startElement)
                                                                                                                   throws XMLSecurityException

Throws:

XMLSecurityException

verifyExternalReference

protected void verifyExternalReference(InputProcessorChain inputProcessorChain,
 InputStream inputStream,
 ReferenceType referenceType)
                                throws XMLSecurityException,
XMLStreamException

Throws:

XMLSecurityException

XMLStreamException

createMessageDigestOutputStream

protected DigestOutputStream createMessageDigestOutputStream(ReferenceType referenceType,
 InboundSecurityContext inboundSecurityContext)
                                                      throws XMLSecurityException

Throws:

XMLSecurityException

buildTransformerChain

protected Transformer buildTransformerChain(ReferenceType referenceType,
 OutputStream outputStream,
 InputProcessorChain inputProcessorChain,
 AbstractSignatureReferenceVerifyInputProcessor.InternalSignatureReferenceVerifier internalSignatureReferenceVerifier)
                                     throws XMLSecurityException

Throws:

XMLSecurityException

compareDigest

protected void compareDigest(byte[] calculatedDigest,
 ReferenceType referenceType)
                      throws XMLSecurityException

Throws:

XMLSecurityException