org.adroitlogic.soapbox.api

Interface WSSecurityManager

public interface WSSecurityManager

Defines WS-Security parameters to the UltraESB configuration, and serves as the central point of control for securing and verifying of messages

See sample # 204

Author:

asankha

Method Summary

Methods

Modifier and Type	Method and Description
void	addDigestUsernameTokenAuthentication(Message msg, String username, String password) Add a WS-Security Username Token authentication element to the request, with a nonce, created and hashed password
void	addDigestUsernameTokenAuthenticationWithTimestamp(Message msg, String username, String password) Add a WS-Security Username Token authentication element and a Timestamp element to the request, with a nonce, created and hashed password
void	addPlainUsernameTokenAuthenticationWithTimestamp(Message msg, String username, String password) Add a WS-Security Username Token authentication element and a Timestamp elemtn to the request, with a nonce, created and hashed password
void	addUsernameTokenAuthentication(Message msg, String username, String password, boolean hashed, boolean addNonceAndCreated, boolean includeTimestamp) Add a WS-Security Username Token authentication element to the request
void	addUsernameTokenAuthentication(Message msg, String username, String password, boolean hashed, boolean addNonceAndCreated, boolean includeTimestamp, boolean mustUnderstand) Add a WS-Security Username Token authentication element to the request
void	removeSecurityHeader(Message msg) Remove the WS-Security header from a message
void	signMessage(Message msg, String signAlias, String signAlgo, String digestAlgo) Secure the message with signature
void	timestampAndEncryptMessage(Message msg, String encryptionAlias) Secure message with a timestamp and encrypt - using default timestamp TTL of 5 minutes and key size of 256
void	timestampAndEncryptMessage(Message msg, String encryptionAlias, long millis, String algo) Secure message with a timestamp and encrypt - using specified timestamp TTL
void	timestampAndSignMessage(Message msg, String signatureAlias) Secure message with a timestamp and signature - using default timestamp TTL of 5 minutes
void	timestampAndSignMessage(Message msg, String signatureAlias, long millis) Secure message with a timestamp and signature - using specified timestamp TTL
void	timestampMessage(Message msg) Secure message with a timestamp - using default timestamp TTL of 5 minutes
void	timestampMessage(Message msg, long millis) Secure message with a timestamp - using specified timestamp TTL
void	timestampSignAndEncryptMessage(Message msg, String encryptionAlias, String signatureAlias) Secure message with a timestamp, signature and encrypt body - using default timestamp TTL of 5 minutes and keysize of 256
void	timestampSignAndEncryptMessage(Message msg, String encryptionAlias, String signatureAlias, long millis, String algo) Secure message with a timestamp, signature and encrypt body - using specified timestamp TTL
void	verifySignedMessage(Message msg, boolean remove) Verify that the message is valid using public key certificates
void	verifyTimestampedAndEncryptedMessage(Message msg, boolean remove) Verify that the message is timestamped and encrypted
void	verifyTimestampedAndSignedMessage(Message msg, boolean remove) Verify that the message is timestamped and signed
void	verifyTimestampedEncryptedAndSignedMessage(Message msg, boolean remove) Verify that the message is timestamped, encrypted and signed
void	verifyTimestampedMessage(Message msg, boolean remove) Verify that the message is timestamped and the timestamp valid
void	verifyUsernameTokenAuthentication(Message msg) Verify that the message contains UsernameToken authentication information, and that its valid
void	verifyUsernameTokenAuthentication(Message msg, boolean remove) Verify that the message contains UsernameToken authentication information, and that its valid

Method Detail

removeSecurityHeader

void removeSecurityHeader(Message msg)

Remove the WS-Security header from a message

Parameters:

msg - the message from which the WS-Security header should be removed

timestampMessage

void timestampMessage(Message msg,
                    long millis)

Secure message with a timestamp - using specified timestamp TTL

Parameters:

msg - message to timestamp

millis - timestamp TTL

timestampMessage

void timestampMessage(Message msg)

Secure message with a timestamp - using default timestamp TTL of 5 minutes

Parameters:

msg - message to timestamp

timestampAndSignMessage

void timestampAndSignMessage(Message msg,
                           String signatureAlias,
                           long millis)

Secure message with a timestamp and signature - using specified timestamp TTL

Parameters:

msg - message to secure

signatureAlias - alias of credentials for signature

millis - timestamp TTL

signMessage

void signMessage(Message msg,
               String signAlias,
               String signAlgo,
               String digestAlgo)

Secure the message with signature

Parameters:

msg - message to secure

signAlias - alias of credentials for signature

signAlgo - signing algorithm to be used

digestAlgo - digest algorithm to be used to generate the hash

timestampAndSignMessage

void timestampAndSignMessage(Message msg,
                           String signatureAlias)

Secure message with a timestamp and signature - using default timestamp TTL of 5 minutes

Parameters:

msg - message to secure

signatureAlias - alias of credentials for signature

timestampAndEncryptMessage

void timestampAndEncryptMessage(Message msg,
                              String encryptionAlias,
                              long millis,
                              String algo)

