Package swiss.trustbroker.config.dto

Class WsTrustConfig

java.lang.Object
swiss.trustbroker.config.dto.WsTrustConfig
public class WsTrustConfig extends Object
WS-Trust protocol configuration.

  • Constructor Details

    • WsTrustConfig

      public WsTrustConfig()

    • WsTrustConfig

      public WsTrustConfig(boolean enabled, String cert, String type, String alias, String password, String wsBasePath, boolean issueEnabled, boolean renewEnabled, List<String> bindings, boolean renewRequiresSsoSession, boolean renewRequiresSecurityToken, boolean issueRequireSignedRequests, boolean issueRequireTimestamp, boolean issueRequireSignedAssertions, boolean renewRequireSignedRequests, boolean doSignResponse, long lifetimeMin, WsTrustConfig.SoapVersionConfig soapVersion, List<String> soapHeadersToConsider, List<String> allowedNetworks, boolean enforceNetwork, String allowedClientIpRegex, boolean enforceClientIp)
      Deprecated.
      use bindings
      Creates a new WsTrustConfig instance.
      Parameters:
      enabled - Feature toggle allowing to disable the WSTrust endpoint
      Default: false (since 1.13.0)
      cert - Keystore path.
      type - Keystore type.
      alias - Keystore alias.
      password - Keystore password.
      wsBasePath - Allow base path differing from SAML API.
      issueEnabled - Enable ISSUE request.
      Default: false (since 1.13.0)
      renewEnabled - Enable RENEW request.
      Default: false
      bindings - List of exposed WS-Trust bindings.
      Default: none
      renewRequiresSsoSession - RENEW request requires a valid SSO session.
      Default: true
      renewRequiresSecurityToken - RENEW request requires a valid security token.
      Default: true
      issueRequireSignedRequests - Require signed SOAP requests for WS-Trust ISSUE.
      Default: true
      issueRequireTimestamp - WS-Trust ISSUE requires timestamp.
      Default: true
      issueRequireSignedAssertions - Require signed SOAP requests for WS-Trust ISSUE.
      Default: true
      renewRequireSignedRequests - Require signed SOAP requests for WS-Trust RENEW.
      Default: true
      doSignResponse - Sign SOAP responses.
      Default: true
      lifetimeMin - Lifetime expiration in minutes.
      Default: 480 (8 hours)
      soapVersion - SOAP version.
      Default: SOAP_1_X (alternatives SOAP_1_1, SOAP_1_2)
      soapHeadersToConsider - SOAP headers considered by the WS-Trust implementation.
      Default: not set
      allowedNetworks - List of client networks allowed (using trustbroker.config.network.networkHeader HTTP header). Default: not restricted
      enforceNetwork - Client networks enforced if configured (allowedNetworks).
      Default: true - set to false in order to warn for violations only
      allowedClientIpRegex - Regex of client IPs allowed (using X-Forwarded-For HTTP header).
      enforceClientIp - Client IPs enforced if configured (allowedClientIpRegex).
      Default: true - set to false in order to warn for violations only
      Since:
      1.9.0, 1.13.0, 1.12.0, 1.11.0, 1.14.0, 1.11.0, 1.11.0, 1.13.0, 1.15.0, 1.13.0, 1.13.0, 1.13.0, 1.12.0, 1.13.0, 1.13.0, 1.13.0, 1.13.0
      See Also:

  • Method Details

    • getWsTrustBindings

      public Set<WsTrustBinding> getWsTrustBindings()

    • builder

      public static WsTrustConfig.WsTrustConfigBuilder builder()

    • isEnabled

      public boolean isEnabled()
      Feature toggle allowing to disable the WSTrust endpoint
      Default: false (since 1.13.0)
      Since:
      1.9.0

    • getCert

      public String getCert()
      Keystore path.

    • getType

      public String getType()
      Keystore type.

    • getAlias

      public String getAlias()
      Keystore alias.
      Since:
      1.13.0

    • getPassword

      public String getPassword()
      Keystore password.

    • getWsBasePath

      public String getWsBasePath()
      Allow base path differing from SAML API.

    • isIssueEnabled

      @Deprecated public boolean isIssueEnabled()
      Deprecated.
      use bindings
      Enable ISSUE request.
      Default: false (since 1.13.0)
      Since:
      1.12.0

    • isRenewEnabled

      @Deprecated public boolean isRenewEnabled()
      Deprecated.
      use bindings
      Enable RENEW request.
      Default: false
      Since:
      1.11.0

    • getBindings

      public List<String> getBindings()
      List of exposed WS-Trust bindings.
      Default: none
      Since:
      1.14.0
      See Also:

    • isRenewRequiresSsoSession

      public boolean isRenewRequiresSsoSession()
      RENEW request requires a valid SSO session.
      Default: true
      Since:
      1.11.0

    • isRenewRequiresSecurityToken

      public boolean isRenewRequiresSecurityToken()
      RENEW request requires a valid security token.
      Default: true
      Since:
      1.11.0

    • isIssueRequireSignedRequests

      public boolean isIssueRequireSignedRequests()
      Require signed SOAP requests for WS-Trust ISSUE.
      Default: true
      Since:
      1.13.0

    • isIssueRequireTimestamp

      public boolean isIssueRequireTimestamp()
      WS-Trust ISSUE requires timestamp.
      Default: true
      Since:
      1.15.0

    • isIssueRequireSignedAssertions

      @Deprecated public boolean isIssueRequireSignedAssertions()
      Deprecated.
      Require signed SOAP requests for WS-Trust ISSUE.
      Default: true
      Since:
      1.13.0

    • isRenewRequireSignedRequests

      public boolean isRenewRequireSignedRequests()
      Require signed SOAP requests for WS-Trust RENEW.
      Default: true
      Since:
      1.13.0

    • isDoSignResponse

      public boolean isDoSignResponse()
      Sign SOAP responses.
      Default: true
      Since:
      1.13.0

    • getLifetimeMin

      public long getLifetimeMin()
      Lifetime expiration in minutes.
      Default: 480 (8 hours)
      Since:
      1.12.0

    • getSoapVersion

      public WsTrustConfig.SoapVersionConfig getSoapVersion()
      SOAP version.
      Default: SOAP_1_X (alternatives SOAP_1_1, SOAP_1_2)

    • getSoapHeadersToConsider

      public List<String> getSoapHeadersToConsider()
      SOAP headers considered by the WS-Trust implementation.
      Default: not set

    • getAllowedNetworks

      public List<String> getAllowedNetworks()
      List of client networks allowed (using trustbroker.config.network.networkHeader HTTP header). Default: not restricted
      Since:
      1.13.0

    • isEnforceNetwork

      public boolean isEnforceNetwork()
      Client networks enforced if configured (allowedNetworks).
      Default: true - set to false in order to warn for violations only
      Since:
      1.13.0

    • getAllowedClientIpRegex

      public String getAllowedClientIpRegex()
      Regex of client IPs allowed (using X-Forwarded-For HTTP header).
      Since:
      1.13.0

    • isEnforceClientIp

      public boolean isEnforceClientIp()
      Client IPs enforced if configured (allowedClientIpRegex).
      Default: true - set to false in order to warn for violations only
      Since:
      1.13.0

    • setEnabled

      public void setEnabled(boolean enabled)
      Feature toggle allowing to disable the WSTrust endpoint
      Default: false (since 1.13.0)
      Since:
      1.9.0

    • setCert

      public void setCert(String cert)
      Keystore path.

    • setType

      public void setType(String type)
      Keystore type.

    • setAlias

      public void setAlias(String alias)
      Keystore alias.
      Since:
      1.13.0

    • setPassword

      public void setPassword(String password)
      Keystore password.

    • setWsBasePath

      public void setWsBasePath(String wsBasePath)
      Allow base path differing from SAML API.

    • setIssueEnabled

      @Deprecated public void setIssueEnabled(boolean issueEnabled)
      Deprecated.
      use bindings
      Enable ISSUE request.
      Default: false (since 1.13.0)
      Since:
      1.12.0

    • setRenewEnabled

      @Deprecated public void setRenewEnabled(boolean renewEnabled)
      Deprecated.
      use bindings
      Enable RENEW request.
      Default: false
      Since:
      1.11.0

    • setBindings

      public void setBindings(List<String> bindings)
      List of exposed WS-Trust bindings.
      Default: none
      Since:
      1.14.0
      See Also:

    • setRenewRequiresSsoSession

      public void setRenewRequiresSsoSession(boolean renewRequiresSsoSession)
      RENEW request requires a valid SSO session.
      Default: true
      Since:
      1.11.0

    • setRenewRequiresSecurityToken

      public void setRenewRequiresSecurityToken(boolean renewRequiresSecurityToken)
      RENEW request requires a valid security token.
      Default: true
      Since:
      1.11.0

    • setIssueRequireSignedRequests

      public void setIssueRequireSignedRequests(boolean issueRequireSignedRequests)
      Require signed SOAP requests for WS-Trust ISSUE.
      Default: true
      Since:
      1.13.0

    • setIssueRequireTimestamp

      public void setIssueRequireTimestamp(boolean issueRequireTimestamp)
      WS-Trust ISSUE requires timestamp.
      Default: true
      Since:
      1.15.0

    • setIssueRequireSignedAssertions

      @Deprecated public void setIssueRequireSignedAssertions(boolean issueRequireSignedAssertions)
      Deprecated.
      Require signed SOAP requests for WS-Trust ISSUE.
      Default: true
      Since:
      1.13.0

    • setRenewRequireSignedRequests

      public void setRenewRequireSignedRequests(boolean renewRequireSignedRequests)
      Require signed SOAP requests for WS-Trust RENEW.
      Default: true
      Since:
      1.13.0

    • setDoSignResponse

      public void setDoSignResponse(boolean doSignResponse)
      Sign SOAP responses.
      Default: true
      Since:
      1.13.0

    • setLifetimeMin

      public void setLifetimeMin(long lifetimeMin)
      Lifetime expiration in minutes.
      Default: 480 (8 hours)
      Since:
      1.12.0

    • setSoapVersion

      public void setSoapVersion(WsTrustConfig.SoapVersionConfig soapVersion)
      SOAP version.
      Default: SOAP_1_X (alternatives SOAP_1_1, SOAP_1_2)

    • setSoapHeadersToConsider

      public void setSoapHeadersToConsider(List<String> soapHeadersToConsider)
      SOAP headers considered by the WS-Trust implementation.
      Default: not set

    • setAllowedNetworks

      public void setAllowedNetworks(List<String> allowedNetworks)
      List of client networks allowed (using trustbroker.config.network.networkHeader HTTP header). Default: not restricted
      Since:
      1.13.0

    • setEnforceNetwork

      public void setEnforceNetwork(boolean enforceNetwork)
      Client networks enforced if configured (allowedNetworks).
      Default: true - set to false in order to warn for violations only
      Since:
      1.13.0

    • setAllowedClientIpRegex

      public void setAllowedClientIpRegex(String allowedClientIpRegex)
      Regex of client IPs allowed (using X-Forwarded-For HTTP header).
      Since:
      1.13.0

    • setEnforceClientIp

      public void setEnforceClientIp(boolean enforceClientIp)
      Client IPs enforced if configured (allowedClientIpRegex).
      Default: true - set to false in order to warn for violations only
      Since:
      1.13.0

    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class Object

    • canEqual

      protected boolean canEqual(Object other)

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • toString

      public String toString()
      Overrides:
      toString in class Object