org.systinet.wasp.security.ws.conf
Interface WSSEGlobalConf

All Superinterfaces:

WSSEConf, WSSEProviderConf

public interface WSSEGlobalConf

extends WSSEProviderConf

Represents global persistent configuration of WS-Security. It extends configuration defined by WSSEProviderConf with namespaces, namespace prefixes and expiration times.
It is located in both client and service deployment descriptors of WSO2 SOA Enablement Server component security_providers. It is located in configuration/config part of deployment descriptor in element <securityProviderPreferences name="WS-Security">. The schema of configuration is described below.

Default persistent configuration contains one Username security token initialized from NamePasswordCredential.

Complete schema of the persistent configurations:

• schema of global (default) configuration is WSSEGlobalConf schema
• schema of configuration on service endpoint and service client is WSSEProviderConf

  <xsd:complexType name="WSSEGlobalConf">
      <xsd:complexContent>
          <xsd:extension base="tns:WSSEProviderConf">
              <xsd:sequence>
                  <xsd:element name="dsNamespace" nillable="true" type="xsd:string"/>
                  <xsd:element name="dsPrefix" nillable="true" type="xsd:string"/>
                  <xsd:element name="encNamespace" nillable="true" type="xsd:string"/>
                  <xsd:element name="encPrefix" nillable="true" type="xsd:string"/>
                  <xsd:element name="timestampHeaderExpiration" nillable="true" type="xsd:int"/>
                  <xsd:element name="clockSkew" nillable="true" type="xsd:int"/>
                  <xsd:element name="tokenExpiration" nillable="true" type="xsd:int"/>
                  <xsd:element name="wssePrefix" nillable="true" type="xsd:string"/>
                  <xsd:element name="wsuPrefix" nillable="true" type="xsd:string"/>
                  <xsd:element name="securityTokenHandler" nillable="true" type="xsd:string" minOccurs="0"/>
              </xsd:sequence>
          </xsd:extension>
      </xsd:complexContent>
 </xsd:complexType>

 <xsd:complexType name="WSSEProviderConf">
      <xsd:complexContent>
          <xsd:extension base="tns:WSSEConf">
              <xsd:sequence>
                  <xsd:element name="securedMessage" nillable="true" type="tns:SecuredMessage" minOccurs="0"/>
              </xsd:sequence>
          </xsd:extension>
      </xsd:complexContent>
  </xsd:complexType>

  <xsd:complexType name="WSSEConf">
      <xsd:sequence>
          <xsd:element name="disableCertCheck" nillable="true" type="xsd:boolean"/>
          <xsd:element name="externalSecurityToken" nillable="true" type="tns:ExternalSecurityTokensConf"/>
          <xsd:element name="ignoreTimestampHeaderExpiration" nillable="true" type="xsd:boolean"/>
          <xsd:element name="noUsernameTokenValidation" nillable="true" type="xsd:boolean"/>
          <xsd:element name="validatorClassName" nillable="true" type="xsd:string"/>
      </xsd:sequence>
  </xsd:complexType>

  <xsd:complexType name="ExternalSecurityTokensConf">
      <xsd:sequence>
          <xsd:element name="securityToken" nillable="true" type="tns:SecurityTokenConf" minOccurs="0"/>
      </xsd:sequence>
  </xsd:complexType>

  <xsd:complexType name="SecurityTokenConf">
      <xsd:sequence>
          <xsd:element name="property" nillable="true" type="tns:PropertyConf" minOccurs="0"/>
          <xsd:element name="type" nillable="true" type="xsd:string"/>
          <xsd:element name="order" nillable="true" type="xsd:int"/>
          <xsd:element name="wsuId" nillable="true" type="xsd:string"/>
      </xsd:sequence>
  </xsd:complexType>

  <xsd:complexType name="PropertyConf">
      <xsd:sequence>
          <xsd:element name="propertyName" nillable="false" type="xsd:string"/>
          <xsd:element name="propertyValue" nillable="true" type="xsd:string"/>
      </xsd:sequence>
  </xsd:complexType>

  <xsd:complexType name="SecuredMessage">
      <xsd:sequence>
          <xsd:element name="messageConf" nillable="true" type="tns:MessageConf"/>
          <xsd:element name="methodName" nillable="true" type="xsd:string" minOccurs="0"/>
      </xsd:sequence>
  </xsd:complexType>

  <xsd:complexType name="MessageConf">
      <xsd:sequence>
          <xsd:element name="encryptedData" nillable="true" type="tns:EncryptedDataConf" minOccurs="0"/>
          <xsd:element name="encryptedKey" nillable="true" type="tns:EncryptedKeyConf" minOccurs="0"/>
          <xsd:element name="referenceList" nillable="true" type="tns:ReferenceListConf" minOccurs="0"/>
          <xsd:element name="securityToken" nillable="true" type="tns:SecurityTokenConf" minOccurs="0"/>
          <xsd:element name="signature" nillable="true" type="tns:SignatureConf" minOccurs="0"/>
          <xsd:element name="createTimestampHeader" nillable="true" type="xsd:boolean"/>
          <xsd:element name="timestampId" nillable="true" type="xsd:string"/>
          <xsd:element name="mustUnderstand" nillable="true" type="xsd:boolean"/>
          <xsd:element name="mustUnderstandTimestampHeader" nillable="true" type="xsd:boolean"/>
          <xsd:element name="NoSecurityHeader" nillable="true" type="xsd:boolean"/>
          <xsd:element name="role" nillable="true" type="xsd:string"/>
          <xsd:element name="secureFault" nillable="true" type="xsd:boolean"/>
          <xsd:element name="wsseNamespace" nillable="true" type="xsd:string"/>
          <xsd:element name="wsuNamespace" nillable="true" type="xsd:string"/>
          <xsd:element name="wsuId" nillable="true" type="xsd:string"/>
      </xsd:sequence>
  </xsd:complexType>

  <xsd:complexType name="EncryptedDataConf">
      <xsd:complexContent>
          <xsd:extension base="tns:EncryptedTypeConf">
              <xsd:sequence>
                  <xsd:element name="encryptBody" nillable="true" type="xsd:boolean"/>
                  <xsd:element name="encryptElementContent" nillable="true" type="xsd:boolean"/>
                  <xsd:element name="encryptionTargetId" nillable="true" type="xsd:string"/>
              </xsd:sequence>
          </xsd:extension>
      </xsd:complexContent>
  </xsd:complexType>

  <xsd:complexType name="EncryptedKeyConf">
      <xsd:complexContent>
          <xsd:extension base="tns:EncryptedTypeConf">
              <xsd:sequence>
                  <xsd:element name="encodedStoredKey" nillable="true" type="xsd:base64Binary"/>
                  <xsd:element name="reference" nillable="false" type="tns:EncryptionReferenceConf" minOccurs="1"/>
              </xsd:sequence>
          </xsd:extension>
      </xsd:complexContent>
  </xsd:complexType>

  <xsd:complexType name="EncryptedTypeConf">
      <xsd:sequence>
          <xsd:element name="IV" nillable="true" type="xsd:base64Binary"/>
          <xsd:element name="encryptionMethodAlgorithm" nillable="false" type="xsd:string"/>
          <xsd:element name="encryptionMethodProperty" nillable="true" type="tns:PropertyConf" minOccurs="0"/>
          <xsd:element name="keyInfo" nillable="true" type="tns:KeyInfoConf"/>
          <xsd:element name="order" nillable="true" type="xsd:int"/>
          <xsd:element name="wsuId" nillable="true" type="xsd:string"/>
      </xsd:sequence>
  </xsd:complexType>

  <xsd:complexType name="KeyInfoConf">
      <xsd:sequence>
          <xsd:element name="securityTokenId" nillable="true" type="xsd:string"/>
          <xsd:element name="securityTokenMode" nillable="true" type="xsd:string"/>
          <xsd:element name="strWsuId" nillable="true" type="xsd:string"/>
          <xsd:element name="wsuId" nillable="true" type="xsd:string"/>
      </xsd:sequence>
  </xsd:complexType>

  <xsd:complexType name="EncryptionReferenceConf">
      <xsd:sequence>
          <xsd:element name="URI" nillable="true" type="xsd:string"/>
      </xsd:sequence>
  </xsd:complexType>

  <xsd:complexType name="ReferenceListConf">
      <xsd:sequence>
          <xsd:element name="reference" nillable="true" type="tns:EncryptionReferenceConf" minOccurs="0"/>
          <xsd:element name="order" nillable="true" type="xsd:int"/>
          <xsd:element name="wsuId" nillable="true" type="xsd:string"/>
      </xsd:sequence>
  </xsd:complexType>

  <xsd:complexType name="SignatureConf">
      <xsd:sequence>
          <xsd:element name="canonicalizationMethod" nillable="true" type="xsd:string"/>
          <xsd:element name="keyInfo" nillable="true" type="tns:KeyInfoConf"/>
          <xsd:element name="reference" nillable="true" type="tns:ReferenceConf" minOccurs="0"/>
          <xsd:element name="signBody" nillable="true" type="xsd:boolean"/>
          <xsd:element name="signatureMethod" nillable="true" type="xsd:string"/>
          <xsd:element name="order" nillable="true" type="xsd:int"/>
          <xsd:element name="wsuId" nillable="true" type="xsd:string"/>
      </xsd:sequence>
  </xsd:complexType>

  <xsd:complexType name="ReferenceConf">
      <xsd:sequence>
          <xsd:element name="digestAlgorithm" nillable="true" type="xsd:string"/>
          <xsd:element name="refUri" nillable="true" type="xsd:string"/>
          <xsd:element name="transform" nillable="true" type="tns:TransformConf" minOccurs="0"/>
          <xsd:element name="wsuId" nillable="true" type="xsd:string"/>
      </xsd:sequence>
  </xsd:complexType>

  <xsd:complexType name="TransformConf">
      <xsd:sequence>
          <xsd:element name="XPath" nillable="true" type="xsd:string"/>
          <xsd:element name="algorithm" nillable="true" type="xsd:string"/>
          <xsd:element name="property" nillable="true" type="tns:PropertyConf" minOccurs="0"/>
          <xsd:element name="wsuId" nillable="true" type="xsd:string"/>
      </xsd:sequence>
  </xsd:complexType>

 

