blob: b5f24f8ec1dd7f2b3a78fdae98f612e11d950577 (
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
|
/****************************************************************************
**
** Copyright (C) 2017 The Qt Company Ltd.
** Contact: https://www.qt.io/licensing/
**
** This file is part of the documentation of the Qt Toolkit.
**
** $QT_BEGIN_LICENSE:FDL$
** 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 Free Documentation License Usage
** Alternatively, this file may be used under the terms of the GNU Free
** Documentation License version 1.3 as published by the Free Software
** Foundation and appearing in the file included in the packaging of
** this file. Please review the following information to ensure
** the GNU Free Documentation License version 1.3 requirements
** will be met: https://www.gnu.org/licenses/fdl-1.3.html.
** $QT_END_LICENSE$
**
****************************************************************************/
/*!
\page qtnetworkauth-index.html
\title Qt Network Authorization
\brief Provides network authorization capabilities (OAuth).
Qt Network Authorization provides a set of APIs that enable Qt
applications to obtain limited access to online accounts and
HTTP services without exposing users' passwords.
Currently, the supported authorization protocol is \l {https://oauth.net}
{OAuth}, versions 1 and 2.
\section1 Getting Started
//! [qtnetworkauth-usage]
To use Qt Network Authorization classes, add this directive into C++ files:
\code
#include <QtNetworkAuth>
\endcode
To link against the Qt Network Authorization module, add this line to the
project file:
\code
QT += network networkauth
\endcode
//! [qtnetworkauth-usage]
\section1 Overview
The goal of this module is to provide a way to handle different
authentication methods present on the Internet.
There are several authentication systems, including:
\list
\li \l {https://tools.ietf.org/html/rfc5849} {OAuth 1}
\li \l {https://tools.ietf.org/html/rfc6749} {OAuth 2}
\li \l {http://openid.net} {OpenID}
\li \l {http://openid.net/connect/} {OpenID Connect}
\li \l {https://developer.mozilla.org/Persona} {Mozilla Persona}
\endlist
These systems allow the application developers to create applications which
use external authentication servers provided by an
\e {Authorization Server}.
Users of these services need not worry about passing their credentials to
suspicious applications. Instead, the credentials are entered in a known
and trusted web interface.
\section1 Examples
\list
\li \l {Qt Network Authorization Examples}
\endlist
\section1 API Reference
\list
\li \l{Qt Network Authorization C++ Classes}{C++ Classes}
\endlist
*/
/*!
\module QtNetworkAuth
\title Qt Network Authorization C++ Classes
\ingroup modules
\qtvariable networkauth
\brief Provides classes for network authorization support (OAuth).
\include qtnetworkauth.qdoc qtnetworkauth-usage
*/
|
