<!DOCTYPE REFENTRY PUBLIC "-//Sun Microsystems//DTD DocBook V3.0-Based SolBook Subset V2.0//EN" [
<!--ArborText, Inc., 1988-1999, v.4002-->
<!--ARC : LSARC 2008/430 gnome-keyring-->
<!ENTITY cmd "libgnome-keyring">
<!ENTITY % commonents SYSTEM "smancommon.ent">
%commonents;
<!ENTITY % booktitles SYSTEM "booktitles.ent">
%booktitles;
<!ENTITY suncopy "Copyright (c) 2008, Sun Microsystems, Inc. All Rights Reserved.">
]>
<?Pub UDT _bookmark _target>
<?Pub Inc>
<refentry id="libgnome-keyring-3">
<!-- %Z%%M% %I% %E% SMI; -->
<refmeta><refentrytitle>&cmd;</refentrytitle><manvolnum>3</manvolnum>
<refmiscinfo class="date">31 Jul 2008</refmiscinfo>
<refmiscinfo class="sectdesc">&man3;</refmiscinfo>
<refmiscinfo class="software">&release;</refmiscinfo>
<refmiscinfo class="arch">generic</refmiscinfo>
<refmiscinfo class="copyright">&suncopy;</refmiscinfo>
</refmeta>
<indexterm><primary>&cmd;</primary></indexterm>
<refnamediv id="libgnome-keyring-3-name"><refname>&cmd;</refname>
<refpurpose>gnome keyring library.
</refpurpose></refnamediv>

<refsect1 id="libgnome-keyring-3-desc"><title>&desc-tt;</title>
<para>
GNOME Keyring is a system to store passwords and other sensitive data in a 
standardized way across all GNOME applications.

A keyring stores a collection of encrypted passwords and encrypted 
information about those passwords. A user can have multiple keyrings, each 
for a different use, but there is a default one, called 'login'. There is 
also a special 'session' keyring which is not stored on disk and goes away 
when you log out.

When a user logs into GNOME, the keyrings are locked and a master keyring 
password has to be provided in order to unlock each of them.

GNOME Keyring includes an SSH agent which integrates with the gnome-keyring
and user login for its passwords. It can also use the main X.509 private
key store.

GNOME Keyring will set the SSH_AUTH_SOCK environment variable when it 
starts up.

The id_rsa and id_dsa files in ~/.ssh are automatically usable through the
SSH agent without first 'loading' them. Other X.509 private keys marked 
with the 'ssh-authentication' purpose are also usable.

Additional SSH keys can be manually loaded and managed via the
<citerefentry><refentrytitle>ssh-add</refentrytitle><manvolnum>1</manvolnum></citerefentry>
command.

If you use another SSH agent (such as
<citerefentry><refentrytitle>ssh-agent</refentrytitle><manvolnum>1</manvolnum></citerefentry>
included with OpenSSH), you may want to disable the SSH agent in GNOME Keyring
to prevent ssh from using it instead of your prefered SSH agent. You can set 
/apps/gnome-keyring/daemon-components/ssh
gconf key to false. This prevents the SSH component of gnome-keyring from 
starting up when the user logs in.
</para>
</refsect1>

<refsect1 id="libgnome-keyring-3-attr"><title>&attr-tt;</title>
<para>See <olink targetdocent="REFMAN5" localinfo="attributes-3"><citerefentry>
<refentrytitle>attributes</refentrytitle><manvolnum>5</manvolnum></citerefentry></olink>
for descriptions of the following attributes:</para>
<informaltable frame="all">
<tgroup cols="2" colsep="1" rowsep="1"><colspec colname="COLSPEC0" colwidth="1*">
<colspec colname="COLSPEC1" colwidth="1*">
<thead>
<row><entry align="center" valign="middle">ATTRIBUTE TYPE</entry><entry align="center"
valign="middle">ATTRIBUTE VALUE</entry></row>
</thead>
<tbody>
<row><entry><para>Availability</para></entry><entry><para>library/gnome/gnome-keyring
</para></entry></row>
<row><entry colname="COLSPEC0"><para>Interface stability</para></entry><entry
colname="COLSPEC1"><para>Volatile</para></entry></row>
</tbody>
</tgroup>
</informaltable>
</refsect1>

<refsect1 id="libgnome-keyring-3-also"><title>&also-tt;</title>
<!--Reference to another man page-->
<!--Reference to a Help manual-->
<!--Reference to a book.-->
<para>
<citerefentry><refentrytitle>gnome-keyring-daemon</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
<citerefentry><refentrytitle>ssh-add</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
<citerefentry><refentrytitle>ssh-agent</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
<citerefentry><refentrytitle>attributes</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
<citerefentry><refentrytitle>gnome-interfaces</refentrytitle><manvolnum>5</manvolnum></citerefentry>
</para>

<variablelist termlength="wholeline">
<varlistentry>
<literal>http://library.gnome.org/devel/gnome-keyring/stable/</literal>
</varlistentry>
</variablelist>

</refsect1>

<refsect1 id="libgnome-keyring-3-note"><title>&note-tt;</title>
<para>Written by Jeff Cai, Sun Microsystems Inc., 2008.</para>
</refsect1>

</refentry>
