<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>GcrSshAskpass: Gcr Library Reference Manual</title>
<meta name="generator" content="DocBook XSL Stylesheets Vsnapshot">
<link rel="home" href="index.html" title="Gcr Library Reference Manual">
<link rel="up" href="prompts.html" title="Part IV. Prompting">
<link rel="prev" href="GcrSystemPrompter.html" title="GcrSystemPrompter">
<link rel="next" href="storage.html" title="Part V. Storage">
<meta name="generator" content="GTK-Doc V1.27.1 (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="#gcr-GcrSshAskpass.description" class="shortcut">Description</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="prompts.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="GcrSystemPrompter.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="storage.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="gcr-GcrSshAskpass"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="gcr-GcrSshAskpass.top_of_page"></a>GcrSshAskpass</span></h2>
<p>GcrSshAskpass — Allows an ssh command to callback for a password</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="gcr-GcrSshAskpass.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="gcr-GcrSshAskpass.html#GcrSshAskpass" title="GcrSshAskpass"><span class="returnvalue">GcrSshAskpass</span></a> *
</td>
<td class="function_name">
<a class="link" href="gcr-GcrSshAskpass.html#gcr-ssh-askpass-new" title="gcr_ssh_askpass_new ()">gcr_ssh_askpass_new</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">GTlsInteraction</span> *
</td>
<td class="function_name">
<a class="link" href="gcr-GcrSshAskpass.html#gcr-ssh-askpass-get-interaction" title="gcr_ssh_askpass_get_interaction ()">gcr_ssh_askpass_get_interaction</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="gcr-GcrSshAskpass.html#gcr-ssh-askpass-child-setup" title="gcr_ssh_askpass_child_setup ()">gcr_ssh_askpass_child_setup</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="gcr-GcrSshAskpass.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="gcr-GcrSshAskpass.html#GcrSshAskpass" title="GcrSshAskpass">GcrSshAskpass</a></td>
</tr></tbody>
</table></div>
</div>
<div class="refsect1">
<a name="gcr-GcrSshAskpass.description"></a><h2>Description</h2>
<p>When used as the setup function while spawning an ssh command like ssh-add
or ssh, this allows callbacks for passwords on the provided interaction.</p>
</div>
<div class="refsect1">
<a name="gcr-GcrSshAskpass.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="gcr-ssh-askpass-new"></a><h3>gcr_ssh_askpass_new ()</h3>
<pre class="programlisting"><a class="link" href="gcr-GcrSshAskpass.html#GcrSshAskpass" title="GcrSshAskpass"><span class="returnvalue">GcrSshAskpass</span></a> *
gcr_ssh_askpass_new (<em class="parameter"><code><span class="type">GTlsInteraction</span> *interaction</code></em>);</pre>
<p>Create a new GcrSshAskpass object which can be used to spawn an
ssh command and prompt for any necessary passwords.</p>
<p>Use the <a class="link" href="gcr-GcrSshAskpass.html#gcr-ssh-askpass-child-setup" title="gcr_ssh_askpass_child_setup ()"><code class="function">gcr_ssh_askpass_child_setup()</code></a> function as a callback with
<code class="function">g_spawn_sync()</code>, <code class="function">g_spawn_async()</code> or <code class="function">g_spawn_async_with_pipes()</code>.</p>
<div class="refsect3">
<a name="gcr-ssh-askpass-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>interaction</p></td>
<td class="parameter_description"><p>the interaction to use for prompting paswords</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gcr-ssh-askpass-new.returns"></a><h4>Returns</h4>
<p>A new <a class="link" href="gcr-GcrSshAskpass.html#GcrSshAskpass" title="GcrSshAskpass"><span class="type">GcrSshAskpass</span></a> object. </p>
<p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="gcr-ssh-askpass-get-interaction"></a><h3>gcr_ssh_askpass_get_interaction ()</h3>
<pre class="programlisting"><span class="returnvalue">GTlsInteraction</span> *
gcr_ssh_askpass_get_interaction (<em class="parameter"><code><a class="link" href="gcr-GcrSshAskpass.html#GcrSshAskpass" title="GcrSshAskpass"><span class="type">GcrSshAskpass</span></a> *self</code></em>);</pre>
<p>Get the interaction associated with this object.</p>
<div class="refsect3">
<a name="gcr-ssh-askpass-get-interaction.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>self</p></td>
<td class="parameter_description"><p>a <a class="link" href="gcr-GcrSshAskpass.html#GcrSshAskpass" title="GcrSshAskpass"><span class="type">GcrSshAskpass</span></a> object</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gcr-ssh-askpass-get-interaction.returns"></a><h4>Returns</h4>
<p>the interaction. </p>
<p><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="gcr-ssh-askpass-child-setup"></a><h3>gcr_ssh_askpass_child_setup ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
gcr_ssh_askpass_child_setup (<em class="parameter"><code><span class="type">gpointer</span> askpass</code></em>);</pre>
<p>Use this function as a callback setup function passed to <code class="function">g_spawn_sync()</code>,
<code class="function">g_spawn_async()</code>, <code class="function">g_spawn_async_with_pipes()</code>.</p>
<div class="refsect3">
<a name="gcr-ssh-askpass-child-setup.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>askpass</p></td>
<td class="parameter_description"><p>a <a class="link" href="gcr-GcrSshAskpass.html#GcrSshAskpass" title="GcrSshAskpass"><span class="type">GcrSshAskpass</span></a> object</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
</div>
</div>
<div class="refsect1">
<a name="gcr-GcrSshAskpass.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="GcrSshAskpass"></a><h3>GcrSshAskpass</h3>
<pre class="programlisting">typedef struct _GcrSshAskpass GcrSshAskpass;</pre>
<p>An object containing the password prompting state.</p>
</div>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.27.1</div>
</body>
</html>