| Current File : //usr/share/doc/dbus/api/dbus-auth_8h_source.html |
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<title>D-Bus: dbus-auth.h Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">D-Bus
 <span id="projectnumber">1.8.20</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- Generated by Doxygen 1.7.6.1 -->
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li><a href="annotated.html"><span>Data Structures</span></a></li>
<li class="current"><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="files.html"><span>File List</span></a></li>
</ul>
</div>
</div>
<div class="header">
<div class="headertitle">
<div class="title">dbus-auth.h</div> </div>
</div><!--header-->
<div class="contents">
<div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">/* -*- mode: C; c-file-style: "gnu"; indent-tabs-mode: nil; -*- */</span>
<a name="l00002"></a>00002 <span class="comment">/* dbus-auth.h Authentication</span>
<a name="l00003"></a>00003 <span class="comment"> *</span>
<a name="l00004"></a>00004 <span class="comment"> * Copyright (C) 2002 Red Hat Inc.</span>
<a name="l00005"></a>00005 <span class="comment"> *</span>
<a name="l00006"></a>00006 <span class="comment"> * Licensed under the Academic Free License version 2.1</span>
<a name="l00007"></a>00007 <span class="comment"> * </span>
<a name="l00008"></a>00008 <span class="comment"> * This program is free software; you can redistribute it and/or modify</span>
<a name="l00009"></a>00009 <span class="comment"> * it under the terms of the GNU General Public License as published by</span>
<a name="l00010"></a>00010 <span class="comment"> * the Free Software Foundation; either version 2 of the License, or</span>
<a name="l00011"></a>00011 <span class="comment"> * (at your option) any later version.</span>
<a name="l00012"></a>00012 <span class="comment"> *</span>
<a name="l00013"></a>00013 <span class="comment"> * This program is distributed in the hope that it will be useful,</span>
<a name="l00014"></a>00014 <span class="comment"> * but WITHOUT ANY WARRANTY; without even the implied warranty of</span>
<a name="l00015"></a>00015 <span class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the</span>
<a name="l00016"></a>00016 <span class="comment"> * GNU General Public License for more details.</span>
<a name="l00017"></a>00017 <span class="comment"> * </span>
<a name="l00018"></a>00018 <span class="comment"> * You should have received a copy of the GNU General Public License</span>
<a name="l00019"></a>00019 <span class="comment"> * along with this program; if not, write to the Free Software</span>
<a name="l00020"></a>00020 <span class="comment"> * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA</span>
<a name="l00021"></a>00021 <span class="comment"> *</span>
<a name="l00022"></a>00022 <span class="comment"> */</span>
<a name="l00023"></a>00023 <span class="preprocessor">#ifndef DBUS_AUTH_H</span>
<a name="l00024"></a>00024 <span class="preprocessor"></span><span class="preprocessor">#define DBUS_AUTH_H</span>
<a name="l00025"></a>00025 <span class="preprocessor"></span>
<a name="l00026"></a>00026 <span class="preprocessor">#include <dbus/dbus-macros.h></span>
<a name="l00027"></a>00027 <span class="preprocessor">#include <dbus/dbus-errors.h></span>
<a name="l00028"></a>00028 <span class="preprocessor">#include <dbus/dbus-string.h></span>
<a name="l00029"></a>00029 <span class="preprocessor">#include <dbus/dbus-sysdeps.h></span>
<a name="l00030"></a>00030
<a name="l00031"></a>00031 <a class="code" href="group__DBusMacros.html#ga875146b01015e9ced22b25d76d549ab2" title="Macro used prior to declaring functions in the D-Bus header files.">DBUS_BEGIN_DECLS</a>
<a name="l00032"></a>00032
<a name="l00033"></a>00033 <span class="keyword">typedef</span> <span class="keyword">struct </span><a class="code" href="structDBusAuth.html" title="Internal members of DBusAuth.">DBusAuth</a> <a class="code" href="structDBusAuth.html" title="Internal members of DBusAuth.">DBusAuth</a>;
<a name="l00034"></a>00034
<a name="l00035"></a>00035 <span class="keyword">typedef</span> <span class="keyword">enum</span>
<a name="l00036"></a>00036 {
<a name="l00037"></a>00037 DBUS_AUTH_STATE_WAITING_FOR_INPUT,
<a name="l00038"></a>00038 DBUS_AUTH_STATE_WAITING_FOR_MEMORY,
<a name="l00039"></a>00039 DBUS_AUTH_STATE_HAVE_BYTES_TO_SEND,
<a name="l00040"></a>00040 DBUS_AUTH_STATE_NEED_DISCONNECT,
<a name="l00041"></a>00041 DBUS_AUTH_STATE_AUTHENTICATED
<a name="l00042"></a>00042 } DBusAuthState;
<a name="l00043"></a>00043
<a name="l00044"></a>00044 <a class="code" href="structDBusAuth.html" title="Internal members of DBusAuth.">DBusAuth</a>* <a class="code" href="group__DBusAuth.html#ga302e454600ae0e1aa27193d4b0a86385" title="Creates a new auth conversation object for the server side.">_dbus_auth_server_new</a> (<span class="keyword">const</span> <a class="code" href="structDBusString.html">DBusString</a> *guid);
<a name="l00045"></a>00045 <a class="code" href="structDBusAuth.html" title="Internal members of DBusAuth.">DBusAuth</a>* <a class="code" href="group__DBusAuth.html#gaee76dbcdada8bcafe131f5a2de151ac3" title="Creates a new auth conversation object for the client side.">_dbus_auth_client_new</a> (<span class="keywordtype">void</span>);
<a name="l00046"></a>00046 <a class="code" href="structDBusAuth.html" title="Internal members of DBusAuth.">DBusAuth</a>* <a class="code" href="group__DBusAuth.html#gaebe46c0887021bb3f6de3d283e0c66db" title="Increments the refcount of an auth object.">_dbus_auth_ref</a> (<a class="code" href="structDBusAuth.html" title="Internal members of DBusAuth.">DBusAuth</a> *auth);
<a name="l00047"></a>00047 <span class="keywordtype">void</span> <a class="code" href="group__DBusAuth.html#ga7fb648be9d6d451917195a0e43eeece0" title="Decrements the refcount of an auth object.">_dbus_auth_unref</a> (<a class="code" href="structDBusAuth.html" title="Internal members of DBusAuth.">DBusAuth</a> *auth);
<a name="l00048"></a>00048 <a class="code" href="group__DBusTypes.html#ga39c9cb0f3a2a8ad6f55cc4855d035349" title="A boolean, valid values are TRUE and FALSE.">dbus_bool_t</a> <a class="code" href="group__DBusAuth.html#ga9454e2c512b4e2ea54d47cff6acaa4db" title="Sets an array of authentication mechanism names that we are willing to use.">_dbus_auth_set_mechanisms</a> (<a class="code" href="structDBusAuth.html" title="Internal members of DBusAuth.">DBusAuth</a> *auth,
<a name="l00049"></a>00049 <span class="keyword">const</span> <span class="keywordtype">char</span> **mechanisms);
<a name="l00050"></a>00050 DBusAuthState <a class="code" href="group__DBusAuth.html#ga097c71f7f20b749275c6b31cd98623f5" title="Analyzes buffered input and moves the auth conversation forward, returning the new state of the auth ...">_dbus_auth_do_work</a> (<a class="code" href="structDBusAuth.html" title="Internal members of DBusAuth.">DBusAuth</a> *auth);
<a name="l00051"></a>00051 <a class="code" href="group__DBusTypes.html#ga39c9cb0f3a2a8ad6f55cc4855d035349" title="A boolean, valid values are TRUE and FALSE.">dbus_bool_t</a> <a class="code" href="group__DBusAuth.html#ga7befc68c815fe31d7fa556b699ef67de" title="Gets bytes that need to be sent to the peer we're conversing with.">_dbus_auth_get_bytes_to_send</a> (<a class="code" href="structDBusAuth.html" title="Internal members of DBusAuth.">DBusAuth</a> *auth,
<a name="l00052"></a>00052 <span class="keyword">const</span> <a class="code" href="structDBusString.html">DBusString</a> **str);
<a name="l00053"></a>00053 <span class="keywordtype">void</span> <a class="code" href="group__DBusAuth.html#gaed9f7f1d3289a0ae2fea2204729ac01f" title="Notifies the auth conversation object that the given number of bytes of the outgoing buffer have been...">_dbus_auth_bytes_sent</a> (<a class="code" href="structDBusAuth.html" title="Internal members of DBusAuth.">DBusAuth</a> *auth,
<a name="l00054"></a>00054 <span class="keywordtype">int</span> bytes_sent);
<a name="l00055"></a>00055 <span class="keywordtype">void</span> <a class="code" href="group__DBusAuth.html#gac0fc38d8d0d139e4d52787881a324c05" title="Get a buffer to be used for reading bytes from the peer we're conversing with.">_dbus_auth_get_buffer</a> (<a class="code" href="structDBusAuth.html" title="Internal members of DBusAuth.">DBusAuth</a> *auth,
<a name="l00056"></a>00056 <a class="code" href="structDBusString.html">DBusString</a> **buffer);
<a name="l00057"></a>00057 <span class="keywordtype">void</span> <a class="code" href="group__DBusAuth.html#ga842c246877d16cb9a75cc9828a5433c2" title="Returns a buffer with new data read into it.">_dbus_auth_return_buffer</a> (<a class="code" href="structDBusAuth.html" title="Internal members of DBusAuth.">DBusAuth</a> *auth,
<a name="l00058"></a>00058 <a class="code" href="structDBusString.html">DBusString</a> *buffer);
<a name="l00059"></a>00059 <span class="keywordtype">void</span> <a class="code" href="group__DBusAuth.html#gaf9e2ab67f2ddd26eeb7deeb8b0af7817" title="Returns leftover bytes that were not used as part of the auth conversation.">_dbus_auth_get_unused_bytes</a> (<a class="code" href="structDBusAuth.html" title="Internal members of DBusAuth.">DBusAuth</a> *auth,
<a name="l00060"></a>00060 <span class="keyword">const</span> <a class="code" href="structDBusString.html">DBusString</a> **str);
<a name="l00061"></a>00061 <span class="keywordtype">void</span> <a class="code" href="group__DBusAuth.html#gabbe8cf9e5958357c49a190ca259aa9b3" title="Gets rid of unused bytes returned by _dbus_auth_get_unused_bytes() after we've gotten them and succes...">_dbus_auth_delete_unused_bytes</a> (<a class="code" href="structDBusAuth.html" title="Internal members of DBusAuth.">DBusAuth</a> *auth);
<a name="l00062"></a>00062 <a class="code" href="group__DBusTypes.html#ga39c9cb0f3a2a8ad6f55cc4855d035349" title="A boolean, valid values are TRUE and FALSE.">dbus_bool_t</a> <a class="code" href="group__DBusAuth.html#ga22ddfb5e12cba3d047dc1d1302c23490" title="Called post-authentication, indicates whether we need to encode the message stream with _dbus_auth_en...">_dbus_auth_needs_encoding</a> (<a class="code" href="structDBusAuth.html" title="Internal members of DBusAuth.">DBusAuth</a> *auth);
<a name="l00063"></a>00063 <a class="code" href="group__DBusTypes.html#ga39c9cb0f3a2a8ad6f55cc4855d035349" title="A boolean, valid values are TRUE and FALSE.">dbus_bool_t</a> <a class="code" href="group__DBusAuth.html#ga0d59bcf62c098cdfb95f610cdfd12690" title="Called post-authentication, encodes a block of bytes for sending to the peer.">_dbus_auth_encode_data</a> (<a class="code" href="structDBusAuth.html" title="Internal members of DBusAuth.">DBusAuth</a> *auth,
<a name="l00064"></a>00064 <span class="keyword">const</span> <a class="code" href="structDBusString.html">DBusString</a> *plaintext,
<a name="l00065"></a>00065 <a class="code" href="structDBusString.html">DBusString</a> *encoded);
<a name="l00066"></a>00066 <a class="code" href="group__DBusTypes.html#ga39c9cb0f3a2a8ad6f55cc4855d035349" title="A boolean, valid values are TRUE and FALSE.">dbus_bool_t</a> <a class="code" href="group__DBusAuth.html#gac6e9dc07335a6291842374d834e95ad2" title="Called post-authentication, indicates whether we need to decode the message stream with _dbus_auth_de...">_dbus_auth_needs_decoding</a> (<a class="code" href="structDBusAuth.html" title="Internal members of DBusAuth.">DBusAuth</a> *auth);
<a name="l00067"></a>00067 <a class="code" href="group__DBusTypes.html#ga39c9cb0f3a2a8ad6f55cc4855d035349" title="A boolean, valid values are TRUE and FALSE.">dbus_bool_t</a> <a class="code" href="group__DBusAuth.html#ga7eb40f71c0ede79f954bcb2c001c8502" title="Called post-authentication, decodes a block of bytes received from the peer.">_dbus_auth_decode_data</a> (<a class="code" href="structDBusAuth.html" title="Internal members of DBusAuth.">DBusAuth</a> *auth,
<a name="l00068"></a>00068 <span class="keyword">const</span> <a class="code" href="structDBusString.html">DBusString</a> *encoded,
<a name="l00069"></a>00069 <a class="code" href="structDBusString.html">DBusString</a> *plaintext);
<a name="l00070"></a>00070 <a class="code" href="group__DBusTypes.html#ga39c9cb0f3a2a8ad6f55cc4855d035349" title="A boolean, valid values are TRUE and FALSE.">dbus_bool_t</a> <a class="code" href="group__DBusAuth.html#ga2bb917d44b44b1a2813f60dec03731cd" title="Sets credentials received via reliable means from the operating system.">_dbus_auth_set_credentials</a> (<a class="code" href="structDBusAuth.html" title="Internal members of DBusAuth.">DBusAuth</a> *auth,
<a name="l00071"></a>00071 <a class="code" href="structDBusCredentials.html">DBusCredentials</a> *<a class="code" href="structDBusAuth.html#aed82f21abc1ad5aa8c0db8a43f93bc22" title="Credentials read from socket.">credentials</a>);
<a name="l00072"></a>00072 <a class="code" href="structDBusCredentials.html">DBusCredentials</a>* <a class="code" href="group__DBusAuth.html#gabfa5450530b999bcb0fabf37c414a80e" title="Gets the identity we authorized the client as.">_dbus_auth_get_identity</a> (<a class="code" href="structDBusAuth.html" title="Internal members of DBusAuth.">DBusAuth</a> *auth);
<a name="l00073"></a>00073 <a class="code" href="group__DBusTypes.html#ga39c9cb0f3a2a8ad6f55cc4855d035349" title="A boolean, valid values are TRUE and FALSE.">dbus_bool_t</a> <a class="code" href="group__DBusAuth.html#gad6d64040b2cf1c91f808a1f31f7ff2f0" title="Sets the "authentication context" which scopes cookies with the DBUS_COOKIE_SHA1 auth mechanism for e...">_dbus_auth_set_context</a> (<a class="code" href="structDBusAuth.html" title="Internal members of DBusAuth.">DBusAuth</a> *auth,
<a name="l00074"></a>00074 <span class="keyword">const</span> <a class="code" href="structDBusString.html">DBusString</a> *<a class="code" href="structDBusAuth.html#aedf6904d461a6f6eba2ee21f12f89611" title="Cookie scope.">context</a>);
<a name="l00075"></a>00075 <span class="keyword">const</span> <span class="keywordtype">char</span>* <a class="code" href="group__DBusAuth.html#gad0bf394093dd9ac43ebf71a5f35a4f3f" title="Gets the GUID from the server if we've authenticated; gets NULL otherwise.">_dbus_auth_get_guid_from_server</a>(<a class="code" href="structDBusAuth.html" title="Internal members of DBusAuth.">DBusAuth</a> *auth);
<a name="l00076"></a>00076
<a name="l00077"></a>00077 <span class="keywordtype">void</span> <a class="code" href="group__DBusAuth.html#ga831cbd78b6c7f382840e4094f02efdb5" title="Sets whether unix fd passing is potentially on the transport and hence shall be negotiated.">_dbus_auth_set_unix_fd_possible</a>(<a class="code" href="structDBusAuth.html" title="Internal members of DBusAuth.">DBusAuth</a> *auth, <a class="code" href="group__DBusTypes.html#ga39c9cb0f3a2a8ad6f55cc4855d035349" title="A boolean, valid values are TRUE and FALSE.">dbus_bool_t</a> b);
<a name="l00078"></a>00078 <a class="code" href="group__DBusTypes.html#ga39c9cb0f3a2a8ad6f55cc4855d035349" title="A boolean, valid values are TRUE and FALSE.">dbus_bool_t</a> <a class="code" href="group__DBusAuth.html#ga2d9119a45123f6b513a60391fb617d5c" title="Queries whether unix fd passing was successfully negotiated.">_dbus_auth_get_unix_fd_negotiated</a>(<a class="code" href="structDBusAuth.html" title="Internal members of DBusAuth.">DBusAuth</a> *auth);
<a name="l00079"></a>00079
<a name="l00080"></a>00080 <a class="code" href="group__DBusMacros.html#gae4a9263a43f8220f6e1c0fd07cf6e59a" title="Macro used after declaring functions in the D-Bus header files.">DBUS_END_DECLS</a>
<a name="l00081"></a>00081
<a name="l00082"></a>00082 <span class="preprocessor">#endif </span><span class="comment">/* DBUS_AUTH_H */</span>
</pre></div></div><!-- contents -->
<hr class="footer"/><address class="footer"><small>
Generated on Thu Mar 3 2016 17:50:29 for D-Bus by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.7.6.1
</small></address>
</body>
</html>