Since:

4.6

Component:

Security-Providers

Method Summary

java.lang.String	getDsNamespace() Gets namespace for the ds (XML Signature) namespace.
java.lang.String	getDsPrefix() Gets prefix for the ds (XML Signature) namespace.
java.lang.String	getEncNamespace() Gets namespace for the ds (XML Encryption) namespace.
java.lang.String	getEncPrefix() Gets prefix for the enc (XML Encryption) namespace.
java.lang.String[]	getSecurityTokenHandlers() Returns an array of security tokens handlers' class names.
java.lang.String	getWssePrefix() Gets prefix for the wsse (WS-Security) namespace.
java.lang.String	getWsuPrefix() Gets prefix for the wsu (Web-Service Utilities) namespace.
void	setDsNamespace(java.lang.String namespace)
void	setDsPrefix(java.lang.String prefix)
void	setEncNamespace(java.lang.String namespace)
void	setEncPrefix(java.lang.String prefix)
void	setSecurityTokenHandlers(java.lang.String[] tokenHandlers) Sets security token handlers' class names.
void	setWssePrefix(java.lang.String prefix)
void	setWsuPrefix(java.lang.String prefix)

Methods inherited from interface org.systinet.wasp.security.ws.conf.WSSEProviderConf

getSecuredMessages, newSecuredMessage, setSecuredMessages

