Class EbicsSecurity

Inheritance

object

EbicsSecurity

Inherited Members

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Namespace: Subsembly.EBICS

Assembly: Subsembly.EBICS.Core.dll

Syntax

public sealed class EbicsSecurity

Constructors

EbicsSecurity(EbicsSecurityCode)

Declaration

public EbicsSecurity(EbicsSecurityCode nCode)

Parameters

Type	Name	Description
EbicsSecurityCode	nCode	One of the defined security operation codes.

Exceptions

Type	Condition
ArgumentException	The parameter nCode was none of the well known security operation codes defined by the EbicsSecurityCode enumeration.

EbicsSecurity(string)

Declaration

public EbicsSecurity(string sCode)

Parameters

Type	Name	Description
string	sCode	The security operation code, such as "A005" or "X001". This must not be null and must be a well known EBICS security operation code.

Exceptions

Type	Condition
ArgumentNullException	The parameter sCode was null.
ArgumentException	The parameter sCode was none of the well known EBICS security operation codes.

Properties

A004

EBICS A004 electronic signature.

Declaration

public static EbicsSecurity A004 { get; }

Property Value

Type	Description
EbicsSecurity

A005

EBICS A005 electronic signature.

Declaration

public static EbicsSecurity A005 { get; }

Property Value

Type	Description
EbicsSecurity

A006

EBICS A006 electronic signature.

Declaration

public static EbicsSecurity A006 { get; }

Property Value

Type	Description
EbicsSecurity

Code

Declaration

public EbicsSecurityCode Code { get; }

Property Value

Type	Description
EbicsSecurityCode

DefaultKeyLength

Default RSA key length in bytes.

Declaration

public int DefaultKeyLength { get; }

Property Value

Type	Description
int

E001

EBICS E001 encryption.

Declaration

public static EbicsSecurity E001 { get; }

Property Value

Type	Description
EbicsSecurity

E002

EBICS E002 encryption.

Declaration

public static EbicsSecurity E002 { get; }

Property Value

Type	Description
EbicsSecurity

MaxKeyLength

Maximum RSA key length in bytes.

Declaration

public int MaxKeyLength { get; }

Property Value

Type	Description
int

MinKeyLength

Minimum RSA key length in bytes.

Declaration

public int MinKeyLength { get; }

Property Value

Type	Description
int

X001

EBICS X001 authentication signature.

Declaration

public static EbicsSecurity X001 { get; }

Property Value

Type	Description
EbicsSecurity

X002

EBICS X002 authentication signature.

Declaration

public static EbicsSecurity X002 { get; }

Property Value

Type	Description
EbicsSecurity

Methods

CodeFromString(string)

Static helper that converts a string representation of a security operation code to an ordinal EbicsSecurityCode value.

Declaration

public static EbicsSecurityCode CodeFromString(string sCode)

Parameters

Type	Name	Description
string	sCode	The security operation code, such as "A005" or "X001". This must not be null and must be a well known EBICS security operation code.

Returns

Type	Description
EbicsSecurityCode	The ordinal EbicsSecurityCode value for the given string identifier.

Exceptions

Type	Condition
ArgumentNullException	The parameter sCode was null.
ArgumentException	The parameter sCode was none of the well known EBICS security operation codes.

CodeToString(EbicsSecurityCode)

Static helper that converts an EbicsSecurityCode to its string representation.

Declaration

public static string CodeToString(EbicsSecurityCode nCode)

Parameters

Type	Name	Description
EbicsSecurityCode	nCode	One of the defined security operation codes.

Returns

Type	Description
string	A string identifier as used in EBICS XML elements such as "A005" or "X002".

Exceptions

Type	Condition
ArgumentException	The parameter nCode was none of the well known security operation codes defined by the EbicsSecurityCode enumeration.

Equals(object)

Declaration

public override bool Equals(object aObject)

Parameters

Type	Name	Description
object	aObject

Returns

Type	Description
bool

Overrides

object.Equals(object)

GetDigestAlgorithm()

Declaration

public CryDigestAlgorithm GetDigestAlgorithm()

Returns

Type	Description
CryDigestAlgorithm

GetDigestAlgorithmUri()

Declaration

public string GetDigestAlgorithmUri()

Returns

Type	Description
string

GetHashCode()

Declaration

public override int GetHashCode()

Returns

Type	Description
int

Overrides

object.GetHashCode()

GetKeyExchange(CryRSA)

Declaration

public CryKeyExchange GetKeyExchange(CryRSA aRSA)

Parameters

Type	Name	Description
CryRSA	aRSA

Returns

Type	Description
CryKeyExchange

GetSecurity(EbicsSecurityCode)

Returns the global EbicsSecurity instance for a given security code.

Declaration

public static EbicsSecurity GetSecurity(EbicsSecurityCode nCode)

Parameters

Type	Name	Description
EbicsSecurityCode	nCode	The security code to return the EbicsSecurity for. This must not be None or a mask, but a single security code value.

Returns

Type	Description
EbicsSecurity	Returns one of A004, A005, A006, E001, E002, X001, or X002, depending on the given parameter value.

Exceptions

Type	Condition
ArgumentException	The given security code did not identify a well known EbicsSecurity.

GetSignatureAlgorithmUri()

Declaration

public string GetSignatureAlgorithmUri()

Returns

Type	Description
string

GetSignatureScheme(CryRSA)

Declaration

public CrySignature GetSignatureScheme(CryRSA aRSA)

Parameters

Type	Name	Description
CryRSA	aRSA

Returns

Type	Description
CrySignature

ToString()

Converts this security operation to its string identifier,

Declaration

public override string ToString()

Returns

Type	Description
string	A string identifier as used in EBICS XML elements such as "A005" or "X002".

Overrides

object.ToString()

ValidateCode(EbicsSecurityCode)

Declaration

public static bool ValidateCode(EbicsSecurityCode nCode)

Parameters

Type	Name	Description
EbicsSecurityCode	nCode

Returns

Type	Description
bool

ValidateSecurity(EbicsVersion, EbicsSecurityCode)

Validates a set of security codes against an EBICS version.

Declaration

public static bool ValidateSecurity(EbicsVersion nVersion, EbicsSecurityCode nCodes)

Parameters

Type	Name	Description
EbicsVersion	nVersion
EbicsSecurityCode	nCodes	A bit set of user key versions, including one bit for authentication key, one bit for encryption key, and one bit for signature key.

Returns

Type	Description
bool	Returns true if, and only if, the given EBICS version is supported and the given set of security version codes is allowed for that EBICS version.