File: grid-proxy-info.1

package info (click to toggle)
globus-proxy-utils 7.4-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 1,708 kB
  • sloc: sh: 4,268; ansic: 3,682; perl: 159; makefile: 105
file content (167 lines) | stat: -rw-r--r-- 6,086 bytes parent folder | download | duplicates (5)
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
'\" t
.\"     Title: grid-proxy-info
.\"    Author: [see the "AUTHOR" section]
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
.\"      Date: 03/31/2018
.\"    Manual: Grid Community Toolkit Manual
.\"    Source: Grid Community Toolkit 6
.\"  Language: English
.\"
.TH "GRID\-PROXY\-INFO" "1" "03/31/2018" "Grid Community Toolkit 6" "Grid Community Toolkit Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" http://bugs.debian.org/507673
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
grid-proxy-info \- Display information about a proxy certificate
.SH "SYNOPSIS"
.sp
\fBgrid\-proxy\-info\fR \-help | \-usage | \-version
.sp
\fBgrid\-proxy\-info\fR \-e | \-exists [\-valid \fIHOURS:MINUTES\fR | \-v \fIHOURS:MINUTES\fR] [\-hours \fIHOURS\fR | \-h \fIHOURS\fR] [\-bits \fIBITS\fR | \-b \fIBITS\fR]
.sp
\fBgrid\-proxy\-info\fR [OPTIONS]
.SH "DESCRIPTION"
.sp
The \fBgrid\-proxy\-info\fR program extracts information from an X\&.509 proxy certificates, and optionally displays or returns an exit code based on that information\&.
.sp
The default mode of operation is to print the following facts about the current user\(cqs default proxy: subject, issuer, identity, type, strength, path, and time left\&. If the command\-line option \fI\-exists\fR or \fI\-e\fR is included in the command\-line, nothing is printed unless one of the print options is specified\&. Instead, \fBgrid\-proxy\-info\fR determines if a valid proxy exists and, if so, exits with the exit code 0; if a proxy does not exist or is not valid, \fBgrid\-proxy\-info\fR exits with the exit code 1\&. Additional validity criteria can be added by using the \fI\-valid\fR, \fI\-v\fR, \fI\-hours\fR, \fI\-h\fR, \fI\-bits\fR, or \fI\-b\fR command\-line options\&. If used, these options must occur \fBafter\fR the \fI\-e\fR or \fI\-exists\fR command\-line options\&. Those options are only valid if one of the \fI\-e\fR or \fI\-exists\fR command\-line options is used\&.
.SH "OPTIONS"
.sp
The complete set of command\-line options to \fBgrid\-proxy\-info\fR are:
.PP
\fB\-help, \-usage\fR
.RS 4
Display the command\-line options to
\fBgrid\-proxy\-info\fR\&.
.RE
.PP
\fB\-version\fR
.RS 4
Display the version number of the
\fBgrid\-proxy\-info\fR
command\&.
.RE
.PP
\fB\-debug\fR
.RS 4
Display verbose error messages\&.
.RE
.PP
\fB\-file \fR\fB\fIPROXYFILE\fR\fR\fB, \-f \fR\fB\fIPROXYFILE\fR\fR
.RS 4
Read the proxy located in the file
\fIPROXYFILE\fR
instead of using the default proxy\&.
.RE
.PP
\fB\-subject, \-s\fR
.RS 4
Display the proxy certificate\(cqs subject distinguished name\&.
.RE
.PP
\fB\-issuer, \-i\fR
.RS 4
Display the proxy certificate issuer\(cqs distinguished name\&.
.RE
.PP
\fB\-identity\fR
.RS 4
Display the proxy certificate\(cqs identity\&. For non\-independent proxies, the identity is the subject of the certificate which issued the first proxy in the proxy chain\&.
.RE
.PP
\fB\-type\fR
.RS 4
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
\fBgrid\-proxy\-init(1)\fR
for information about how to create different types of proxies\&.
.RE
.PP
\fB\-timeleft\fR
.RS 4
Display the number of seconds remaining until the proxy certificate expires\&.
.RE
.PP
\fB\-strength\fR
.RS 4
Display the strength (in bits) of the key associated with the proxy certificate\&.
.RE
.PP
\fB\-all\fR
.RS 4
Display the default information for the proxy when also using the
\fI\-e\fR
or
\fI\-exists\fR
command\-line option\&.
.RE
.PP
\fB\-text\fR
.RS 4
Display the proxy certificate contents to standard output, including policy information, issuer, public key, and modulus\&.
.RE
.PP
\fB\-path\fR
.RS 4
Display the path to the file containing the default proxy certificate\&.
.RE
.PP
\fB\-rfc2253\fR
.RS 4
Display distinguished names for the subject, issuer, and identity using the string representation described in RFC 2253, instead of the legacy format\&.
.RE
.PP
\fB\-exists, \-e\fR
.RS 4
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
\fI\-all\fR
option to have the information displayed as well as the exit code set\&.
.RE
.PP
\fB\-valid \fR\fB\fIHOURS:MINUTES\fR\fR\fB, \-v \fR\fB\fIHOURS:MINUTES\fR\fR\fB, \-hours \fR\fB\fIHOURS\fR\fR\fB, \-h \fR\fB\fIHOURS\fR\fR
.RS 4
Check that the proxy certificate is valid for at least
\fIHOURS\fR
hours and
\fIMINUTES\fR
minutes\&. If it is not,
\fBgrid\-proxy\-info\fR
will exit with exit code
1\&.
.RE
.PP
\fB\-bits \fR\fB\fIBITS\fR\fR\fB, \-b \fR\fB\fIBITS\fR\fR
.RS 4
Check that the proxy certificate key strength is at least
\fIBITS\fR
bits\&.
.RE
.SH "ENVIRONMENT"
.sp
The following environment variables affect the execution of \fBgrid\-proxy\-info\fR:
.PP
\fBX509_USER_PROXY\fR
.RS 4
Path to the default user proxy\&.
.RE
.SH "SEE ALSO"
.sp
grid\-proxy\-init(1), grid\-proxy\-destroy(1)
.SH "AUTHOR"
.sp
Copyright \(co 1999\-2014 University of Chicago