Class FinSecurityMediaKeyFile

Abstract base class for all key file based IFinSecurityMedia interface implementations.

Inheritance

System.Object

FinSecurityMediaKeyFile

Implements

IFinSecurityMedia

Inherited Members

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.ToString()

Namespace: Subsembly.FinTS

Assembly: Subsembly.FinTS.Core.dll

Syntax

public abstract class FinSecurityMediaKeyFile : IFinSecurityMedia

Remarks

This class implements all methods of the IFinSecurityMedia interface, delegating key file specific work to some abstract methods that must be overridden by the derived concrete class.

Constructors

FinSecurityMediaKeyFile()

Declaration

protected FinSecurityMediaKeyFile()

Properties

Capabilities

By default always returns CanVerifyEncrypt.

Declaration

public FinSecurityMediaCaps Capabilities { get; }

Property Value

Type	Description
FinSecurityMediaCaps

Remarks

A derived class must call SetCapabilities(FinSecurityMediaCaps) in its constructor in order to change the value returned through this property.

ContactCapacity

Number of contacts that are or may be stored in the key file.

Declaration

public int ContactCapacity { get; }

Property Value

Type	Description
System.Int32

Remarks

This property actually returns the number of contacts that have been added through AddContact(FinContact). Thus, if the actual key file can grow in order to store more contacts, then an additional empty contact record should be added at the end.

MaxKeyLength

By default returns 96.

Declaration

public int MaxKeyLength { get; }

Property Value

Type	Description
System.Int32

Remarks

A derived class must override OnGetMaxKeyLength() in order to change the value returned through this property.

PassphraseFlags

By default returns None.

Declaration

public FinSecurityMediaPassphraseFlags PassphraseFlags { get; }

Property Value

Type	Description
FinSecurityMediaPassphraseFlags

Remarks

A derived class must call SetPassphraseFlags(FinSecurityMediaPassphraseFlags) in its constructor in order to change the value returned through this property.

PassphraseMaxLength

By default returns 256.

Declaration

public int PassphraseMaxLength { get; }

Property Value

Type	Description
System.Int32

Remarks

A derived class must call SetPassphraseMaxLength(Int32) in its constructor in order to change the value returned through this property.

PassphraseMinLength

By default returns 0.

Declaration

public int PassphraseMinLength { get; }

Property Value

Type	Description
System.Int32

Remarks

A derived class must call SetPassphraseMinLength(Int32) in its constructor in order to change the value returned through this property.

SecurityMediaID

Provides the security media ID of the currently selected key file.

Declaration

public string SecurityMediaID { get; }

Property Value

Type	Description
System.String

SecurityMediaType

Always returns KeyFile.

Declaration

public FinSecurityMediaType SecurityMediaType { get; }

Property Value

Type	Description
FinSecurityMediaType

SecurityProfiles

Declaration

public FinSecurityProfile[] SecurityProfiles { get; }

Property Value

Type	Description
FinSecurityProfile[]

Remarks

The default implementation always returns an array with a single RDH-1 element.

State

Indicates the current state of this IFinSecurityMedia implementation.

Declaration

public FinSecurityMediaState State { get; }

Property Value

Type	Description
FinSecurityMediaState

Methods

AddContact(FinContact)

Declaration

protected void AddContact(FinContact aContact)

Parameters

Type	Name	Description
FinContact	aContact

AddKey(FinSecureKey)

Add another key to this key store.

Declaration

protected void AddKey(FinSecureKey aKey)

Parameters

Type	Name	Description
FinSecureKey	aKey

Authenticate(String, String)

Declaration

public FinAuthenticateResult Authenticate(string sUserName, string sPassphrase)

Parameters

Type	Name	Description
System.String	sUserName	Optional UserName.
System.String	sPassphrase

Returns

Type	Description
FinAuthenticateResult

AuthenticateAdmin(String, String)

Declaration

public FinAuthenticateResult AuthenticateAdmin(string sUserName, string sAdminPassphrase)

Parameters

Type	Name	Description
System.String	sUserName
System.String	sAdminPassphrase

Returns

Type	Description
FinAuthenticateResult

AuthenticateSecure()

Always just returns AuthenticateSecureNotSupported

Declaration

public FinAuthenticateResult AuthenticateSecure()

Returns

Type	Description
FinAuthenticateResult

CanAuthenticateSecure()

Declaration

public bool CanAuthenticateSecure()

Returns

Type	Description
System.Boolean

Cancel()

Declaration

public void Cancel()

CanChangePassphraseSecure()

Declaration

public bool CanChangePassphraseSecure()

Returns

Type	Description
System.Boolean

ChangePassphrase(String, String, String)

Declaration

public FinAuthenticateResult ChangePassphrase(string sUserName, string sOldPassphrase, string sNewPassphrase)

Parameters

