summaryrefslogtreecommitdiffstats
path: root/src/installer-lib/sudo.h
blob: 729327f4489a464a9d6857ec14ad3e4c06181508 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
/****************************************************************************
**
** Copyright (C) 2018 Pelagicore AG
** Contact: https://www.qt.io/licensing/
**
** This file is part of the Pelagicore Application Manager.
**
** $QT_BEGIN_LICENSE:LGPL-QTAS$
** Commercial License Usage
** Licensees holding valid commercial Qt Automotive Suite licenses may use
** this file in accordance with the commercial license agreement provided
** with the Software or, alternatively, in accordance with the terms
** contained in a written agreement between you and The Qt Company.  For
** licensing terms and conditions see https://www.qt.io/terms-conditions.
** For further information use the contact form at https://www.qt.io/contact-us.
**
** GNU Lesser General Public License Usage
** Alternatively, this file may be used under the terms of the GNU Lesser
** General Public License version 3 as published by the Free Software
** Foundation and appearing in the file LICENSE.LGPL3 included in the
** packaging of this file. Please review the following information to
** ensure the GNU Lesser General Public License version 3 requirements
** will be met: https://www.gnu.org/licenses/lgpl-3.0.html.
**
** GNU General Public License Usage
** Alternatively, this file may be used under the terms of the GNU
** General Public License version 2.0 or (at your option) the GNU General
** Public license version 3 or any later version approved by the KDE Free
** Qt Foundation. The licenses are as published by the Free Software
** Foundation and appearing in the file LICENSE.GPL2 and LICENSE.GPL3
** included in the packaging of this file. Please review the following
** information to ensure the GNU General Public License requirements will
** be met: https://www.gnu.org/licenses/gpl-2.0.html and
** https://www.gnu.org/licenses/gpl-3.0.html.
**
** $QT_END_LICENSE$
**
** SPDX-License-Identifier: LGPL-3.0
**
****************************************************************************/

#pragma once

#include <QString>
#include <QByteArray>
#include <QMutex>
#include <qplatformdefs.h>

#ifdef Q_OS_UNIX
#  include <sys/types.h>
#else
typedef uint uid_t;
typedef uint gid_t;
//typedef uint mode_t; // already typedef'ed in qplatformdefs.h
#endif

#include <QtAppManCommon/global.h>

QT_BEGIN_NAMESPACE_AM

class Sudo
{
public:
    enum DropPrivileges {
        DropPrivilegesPermanently,
        DropPrivilegesRegainable, // only use this for auto-tests
    };

    static void forkServer(DropPrivileges dropPrivileges, QStringList *warnings = nullptr) Q_DECL_NOEXCEPT_EXPR(false);
};

class SudoInterface
{
public:
    virtual ~SudoInterface() = default;

    virtual QString attachLoopback(const QString &imagePath, bool readonly) = 0;
    virtual bool detachLoopback(const QString &loopDev) = 0;
    virtual bool mount(const QString &device, const QString &mountPoint, bool readonly, const QString &fstype) = 0;
    virtual bool unmount(const QString &mountPoint, bool force) = 0;
    virtual bool mkfs(const QString &device, const QString &fstype, const QStringList &options) = 0;
    virtual bool removeRecursive(const QString &fileOrDir) = 0;
    virtual bool setOwnerAndPermissionsRecursive(const QString &fileOrDir, uid_t user, gid_t group, mode_t permissions) = 0;

protected:
    enum MessageType { Request, Reply };

#ifdef Q_OS_LINUX
    QByteArray receiveMessage(int socket, MessageType type, QString *errorString);
    bool sendMessage(int socket, const QByteArray &msg, MessageType type, const QString &errorString = QString());
#endif
    QByteArray receive(const QByteArray &packet);

protected:
    SudoInterface();
private:
    Q_DISABLE_COPY(SudoInterface)
};

class SudoServer;

class SudoClient : public SudoInterface
{
public:
    static SudoClient *createInstance(int socketFd, SudoServer *shortCircuit = 0);

    static SudoClient *instance();

    bool isFallbackImplementation() const;

    QString attachLoopback(const QString &imagePath, bool readonly = false) override;
    bool detachLoopback(const QString &loopDev) override;
    bool mount(const QString &device, const QString &mountPoint, bool readonly = false, const QString &fstype = QStringLiteral("ext2")) override;
    bool unmount(const QString &mountPoint, bool force = false) override;
    bool mkfs(const QString &device, const QString &fstype = QStringLiteral("ext2"), const QStringList &options = QStringList()) override;
    bool removeRecursive(const QString &fileOrDir) override;
    bool setOwnerAndPermissionsRecursive(const QString &fileOrDir, uid_t user, gid_t group, mode_t permissions) override;

    void stopServer();

    QString lastError() const { return m_errorString; }

private:
    SudoClient(int socketFd);

    QByteArray call(const QByteArray &msg);

    int m_socket;
    QString m_errorString;
    QMutex m_mutex;
    SudoServer *m_shortCircuit;

    static SudoClient *s_instance;
};

class SudoServer : public SudoInterface
{
public:
    static SudoServer *createInstance(int socketFd, int loopControlFd);

    static SudoServer *instance();

    QString attachLoopback(const QString &imagePath, bool readonly) override;
    bool detachLoopback(const QString &loopDev) override;
    bool mount(const QString &device, const QString &mountPoint, bool readonly, const QString &fstype) override;
    bool unmount(const QString &mountPoint, bool force) override;
    bool mkfs(const QString &device, const QString &fstype, const QStringList &options) override;
    bool removeRecursive(const QString &fileOrDir) override;
    bool setOwnerAndPermissionsRecursive(const QString &fileOrDir, uid_t user, gid_t group, mode_t permissions) override;

    QString lastError() const { return m_errorString; }

    Q_NORETURN void run();

private:
    SudoServer(int socketFd, int loopControlFd);

    QByteArray receive(const QByteArray &msg);
    friend class SudoClient;

    int m_socket;
    int m_loopControl;
    QString m_errorString;
    bool m_stop = false;

    static SudoServer *s_instance;
};

QT_END_NAMESPACE_AM