DlmsSecuritySetup Class

Instances of the “Security setup” IC contain the necessary information on the security suite in use and the security policy applicable between a client and a server identified by their respective system title. They also provide methods to increase the level of security and to manage symmetric keys, asymmetric key pairs and certificates.

Definition

Namespace: OddPrg.Protocols.DLMS
Assembly: OddPrg.Frames.Dlms (in OddPrg.Frames.Dlms.dll) Version: 2.0.0.24 (2.0.0.24)
C#
public class DlmsSecuritySetup : DlmsObject
Inheritance
Object    DlmsObject    DlmsSecuritySetup

Constructors

DlmsSecuritySetup Creates new instance of class DlmsSecuritySetup. This constructor is used by XmlSerializer.
DlmsSecuritySetup(DlmsTypeOctetString) Creates new instance of class DlmsSecuritySetup using its logical name. This constructor is used for create DlmsAssociationSN after object_list is read using LN referencing.
DlmsSecuritySetup(DlmsTypeLong, DlmsTypeOctetString) Creates new instance of class DlmsSecuritySetup. This constructor is used for create DlmsAssociationSN after object_list is read using SN referencing.

Properties

AttributeAccess Stored access rights to all attributes. this property is filled after this object is created during reading object list.
(Inherited from DlmsObject)
AuthenticatedRequest Gets or sets if requests will be authentized.
AuthenticatedResponse Gets or sets if responses will be authentized.
BaseName Base name of the object used for SN referencing.
(Inherited from DlmsObject)
Certificates Carries X.509 v3 certificates available and stored in the server.
ClassId Returns 1 as class id of COSEM Data object.
(Overrides DlmsObjectClassId)
ClientSystemTitle Carries the (current) client system title
DigitallySignedRequest Gets or sets if requests will be digitally signed.
DigitallySignedResponse Gets or sets if responses will be digitally signed.
DisplayDescription Returns description of all attributes fo displaying.
(Overrides DlmsObjectDisplayDescription)
EncryptRequest Gets or sets if requests will be encrypted.
EncryptResponse Gets or sets if responses will be encrypted.
LastAttributeId ID of last defined attribute.
(Overrides DlmsObjectLastAttributeId)
LogicalName Logical name of the object used for LN refernecing. It corresponds to logical_name attribute defined in BB 4.2
(Inherited from DlmsObject)
MethodAccess Stored access rights to all methods. This property is filled after this object is created during reading object list.
(Inherited from DlmsObject)
SecurityPolicy Enforces authentication and/or encryption and/or digital signature using the security algorithms available within the security suite. It applies independently for requests and responses.
SecuritySuite Specifies the security algorithms available.
ServerSystemTitle Carries the server system title.

Methods

AddProprietaryAttribute Guarantees that the DLMS object will have a proprietary attribute with attributeIndex or attributeName
(Inherited from DlmsObject)
ClassVersionSupported Checks if this object implements particular class version.
(Overrides DlmsObjectClassVersionSupported(Byte))
CreateSecurityPolicyVersion0 Creates a security policy byte of version 0.
CreateSecurityPolicyVersion1 Creates a security policy byte of version 1.
GetAttributeAccess Returns attribute access rights of attribute with given id. It uses AttributeAccess property which is filled during reading an object list.
(Inherited from DlmsObject)
GetAttributeId Gets the attribute index from the short name used in SN referencing
(Overrides DlmsObjectGetAttributeId(UInt16))
GetAttributeIds Returns a list of COSEM attribute IDs this object contains and are implemented.
(Inherited from DlmsObject)
GetAttributeName Gets name of the attribute.
(Overrides DlmsObjectGetAttributeName(SByte))
GetAttributeValue Gets a value of COSEM attribute with specified name.
(Overrides DlmsObjectGetAttributeValue(SByte))
GetAttributeVariableName Returns a variable name used in SN referencing of a given attribute. Attribute short name offsets are defined in BB.
(Overrides DlmsObjectGetAttributeVariableName(SByte))
GetMethodIds Gets list of method IDs that are defined for the DLMS object.
(Overrides DlmsObjectGetMethodIds)
GetMethodName Gets name of a method with a ID.
(Overrides DlmsObjectGetMethodName(SByte))
GetSecuritySuiteDescription Det description of security suite.
IsAuthenticatedReq Checks if request is authenticated according to the security policy.
IsAuthenticatedResp Checks if response is authenticated according to the security policy.
IsEncryptedReq Checks if request is encrypted according to the security policy.
IsEncryptedResp Checks if response is encrypted according to the security policy.
IsSignedReq Checks if response is signed according to the security policy.
IsSignedResp Checks if request is signed according to the security policy.
SetAttributeValue Sets a value to COSEM attribute of specified name.
(Overrides DlmsObjectSetAttributeValue(SByte, DlmsType))
ToString Returns string representation of the object.
(Inherited from DlmsObject)

Fields

See Also