docs/html/GSignondDigestPlugin.html

   1 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
   2 <html>
   3 <head>
   4 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
   5 <title>gsignond API Reference Manual: GSignondDigestPlugin</title>
   6 <meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
   7 <link rel="home" href="index.html" title="gsignond API Reference Manual">
   8 <link rel="up" href="ch05.html" title="Standard in-tree authentication plugins">
   9 <link rel="prev" href="ch05.html" title="Standard in-tree authentication plugins">
  10 <link rel="next" href="GSignondSsoTestPlugin.html" title="GSignondSsoTestPlugin">
  11 <meta name="generator" content="GTK-Doc V1.20 (XML mode)">
  12 <link rel="stylesheet" href="style.css" type="text/css">
  13 </head>
  14 <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
  15 <table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="10"><tr valign="middle">
  16 <td width="100%" align="left" class="shortcuts">
  17 <a href="#" class="shortcut">Top</a><span id="nav_description"> <span class="dim">|</span>
  18                   <a href="#GSignondDigestPlugin.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span>
  19                   <a href="#GSignondDigestPlugin.object-hierarchy" class="shortcut">Object Hierarchy</a></span>
  20 </td>
  21 <td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
  22 <td><a accesskey="u" href="ch05.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
  23 <td><a accesskey="p" href="ch05.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
  24 <td><a accesskey="n" href="GSignondSsoTestPlugin.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
  25 </tr></table>
  26 <div class="refentry">
  27 <a name="GSignondDigestPlugin"></a><div class="titlepage"></div>
  28 <div class="refnamediv"><table width="100%"><tr>
  29 <td valign="top">
  30 <h2><span class="refentrytitle"><a name="GSignondDigestPlugin.top_of_page"></a>GSignondDigestPlugin</span></h2>
  31 <p>GSignondDigestPlugin — a plugin that performs HTTP Digest authentication</p>
  32 </td>
  33 <td class="gallery_image" valign="top" align="right"></td>
  34 </tr></table></div>
  35 <div class="refsect1">
  36 <a name="GSignondDigestPlugin.object-hierarchy"></a><h2>Object Hierarchy</h2>
  37 <pre class="screen">    <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject">GObject</a>
  38     <span class="lineart">╰──</span> GSignondDigestPlugin
  39 </pre>
  40 </div>
  41 <div class="refsect1">
  42 <a name="GSignondDigestPlugin.includes"></a><h2>Includes</h2>
  43 <pre class="synopsis">#include &lt;gsignond/gsignond-digest-plugin.h&gt;
  44 </pre>
  45 </div>
  46 <div class="refsect1">
  47 <a name="GSignondDigestPlugin.description"></a><h2>Description</h2>
  48 <p><a class="link" href="GSignondDigestPlugin.html" title="GSignondDigestPlugin"><span class="type">GSignondDigestPlugin</span></a> performs HTTP Digest authentication without exposing
  49 the password to the application. Digest authentication is described in </p>
  50 <a class="ulink" href="http://tools.ietf.org/html/rfc2617" target="_top">RFC 2617</a>.
  51 <p>gsignond_plugin_request_initial() <em class="parameter"><code>session_data</code></em>
  52  parameter should include
  53 the following string items, whose meaning is described in the RFC: </p>
  54 <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
  55 <li class="listitem"><p>username and secret. If they are absent, they are requested from the user
  56 via gSSO UI.</p></li>
  57 <li class="listitem"><p>realm, allowed realms, "Algo", "Nonce", "Method", "DigestUri" - mandatory items.</p></li>
  58 <li class="listitem"><p>"NonceCount", "Qop", "HEntity". "NonceCount" must be present if "Qop" is
  59 present, "HEntity" must be present if "Qop" is present and set to "auth-int".</p></li>
  60 </ul></div>
  61 <p>If the plugin has all the data to calculate the digest, it issues
  62 <a class="link" href="GSignondPlugin.html#GSignondPlugin-response-final" title="The “response-final” signal"><span class="type">“response-final”</span></a> signal. <em class="parameter"><code>session_data</code></em>
  63  in that signal contains
  64 the username, "CNonce" item and the digest value under the "Response" key.</p>
  65 <p>If some of the data is incorrect or not available, <a class="link" href="GSignondPlugin.html#GSignondPlugin-error" title="The “error” signal"><span class="type">“error”</span></a>
  66 signal is issued instead.</p>
  67 <p><a class="link" href="GSignondPlugin.html#GSignondPlugin--type" title="The “type” property"><span class="type">“type”</span></a> property is set to "digest", and <a class="link" href="GSignondPlugin.html#GSignondPlugin--mechanisms" title="The “mechanisms” property"><span class="type">“mechanisms”</span></a>
  68 property contains a single entry "digest".</p>
  69 </div>
  70 <div class="refsect1">
  71 <a name="GSignondDigestPlugin.functions_details"></a><h2>Functions</h2>
  72 </div>
  73 <div class="refsect1">
  74 <a name="GSignondDigestPlugin.other_details"></a><h2>Types and Values</h2>
  75 </div>
  76 </div>
  77 <div class="footer">
  78 <hr>
  79           Generated by GTK-Doc V1.20</div>
  80 </body>
  81 </html>