File: grid_proxy_init-manual.xml

package info (click to toggle)
globus-proxy-utils 3.9-1
  • links: PTS, VCS
  • area: main
  • in suites: squeeze
  • size: 1,660 kB
  • ctags: 131
  • sloc: sh: 8,562; ansic: 2,608; xml: 831; makefile: 224
file content (313 lines) | stat: -rwxr-xr-x 14,337 bytes parent folder | download | duplicates (4)
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
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
<?xml version='1.0' encoding='UTF-8'?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN"
"http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd" [
    <!ENTITY cmdname "grid-proxy-init">
    <!ENTITY cmd "<command>grid-proxy-init</command>">
]>

<refentry id="grid-proxy-init" xreflabel="grid-proxy-init">
  <refentryinfo>
    <corpauthor>University of Chicago</corpauthor>
  </refentryinfo>
  <refmeta>
    <refentrytitle>&cmdname;</refentrytitle>
    <manvolnum>1</manvolnum>
    <refmiscinfo class="source">Globus Toolkit</refmiscinfo>
    <refmiscinfo class="version"><replaceable role="entity">version</replaceable></refmiscinfo>
  </refmeta>
  <refnamediv>
    <refname>&cmdname;</refname>
    <refpurpose>Generate a new proxy certificate</refpurpose>
  </refnamediv>
  <refsynopsisdiv>
    <cmdsynopsis>
      &cmd;
      <arg>-help</arg>
      <arg>-usage</arg>
      <arg>-version</arg>
    </cmdsynopsis>
    <cmdsynopsis>
      &cmd;
      <arg>-debug</arg>
      <arg>-q</arg>
      <arg>-verify</arg>
      <sbr/>
      <group>
          <arg>-valid <replaceable>HOURS</replaceable>:<replaceable>MINUTES</replaceable></arg>
          <arg>-hours <replaceable>HOURS</replaceable></arg>
      </group>
      <arg>-cert <replaceable>CERTFILE</replaceable></arg>
      <arg>-key <replaceable>KEYFILE</replaceable></arg>
      <arg>-certdir <replaceable>CERTDIR</replaceable></arg>
      <arg>-out <replaceable>PROXYPATH</replaceable></arg>
      <arg>-bits <replaceable>BITS</replaceable></arg>
      <sbr/>
      <arg>-policy <replaceable>POLICYFILE</replaceable></arg>
      <sbr/>
      <group>
          <arg>-pl <replaceable>POLICY-OID</replaceable></arg>
          <arg>-policy-language <replaceable>POLICY-OID</replaceable></arg>
      </group>
      <arg>-path-length <replaceable>MAXIMUM</replaceable></arg>
      <arg>-pwstdin</arg>
      <arg >-limited</arg>
      <arg >-independent</arg>
      <group>
          <arg >-draft</arg>
          <arg >-old</arg>
          <arg >-rfc</arg>
      </group>

    </cmdsynopsis>
  </refsynopsisdiv>
  <refsect1>
    <title>Description</title>
    <para>
    The &cmd; program generates X.509 proxy certificates derived from the
    currently available certificate files.  By default, this command generates
    a <ulink url="http://www.ietf.org/rfc/rfc3820.txt">RFC 3820</ulink> Proxy
    Certificate with a 512 bit key valid for 12 hours in a file named
    <filename>/tmp/x509up_u<replaceable>UID</replaceable></filename>.
    Command-line options and variables can modify the format, strength,
    lifetime, and location of the generated proxy certificate.
    </para>
    <para>
    X.509 proxy certificates are short-lived certificates, signed usually by a
    user's identity certificate or another proxy certificate. The key
    associated with a proxy certificate is unencrypted, so applications
    can authenticate using a proxy identity without providing a passphrase.
    </para>

    <para>Proxy certificates provide a convenient alternative to constantly
    entering passwords, but are also less secure than the user's normal
    security credential. Therefore, they should always be user-readable only
    (this is enforced by the GSI libraries), and should be deleted after they
    are no longer needed.</para>

    <para>This version of &cmd; supports three different proxy formats: the
    old proxy format used in early releases of the Globus Toolkit up to
    version 2.4.x, an IETF draft version of X.509 Proxy Certificate profile
    used in Globus Toolkit 3.0.x and 3.2.x, and the RFC 3820 profile used in
    Globus Toolkit Version 4.0.x and 4.2.x. By default, this version of &cmd; 
    creates an RFC 3820 compliant proxy. To create a proxy compatible with
    older versions of the Globus Toolkit, use the <option>-old</option> or
    <option>-draft</option> command-line options.
    </para>

    <para>
    The full set of command-line options to &cmd; are:

    <variablelist>
        <varlistentry>
            <term><option>-help</option></term>
            <term><option>-usage</option></term>
            <listitem><simpara>Display the command-line options to 
            &cmd;.</simpara></listitem>
        </varlistentry>
        <varlistentry>
            <term><option>-version</option></term>
            <listitem><simpara>Display the version number of the &cmd;
            command</simpara></listitem>
        </varlistentry>
        <varlistentry>
            <term><option>-debug</option></term>
            <listitem><simpara>Display information about the path to the
            certificate and key used to generate the proxy certificate, the
            path to the trusted certificate directory, and verbose error
            messages</simpara></listitem>
        </varlistentry>
        <varlistentry>
            <term><option>-q</option></term>
            <listitem><simpara>Suppress all output from &cmd; except for
            passphrase prompts.</simpara></listitem>
        </varlistentry>
        <varlistentry>
            <term><option>-verify</option></term>
            <listitem><simpara>Perform certificate chain validity checks on the
            generated proxy.</simpara></listitem>
        </varlistentry>
        <varlistentry>
            <term><option>-valid <replaceable>HOURS</replaceable>:<replaceable>MINUTES</replaceable></option></term>
            <term><option>-hours <replaceable>HOURS</replaceable></option></term>
            <listitem><simpara>Create a certificate that is valid for
            <replaceable>HOURS</replaceable> hours and
            <replaceable>MINUTES</replaceable> minutes. If not specified, the
            default of twelve hours and no minutes is used.</simpara></listitem>
        </varlistentry>
        <varlistentry>
            <term><option>-cert <replaceable>CERTFILE</replaceable></option></term>
            <term><option>-key <replaceable>KEYFILE</replaceable></option></term>
            <listitem><simpara>Create a proxy certificate signed by
            the certificate located in <filename>CERTFILE</filename> using the
            key located in <filename>KEYFILE</filename>. If not specified the
            default certificate and key will be used. This overrides the
            values of environment variables described
            below.</simpara></listitem>
        </varlistentry>
        <varlistentry>
            <term><option>-certdir <replaceable>CERTDIR</replaceable></option></term>
            <listitem><simpara>Search <replaceable>CERTDIR</replaceable> for
            trusted certificates if verifying the proxy certificate. If not 
            specified, the default trusted certificate search path is used. This
            overrides the value of the <envar>X509_CERT_DIR</envar> environment
            variable</simpara></listitem>
        </varlistentry>
        <varlistentry>
            <term><option>-out <replaceable>PROXYPATH</replaceable></option></term>
            <listitem><simpara>Write the generated proxy certificate file to
            <replaceable>PROXYPATH</replaceable> instead of the default path of
            <filename>/tmp/x509up_u<replaceable>UID</replaceable></filename>.</simpara></listitem>
        </varlistentry>
        <varlistentry>
            <term><option>-bits <replaceable>BITS</replaceable></option></term>
            <listitem><simpara>When creating the proxy certificate, use a 
            <replaceable>BITS</replaceable> bit key instead of the default
            512 bit keys.</simpara></listitem>
        </varlistentry>
        <varlistentry>
            <term><option>-policy <replaceable>POLICYFILE</replaceable></option></term>
            <listitem><simpara>Add the certificate policy data described in
            <replaceable>POLICYFILE</replaceable> as the ProxyCertInfo X.509
            extension to the generated proxy certificate.</simpara></listitem>
        </varlistentry>
        <varlistentry>
          <term><option>-pl <replaceable>POLICY-OID</replaceable></option></term>
          <term><option>-policy-language <replaceable>POLICY-OID</replaceable></option></term>
          <listitem><simpara>Set the policy language identifier of the policy
          data specified by the <option>-policy</option> command-line option
          to the oid specified by the <replaceable>POLICY-OID</replaceable>
          string.</simpara></listitem>
        </varlistentry>
        <varlistentry>
            <term><option>-path-length <replaceable>MAXIMUM</replaceable></option></term>
            <listitem><simpara>Set the maximum length of the chain of proxies
            that can be created by the generated proxy to
            <replaceable>MAXIMUM</replaceable>. If not set, the default of an
            unlimited proxy chain length is used.</simpara></listitem>
        </varlistentry>
        <varlistentry>
            <term><option>-pwstdin</option></term>
            <listitem><simpara>Read the private key's passphrase from stdin
            instead of reading input from the controlling tty. This is useful
            when scripting &cmd;.</simpara></listitem>
        </varlistentry>
        <varlistentry>
            <term><option>-limited</option></term>
            <listitem><simpara>Create a limited proxy. Limited proxies are
            generally refused by process-creating services, but may be
            used to authorize with other services.</simpara></listitem>
        </varlistentry>
        <varlistentry>
            <term><option>-independent</option></term>
            <listitem><simpara>Create an independent proxy. An independent
            proxy is not treated as an impersonation proxy but as a separate
            identity for authorization purposes.</simpara></listitem>
        </varlistentry>
        <varlistentry>
            <term><option>-draft</option></term>
            <listitem><simpara>Create a IETF draft proxy instead of the default
            RFC 3280-compliant proxy. This type of proxy uses a non-standard proxy
            policy identifier. This might be useful for authenticating with
            older versions of the Globus Toolkit.</simpara></listitem>
        </varlistentry>
        <varlistentry>
            <term><option>-old</option></term>
            <listitem><simpara>Create a legacy proxy instead of the default
            RFC 3280-compliant proxy. This type of proxy uses a non-standard method
            of indicating that the certificate is a proxy and whether it is
            limited.  This might be useful for authenticating with
            older versions of the Globus Toolkit.</simpara></listitem>
        </varlistentry>
        <varlistentry>
            <term><option>-rfc</option></term>
            <listitem><simpara>Create an RFC 3820-compliant proxy certificate.
            This is the default for this version of &cmd;.</simpara></listitem>
        </varlistentry>
    </variablelist>

    </para>
  </refsect1>

  <refsect1>
    <title>Examples</title>
    <para>To create a proxy with the default lifetime and format, run the
        &cmd; program with no arguments. For example:
    
    <screen><prompt>% </prompt><command>grid-proxy-init</command>
