org.eclipse.milo.opcua.sdk.server.identity

Class AbstractIdentityValidator

java.lang.Object

org.eclipse.milo.opcua.sdk.server.identity.AbstractIdentityValidator

All Implemented Interfaces:

IdentityValidator

Direct Known Subclasses:

AnonymousIdentityValidator, UsernameIdentityValidator, X509IdentityValidator

public abstract class AbstractIdentityValidator
extends Object
implements IdentityValidator

Constructor Summary

Constructors

Constructor and Description
AbstractIdentityValidator()

Method Summary

Modifier and Type	Method and Description
protected byte[]	decryptTokenData(ServerSecureChannel channel, Session session, SecurityAlgorithm algorithm, byte[] dataBytes) Decrypt the data contained in a UserNameIdentityToken or IssuedIdentityToken.
protected Object	validateAnonymousToken(ServerSecureChannel channel, Session session, AnonymousIdentityToken token, UserTokenPolicy tokenPolicy, SignatureData tokenSignature) Validate an AnonymousIdentityToken and return an identity Object that represents the user.
Object	validateIdentityToken(ServerSecureChannel channel, Session session, UserIdentityToken token, UserTokenPolicy tokenPolicy, SignatureData tokenSignature) Validate the provided UserIdentityToken and return an identity Object that represents the user.
protected Object	validateIssuedIdentityToken(ServerSecureChannel channel, Session session, IssuedIdentityToken token, UserTokenPolicy tokenPolicy, SignatureData tokenSignature) Validate an IssuedIdentityToken and return an identity Object that represents the user.
protected Object	validateUsernameToken(ServerSecureChannel channel, Session session, UserNameIdentityToken token, UserTokenPolicy tokenPolicy, SignatureData tokenSignature) Validate a UserNameIdentityToken and return an identity Object that represents the user.
protected Object	validateX509Token(ServerSecureChannel channel, Session session, X509IdentityToken token, UserTokenPolicy tokenPolicy, SignatureData tokenSignature) Validate an X509IdentityToken and return an identity Object that represents the user.

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractIdentityValidator

public AbstractIdentityValidator()

Method Detail

validateIdentityToken

public Object validateIdentityToken(ServerSecureChannel channel,
                                    Session session,
                                    UserIdentityToken token,
                                    UserTokenPolicy tokenPolicy,
                                    SignatureData tokenSignature)
                             throws UaException

Description copied from interface: IdentityValidator

Validate the provided UserIdentityToken and return an identity Object that represents the user.

This Object should implement equality in such a way that a subsequent identity validation for the same user yields a comparable Object.

Specified by:

validateIdentityToken in interface IdentityValidator

Parameters:

channel - the ServerSecureChannel the request is arriving on.

session - the Session the request is arriving on.

token - the UserIdentityToken.

tokenPolicy - the UserTokenPolicy specified by the policyId in token.

tokenSignature - the SignatureData sent in the ActivateSessionRequest

Returns:

an identity Object that represents the user.

Throws:

UaException - if the token is invalid, rejected, or user access is denied.

validateAnonymousToken

protected Object validateAnonymousToken(ServerSecureChannel channel,
                                        Session session,
                                        AnonymousIdentityToken token,
                                        UserTokenPolicy tokenPolicy,
                                        SignatureData tokenSignature)
                                 throws UaException

Validate an AnonymousIdentityToken and return an identity Object that represents the user.

This Object should implement equality in such a way that a subsequent identity validation for the same user yields a comparable Object.

Parameters:

channel - the ServerSecureChannel the request is arriving on.

session - the Session the request is arriving on.

token - the AnonymousIdentityToken.

tokenPolicy - the UserTokenPolicy specified by the policyId in token.

tokenSignature - the SignatureData sent in the ActivateSessionRequest.

Returns:

an identity Object that represents the user.

Throws:

UaException - if the token is invalid, rejected, or user access is denied.

validateUsernameToken

protected Object validateUsernameToken(ServerSecureChannel channel,
                                       Session session,
                                       UserNameIdentityToken token,
                                       UserTokenPolicy tokenPolicy,
                                       SignatureData tokenSignature)
                                throws UaException

Validate a UserNameIdentityToken and return an identity Object that represents the user.

This Object should implement equality in such a way that a subsequent identity validation for the same user yields a comparable Object.

Parameters:

channel - the ServerSecureChannel the request is arriving on.

session - the Session the request is arriving on.

token - the UserNameIdentityToken.

tokenPolicy - the UserTokenPolicy specified by the policyId in token.

tokenSignature - the SignatureData sent in the ActivateSessionRequest.

Returns:

an identity Object that represents the user.

Throws:

UaException - if the token is invalid, rejected, or user access is denied.

validateX509Token

protected Object validateX509Token(ServerSecureChannel channel,
                                   Session session,
                                   X509IdentityToken token,
                                   UserTokenPolicy tokenPolicy,
                                   SignatureData tokenSignature)
                            throws UaException

Validate an X509IdentityToken and return an identity Object that represents the user.

This Object should implement equality in such a way that a subsequent identity validation for the same user yields a comparable Object.

Parameters:

channel - the ServerSecureChannel the request is arriving on.

session - the Session the request is arriving on.

token - the X509IdentityToken.

tokenPolicy - the UserTokenPolicy specified by the policyId in token.

tokenSignature - the SignatureData sent in the ActivateSessionRequest.

Returns:

an identity Object that represents the user.

Throws:

UaException - if the token is invalid, rejected, or user access is denied.

validateIssuedIdentityToken

protected Object validateIssuedIdentityToken(ServerSecureChannel channel,
                                             Session session,
                                             IssuedIdentityToken token,
                                             UserTokenPolicy tokenPolicy,
                                             SignatureData tokenSignature)
                                      throws UaException

Validate an IssuedIdentityToken and return an identity Object that represents the user.

This Object should implement equality in such a way that a subsequent identity validation for the same user yields a comparable Object.

Parameters:

channel - the ServerSecureChannel the request is arriving on.

session - the Session the request is arriving on.

token - the IssuedIdentityToken.

tokenPolicy - the UserTokenPolicy specified by the policyId in token.

tokenSignature - the SignatureData sent in the ActivateSessionRequest.

Returns:

an identity Object that represents the user.

Throws:

UaException - if the token is invalid, rejected, or user access is denied.

decryptTokenData

protected byte[] decryptTokenData(ServerSecureChannel channel,
                                  Session session,
                                  SecurityAlgorithm algorithm,
                                  byte[] dataBytes)
                           throws UaException

Decrypt the data contained in a UserNameIdentityToken or IssuedIdentityToken.

See UserNameIdentityToken.getPassword() and IssuedIdentityToken.getTokenData().

Parameters:

channel - the ServerSecureChannel.

session - the current Session.

dataBytes - the encrypted data.

Returns:

the decrypted data.

Throws:

UaException - if decryption fails.