File: grid_proxy_info-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 (257 lines) | stat: -rwxr-xr-x 11,301 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
<?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-info">
<!ENTITY cmd "<command>grid-proxy-info</command>">
]>
<refentry id="grid-proxy-info" xreflabel="grid-proxy-info">
    <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>Display information about a proxy certificate</refpurpose>
    </refnamediv>
    <refsynopsisdiv>
        <cmdsynopsis>
      &cmd;
      <arg>-help</arg>
      <arg>-usage</arg>
      <arg>-version</arg>
    </cmdsynopsis>
    <cmdsynopsis>
        &cmd;
        <group>
            <arg>-subject</arg>
            <arg>-s</arg>
        </group>
        <sbr/>
        <group>
            <arg>-issuer</arg>
            <arg>-i</arg>
        </group>
        <sbr/>
        <arg>-identity</arg>
        <arg>-type</arg>
        <arg>-timeleft</arg>
        <arg>-strength</arg>
        <arg>-all</arg>
        <arg>-text</arg>
        <arg>-path</arg>
        <arg>-rfc2253</arg>
        <sbr/>
        <group>
            <group choice="req">
                <arg choice="plain">-exists</arg>
                <arg choice="plain">-e</arg>
            </group>
            <sbr/>
            <group>
                <arg>-valid <replaceable>HOURS</replaceable>:<replaceable>MINUTES</replaceable></arg>
                <arg>-v <replaceable>HOURS</replaceable>:<replaceable>MINUTES</replaceable></arg>
            </group>
            <sbr/>
            <group>
                <arg>-hours <replaceable>HOURS</replaceable></arg>
                <arg>-h <replaceable>HOURS</replaceable></arg>
            </group>
            <sbr/>
            <group>
                <arg>-bits <replaceable>BITS</replaceable></arg>
                <arg>-b <replaceable>BITS</replaceable></arg>
            </group>
        </group>
    </cmdsynopsis>
    </refsynopsisdiv>

    <refsect1>
        <title>Description</title>
        <para>
            The &cmd; program extracts information from an X.509 proxy
            certificates, and optionally displays or returns an exit code based
            on that information.
        </para>
        <para>
            The default mode of operation is to print the following facts
            about the current user's default proxy: 
            subject, issuer, identity, type, strength, path, and time left.
            If the command-line option <option>-exists</option> or
            <option>-e</option> is included in the command-line, nothing
            is printed unless one of the print options is specified. Instead,
            &cmd; determines if a valid proxy exists and, if so, exits with the
            exit code <literal>0</literal>; if a proxy does not exist or 
            is not valid, &cmd; exits with the exit code <literal>1</literal>.
            Additional validity criteria can be added by using the
            <option>-valid</option>, <option>-v</option>,
            <option>-hours</option>, <option>-h</option>,
            <option>-bits</option>, or <option>-b</option> command-line
            options. If used, these options must occur
            <emphasis>after</emphasis> the <option>-e</option> or
            <option>-exists</option> command-line options. Those options are
            only valid if one of the <option>-e</option> or
            <option>-exists</option> command-line options is used.
        </para>

        <para>
        The complete 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 verbose error
                messages.</simpara></listitem>
            </varlistentry>
            <varlistentry>
                <term><option>-file <replaceable>PROXYFILE</replaceable></option></term>
                <term><option>-f <replaceable>PROXYFILE</replaceable></option></term>
                <listitem><simpara>Read the proxy located in the file
                <replaceable>PROXYFILE</replaceable> instead of using the
                default proxy.</simpara></listitem>
            </varlistentry>
            <varlistentry>
                <term><option>-subject</option></term>
                <term><option>-s</option></term>
                <listitem><simpara>Display the proxy certificate's subject
                distinguished name.</simpara></listitem>
            </varlistentry>

            <varlistentry>
                <term><option>-issuer</option></term>
                <term><option>-i</option></term>
                <listitem><simpara>Display the proxy certificate issuer's
                distinguished name.</simpara></listitem>
            </varlistentry>

            <varlistentry>
                <term><option>-identity</option></term>
                <listitem><simpara>Display the proxy certificate's identity.
                For non-independent proxies, the identity is the subject of
                the certificate which issued the first proxy in the proxy
                chain.</simpara></listitem>
            </varlistentry>

            <varlistentry>
                <term><option>-type</option></term>
                <listitem><simpara>Display the type of proxy certificate. The
                type string includes the format ("legacy", "draft", or RFC 3280
                compliant), identity type ("impersonation" or "independent"),
                and policy ("limited" or "full"). See
                <citerefentry><refentrytitle>grid-proxy-init</refentrytitle><manvolnum>1</manvolnum></citerefentry>
                for information about how to create different types of
                proxies.</simpara></listitem>
            </varlistentry>

            <varlistentry>
                <term><option>-timeleft</option></term>
                <listitem><simpara>Display the number of seconds remaining
                until the proxy certificate expires.</simpara></listitem>
            </varlistentry>

            <varlistentry>
                <term><option>-strength</option></term>
                <listitem><simpara>Display the strength (in bits) of the key
                associated with the proxy certificate.</simpara></listitem>
            </varlistentry>

            <varlistentry>
                <term><option>-all</option></term>
                <listitem><simpara>Display the default information for the
                proxy when also using the <option>-e</option> or
                <option>-exists</option> command-line
                option.</simpara></listitem>
            </varlistentry>

            <varlistentry>
                <term><option>-text</option></term>
                <listitem><simpara>Display the proxy certificate contents
                to standard output, including policy information, issuer,
                public key, and modulus.</simpara></listitem>
            </varlistentry>

            <varlistentry>
                <term><option>-path</option></term>
                <listitem><simpara>Display the path to the file containing
                the default proxy certificate.</simpara></listitem>
            </varlistentry>

            <varlistentry>
                <term><option>-rfc2253</option></term>
                <listitem><simpara>Display distinguished names for the subject,
                issuer, and identity using the string representation described
                in RFC 2253, instead of the legacy format.</simpara></listitem>
            </varlistentry>

            <varlistentry>
                <term><option>-exists</option></term>
                <term><option>-e</option></term>
                <listitem><simpara>Perform an existence and validity check for
                the proxy. If a valid proxy exists and matches the criteria
                described by other command-line options (if any), exit with 0; 
                otherwise, exit with 1. This option must be before
                other validity check predicate in the command-line
                options. If this option is specified, the output of the default
                facts about the proxy is disabled. Use the
                <option>-all</option> option to have the information displayed
                as well as the exit code set.</simpara></listitem>
            </varlistentry>

            <varlistentry>
                <term><option>-valid <replaceable>HOURS</replaceable>:<replaceable>MINUTES</replaceable></option></term>
                <term><option>-v <replaceable>HOURS</replaceable>:<replaceable>MINUTES</replaceable></option></term>
                <term><option>-hours <replaceable>HOURS</replaceable></option></term>
                <term><option>-h <replaceable>HOURS</replaceable></option></term>
                <listitem><simpara>Check that the proxy certificate is valid
                for at least <replaceable>HOURS</replaceable> hours and
                <replaceable>MINUTES</replaceable> minutes. If it is not, 
                &cmd; will exit with exit code <literal>1</literal>.</simpara></listitem>
            </varlistentry>

            <varlistentry>
                <term><option>-bits <replaceable>BITS</replaceable></option></term>
                <term><option>-b <replaceable>BITS</replaceable></option></term>
                <listitem><simpara>Check that the proxy certificate key
                strength is at least <replaceable>BITS</replaceable>
                bits.</simpara></listitem>
            </varlistentry>
        </variablelist>
        </para>
    </refsect1>
    <refsect1>
        <title>Environment Variables</title>

        <para>The following environment variables affect the execution of
        &cmd;:
        
        <variablelist>
            <varlistentry>
                <term><envar>X509_USER_PROXY</envar></term>
                <listitem><simpara>Path to the default user
                proxy.</simpara></listitem>
            </varlistentry>
        </variablelist>
        </para>
    </refsect1>

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