summaryrefslogtreecommitdiffstats
path: root/src/serviceframework/qserviceclientcredentials.cpp
blob: c744345ea20e2f2886953db2be40821cb16a6a5b (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
/****************************************************************************
**
** Copyright (C) 2018 The Qt Company Ltd and/or its subsidiary(-ies).
** Contact: http://www.qt-project.org/legal
**
** This file is part of the QtSystems module of the Qt Toolkit.
**
** $QT_BEGIN_LICENSE:LGPL$
** Commercial License Usage
** Licensees holding valid commercial Qt 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$
**
****************************************************************************/

#include "qserviceclientcredentials_p.h"
#include "qserviceclientcredentials.h"
#include <QDebug>

QT_BEGIN_NAMESPACE

/*!
    \class QServiceClientCredentials
    \brief The QServiceClientCredentials class holds credentials for the service client.

    This class is used when implementing service security. It allows the service to check
    the credentials of the client and then accept or reject the client.
*/

/*!
    \internal
*/
QServiceClientCredentials::QServiceClientCredentials()
    : d(new QServiceClientCredentialsPrivate)
{
    Q_ASSERT(d);
}

/*!
    \internal
*/
QServiceClientCredentials::QServiceClientCredentials(const QServiceClientCredentials &other)
    : d(other.d)
{
}

/*!
    \internal
*/
QServiceClientCredentials &QServiceClientCredentials::operator=(const QServiceClientCredentials &other)
{
    d = other.d;
    return *this;
}

/*!
    \internal
*/
QServiceClientCredentials::~QServiceClientCredentials()
{
}

/*!
    Returns the process identifier for the client. On Unix systems this is the PID
    of the client process.
*/
qintptr QServiceClientCredentials::getProcessIdentifier() const
{
    return d->pid;
}

/*!
    Returns the group identifier for the client. On Unix systems this is the GID
    of the client process.
*/
qintptr QServiceClientCredentials::getGroupIdentifier() const
{
    return d->gid;
}

/*!
    Returns the user identifier for the client. On Unix systems this is the UID
    of the client process.
*/
qintptr QServiceClientCredentials::getUserIdentifier() const
{
    return d->uid;
}

/*!
    Returns true if this object is valid.
*/
bool QServiceClientCredentials::isValid() const
{
    return d && (d->pid || d->uid || d->gid);
}

/*!
    Called by the service to accept or reject the client. Set \a isAccepted
    to true to accept the client.
*/
void QServiceClientCredentials::setClientAccepted(bool isAccepted)
{
    d->acceptedSet = true;
    d->accepted = isAccepted;
}

/*!
    Returns true if the client has been accepted, false otherwise.
*/
bool QServiceClientCredentials::isClientAccepted() const
{
    if (!d->acceptedSet) {
        qWarning() << "SFW credentials were queried, but service never called setClientAccepted(bool).  Returning default accepted.  This will break in the furture.";
    }
    return d->accepted;
}

QT_END_NAMESPACE