<?xml version="1.0"?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook V4.1.2//EN"
  "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">


<refentry id="gfkey.1">

<refentryinfo><date>13 Feb 2020</date></refentryinfo>

<refmeta>
<refentrytitle>gfkey</refentrytitle>
<manvolnum>1</manvolnum>
<refmiscinfo>Gfarm</refmiscinfo>
</refmeta>
<refnamediv id="name">
<refname>gfkey</refname>
<refpurpose>Gfarm セッション・キー管理コマンド</refpurpose>
</refnamediv>

<refsynopsisdiv id="synopsis">
<cmdsynopsis sepchar=" ">
  <command moreinfo="none">gfkey</command>
    <arg choice="opt" rep="norepeat"><replaceable>オプション</replaceable></arg>
</cmdsynopsis>
</refsynopsisdiv>

<!-- body begins here -->

<refsect1 id="description"><title>DESCRIPTION</title>
<para>信頼された環境で gfsd、gfmd を共有秘密鍵認証でアクセスするのに
必要なセッション・キー・ファイル 
<filename moreinfo="none">$HOME/.gfarm_shared_key</filename>
を扱うコマンドです。
セッション・キー・ファイルのパス名は gfarm2.conf の shared_key_file
により変更可能です。</para>

<para>ホーム・ディレクトリを共有している環境では、このコマンドを使う必要性
はあまりありませんが、そうでない環境では、このコマンドでキーを生成し
た後、全ファイルシステムノードにキーを配付する必要があります。</para>

</refsect1>

<refsect1 id="options"><title>OPTIONS</title>
<variablelist>
<varlistentry>
<term><option>-c</option></term>
<listitem>
<para>このオプションを指定すると、有効なセッション・キーがない場合に、セッ
ション・キー・ファイルを作成します。既に有効なセッション・キーが存
在する場合には何もしません。</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-f</option></term>
<listitem>
<para>強制的にセッション・キーを作成します。
既に有効なセッション・キーが存在する場合でも、そのキーを捨てて新た
にキーを作成します。</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-p</option> <parameter moreinfo="none">period</parameter></term>
<listitem>
<para>セッション・キーの有効期限を指定します。単位は秒です。
このオプションは -c オプションあるいは -f
オプションと同時に指定する必要があります。
デフォルトは86400秒（1日）です。
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-l</option></term>
<listitem>
<para>現在のキーを表示します。</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-e</option></term>
<listitem>
<para>現在のキーの期限が切れる時刻を表示します。</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-L</option> <parameter moreinfo="none">message-priority-level</parameter></term>
<listitem>
<para>
このオプションで指定したレベル以上の優先度のメッセージを出力します。
デフォルトはinfoです。
指定できる値はgfarm2.conf(5)のlog_levelの項を参照してください。
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-V</option></term>
<listitem>
<para>バージョンを表示します。</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-?</option></term>
<listitem>
<para>引数オプションを表示します。</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>

<refsect1 id="files"><title>FILES</title>
<variablelist>
<varlistentry>
<term><filename moreinfo="none">$HOME/.gfarm_shared_key</filename></term>
<listitem>
<para>セッション・キー・ファイルです。</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
</refentry>
