2 * @file PswGen/Generator/igenerator.h
3 * @brief Interface for password generator modules
6 * Copyright (c) 2011 Enar Vaikene
8 * This file is part of the eVaf C++ cross-platform application development framework.
10 * This file can be used under the terms of the GNU General Public License
11 * version 3.0 as published by the Free Software Foundation and appearing in
12 * the file LICENSE included in the packaging of this file. Please review the
13 * the following information to ensure the GNU General Public License version
14 * 3.0 requirements will be met: http://www.gnu.org/copyleft/gpl.html.
16 * Alternatively, this file may be used in accordance with the Commercial License
17 * Agreement provided with the Software.
20 #ifndef __PSWGEN_GENERATOR_IGENERATOR_H
21 # define __PSWGEN_GENERATOR_IGENERATOR_H
32 * Password generator interface.
34 * This interface is used to generate strong passwords.
36 class PSWGEN_GENERATOR_EXPORT iGenerator
: public QObject
42 /// Interface constructor
43 iGenerator() : QObject() {}
45 /// Empty virtual destructor
46 virtual ~iGenerator() {}
49 * Flags for the password generator.
52 ALPHANUMERIC
= 0x01 ///< Generated password contains only alphanumeric characters
56 * Generates a strong password
57 * @param name Name of the password
58 * @param masterPassword Master password
59 * @param length Length of the password (if zero, then uses the max length)
60 * @param flags Flags for the generator
61 * @return Generated password
63 * This function generates a strong password using the name and the master password string
64 * as inputs. Calling this function with the same input always returns the same generated
67 * The length of the password is specified with the length argument. However, the generated password
68 * is never longer than possible with the particular cryptographic method.
70 * Optional flags can be used to fine-tune the generator.
72 virtual QString
generatePassword(QString
const & name
, QString
const & masterPassword
, int length
, uint flags
= 0) const = 0;
75 * Returns the maximum length of generated passwords
76 * @return Maximum length
78 * This function returns the maximum length of generated passwords that is possible with the cryptographic method
79 * used by the module implementing this interface.
81 virtual int maxLength() const = 0;
85 } // namespace eVaf::PswGen
88 #endif // igenerator.h