Skip to content

refactor: Refactor PAM authenticate module #55

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
zccrs merged 1 commit into from
Dec 16, 2025
Merged

refactor: Refactor PAM authenticate module #55

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion REUSE.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,7 @@ SPDX-FileCopyrightText = "None"
SPDX-License-Identifier = "GPL-2.0-or-later"

[[annotations]]
path = ["releng/prepare-relnotes", "src/auth/Auth.cpp", "src/auth/Auth.h", "src/auth/AuthMessages.h", "src/auth/AuthPrompt.cpp", "src/auth/AuthPrompt.h", "src/auth/AuthRequest.cpp", "src/auth/AuthRequest.h", "src/common/ConfigReader.cpp", "src/common/ConfigReader.h", "src/common/Configuration.cpp", "src/common/Configuration.h", "src/common/MessageHandler.h", "src/common/Messages.h", "src/common/SafeDataStream.cpp", "src/common/SafeDataStream.h", "src/common/Session.cpp", "src/common/Session.h", "src/common/SignalHandler.cpp", "src/common/SignalHandler.h", "src/common/SocketWriter.cpp", "src/common/SocketWriter.h", "src/common/ThemeConfig.cpp", "src/common/ThemeConfig.h", "src/common/ThemeMetadata.cpp", "src/common/ThemeMetadata.h", "src/common/VirtualTerminal.cpp", "src/common/VirtualTerminal.h", "src/common/XAuth.cpp", "src/common/XAuth.h", "src/daemon/DaemonApp.cpp", "src/daemon/DaemonApp.h", "src/daemon/Display.cpp", "src/daemon/Display.h", "src/daemon/DisplayManager.cpp", "src/daemon/DisplayManager.h", "src/daemon/DisplayServer.cpp", "src/daemon/DisplayServer.h", "src/daemon/Greeter.cpp", "src/daemon/Greeter.h", "src/daemon/PowerManager.cpp", "src/daemon/PowerManager.h", "src/daemon/Seat.cpp", "src/daemon/Seat.h", "src/daemon/SeatManager.cpp", "src/daemon/SeatManager.h", "src/daemon/SocketServer.cpp", "src/daemon/SocketServer.h", "src/daemon/TreelandConnector.cpp", "src/daemon/TreelandConnector.h", "src/daemon/Utils.h", "src/daemon/WaylandDisplayServer.cpp", "src/daemon/WaylandDisplayServer.h", "src/daemon/XorgDisplayServer.cpp", "src/daemon/XorgDisplayServer.h", "src/daemon/XorgUserDisplayServer.cpp", "src/daemon/XorgUserDisplayServer.h", "src/greeter/GreeterApp.h", "src/greeter/GreeterProxy.cpp", "src/greeter/GreeterProxy.h", "src/greeter/SessionModel.cpp", "src/greeter/SessionModel.h", "src/greeter/UserModel.cpp", "src/greeter/UserModel.h", "src/helper/Backend.cpp", "src/helper/Backend.h", "src/helper/HelperApp.cpp", "src/helper/HelperApp.h", "src/helper/HelperStartWayland.cpp", "src/helper/HelperStartX11User.cpp", "src/helper/UserSession.cpp", "src/helper/UserSession.h", "src/helper/backend/PamBackend.cpp", "src/helper/backend/PamBackend.h", "src/helper/backend/PamHandle.cpp", "src/helper/backend/PamHandle.h", "src/helper/waylandhelper.cpp", "src/helper/waylandhelper.h", "src/helper/waylandsocketwatcher.cpp", "src/helper/waylandsocketwatcher.h", "src/helper/xorguserhelper.cpp", "src/helper/xorguserhelper.h", "src/common/LogindDBusTypes.cpp", "src/common/LogindDBusTypes.h", "src/greeter/GreeterApp.cpp"]
path = ["releng/prepare-relnotes", "src/auth/Auth.cpp", "src/auth/Auth.h", "src/auth/AuthMessages.h", "src/auth/AuthPrompt.cpp", "src/auth/AuthPrompt.h", "src/auth/AuthRequest.cpp", "src/auth/AuthRequest.h", "src/common/ConfigReader.cpp", "src/common/ConfigReader.h", "src/common/Configuration.cpp", "src/common/Configuration.h", "src/common/MessageHandler.h", "src/common/Messages.h", "src/common/SafeDataStream.cpp", "src/common/SafeDataStream.h", "src/common/Session.cpp", "src/common/Session.h", "src/common/SignalHandler.cpp", "src/common/SignalHandler.h", "src/common/SocketWriter.cpp", "src/common/SocketWriter.h", "src/common/ThemeConfig.cpp", "src/common/ThemeConfig.h", "src/common/ThemeMetadata.cpp", "src/common/ThemeMetadata.h", "src/common/VirtualTerminal.cpp", "src/common/VirtualTerminal.h", "src/common/XAuth.cpp", "src/common/XAuth.h", "src/daemon/DaemonApp.cpp", "src/daemon/DaemonApp.h", "src/daemon/Display.cpp", "src/daemon/Display.h", "src/daemon/DisplayManager.cpp", "src/daemon/DisplayManager.h", "src/daemon/DisplayServer.cpp", "src/daemon/DisplayServer.h", "src/daemon/Greeter.cpp", "src/daemon/Greeter.h", "src/daemon/PowerManager.cpp", "src/daemon/PowerManager.h", "src/daemon/Seat.cpp", "src/daemon/Seat.h", "src/daemon/SeatManager.cpp", "src/daemon/SeatManager.h", "src/daemon/SocketServer.cpp", "src/daemon/SocketServer.h", "src/daemon/TreelandConnector.cpp", "src/daemon/TreelandConnector.h", "src/daemon/Utils.h", "src/daemon/WaylandDisplayServer.cpp", "src/daemon/WaylandDisplayServer.h", "src/daemon/XorgDisplayServer.cpp", "src/daemon/XorgDisplayServer.h", "src/daemon/XorgUserDisplayServer.cpp", "src/daemon/XorgUserDisplayServer.h", "src/greeter/GreeterApp.h", "src/greeter/GreeterProxy.cpp", "src/greeter/GreeterProxy.h", "src/greeter/SessionModel.cpp", "src/greeter/SessionModel.h", "src/greeter/UserModel.cpp", "src/greeter/UserModel.h", "src/helper/Pam.cpp", "src/helper/Pam.h", "src/helper/HelperApp.cpp", "src/helper/HelperApp.h", "src/helper/HelperStartWayland.cpp", "src/helper/HelperStartX11User.cpp", "src/helper/UserSession.cpp", "src/helper/UserSession.h", "src/helper/waylandhelper.cpp", "src/helper/waylandhelper.h", "src/helper/waylandsocketwatcher.cpp", "src/helper/waylandsocketwatcher.h", "src/helper/xorguserhelper.cpp", "src/helper/xorguserhelper.h", "src/common/LogindDBusTypes.cpp", "src/common/LogindDBusTypes.h", "src/greeter/GreeterApp.cpp"]
precedence = "aggregate"
SPDX-FileCopyrightText = "None"
SPDX-License-Identifier = "GPL-2.0-or-later"
124 changes: 0 additions & 124 deletions src/helper/Backend.cpp
View file
Open in desktop

