cutelyst  5.1.0
A C++ Web Framework built on top of Qt, using the simple approach of Catalyst (Perl) framework.
credentialpassword.h
1 /*
2  * SPDX-FileCopyrightText: (C) 2013-2023 Daniel Nicoletti <dantti12@gmail.com>
3  * SPDX-License-Identifier: BSD-3-Clause
4  */
5 #pragma once
6 
7 #include <Cutelyst/Plugins/Authentication/authentication.h>
8 
9 #include <QtCore/QCryptographicHash>
10 
11 namespace Cutelyst {
12 
13 class CredentialPasswordPrivate;
14 
27 class CUTELYST_PLUGIN_AUTHENTICATION_EXPORT CredentialPassword : public AuthenticationCredential
28 {
29  Q_OBJECT
30  Q_DECLARE_PRIVATE(CredentialPassword)
31 public:
35  enum PasswordType {
36  None,
37  Clear,
38  Hashed,
40  SelfCheck
41  };
42  Q_ENUM(PasswordType)
43 
44 
47  explicit CredentialPassword(QObject *parent = nullptr);
48 
52  virtual ~CredentialPassword() override;
53 
59  [[nodiscard]] AuthenticationUser
60  authenticate(Context *c, AuthenticationRealm *realm, const ParamsMultiMap &authinfo) final;
61 
66  [[nodiscard]] QString passwordField() const;
67 
72  void setPasswordField(const QString &fieldName);
73 
78  [[nodiscard]] PasswordType passwordType() const;
79 
88  void setPasswordType(PasswordType type);
89 
94  [[nodiscard]] QString passwordPreSalt() const;
95 
100  void setPasswordPreSalt(const QString &passwordPreSalt);
101 
106  [[nodiscard]] QString passwordPostSalt() const;
107 
112  void setPasswordPostSalt(const QString &passwordPostSalt);
113 
117  [[nodiscard]] static bool validatePassword(const QByteArray &password,
118  const QByteArray &correctHash);
119 
123  [[nodiscard]] static bool validatePassword(const QString &password, const QString &correctHash);
124 
132  [[nodiscard]] static QByteArray createPassword(const QByteArray &password,
134  int iterations,
135  int saltByteSize,
136  int hashByteSize);
137 
147  [[nodiscard]] static QByteArray createPassword(const QByteArray &password);
148 
158  [[nodiscard]] inline static QString createPassword(const QString &password);
159 
164  [[nodiscard]] static QByteArray pbkdf2(QCryptographicHash::Algorithm method,
165  const QByteArray &password,
166  const QByteArray &salt,
167  int rounds,
168  int keyLength);
169 
173  [[nodiscard]] static QByteArray hmac(QCryptographicHash::Algorithm method,
174  const QByteArray &key,
175  const QByteArray &message);
176 
177 protected:
178  CredentialPasswordPrivate *d_ptr;
179 };
180 
181 inline bool CredentialPassword::validatePassword(const QString &password,
182  const QString &correctHash)
183 {
184  return validatePassword(password.toUtf8(), correctHash.toLatin1());
185 }
186 
188 {
189  return QString::fromLatin1(createPassword(password.toUtf8()));
190 }
191 
192 } // namespace Cutelyst
Use password based authentication to authenticate a user.
Combines user store and credential validation into a named realm.
static QByteArray createPassword(const QByteArray &password, QCryptographicHash::Algorithm method, int iterations, int saltByteSize, int hashByteSize)
The Cutelyst Context.
Definition: context.h:42
The Cutelyst namespace holds all public Cutelyst API.
Container for user data retrieved from an AuthenticationStore.
QString fromLatin1(QByteArrayView str)
QByteArray toLatin1() const const
static bool validatePassword(const QByteArray &password, const QByteArray &correctHash)
QByteArray toUtf8() const const