| Current File : //usr/share/doc/dbus/api/dbus-credentials_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-credentials.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-credentials.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-credentials.h Credentials provable through authentication</span>
<a name="l00003"></a>00003 <span class="comment"> *</span>
<a name="l00004"></a>00004 <span class="comment"> * Copyright (C) 2007 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_CREDENTIALS_H</span>
<a name="l00024"></a>00024 <span class="preprocessor"></span><span class="preprocessor">#define DBUS_CREDENTIALS_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">enum</span> {
<a name="l00034"></a>00034 DBUS_CREDENTIAL_UNIX_PROCESS_ID,
<a name="l00035"></a>00035 DBUS_CREDENTIAL_UNIX_USER_ID,
<a name="l00036"></a>00036 DBUS_CREDENTIAL_ADT_AUDIT_DATA_ID,
<a name="l00037"></a>00037 DBUS_CREDENTIAL_WINDOWS_SID
<a name="l00038"></a>00038 } DBusCredentialType;
<a name="l00039"></a>00039
<a name="l00040"></a>00040 <a class="code" href="structDBusCredentials.html">DBusCredentials</a>* <a class="code" href="group__DBusCredentials.html#ga63b2f88e91962510ed947bae98270818" title="Creates a new object with credentials (user ID and process ID) from the current process.">_dbus_credentials_new_from_current_process</a> (<span class="keywordtype">void</span>);
<a name="l00041"></a>00041 <a class="code" href="structDBusCredentials.html">DBusCredentials</a>* <a class="code" href="group__DBusCredentials.html#ga749dd398d725f37a7943d60074785844" title="Creates a new credentials object.">_dbus_credentials_new</a> (<span class="keywordtype">void</span>);
<a name="l00042"></a>00042 <span class="keywordtype">void</span> <a class="code" href="group__DBusCredentials.html#ga09d375f124bddbbaa1aac62ef49078ac" title="Increment refcount on credentials.">_dbus_credentials_ref</a> (<a class="code" href="structDBusCredentials.html">DBusCredentials</a> *credentials);
<a name="l00043"></a>00043 <span class="keywordtype">void</span> <a class="code" href="group__DBusCredentials.html#ga89913c830c3627cd006a50ca693af580" title="Decrement refcount on credentials.">_dbus_credentials_unref</a> (<a class="code" href="structDBusCredentials.html">DBusCredentials</a> *credentials);
<a name="l00044"></a>00044 <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__DBusCredentials.html#gaad133a8d06af2a447307266a8425a9f8" title="Add a UNIX process ID to the credentials.">_dbus_credentials_add_pid</a> (<a class="code" href="structDBusCredentials.html">DBusCredentials</a> *credentials,
<a name="l00045"></a>00045 <a class="code" href="group__DBusSysdeps.html#ga1eff6303266888ec466cddba6c03aa40" title="A process ID.">dbus_pid_t</a> pid);
<a name="l00046"></a>00046 <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__DBusCredentials.html#ga9cec6da43e4be233d44f5bd60b071624" title="Add a UNIX user ID to the credentials.">_dbus_credentials_add_unix_uid</a> (<a class="code" href="structDBusCredentials.html">DBusCredentials</a> *credentials,
<a name="l00047"></a>00047 <a class="code" href="group__DBusSysdeps.html#ga186e987b700f9ddc6cea8aa0db82b151" title="A user ID.">dbus_uid_t</a> uid);
<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__DBusCredentials.html#ga9d2186a4cfa8a421c552ae4592b400f5" title="Add a Windows user SID to the credentials.">_dbus_credentials_add_windows_sid</a> (<a class="code" href="structDBusCredentials.html">DBusCredentials</a> *credentials,
<a name="l00049"></a>00049 <span class="keyword">const</span> <span class="keywordtype">char</span> *windows_sid);
<a name="l00050"></a>00050 <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__DBusCredentials.html#gab26eb5cb8d05139806cf06e99c4ec5b0" title="Add ADT audit data to the credentials.">_dbus_credentials_add_adt_audit_data</a> (<a class="code" href="structDBusCredentials.html">DBusCredentials</a> *credentials,
<a name="l00051"></a>00051 <span class="keywordtype">void</span> *audit_data,
<a name="l00052"></a>00052 <a class="code" href="group__DBusTypes.html#gab18afa60e9b17b6e322735bda3d863d8" title="A 32-bit signed integer on all platforms.">dbus_int32_t</a> size);
<a name="l00053"></a>00053 <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__DBusCredentials.html#ga0fb8d13878e126ccc243c4a30fd8598c" title="Checks whether the given credential is present.">_dbus_credentials_include</a> (<a class="code" href="structDBusCredentials.html">DBusCredentials</a> *credentials,
<a name="l00054"></a>00054 DBusCredentialType type);
<a name="l00055"></a>00055 <a class="code" href="group__DBusSysdeps.html#ga1eff6303266888ec466cddba6c03aa40" title="A process ID.">dbus_pid_t</a> <a class="code" href="group__DBusCredentials.html#gaafde142353288854a8a3969949d2e548" title="Gets the UNIX process ID in the credentials, or DBUS_PID_UNSET if the credentials object doesn't cont...">_dbus_credentials_get_pid</a> (<a class="code" href="structDBusCredentials.html">DBusCredentials</a> *credentials);
<a name="l00056"></a>00056 <a class="code" href="group__DBusSysdeps.html#ga186e987b700f9ddc6cea8aa0db82b151" title="A user ID.">dbus_uid_t</a> <a class="code" href="group__DBusCredentials.html#ga462892f995f2932bf0eb3b843407e6d5" title="Gets the UNIX user ID in the credentials, or DBUS_UID_UNSET if the credentials object doesn't contain...">_dbus_credentials_get_unix_uid</a> (<a class="code" href="structDBusCredentials.html">DBusCredentials</a> *credentials);
<a name="l00057"></a>00057 <span class="keyword">const</span> <span class="keywordtype">char</span>* <a class="code" href="group__DBusCredentials.html#ga53680e02140559fb36efeec68d398ac0" title="Gets the Windows user SID in the credentials, or NULL if the credentials object doesn't contain a Win...">_dbus_credentials_get_windows_sid</a> (<a class="code" href="structDBusCredentials.html">DBusCredentials</a> *credentials);
<a name="l00058"></a>00058 <span class="keywordtype">void</span> * <a class="code" href="group__DBusCredentials.html#ga7a8e112e8ff3938e99ded65dd992ba05" title="Gets the ADT audit data in the credentials, or NULL if the credentials object doesn't contain ADT aud...">_dbus_credentials_get_adt_audit_data</a> (<a class="code" href="structDBusCredentials.html">DBusCredentials</a> *credentials);
<a name="l00059"></a>00059 <a class="code" href="group__DBusTypes.html#gab18afa60e9b17b6e322735bda3d863d8" title="A 32-bit signed integer on all platforms.">dbus_int32_t</a> <a class="code" href="group__DBusCredentials.html#gab3f338ba37ed9bfa1531e00b3a8a10ce" title="Gets the ADT audit data size in the credentials, or 0 if the credentials object doesn't contain ADT a...">_dbus_credentials_get_adt_audit_data_size</a> (<a class="code" href="structDBusCredentials.html">DBusCredentials</a> *credentials);
<a name="l00060"></a>00060 <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__DBusCredentials.html#ga1c6090c76e5151ae8a1efe9e84382934" title="Checks whether the first credentials object contains all the credentials found in the second credenti...">_dbus_credentials_are_superset</a> (<a class="code" href="structDBusCredentials.html">DBusCredentials</a> *credentials,
<a name="l00061"></a>00061 <a class="code" href="structDBusCredentials.html">DBusCredentials</a> *possible_subset);
<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__DBusCredentials.html#ga9aea1a288097b0820d1cd05c2448501d" title="Checks whether a credentials object contains anything.">_dbus_credentials_are_empty</a> (<a class="code" href="structDBusCredentials.html">DBusCredentials</a> *credentials);
<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__DBusCredentials.html#gabfd7a1f681a91b45ba2f4e7461131827" title="Checks whether a credentials object contains a user identity.">_dbus_credentials_are_anonymous</a> (<a class="code" href="structDBusCredentials.html">DBusCredentials</a> *credentials);
<a name="l00064"></a>00064 <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__DBusCredentials.html#ga6b6cab83ecaa05e765967c188f62dd05" title="Merge all credentials found in the second object into the first object, overwriting the first object ...">_dbus_credentials_add_credentials</a> (<a class="code" href="structDBusCredentials.html">DBusCredentials</a> *credentials,
<a name="l00065"></a>00065 <a class="code" href="structDBusCredentials.html">DBusCredentials</a> *other_credentials);
<a name="l00066"></a>00066 <span class="comment">/* must silently allow 'which' to not exist */</span>
<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__DBusCredentials.html#gabd5a6d038f1d35fd23af8b2e73bb7ef8" title="Merge the given credential found in the second object into the first object, overwriting the first ob...">_dbus_credentials_add_credential</a> (<a class="code" href="structDBusCredentials.html">DBusCredentials</a> *credentials,
<a name="l00068"></a>00068 DBusCredentialType which,
<a name="l00069"></a>00069 <a class="code" href="structDBusCredentials.html">DBusCredentials</a> *other_credentials);
<a name="l00070"></a>00070 <span class="keywordtype">void</span> <a class="code" href="group__DBusCredentials.html#ga40a5c7e37b10419e233a473dc7173f3c" title="Clear all credentials in the object.">_dbus_credentials_clear</a> (<a class="code" href="structDBusCredentials.html">DBusCredentials</a> *credentials);
<a name="l00071"></a>00071 <a class="code" href="structDBusCredentials.html">DBusCredentials</a>* <a class="code" href="group__DBusCredentials.html#ga416f5b9d174e672b63fdd2c11d567eb2" title="Copy a credentials object.">_dbus_credentials_copy</a> (<a class="code" href="structDBusCredentials.html">DBusCredentials</a> *credentials);
<a name="l00072"></a>00072 <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__DBusCredentials.html#ga2f10263b80ff6611c15a78e8f6823dfa" title="Check whether the user-identifying credentials in two credentials objects are identical.">_dbus_credentials_same_user</a> (<a class="code" href="structDBusCredentials.html">DBusCredentials</a> *credentials,
<a name="l00073"></a>00073 <a class="code" href="structDBusCredentials.html">DBusCredentials</a> *other_credentials);
<a name="l00074"></a>00074 <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__DBusCredentials.html#ga50047ecf44c85ecb0878a370592c1576" title="Convert the credentials in this object to a human-readable string format, and append to the given str...">_dbus_credentials_to_string_append</a> (<a class="code" href="structDBusCredentials.html">DBusCredentials</a> *credentials,
<a name="l00075"></a>00075 <a class="code" href="structDBusString.html">DBusString</a> *<span class="keywordtype">string</span>);
<a name="l00076"></a>00076
<a name="l00077"></a>00077 <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="l00078"></a>00078
<a name="l00079"></a>00079 <span class="preprocessor">#endif </span><span class="comment">/* DBUS_CREDENTIALS_H */</span>
</pre></div></div><!-- contents -->
<hr class="footer"/><address class="footer"><small>
Generated on Thu Mar 3 2016 17:50:30 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>