-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathjwt-agent.1
82 lines (82 loc) · 2.17 KB
/
jwt-agent.1
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
.\" Automatically generated by Pandoc 3.1.3
.\"
.\" Define V font for inline verbatim, using C font in formats
.\" that render this, and otherwise B font.
.ie "\f[CB]x\f[]"x" \{\
. ftr V B
. ftr VI BI
. ftr VB B
. ftr VBI BI
.\}
.el \{\
. ftr V CR
. ftr VI CI
. ftr VB CB
. ftr VBI CBI
.\}
.TH "jwt-agent" "1" "September 2, 2023" "" ""
.hy
.SH NAME
.PP
jwt-agent - Obtain and keep refreshing a JSON Web Token
.SH SYNOPSIS
.PP
\f[B]jwt-agent\f[R] [-s \f[I]URL\f[R]] \&...
[-l \f[I]user\f[R]] [-f] [-t \f[I]timeout\f[R]] \f[B]jwt-agent\f[R]
\[en]status \f[B]jwt-agent\f[R] \[en]stop [-t \f[I]timeout\f[R]]
\f[B]jwt-agent\f[R] \[en]version
.SH DESCRIPTION
.PP
\f[B]jwt-agent\f[R] obtains a JSON Web Token (JWT) from a JWT
server (https://github.com/oss-tsukuba/jwt-server.git), and keep
refreshing it not to expire.
It is running in the background unless the -f option is specified.
When the -s option is not specified, JWT_SERVER_URL environment variable
is used.
When the -l option is not specified, LOGNAME environment variable is
used.
.PP
The jwt-agent asks a passphrase at the start up to obtain a JWT, which
is provided by a JWT server.
The jwt-agent also accepts the passphrase by the standard input.
The jwt-agent does not stop unless it is explicitly shut down, or some
error happens.
.PP
By default, the jwt-agent stores a JWT at /tmp/jwt_user_u$UID/token.jwt,
which can be changed by JWT_USER_PATH environment variable.
.PP
When multiple -s options are specified, the jwt-agent attempts to
retrieve the JWT in order if the server is not working.
If the passphrase is incorrect, the program terminates at that point.
Also, the jwt-agent exits if all URLs are not working.
.SH OPTIONS
.TP
-s \f[I]URL\f[R]
specifies the URL of a JWT server
.TP
-l \f[I]user\f[R]
specifies a user name
.TP
-f
executes in the foreground not in the background
.TP
-t \f[I]timeout\f[R]
specifies the timeout in seconds.
Default is 60 seconds.
.TP
\[en]status
checks the running status of the jwt-agent
.TP
\[en]stop
stops the jwt-agent execution
.TP
\[en]version
displays the version number
.SH ENVIRONMENT
.TP
JWT_USER_PATH
path to the JSON Web Token.
Default is /tmp/jwt_user_u$UID/token.jwt
.TP
JWT_SERVER_URL
URL of a JWT server