13725N/A<!DOCTYPE REFENTRY PUBLIC "-//Sun Microsystems//DTD DocBook V3.0-Based SolBook Subset V2.0//EN" [

13725N/A<!--ArborText, Inc., 1988-1999, v.4002-->

13725N/A<!ENTITY cmd "libgnome-keyring">

13725N/A<!ENTITY % commonents SYSTEM "smancommon.ent">

13725N/A%commonents;

13725N/A<!ENTITY % booktitles SYSTEM "booktitles.ent">

13725N/A%booktitles;

13725N/A<!ENTITY suncopy "Copyright (c) 2008, Sun Microsystems, Inc. All Rights Reserved.">

13725N/A]>

13725N/A<?Pub UDT _bookmark _target>

13725N/A<?Pub Inc>

13725N/A<refentry id="libgnome-keyring-3">

13725N/A<refmeta><refentrytitle>&cmd;</refentrytitle><manvolnum>3</manvolnum>

13725N/A<refmiscinfo class="date">31 Jul 2008</refmiscinfo>

13725N/A<refmiscinfo class="sectdesc">&man3;</refmiscinfo>

13725N/A<refmiscinfo class="software">&release;</refmiscinfo>

13725N/A<refmiscinfo class="arch">generic</refmiscinfo>

13725N/A<refmiscinfo class="copyright">&suncopy;</refmiscinfo>

13725N/A</refmeta>

13725N/A<indexterm><primary>&cmd;</primary></indexterm>

13725N/A<refnamediv id="libgnome-keyring-3-name"><refname>&cmd;</refname>

13731N/A<refpurpose>gnome keyring library.

13725N/A</refpurpose></refnamediv>

13725N/A

13725N/A<refsect1 id="libgnome-keyring-3-desc"><title>&desc-tt;</title>

13725N/A<para>

13731N/AGNOME Keyring is a system to store passwords and other sensitive data in a

13731N/Astandardized way across all GNOME applications.

13731N/A

13725N/AA keyring stores a collection of encrypted passwords and encrypted

13725N/Ainformation about those passwords. A user can have multiple keyrings, each

13725N/Afor a different use, but there is a default one, called 'login'. There is

13725N/Aalso a special 'session' keyring which is not stored on disk and goes away

13725N/Awhen you log out.

13725N/A

13725N/AWhen a user logs into GNOME, the keyrings are locked and a master keyring

13725N/Apassword has to be provided in order to unlock each of them.

13725N/A

13725N/AGNOME Keyring includes an SSH agent which integrates with the gnome-keyring

13725N/Aand user login for its passwords. It can also use the main X.509 private

13725N/Akey store.

13725N/A

13725N/AGNOME Keyring will set the SSH_AUTH_SOCK environment variable when it

13725N/Astarts up.

13725N/A

13725N/AThe id_rsa and id_dsa files in ~/.ssh are automatically usable through the

13725N/ASSH agent without first 'loading' them. Other X.509 private keys marked

13725N/Awith the 'ssh-authentication' purpose are also usable.

13725N/A

15995N/AAdditional SSH keys can be manually loaded and managed via the

15995N/A<citerefentry><refentrytitle>ssh-add</refentrytitle><manvolnum>1</manvolnum></citerefentry>

13725N/Acommand.

13725N/A

15995N/AIf you use another SSH agent (such as

15995N/A<citerefentry><refentrytitle>ssh-agent</refentrytitle><manvolnum>1</manvolnum></citerefentry>

15995N/Aincluded with OpenSSH), you may want to disable the SSH agent in GNOME Keyring

15995N/Ato prevent ssh from using it instead of your prefered SSH agent. You can set

13725N/A/apps/gnome-keyring/daemon-components/ssh

13725N/Agconf key to false. This prevents the SSH component of gnome-keyring from

13725N/Astarting up when the user logs in.

13725N/A</para>

13725N/A</refsect1>

13725N/A

13725N/A<refsect1 id="libgnome-keyring-3-attr"><title>&attr-tt;</title>

13725N/A<para>See <olink targetdocent="REFMAN5" localinfo="attributes-3"><citerefentry>

13725N/A<refentrytitle>attributes</refentrytitle><manvolnum>5</manvolnum></citerefentry></olink>

13725N/Afor descriptions of the following attributes:</para>

13725N/A<informaltable frame="all">

13725N/A<tgroup cols="2" colsep="1" rowsep="1"><colspec colname="COLSPEC0" colwidth="1*">

13725N/A<colspec colname="COLSPEC1" colwidth="1*">

13725N/A<thead>

13725N/A<row><entry align="center" valign="middle">ATTRIBUTE TYPE</entry><entry align="center"

13725N/Avalign="middle">ATTRIBUTE VALUE</entry></row>

13725N/A</thead>

13725N/A<tbody>

18768N/A<row><entry><para>Availability</para></entry><entry><para>library/gnome/gnome-keyring

13725N/A</para></entry></row>

13725N/A<row><entry colname="COLSPEC0"><para>Interface stability</para></entry><entry

13725N/Acolname="COLSPEC1"><para>Volatile</para></entry></row>

13725N/A</tbody>

13725N/A</tgroup>

13725N/A</informaltable>

13725N/A</refsect1>

13725N/A

13725N/A<refsect1 id="libgnome-keyring-3-also"><title>&also-tt;</title>

13725N/A<para>

13725N/A<citerefentry><refentrytitle>gnome-keyring-daemon</refentrytitle><manvolnum>1</manvolnum></citerefentry>,

15995N/A<citerefentry><refentrytitle>ssh-add</refentrytitle><manvolnum>1</manvolnum></citerefentry>,

15995N/A<citerefentry><refentrytitle>ssh-agent</refentrytitle><manvolnum>1</manvolnum></citerefentry>,

13741N/A<citerefentry><refentrytitle>attributes</refentrytitle><manvolnum>5</manvolnum></citerefentry>,

13741N/A<citerefentry><refentrytitle>gnome-interfaces</refentrytitle><manvolnum>5</manvolnum></citerefentry>

13725N/A</para>

13725N/A

13725N/A<variablelist termlength="wholeline">

13725N/A<varlistentry>

13725N/A<literal>http://library.gnome.org/devel/gnome-keyring/stable/</literal>

13725N/A</varlistentry>

13725N/A</variablelist>

13725N/A

13725N/A</refsect1>

13725N/A

13725N/A<refsect1 id="libgnome-keyring-3-note"><title>&note-tt;</title>

13725N/A<para>Written by Jeff Cai, Sun Microsystems Inc., 2008.</para>

13725N/A</refsect1>

13725N/A

13725N/A</refentry>