Secure message with a timestamp and encrypt - using specified timestamp TTL

Parameters:

msg - message to secure

encryptionAlias - alias of credentials for encryption

algo - encryption algorithm URI or prefix

timestampAndEncryptMessage

void timestampAndEncryptMessage(Message msg,
                              String encryptionAlias)

Secure message with a timestamp and encrypt - using default timestamp TTL of 5 minutes and key size of 256

Parameters:

msg - message to secure

encryptionAlias - alias of credentials for encryption

timestampSignAndEncryptMessage

void timestampSignAndEncryptMessage(Message msg,
                                  String encryptionAlias,
                                  String signatureAlias,
                                  long millis,
                                  String algo)

Secure message with a timestamp, signature and encrypt body - using specified timestamp TTL

Parameters:

msg - message to secure

encryptionAlias - alias of credentials for encryption

signatureAlias - alias of credentials for signature

millis - timestamp TTL

algo - encryption algorithm

timestampSignAndEncryptMessage

void timestampSignAndEncryptMessage(Message msg,
                                  String encryptionAlias,
                                  String signatureAlias)

Secure message with a timestamp, signature and encrypt body - using default timestamp TTL of 5 minutes and keysize of 256

Parameters:

msg - message to secure

encryptionAlias - alias of credentials for encryption

signatureAlias - alias of credentials for signature

addUsernameTokenAuthentication

void addUsernameTokenAuthentication(Message msg,
                                  String username,
                                  String password,
                                  boolean hashed,
                                  boolean addNonceAndCreated,
                                  boolean includeTimestamp)

Add a WS-Security Username Token authentication element to the request

Parameters:

msg - message to secure

username - username to add

password - password to add

hashed - true if password is a digest

addNonceAndCreated - true if a nonce and digest should be added (true of hashed)

includeTimestamp - should a Timestamp element be included?

addUsernameTokenAuthentication

void addUsernameTokenAuthentication(Message msg,
                                  String username,
                                  String password,
                                  boolean hashed,
                                  boolean addNonceAndCreated,
                                  boolean includeTimestamp,
                                  boolean mustUnderstand)

Add a WS-Security Username Token authentication element to the request

Parameters:

msg - message to secure

username - username to add

password - password to add

hashed - true if password is a digest

addNonceAndCreated - true if a nonce and digest should be added (true of hashed)

includeTimestamp - should a Timestamp element be included?

mustUnderstand - decides the must-understand flag of the security header

addDigestUsernameTokenAuthentication

void addDigestUsernameTokenAuthentication(Message msg,
                                        String username,
                                        String password)

Add a WS-Security Username Token authentication element to the request, with a nonce, created and hashed password

Parameters:

msg - message to secure

username - username to add

password - password to add

addDigestUsernameTokenAuthenticationWithTimestamp

void addDigestUsernameTokenAuthenticationWithTimestamp(Message msg,
                                                     String username,
                                                     String password)

Add a WS-Security Username Token authentication element and a Timestamp element to the request, with a nonce, created and hashed password

Parameters:

msg - message to secure

username - username to add

password - password to add

addPlainUsernameTokenAuthenticationWithTimestamp

void addPlainUsernameTokenAuthenticationWithTimestamp(Message msg,
                                                    String username,
                                                    String password)

Add a WS-Security Username Token authentication element and a Timestamp elemtn to the request, with a nonce, created and hashed password

Parameters:

msg - message to secure

username - username to add

password - password to add

verifyTimestampedMessage

void verifyTimestampedMessage(Message msg,
                            boolean remove)

Verify that the message is timestamped and the timestamp valid

Parameters:

msg - message to validate

remove - remove security header after processing

verifySignedMessage

void verifySignedMessage(Message msg,
                       boolean remove)

Verify that the message is valid using public key certificates

Parameters:

msg - message to validate

remove - remove security header after processing

verifyTimestampedAndSignedMessage

void verifyTimestampedAndSignedMessage(Message msg,
                                     boolean remove)

Verify that the message is timestamped and signed

Parameters:

msg - message to validate

remove - remove security header after processing

verifyTimestampedAndEncryptedMessage

void verifyTimestampedAndEncryptedMessage(Message msg,
                                        boolean remove)

Verify that the message is timestamped and encrypted

Parameters:

msg - message to validate

remove - remove security header after processing

verifyTimestampedEncryptedAndSignedMessage

void verifyTimestampedEncryptedAndSignedMessage(Message msg,
                                              boolean remove)

Verify that the message is timestamped, encrypted and signed

Parameters:

msg - message to validate

remove - remove security header after processing

verifyUsernameTokenAuthentication

void verifyUsernameTokenAuthentication(Message msg,
                                     boolean remove)

Verify that the message contains UsernameToken authentication information, and that its valid

Parameters:

msg - message to validate

remove - remove security header after processing

verifyUsernameTokenAuthentication

void verifyUsernameTokenAuthentication(Message msg)

Verify that the message contains UsernameToken authentication information, and that its valid

Parameters:

msg - message to validate