Type	Name	Description
System.String	sUserName
System.String	sOldPassphrase
System.String	sNewPassphrase

Returns

Type	Description
FinAuthenticateResult

ChangePassphraseSecure()

Always just returns AuthenticateSecureNotSupported

Declaration

public FinAuthenticateResult ChangePassphraseSecure()

Returns

Type	Description
FinAuthenticateResult

Create(String, String, String)

Declaration

public void Create(string sSecurityMediaID, string sUserName, string sPassphrase)

Parameters

Type	Name	Description
System.String	sSecurityMediaID
System.String	sUserName
System.String	sPassphrase

Remarks

The default implementation validates the given parameters and the current object State and then delegates to OnCreateKeyFile(String, String).

CreateContact()

Declaration

public FinContact CreateContact()

Returns

Type	Description
FinContact

Decrypt(FinContact, FinSecureKey, FinOperationMode, Byte[])

Declaration

public byte[] Decrypt(FinContact aContact, FinSecureKey aKey, FinOperationMode nOpMode, byte[] vbCrypt)

Parameters

Type	Name	Description
FinContact	aContact
FinSecureKey	aKey
FinOperationMode	nOpMode
System.Byte[]	vbCrypt

Returns

Type	Description
System.Byte[]

ElevateKey(FinContact, FinSecureKey, FinSecureKeyState)

Declaration

public void ElevateKey(FinContact aContact, FinSecureKey aKey, FinSecureKeyState nNewKeyState)

Parameters

Type	Name	Description
FinContact	aContact
FinSecureKey	aKey
FinSecureKeyState	nNewKeyState

Encrypt(FinContact, FinSecureKey, FinOperationMode, Byte[])

Declaration

public byte[] Encrypt(FinContact aContact, FinSecureKey aKey, FinOperationMode nOpMode, byte[] vbData)

Parameters

Type	Name	Description
FinContact	aContact
FinSecureKey	aKey
FinOperationMode	nOpMode
System.Byte[]	vbData

Returns

Type	Description
System.Byte[]

EraseContact(Int32)

Declaration

public void EraseContact(int nContactIndex)

Parameters

Type	Name	Description
System.Int32	nContactIndex

EraseKey(FinContact, FinSecureKey)

Declaration

public void EraseKey(FinContact aContact, FinSecureKey aKey)

Parameters

Type	Name	Description
FinContact	aContact
FinSecureKey	aKey

GenerateKey(FinContact, FinSecureKeyType, Int32, Int32, Int32)

Generates ans stores a new key.

Declaration

public FinSecureKey GenerateKey(FinContact aContact, FinSecureKeyType nKeyType, int nKeyLength, int nKeyNumber, int nKeyVersion)

Parameters

Type	Name	Description
FinContact	aContact
FinSecureKeyType	nKeyType
System.Int32	nKeyLength
System.Int32	nKeyNumber
System.Int32	nKeyVersion

Returns

Type	Description
FinSecureKey

Remarks

Any existing key with the same attributes will be replaced.

InitPassphrase(String, String)

Always throws a NotSupportedException.

Declaration

public FinAuthenticateResult InitPassphrase(string sUserName, string sPassphrase)

Parameters

Type	Name	Description
System.String	sUserName
System.String	sPassphrase

Returns

Type	Description
FinAuthenticateResult

ObtainContact(Int32)

Declaration

public FinContact ObtainContact(int nContactIndex)

Parameters

Type	Name	Description
System.Int32	nContactIndex

Returns

Type	Description
FinContact

ObtainKey(FinContact, FinSecureKeyType, Int32, Int32)

Declaration

public virtual FinSecureKey ObtainKey(FinContact aContact, FinSecureKeyType nKeyType, int nKeyNumber, int nKeyVersion)

Parameters

Type	Name	Description
FinContact	aContact
FinSecureKeyType	nKeyType
System.Int32	nKeyNumber
System.Int32	nKeyVersion

Returns

Type	Description
FinSecureKey

OnCancel()

Declaration

protected virtual void OnCancel()

OnChangePassphrase(String)

Declaration

protected virtual FinAuthenticateResult OnChangePassphrase(string sNewPassphrase)

Parameters

Type	Name	Description
System.String	sNewPassphrase

Returns

Type	Description
FinAuthenticateResult

OnCreateKeyFile(String, String)

Override in order to create a new key file instance from scratch.

Declaration

protected virtual void OnCreateKeyFile(string sUserName, string sPassphrase)

Parameters

Type	Name	Description
System.String	sUserName	Optional UserName parameter.
System.String	sPassphrase	The passphrase to be used in order to protect the key file.

Remarks

The default implementation simply throws NotSupportedException.

OnGetMaxKeyLength()

Declaration

protected virtual int OnGetMaxKeyLength()

Returns

Type	Description
System.Int32

OnGetSecurityProfiles()

Declaration

protected virtual FinSecurityProfile[] OnGetSecurityProfiles()