Methods inherited from interface org.systinet.wasp.security.ws.conf.WSSEConf

getClockSkew, getDisableCertCheck, getExternalSecurityTokens, getFaultStackTrace, getIgnoreTimestampHeaderExpiration, getNoUsernameTokenValidation, getTimestampHeaderExpiration, getTimestampHeaderMaxAge, getTokenExpiration, getValidatorClassName, newExternalSecurityTokens, setClockSkew, setDisableCertCheck, setExternalSecurityTokens, setFaultStackTrace, setIgnoreTimestampHeaderExpiration, setNoUsernameTokenValidation, setTimestampHeaderExpiration, setTimestampHeaderMaxAge, setTokenExpiration, setValidatorClassName

Method Detail

getWssePrefix

public java.lang.String getWssePrefix()

Gets prefix for the wsse (WS-Security) namespace.

Returns:

the prefix

setWssePrefix

public void setWssePrefix(java.lang.String prefix)

getWsuPrefix

public java.lang.String getWsuPrefix()

Gets prefix for the wsu (Web-Service Utilities) namespace.

Returns:

the prefix

setWsuPrefix

public void setWsuPrefix(java.lang.String prefix)

getDsPrefix

public java.lang.String getDsPrefix()

Gets prefix for the ds (XML Signature) namespace.

Returns:

the prefix

setDsPrefix

public void setDsPrefix(java.lang.String prefix)

getDsNamespace

public java.lang.String getDsNamespace()

Gets namespace for the ds (XML Signature) namespace.

Returns:

the namespace

setDsNamespace

public void setDsNamespace(java.lang.String namespace)

getEncPrefix

public java.lang.String getEncPrefix()

Gets prefix for the enc (XML Encryption) namespace.

Returns:

the prefix

setEncPrefix

public void setEncPrefix(java.lang.String prefix)

getEncNamespace

public java.lang.String getEncNamespace()

Gets namespace for the ds (XML Encryption) namespace.

Returns:

the namespace

setEncNamespace

public void setEncNamespace(java.lang.String namespace)

setSecurityTokenHandlers

public void setSecurityTokenHandlers(java.lang.String[] tokenHandlers)

Sets security token handlers' class names.

getSecurityTokenHandlers

public java.lang.String[] getSecurityTokenHandlers()

Returns an array of security tokens handlers' class names.

Returns:

array of security tokens handlers' class names.