ddf.security.samlp.impl

Class SamlValidator.Builder

java.lang.Object

ddf.security.samlp.impl.SamlValidator.Builder

Enclosing class:

SamlValidator

public static class SamlValidator.Builder
extends Object

Builder class for SamlValidator.
Default Timeout of 10 minutes and clockSkew of 30 seconds.
If validating a redirect saml type, the Signature, Signature Algorithm, Relay State, original Saml string, and signing certificate are required. For Post binding type, only the object is required.

Field Summary

Fields

Modifier and Type	Field and Description
protected SamlProtocol.Binding	binding
protected Duration	clockSkew
protected String	destination
protected boolean	isRequest
protected String	relayState
protected String	requestId
protected String	samlString
protected String	sigAlgo
protected String	signature
protected String	signingCertificate
protected SimpleSign	simpleSign
protected Duration	timeout
protected org.opensaml.core.xml.XMLObject	xmlObject

Constructor Summary

Constructors

Constructor and Description
Builder(SimpleSign simpleSign) Creates a new SamlValidator.Builder with the given SimpleSign.

Method Summary

Modifier and Type	Method and Description
SamlValidator	build(String destination, SamlProtocol.Binding binding, org.opensaml.xmlsec.signature.SignableXMLObject xmlObject)
void	buildAndValidate(String destination, SamlProtocol.Binding binding, org.opensaml.xmlsec.signature.SignableXMLObject xmlObject) Utility method that calls the build(String, SamlProtocol.Binding, SignableXMLObject) method and then validates the object.
SamlValidator.Builder	setClockSkew(Duration clockSkew)
SamlValidator.Builder	setRedirectParams(String relayState, String signature, String sigAlgo, String samlString, String signingCertificate)
SamlValidator.Builder	setRequestId(String requestId)
SamlValidator.Builder	setTimeout(Duration timeout)

Methods inherited from class java.lang.Object

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

Field Detail

simpleSign

protected SimpleSign simpleSign

binding

protected SamlProtocol.Binding binding

isRequest

protected boolean isRequest

xmlObject

protected org.opensaml.core.xml.XMLObject xmlObject

timeout

protected Duration timeout

clockSkew

protected Duration clockSkew

requestId

protected String requestId

destination

protected String destination

relayState

protected String relayState

signature

protected String signature

sigAlgo

protected String sigAlgo

samlString

protected String samlString

signingCertificate

protected String signingCertificate

Constructor Detail

Builder

public Builder(SimpleSign simpleSign)

Creates a new SamlValidator.Builder with the given SimpleSign.
Create a new instance, set any optional arguments, and then finish by calling either build() or buildAndValidate.

Parameters:

simpleSign - an instance of SimpleSign

Method Detail

buildAndValidate

public void buildAndValidate(@NotNull
                             String destination,
                             @NotNull
                             SamlProtocol.Binding binding,
                             @NotNull
                             org.opensaml.xmlsec.signature.SignableXMLObject xmlObject)
                      throws IllegalStateException,
                             ValidationException

Utility method that calls the build(String, SamlProtocol.Binding, SignableXMLObject) method and then validates the object.

Parameters:

destination - The actual endpoint that the saml object was sent to, not the destination field on the object

binding - The binding of the object (POST or REDIRECT)

xmlObject - target object to validate

Throws:

IllegalStateException

ValidationException

build

public SamlValidator build(@NotNull
                           String destination,
                           @NotNull
                           SamlProtocol.Binding binding,
                           @NotNull
                           org.opensaml.xmlsec.signature.SignableXMLObject xmlObject)
                    throws IllegalStateException,
                           ValidationException

Parameters:

destination - The actual endpoint that the saml object was sent to, not the destination field on the object

binding - The binding of the object (POST or REDIRECT)

xmlObject - target object to validate

Returns:

A SamlValidator object

Throws:

IllegalStateException

ValidationException

setRedirectParams

public SamlValidator.Builder setRedirectParams(String relayState,
                                               String signature,
                                               String sigAlgo,
                                               String samlString,
                                               String signingCertificate)

setRequestId

public SamlValidator.Builder setRequestId(@NotNull
                                          String requestId)

setTimeout

public SamlValidator.Builder setTimeout(@NotNull
                                        Duration timeout)

setClockSkew

public SamlValidator.Builder setClockSkew(@NotNull
                                          Duration clockSkew)