Returns

Type	Description
FinSecurityProfile[]

OnLoadKeyFile(String, String)

Must be overriden in order to fully load a previously selected key file.

Declaration

protected abstract FinAuthenticateResult OnLoadKeyFile(string sUserName, string sPassphrase)

Parameters

Type	Name	Description
System.String	sUserName	Optional UserName parameter.
System.String	sPassphrase

Returns

Type	Description
FinAuthenticateResult	This method is also responsible for checking the passphrase and to return an appropriate FinAuthenticateResult for it.

OnRelease()

Declaration

protected virtual void OnRelease()

OnSaveKeyFile(String)

Declaration

protected virtual void OnSaveKeyFile(string sFileName)

Parameters

Type	Name	Description
System.String	sFileName

OnSelectKeyFile(String)

Must be overriden in order to select an existing key file.

Declaration

protected abstract FinAuthenticateResult OnSelectKeyFile(string sFileName)

Parameters

Type	Name	Description
System.String	sFileName	The complete file name including path and file name extension of the key file to be selected by this method.

Returns

Type	Description
FinAuthenticateResult

Release()

Declaration

public void Release()

ResetKey(FinContact, FinSecureKey)

Declaration

public void ResetKey(FinContact aContact, FinSecureKey aKey)

Parameters

Type	Name	Description
FinContact	aContact
FinSecureKey	aKey

Select(String)

Declaration

public FinAuthenticateResult Select(string sSecurityMediaID)

Parameters

Type	Name	Description
System.String	sSecurityMediaID

Returns

Type	Description
FinAuthenticateResult

SelectKeyFile(String)

Convenience helper that attempts to detect the type of the given key file and returns a suitable IFinSecurityMedia instance for it.

Declaration

public static IFinSecurityMedia SelectKeyFile(string sFilename)

Parameters

Type	Name	Description
System.String	sFilename	The name of the key file to select with a suitable IFinSecurityMedia implementation. Must not be `null`.

Returns

Type	Description
IFinSecurityMedia	If the key file was successfully detected and also successfully selected by the IFinSecurityMedia implementation, then a reference to the selected instance is returned. If the key file was not recognized, or selection failed, then `null` is returned.

Exceptions

Type	Condition
System.ArgumentNullException	The parameter sFilename was `null`.
System.ArgumentException	The parameter aFilename was an empty string.

SetCapabilities(FinSecurityMediaCaps)

Declaration

protected void SetCapabilities(FinSecurityMediaCaps nCapabilities)

Parameters

Type	Name	Description
FinSecurityMediaCaps	nCapabilities

SetPassphraseFlags(FinSecurityMediaPassphraseFlags)

Declaration

protected void SetPassphraseFlags(FinSecurityMediaPassphraseFlags nPassphraseFlags)

Parameters

Type	Name	Description
FinSecurityMediaPassphraseFlags	nPassphraseFlags

SetPassphraseMaxLength(Int32)

Declaration

protected void SetPassphraseMaxLength(int nPassphraseMaxLength)

Parameters

Type	Name	Description
System.Int32	nPassphraseMaxLength

SetPassphraseMinLength(Int32)

Declaration

protected void SetPassphraseMinLength(int nPassphraseMinLength)

Parameters

Type	Name	Description
System.Int32	nPassphraseMinLength

SignHash(FinContact, FinSecureKey, FinOperationMode, FinHash, Byte[])

Declaration

public byte[] SignHash(FinContact aContact, FinSecureKey aKey, FinOperationMode nOpMode, FinHash nHash, byte[] vbHash)

Parameters

Type	Name	Description
FinContact	aContact
FinSecureKey	aKey
FinOperationMode	nOpMode
FinHash	nHash
System.Byte[]	vbHash

Returns

Type	Description
System.Byte[]

StoreContact(Int32, FinContact)

Declaration

public void StoreContact(int nContactIndex, FinContact aContact)

Parameters

Type	Name	Description
System.Int32	nContactIndex
FinContact	aContact

StoreKey(FinContact, FinSecureKey)

Declaration

public void StoreKey(FinContact aContact, FinSecureKey aKey)

Parameters

Type	Name	Description
FinContact	aContact
FinSecureKey	aKey

Remarks

Any existing key with the same attributes will be replaced.

Verify(FinContact, FinSecureKey, FinOperationMode, FinHash, Byte[], Byte[])

Declaration

public bool Verify(FinContact aContact, FinSecureKey aKey, FinOperationMode nOpMode, FinHash nHash, byte[] vbHash, byte[] vbSignature)

Parameters

Type	Name	Description
FinContact	aContact
FinSecureKey	aKey
FinOperationMode	nOpMode
FinHash	nHash
System.Byte[]	vbHash
System.Byte[]	vbSignature

Returns

Type	Description
System.Boolean

Implements

IFinSecurityMedia