Package org.openmuc.jdlms

Class SecuritySuite

java.lang.Object

org.openmuc.jdlms.SecuritySuite

public class SecuritySuite
extends java.lang.Object

This Suite hold the necessary information to authenticate a client to a server and to encrypt and authenticity

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	SecuritySuite.EncryptionMechanism	Cryptographic algorithm identify the algorithm for which a derived secret symmetrical key will be used.
static class	SecuritySuite.SecurityPolicy	The security policy.
static class	SecuritySuite.SecuritySuiteBuilder

Method Summary

Modifier and Type	Method	Description
static SecuritySuite.SecuritySuiteBuilder	builder()	Creates a new Security Suite builder.
byte[]	getAuthenticationKey()	Get the authentication key.
AuthenticationMechanism	getAuthenticationMechanism()	Get the authentication mechanism.
SecuritySuite.EncryptionMechanism	getEncryptionMechanism()	Get the encryption mechanism which is used to encrypt the transported data.
byte[]	getGlobalUnicastEncryptionKey()	Get the global unicast encryption key.
byte[]	getPassword()	Get the password.
SecuritySuite.SecurityPolicy	getSecurityPolicy()	Get the get security policy.
static SecuritySuite	newSecuritySuiteFrom(SecuritySuite securitySuite)

Methods inherited from class java.lang.Object

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

Method Detail

getGlobalUnicastEncryptionKey

public byte[] getGlobalUnicastEncryptionKey()

Get the global unicast encryption key.

Returns:

the global unicast encryption key.

getAuthenticationKey

public byte[] getAuthenticationKey()

Get the authentication key.

Returns:

the authentication key.

getPassword

public byte[] getPassword()

Get the password.

This value is null when an authentication level other than LOW is used

Returns:

the password.

getEncryptionMechanism

public SecuritySuite.EncryptionMechanism getEncryptionMechanism()

Get the encryption mechanism which is used to encrypt the transported data.

Returns:

the encryption mechanism .

getAuthenticationMechanism

public AuthenticationMechanism getAuthenticationMechanism()

Get the authentication mechanism.

Returns:

the authentication mechanism.

getSecurityPolicy

public SecuritySuite.SecurityPolicy getSecurityPolicy()

Get the get security policy.

Returns:

the security policy.

builder

public static SecuritySuite.SecuritySuiteBuilder builder()

Creates a new Security Suite builder. With a default config of no authentication and no encryption.

Returns:

the new builder.

newSecuritySuiteFrom

public static SecuritySuite newSecuritySuiteFrom(SecuritySuite securitySuite)