qtnetworkauth-index.html 4.91 KB
Newer Older
xuebingbing's avatar
xuebingbing committed
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
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html>
<html lang="en">
<head>
  <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<!-- qtnetworkauth.qdoc -->
  <title>Qt Network Authorization 5.11</title>
  <link rel="stylesheet" type="text/css" href="style/offline-simple.css" />
  <script type="text/javascript">
    document.getElementsByTagName("link").item(0).setAttribute("href", "style/offline.css");
    // loading style sheet breaks anchors that were jumped to before
    // so force jumping to anchor again
    setTimeout(function() {
        var anchor = location.hash;
        // need to jump to different anchor first (e.g. none)
        location.hash = "#";
        setTimeout(function() {
            location.hash = anchor;
        }, 0);
    }, 0);
  </script>
</head>
<body>
<div class="header" id="qtdocheader">
  <div class="main">
    <div class="main-rounded">
      <div class="navigationbar">
        <table><tr>
<td ><a href="../qtdoc/index.html">Qt 5.11</a></td><td >Qt Network Authorization</td></tr></table><table class="buildversion"><tr>
<td id="buildversion" width="100%" align="right">Qt 5.11.2 Reference Documentation</td>
        </tr></table>
      </div>
    </div>
<div class="content">
<div class="line">
<div class="content mainContent">
<div class="sidebar">
<div class="toc">
<h3><a name="toc">Contents</a></h3>
<ul>
<li class="level1"><a href="#getting-started">Getting Started</a></li>
<li class="level1"><a href="#overview">Overview</a></li>
<li class="level1"><a href="#licenses">Licenses</a></li>
<li class="level1"><a href="#examples">Examples</a></li>
<li class="level1"><a href="#api-reference">API Reference</a></li>
</ul>
</div>
<div class="sidebar-content" id="sidebar-content"></div></div>
<h1 class="title">Qt Network Authorization</h1>
<span class="subtitle"></span>
<!-- $$$qtnetworkauth-index.html-description -->
<div class="descr"> <a name="details"></a>
<p>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.</p>
<p>Currently, the supported authorization protocol is <a href="https://oauth.net">OAuth</a>, versions 1 and 2.</p>
<a name="getting-started"></a>
<h2 id="getting-started">Getting Started</h2>
<p>To use Qt Network Authorization classes, add this directive into C++ files:</p>
<pre class="cpp">

  <span class="preprocessor">#include &lt;QtNetworkAuth&gt;</span>

</pre>
<p>To link against the Qt Network Authorization module, add this line to the project file:</p>
<pre class="cpp">

  QT <span class="operator">+</span><span class="operator">=</span> network networkauth

</pre>
<a name="overview"></a>
<h2 id="overview">Overview</h2>
<p>The goal of this module is to provide a way to handle different authentication methods present on the Internet.</p>
<p>There are several authentication systems, including:</p>
<ul>
<li><a href="https://tools.ietf.org/html/rfc5849">OAuth 1</a></li>
<li><a href="https://tools.ietf.org/html/rfc6749">OAuth 2</a></li>
<li><a href="http://openid.net">OpenID</a></li>
<li><a href="http://openid.net/connect/">OpenID Connect</a></li>
<li><a href="https://developer.mozilla.org/Persona">Mozilla Persona</a></li>
</ul>
<p>These systems allow the application developers to create applications which use external authentication servers provided by an <i>Authorization Server</i>. 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.</p>
<a name="licenses"></a>
<h2 id="licenses">Licenses</h2>
<p>Qt Network Authorization is available under commercial licenses from <a href="http://www.qt.io/about-us/">The Qt Company</a>. In addition, it is available under the <a href="http://www.gnu.org/licenses/gpl-3.0.html">GNU General Public License, version 3</a>. See <a href="../qtdoc/licensing.html">Qt Licensing</a> for further details.</p>
<a name="examples"></a>
<h2 id="examples">Examples</h2>
<ul>
<li><a href="examples-qtnetworkauth.html">Qt Network Authorization Examples</a></li>
</ul>
<a name="api-reference"></a>
<h2 id="api-reference">API Reference</h2>
<ul>
<li><a href="qtnetworkauth-module.html">C++ Classes</a></li>
</ul>
</div>
<!-- @@@qtnetworkauth-index.html -->
        </div>
       </div>
   </div>
   </div>
</div>
<div class="footer">
   <p>
   <acronym title="Copyright">&copy;</acronym> 2018 The Qt Company Ltd.
   Documentation contributions included herein are the copyrights of
   their respective owners.<br/>    The documentation provided herein is licensed under the terms of the    <a href="http://www.gnu.org/licenses/fdl.html">GNU Free Documentation    License version 1.3</a> as published by the Free Software Foundation.<br/>    Qt and respective logos are trademarks of The Qt Company Ltd.     in Finland and/or other countries worldwide. All other trademarks are property
   of their respective owners. </p>
</div>
</body>
</html>