Passwordfile library  4.0.0
C++ library to read/write passwords from/to encrypted files
Classes | Enumerations | Functions | Variables
Io Namespace Reference

Contains all IO related classes. More...

Classes

class  AccountEntry
 The exception that is thrown when a parsing error occurs. More...
 
class  CryptoException
 The exception that is thrown when an encryption/decryption error occurs. More...
 
class  Entry
 Instances of the Entry class form a hierarchic data strucutre used to store account information. More...
 
struct  EntryStatistics
 
class  Field
 The Field class holds field information which consists of a name and a value and is able to serialize and deserialize this information. More...
 
class  NodeEntry
 The NodeEntry class acts as parent for other entries. More...
 
class  ParsingException
 The exception that is thrown when a parsing error occurs. More...
 
class  PasswordFile
 The PasswordFile class holds account information in the form of Entry and Field instances and provides methods to read and write these information to encrypted files using OpenSSL. More...
 

Enumerations

enum  EntryType : int { EntryType::Node, EntryType::Account }
 Specifies the entry type. More...
 
enum  FieldType : int { FieldType::Normal, FieldType::Password }
 
enum  PasswordFileOpenFlags : uint64 { PasswordFileOpenFlags::None = 0, PasswordFileOpenFlags::ReadOnly = 1, PasswordFileOpenFlags::Default = None }
 
enum  PasswordFileSaveFlags : uint64 {
  PasswordFileSaveFlags::None = 0, PasswordFileSaveFlags::Encryption = 1, PasswordFileSaveFlags::Compression = 2, PasswordFileSaveFlags::PasswordHashing = 4,
  PasswordFileSaveFlags::Default = Encryption | Compression | PasswordHashing
}
 

Functions

std::string PASSWORD_FILE_EXPORT flagsToString (PasswordFileOpenFlags flags)
 Returns a comma-separated string for the specified flags. More...
 
constexpr PasswordFileOpenFlags operator| (PasswordFileOpenFlags lhs, PasswordFileOpenFlags rhs)
 
constexpr PasswordFileOpenFlagsoperator|= (PasswordFileOpenFlags &lhs, PasswordFileOpenFlags rhs)
 
constexpr bool operator & (PasswordFileOpenFlags lhs, PasswordFileOpenFlags rhs)
 
std::string PASSWORD_FILE_EXPORT flagsToString (PasswordFileSaveFlags flags)
 Returns a comma-separated string for the specified flags. More...
 
constexpr PasswordFileSaveFlags operator| (PasswordFileSaveFlags lhs, PasswordFileSaveFlags rhs)
 
constexpr PasswordFileSaveFlagsoperator|= (PasswordFileSaveFlags &lhs, PasswordFileSaveFlags rhs)
 
constexpr bool operator & (PasswordFileSaveFlags lhs, PasswordFileSaveFlags rhs)
 

Variables

const unsigned int aes256cbcIvSize = 16U
 

Detailed Description

Contains all IO related classes.

Enumeration Type Documentation

◆ EntryType

enum Io::EntryType : int
strong

Specifies the entry type.

Enumerator
Node 

denotes a NodeEntry

Account 

denotes an AccountEntry

Definition at line 18 of file entry.h.

◆ FieldType

enum Io::FieldType : int
strong
Enumerator
Normal 
Password 

Definition at line 11 of file field.h.

◆ PasswordFileOpenFlags

enum Io::PasswordFileOpenFlags : uint64
strong
Enumerator
None 
ReadOnly 
Default 

Definition at line 19 of file passwordfile.h.

◆ PasswordFileSaveFlags

enum Io::PasswordFileSaveFlags : uint64
strong
Enumerator
None 
Encryption 
Compression 
PasswordHashing 
Default 

Definition at line 45 of file passwordfile.h.

Function Documentation

◆ flagsToString() [1/2]

string Io::flagsToString ( PasswordFileOpenFlags  flags)

Returns a comma-separated string for the specified flags.

Definition at line 762 of file passwordfile.cpp.

◆ flagsToString() [2/2]

string Io::flagsToString ( PasswordFileSaveFlags  flags)

Returns a comma-separated string for the specified flags.

Definition at line 777 of file passwordfile.cpp.

◆ operator &() [1/2]

constexpr bool Io::operator& ( PasswordFileOpenFlags  lhs,
PasswordFileOpenFlags  rhs 
)

Definition at line 39 of file passwordfile.h.

◆ operator &() [2/2]

constexpr bool Io::operator& ( PasswordFileSaveFlags  lhs,
PasswordFileSaveFlags  rhs 
)

Definition at line 67 of file passwordfile.h.

◆ operator|() [1/2]

constexpr PasswordFileOpenFlags Io::operator| ( PasswordFileOpenFlags  lhs,
PasswordFileOpenFlags  rhs 
)

Definition at line 27 of file passwordfile.h.

◆ operator|() [2/2]

constexpr PasswordFileSaveFlags Io::operator| ( PasswordFileSaveFlags  lhs,
PasswordFileSaveFlags  rhs 
)

Definition at line 55 of file passwordfile.h.

◆ operator|=() [1/2]

constexpr PasswordFileOpenFlags& Io::operator|= ( PasswordFileOpenFlags lhs,
PasswordFileOpenFlags  rhs 
)

Definition at line 33 of file passwordfile.h.

◆ operator|=() [2/2]

constexpr PasswordFileSaveFlags& Io::operator|= ( PasswordFileSaveFlags lhs,
PasswordFileSaveFlags  rhs 
)

Definition at line 61 of file passwordfile.h.

Variable Documentation

◆ aes256cbcIvSize

const unsigned int Io::aes256cbcIvSize = 16U

Definition at line 33 of file passwordfile.cpp.