NanoXLSX.Reader 3.0.0-rc.2
Loading...
Searching...
No Matches
NanoXLSX.Internal.Readers.LegacyPasswordReader Class Reference

Class representing a reader for legacy passwords. More...

Inheritance diagram for NanoXLSX.Internal.Readers.LegacyPasswordReader:

Public Member Functions

virtual void Init (PasswordType type, ReaderOptions readerOptions)
 Initialization method (interface implementation).
virtual void ReadXmlAttributes (XmlNode node)
 Reads the attributes of the passed XML node that contains password information.
virtual string GetPassword ()
 Gets the password. This method is not supported in a reader and will always return null.
virtual bool PasswordIsSet ()
 Indicates whether a password is set. This can be the case, if a legacy or contemporary password was detected, regardless of the ability of the decoding of this reader.
virtual void CopyFrom (IPassword passwordInstance)
 Not relevant for the reader (inherited from IPassword).
virtual void SetPassword (string plainText)
 Not relevant for the reader (inherited from IPassword).
virtual void UnsetPassword ()
 Not relevant for the reader (inherited from IPassword).

Properties

virtual bool ContemporaryAlgorithmDetected [get]
 Gets whether a contemporary password algorithm was detected (not supported by core functionality).
virtual PasswordType Type [get]
 Current target type of the password instance.
virtual ReaderOptions Options [get]
 Reader options.
virtual string PasswordHash [get, set]
 Gets or sets the password hash.

Detailed Description

Class representing a reader for legacy passwords.

Definition at line 23 of file LegacyPasswordReader.cs.

Member Function Documentation

◆ CopyFrom()

virtual void NanoXLSX.Internal.Readers.LegacyPasswordReader.CopyFrom ( IPassword passwordInstance)
virtual

Not relevant for the reader (inherited from IPassword).

Parameters
passwordInstanceSource instance
Exceptions
NotImplementedExceptionThrows a NotImplementedException if called in any case

Definition at line 138 of file LegacyPasswordReader.cs.

◆ GetPassword()

virtual string NanoXLSX.Internal.Readers.LegacyPasswordReader.GetPassword ( )
virtual

Gets the password. This method is not supported in a reader and will always return null.

Returns
Always null, since the plain text password cannot be recovered

Definition at line 119 of file LegacyPasswordReader.cs.

◆ Init()

virtual void NanoXLSX.Internal.Readers.LegacyPasswordReader.Init ( PasswordType type,
ReaderOptions readerOptions )
virtual

Initialization method (interface implementation).

Parameters
typePassword type
readerOptionsReader options

Implements NanoXLSX.Interfaces.Reader.IPasswordReader.

Definition at line 64 of file LegacyPasswordReader.cs.

◆ PasswordIsSet()

virtual bool NanoXLSX.Internal.Readers.LegacyPasswordReader.PasswordIsSet ( )
virtual

Indicates whether a password is set. This can be the case, if a legacy or contemporary password was detected, regardless of the ability of the decoding of this reader.

Returns
True if a password was set

Definition at line 128 of file LegacyPasswordReader.cs.

◆ ReadXmlAttributes()

virtual void NanoXLSX.Internal.Readers.LegacyPasswordReader.ReadXmlAttributes ( XmlNode node)
virtual

Reads the attributes of the passed XML node that contains password information.

Parameters
nodeXML node

Implements NanoXLSX.Interfaces.Reader.IPasswordReader.

Definition at line 74 of file LegacyPasswordReader.cs.

◆ SetPassword()

virtual void NanoXLSX.Internal.Readers.LegacyPasswordReader.SetPassword ( string plainText)
virtual

Not relevant for the reader (inherited from IPassword).

Parameters
plainText
Exceptions
NotImplementedExceptionThrows a NotImplementedException if called in any case

Definition at line 148 of file LegacyPasswordReader.cs.

◆ UnsetPassword()

virtual void NanoXLSX.Internal.Readers.LegacyPasswordReader.UnsetPassword ( )
virtual

Not relevant for the reader (inherited from IPassword).

Exceptions
NotImplementedExceptionThrows a NotImplementedException if called in any case

Definition at line 157 of file LegacyPasswordReader.cs.

Property Documentation

◆ ContemporaryAlgorithmDetected

virtual bool NanoXLSX.Internal.Readers.LegacyPasswordReader.ContemporaryAlgorithmDetected
get

Gets whether a contemporary password algorithm was detected (not supported by core functionality).

Definition at line 30 of file LegacyPasswordReader.cs.

◆ Options

virtual ReaderOptions NanoXLSX.Internal.Readers.LegacyPasswordReader.Options
get

Reader options.

Definition at line 40 of file LegacyPasswordReader.cs.

◆ PasswordHash

virtual string NanoXLSX.Internal.Readers.LegacyPasswordReader.PasswordHash
getset

Gets or sets the password hash.

Definition at line 45 of file LegacyPasswordReader.cs.

◆ Type

virtual PasswordType NanoXLSX.Internal.Readers.LegacyPasswordReader.Type
get

Current target type of the password instance.

Definition at line 35 of file LegacyPasswordReader.cs.


The documentation for this class was generated from the following file: