/usr/share/gtk-doc/html/snapd-glib/SnapdAuthData.html is in libsnapd-glib-dev 1.39-0ubuntu1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>SnapdAuthData: snapd-glib Reference Manual</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
<link rel="home" href="index.html" title="snapd-glib Reference Manual">
<link rel="up" href="ch01.html" title="Snapd-GLib">
<link rel="prev" href="SnapdAlias.html" title="SnapdAlias">
<link rel="next" href="SnapdChange.html" title="SnapdChange">
<meta name="generator" content="GTK-Doc V1.27 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="5"><tr valign="middle">
<td width="100%" align="left" class="shortcuts">
<a href="#" class="shortcut">Top</a><span id="nav_description"> <span class="dim">|</span>
<a href="#SnapdAuthData.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span>
<a href="#SnapdAuthData.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_properties"> <span class="dim">|</span>
<a href="#SnapdAuthData.properties" class="shortcut">Properties</a></span>
</td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
<td><a accesskey="u" href="ch01.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="SnapdAlias.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="SnapdChange.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="SnapdAuthData"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="SnapdAuthData.top_of_page"></a>SnapdAuthData</span></h2>
<p>SnapdAuthData — Authorization data</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="SnapdAuthData.functions"></a><h2>Functions</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="functions_return">
<col class="functions_name">
</colgroup>
<tbody>
<tr>
<td class="function_type">
<a class="link" href="SnapdAuthData.html" title="SnapdAuthData"><span class="returnvalue">SnapdAuthData</span></a> *
</td>
<td class="function_name">
<a class="link" href="SnapdAuthData.html#snapd-auth-data-new" title="snapd_auth_data_new ()">snapd_auth_data_new</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">const <span class="returnvalue">gchar</span> *
</td>
<td class="function_name">
<a class="link" href="SnapdAuthData.html#snapd-auth-data-get-macaroon" title="snapd_auth_data_get_macaroon ()">snapd_auth_data_get_macaroon</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gchar</span> **
</td>
<td class="function_name">
<a class="link" href="SnapdAuthData.html#snapd-auth-data-get-discharges" title="snapd_auth_data_get_discharges ()">snapd_auth_data_get_discharges</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="SnapdAuthData.properties"></a><h2>Properties</h2>
<div class="informaltable"><table class="informaltable" border="0">
<colgroup>
<col width="150px" class="properties_type">
<col width="300px" class="properties_name">
<col width="200px" class="properties_flags">
</colgroup>
<tbody>
<tr>
<td class="property_type"><span class="type">GStrv</span></td>
<td class="property_name"><a class="link" href="SnapdAuthData.html#SnapdAuthData--discharges" title="The “discharges” property">discharges</a></td>
<td class="property_flags">Read / Write</td>
</tr>
<tr>
<td class="property_type">
<span class="type">gchar</span> *</td>
<td class="property_name"><a class="link" href="SnapdAuthData.html#SnapdAuthData--macaroon" title="The “macaroon” property">macaroon</a></td>
<td class="property_flags">Read / Write</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="SnapdAuthData.other"></a><h2>Types and Values</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="name">
<col class="description">
</colgroup>
<tbody><tr>
<td class="datatype_keyword"> </td>
<td class="function_name"><a class="link" href="SnapdAuthData.html#SnapdAuthData-struct" title="SnapdAuthData">SnapdAuthData</a></td>
</tr></tbody>
</table></div>
</div>
<div class="refsect1">
<a name="SnapdAuthData.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="screen"> GObject
<span class="lineart">╰──</span> SnapdAuthData
</pre>
</div>
<div class="refsect1">
<a name="SnapdAuthData.includes"></a><h2>Includes</h2>
<pre class="synopsis">#include <snapd-glib/snapd-glib.h>
</pre>
</div>
<div class="refsect1">
<a name="SnapdAuthData.description"></a><h2>Description</h2>
<p>A <a class="link" href="SnapdAuthData.html" title="SnapdAuthData"><span class="type">SnapdAuthData</span></a> contains authorization data to communicate with snapd.
Authenticating with <a class="link" href="snapd-glib-snapd-login().html#snapd-login-sync" title="snapd_login_sync ()"><code class="function">snapd_login_sync()</code></a> or <a class="link" href="SnapdClient.html#snapd-client-login-sync" title="snapd_client_login_sync ()"><code class="function">snapd_client_login_sync()</code></a> returns
authorization data that can be used for requests by calling
<a class="link" href="SnapdClient.html#snapd-client-set-auth-data" title="snapd_client_set_auth_data ()"><code class="function">snapd_client_set_auth_data()</code></a>.</p>
<p>It is recommended that the data is securely stored between sessions so
authentication is not required to be repeated. The authorization data is
made up of printable strings that can be easily written to a file/database.</p>
</div>
<div class="refsect1">
<a name="SnapdAuthData.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="snapd-auth-data-new"></a><h3>snapd_auth_data_new ()</h3>
<pre class="programlisting"><a class="link" href="SnapdAuthData.html" title="SnapdAuthData"><span class="returnvalue">SnapdAuthData</span></a> *
snapd_auth_data_new (<em class="parameter"><code>const <span class="type">gchar</span> *macaroon</code></em>,
<em class="parameter"><code><span class="type">gchar</span> **discharges</code></em>);</pre>
<p>Create some authorization data.</p>
<div class="refsect3">
<a name="snapd-auth-data-new.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>macaroon</p></td>
<td class="parameter_description"><p>serialized macaroon used to authorize access to snapd.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>discharges</p></td>
<td class="parameter_description"><p>serialized discharges. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter points to an array of items."><span class="acronym">array</span></acronym> zero-terminated=1]</span></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="snapd-auth-data-new.returns"></a><h4>Returns</h4>
<p> a new <a class="link" href="SnapdAuthData.html" title="SnapdAuthData"><span class="type">SnapdAuthData</span></a></p>
</div>
<p class="since">Since: <a class="link" href="api-index-1-0.html#api-index-1.0">1.0</a></p>
</div>
<hr>
<div class="refsect2">
<a name="snapd-auth-data-get-macaroon"></a><h3>snapd_auth_data_get_macaroon ()</h3>
<pre class="programlisting">const <span class="returnvalue">gchar</span> *
snapd_auth_data_get_macaroon (<em class="parameter"><code><a class="link" href="SnapdAuthData.html" title="SnapdAuthData"><span class="type">SnapdAuthData</span></a> *auth_data</code></em>);</pre>
<p>Get the Macaroon that this authorization uses.</p>
<div class="refsect3">
<a name="snapd-auth-data-get-macaroon.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>auth_data</p></td>
<td class="parameter_description"><p>a <a class="link" href="SnapdAuthData.html" title="SnapdAuthData"><span class="type">SnapdAuthData</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="snapd-auth-data-get-macaroon.returns"></a><h4>Returns</h4>
<p> the serialized Macaroon used to authorize access to snapd.</p>
</div>
<p class="since">Since: <a class="link" href="api-index-1-0.html#api-index-1.0">1.0</a></p>
</div>
<hr>
<div class="refsect2">
<a name="snapd-auth-data-get-discharges"></a><h3>snapd_auth_data_get_discharges ()</h3>
<pre class="programlisting"><span class="returnvalue">gchar</span> **
snapd_auth_data_get_discharges (<em class="parameter"><code><a class="link" href="SnapdAuthData.html" title="SnapdAuthData"><span class="type">SnapdAuthData</span></a> *auth_data</code></em>);</pre>
<p>Get the discharges that this authorization uses.</p>
<div class="refsect3">
<a name="snapd-auth-data-get-discharges.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>auth_data</p></td>
<td class="parameter_description"><p>a <a class="link" href="SnapdAuthData.html" title="SnapdAuthData"><span class="type">SnapdAuthData</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="snapd-auth-data-get-discharges.returns"></a><h4>Returns</h4>
<p>the discharges as serialized strings. </p>
<p><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>][<acronym title="Parameter points to an array of items."><span class="acronym">array</span></acronym> zero-terminated=1]</span></p>
</div>
<p class="since">Since: <a class="link" href="api-index-1-0.html#api-index-1.0">1.0</a></p>
</div>
</div>
<div class="refsect1">
<a name="SnapdAuthData.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="SnapdAuthData-struct"></a><h3>SnapdAuthData</h3>
<pre class="programlisting">typedef struct _SnapdAuthData SnapdAuthData;</pre>
<p><a class="link" href="SnapdAuthData.html" title="SnapdAuthData"><span class="type">SnapdAuthData</span></a> contains authorization data used to communicate with snapd.</p>
<p>The authorization data is in the form of a <a class="ulink" href="https://research.google.com/pubs/pub41892.html" target="_top">Macaroon</a>.</p>
<p class="since">Since: <a class="link" href="api-index-1-0.html#api-index-1.0">1.0</a></p>
</div>
</div>
<div class="refsect1">
<a name="SnapdAuthData.property-details"></a><h2>Property Details</h2>
<div class="refsect2">
<a name="SnapdAuthData--discharges"></a><h3>The <code class="literal">“discharges”</code> property</h3>
<pre class="programlisting"> “discharges” <span class="type">GStrv</span></pre>
<p>Serialized discharges.</p>
<p>Flags: Read / Write</p>
</div>
<hr>
<div class="refsect2">
<a name="SnapdAuthData--macaroon"></a><h3>The <code class="literal">“macaroon”</code> property</h3>
<pre class="programlisting"> “macaroon” <span class="type">gchar</span> *</pre>
<p>Serialized macaroon.</p>
<p>Flags: Read / Write</p>
<p>Default value: NULL</p>
</div>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.27</div>
</body>
</html>
|