This file was deleted.

66 changes: 0 additions & 66 deletions src/helper/Backend.h
View file
Open in desktop

This file was deleted.

4 changes: 1 addition & 3 deletions src/helper/CMakeLists.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,11 +5,9 @@ include_directories(
)

set(HELPER_SOURCES
Backend.cpp
HelperApp.cpp
UserSession.cpp
backend/PamHandle.cpp
backend/PamBackend.cpp
Pam.cpp
)

add_executable(ddm-helper ${HELPER_SOURCES})
Expand Down
74 changes: 43 additions & 31 deletions src/helper/HelperApp.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,10 +19,10 @@
*/

#include "HelperApp.h"
#include "Backend.h"
#include "Pam.h"
#include "Configuration.h"

Check warning on line 23 in src/helper/HelperApp.cpp

View workflow job for this annotation

GitHub Actions / cppcheck 

Include file: "Configuration.h" not found.
#include "UserSession.h"
#include "SafeDataStream.h"

Check warning on line 25 in src/helper/HelperApp.cpp

View workflow job for this annotation

GitHub Actions / cppcheck 

Include file: "SafeDataStream.h" not found.

#include "MessageHandler.h"
#include "VirtualTerminal.h"
Expand All @@ -46,12 +46,16 @@
#endif
#include <utmpx.h>
#include <QByteArray>
#include <signal.h>

Check warning on line 49 in src/helper/HelperApp.cpp

View workflow job for this annotation

GitHub Actions / cppcheck 

Include file: <signal.h> not found. Please note: Cppcheck does not need standard library headers to get proper results.

namespace DDM {
static Request passwordRequest{
{ { AuthPrompt::LOGIN_PASSWORD, QStringLiteral("Password: "), true } }
};

HelperApp::HelperApp(int& argc, char** argv)
: QCoreApplication(argc, argv)
, m_backend(Backend::get(this))
, m_pam(new Pam(this))
, m_session(new UserSession(this))
, m_socket(new QLocalSocket(this)) {
qInstallMessageHandler(HelperMessageHandler);
Expand Down Expand Up @@ -99,6 +103,7 @@
return;
}
m_user = args[pos + 1];
m_pam->user = m_user;
}

if ((pos = args.indexOf(QStringLiteral("--display-server"))) >= 0) {
Expand All @@ -108,19 +113,10 @@
return;
}
m_session->setDisplayServerCommand(args[pos + 1]);
m_backend->setDisplayServer(true);
}

if ((pos = args.indexOf(QStringLiteral("--autologin"))) >= 0) {
m_backend->setAutologin(true);
}