<computeroutput>Your identity: /DC=org/DC=example/CN=Joe User</computeroutput>
<prompt>Enter GRID pass phrase for this identity:</prompt>
<computeroutput>Creating proxy .................................. Done
Your proxy is valid until: Thu Mar 18 03:48:05 2010</computeroutput></screen>
    </para>
    
    <para>To create a stronger proxy that lasts for only 8 hours, use the
    <option>-hours</option> and <option>-bits</option> command-line options to
    &cmd;. For example:
    
    <screen><prompt>% </prompt><command>grid-proxy-init</command> <option>-hours 8</option> <option>-bits 1024</option>
<computeroutput>Your identity: /DC=org/DC=example/CN=Joe User</computeroutput>
<prompt>Enter GRID pass phrase for this identity:</prompt>
<computeroutput>Creating proxy .................................. Done
Your proxy is valid until: Thu Mar 17 23:48:05 2010</computeroutput></screen>
    </para>
  </refsect1>

  <refsect1>
    <title>Environment Variables</title>

    <para>
    The following environment variables affect the execution of &cmd;:
    <variablelist>
        <varlistentry>
            <term><envar>X509_USER_CERT</envar></term>
            <listitem><simpara>Path to the certificate to use as issuer of the
            new proxy.</simpara></listitem>
        </varlistentry>
        <varlistentry>
            <term><envar>X509_USER_KEY</envar></term>
            <listitem><simpara>Path to the key to use to sign the new
            proxy.</simpara></listitem>
        </varlistentry>
        <varlistentry>
            <term><envar>X509_CERT_DIR</envar></term>
            <listitem><simpara>Path to the directory containing trusted
            certifiate certificates and signing policies.</simpara></listitem>
        </varlistentry>
    </variablelist>
    </para>
  </refsect1>

  <refsect1>
    <title>Files</title>

    <para>
    The following files affect the execution of &cmd;:
    <variablelist>
        <varlistentry>
            <term><filename><envar>$HOME</envar>/.globus/usercert.pem</filename></term>
            <listitem><simpara>Default path to the certificate to use as issuer
            of the new proxy.</simpara></listitem>
        </varlistentry>
        <varlistentry>
            <term><filename><envar>$HOME</envar>/.globus/userkey.pem</filename></term>
            <listitem><simpara>Default path to the key to use to sign the new
            proxy.</simpara></listitem>
        </varlistentry>
    </variablelist>
    </para>
  </refsect1>

  <refsect1>
    <title>Compatibility</title>
    <para>
    For more information about proxy certificate types and their compatibility in GT, see <ulink url="http://dev.globus.org/wiki/Security/ProxyCertTypes">http://dev.globus.org/wiki/Security/ProxyCertTypes</ulink>.</para>
  </refsect1>

  <refsect1>
    <title>See Also</title>
    <para>
        <citerefentry><refentrytitle>grid-proxy-destroy</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
        <citerefentry><refentrytitle>grid-proxy-info</refentrytitle><manvolnum>1</manvolnum></citerefentry>
    </para>
  </refsect1>
</refentry>