if ((pos = args.indexOf(QStringLiteral("--greeter"))) >= 0) {
m_backend->setGreeter(true);
}

if ((pos = args.indexOf(QStringLiteral("--identify-only"))) >= 0) {
m_backend->setIdentifyOnly(true);
m_identifyOnly = true;
}

if ((pos = args.indexOf(QStringLiteral("--skip-auth"))) >= 0) {
Expand All @@ -134,7 +130,7 @@
}

connect(m_socket, &QLocalSocket::connected, this, &HelperApp::doAuth);
if(!m_backend->identifyOnly()){
if(!m_identifyOnly){
connect(m_session, &UserSession::finished, this, &HelperApp::sessionFinished);
}

Expand All @@ -153,7 +149,7 @@
if (str.status() != QDataStream::Ok)
qCritical() << "Couldn't write initial message:" << str.status();

if (!m_backend->start(m_user)) {
if (!m_pam->start()) {
authenticated(QString());

// write failed login to btmp
Expand All @@ -167,20 +163,22 @@
}

Q_ASSERT(getuid() == 0);
if (!m_skipAuth && !m_backend->authenticate()) {
authenticated(QString());

// write failed login to btmp
const QProcessEnvironment env = m_session->processEnvironment();
const QString displayId = env.value(QStringLiteral("DISPLAY"));
const QString vt = env.value(QStringLiteral("XDG_VTNR"));
utmpLogin(vt, displayId, m_user, 0, false);

exit(Auth::HELPER_AUTH_ERROR);
return;
if (!m_skipAuth) {
Request req = request(passwordRequest);
if (req.prompts.length() <= 0 || !m_pam->authenticate(req.prompts[0].response)) {
authenticated(QString());

// write failed login to btmp
const QProcessEnvironment env = m_session->processEnvironment();
const QString displayId = env.value(QStringLiteral("DISPLAY"));
const QString vt = env.value(QStringLiteral("XDG_VTNR"));
utmpLogin(vt, displayId, m_user, 0, false);

exit(Auth::HELPER_AUTH_ERROR);
return;
}
}

m_user = m_backend->userName();
QProcessEnvironment env = authenticated(m_user);

if (env.value(QStringLiteral("XDG_SESSION_CLASS")) == QLatin1String("greeter")) {
Expand All @@ -200,16 +198,30 @@
env.insert(m_session->processEnvironment());
m_session->setProcessEnvironment(env);

if (!m_backend->openSession()) {
auto sessionEnv = m_pam->openSession(env);
if (!sessionEnv.has_value()) {
sessionOpened(false, 0);
exit(Auth::HELPER_SESSION_ERROR);
return;
}

sessionOpened(true, m_backend->sessionId());
env = *sessionEnv;
int sessionId = env.value(QStringLiteral("XDG_SESSION_ID")).toInt();
sessionOpened(true, sessionId);

struct passwd *pw;
pw = getpwnam(qPrintable(m_user));
if (pw) {
env.insert(QStringLiteral("HOME"), QString::fromLocal8Bit(pw->pw_dir));
env.insert(QStringLiteral("PWD"), QString::fromLocal8Bit(pw->pw_dir));
env.insert(QStringLiteral("SHELL"), QString::fromLocal8Bit(pw->pw_shell));
env.insert(QStringLiteral("USER"), QString::fromLocal8Bit(pw->pw_name));
env.insert(QStringLiteral("LOGNAME"), QString::fromLocal8Bit(pw->pw_name));
}
m_session->setProcessEnvironment(env);
m_session->start();

// write successful login to utmp/wtmp
const QProcessEnvironment env = m_session->processEnvironment();
const QString displayId = env.value(QStringLiteral("DISPLAY"));
const QString vt = env.value(QStringLiteral("XDG_VTNR"));
if (env.value(QStringLiteral("XDG_SESSION_CLASS")) != QLatin1String("greeter")) {
Expand Down Expand Up @@ -323,8 +335,8 @@
Q_ASSERT(getuid() == 0);

m_session->stop();
if(!m_backend->identifyOnly()){
m_backend->closeSession();
if(!m_identifyOnly && m_pam->sessionOpened){
m_pam->closeSession();
}

// write logout to utmp/wtmp
Expand Down
5 changes: 3 additions & 2 deletions src/helper/HelperApp.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@
class QLocalSocket;

namespace DDM {
class Backend;
class Pam;
class UserSession;
class HelperApp : public QCoreApplication
{
Expand Down Expand Up @@ -61,13 +61,14 @@ namespace DDM {

private:
qint64 m_id { -1 };
Backend *m_backend { nullptr };
Pam *m_pam { nullptr };
UserSession *m_session { nullptr };
QLocalSocket *m_socket { nullptr };
QString m_user { };
// TODO: get rid of this in a nice clean way along the way with moving to user session X server
QByteArray m_cookie { };
bool m_skipAuth = false;
bool m_identifyOnly = false;

/*!
\brief Write utmp/wtmp/btmp records when a user logs in
Expand Down
Loading