Blame


1 137b80e4 2024-02-16 op .\" Copyright (c) 2024 Omar Polo <op@omarpolo.com>
2 137b80e4 2024-02-16 op .\"
3 137b80e4 2024-02-16 op .\" Permission to use, copy, modify, and distribute this software for any
4 137b80e4 2024-02-16 op .\" purpose with or without fee is hereby granted, provided that the above
5 137b80e4 2024-02-16 op .\" copyright notice and this permission notice appear in all copies.
6 137b80e4 2024-02-16 op .\"
7 137b80e4 2024-02-16 op .\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
8 137b80e4 2024-02-16 op .\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
9 137b80e4 2024-02-16 op .\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
10 137b80e4 2024-02-16 op .\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
11 137b80e4 2024-02-16 op .\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
12 137b80e4 2024-02-16 op .\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
13 137b80e4 2024-02-16 op .\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
14 137b80e4 2024-02-16 op .Dd $Mdocdate: February 16 2024$
15 137b80e4 2024-02-16 op .Dt TELESCOPE-IDENTITY 1
16 137b80e4 2024-02-16 op .Os
17 137b80e4 2024-02-16 op .Sh NAME
18 137b80e4 2024-02-16 op .Nm telescope-identity
19 137b80e4 2024-02-16 op .Nd manage telescope identities
20 137b80e4 2024-02-16 op .Sh SYNOPSIS
21 137b80e4 2024-02-16 op .Nm
22 137b80e4 2024-02-16 op .Bk -words
23 137b80e4 2024-02-16 op .Ar command
24 137b80e4 2024-02-16 op .Ar args...
25 137b80e4 2024-02-16 op .Ek
26 137b80e4 2024-02-16 op .Sh DESCRIPTION
27 137b80e4 2024-02-16 op .Nm
28 137b80e4 2024-02-16 op is an utility to manage
29 137b80e4 2024-02-16 op .Xr telescope 1
30 137b80e4 2024-02-16 op identities.
31 137b80e4 2024-02-16 op Identities are TLS client certificates used for Gemini.
32 137b80e4 2024-02-16 op .Pp
33 137b80e4 2024-02-16 op The commands for
34 137b80e4 2024-02-16 op .Nm
35 137b80e4 2024-02-16 op are as follows:
36 137b80e4 2024-02-16 op .Bl -tag -width generate
37 137b80e4 2024-02-16 op .It Xo
38 137b80e4 2024-02-16 op .Cm generate
39 137b80e4 2024-02-16 op .Op Fl t Ar type
40 137b80e4 2024-02-16 op .Ar name
41 137b80e4 2024-02-16 op .Xc
42 137b80e4 2024-02-16 op Generate a new keypair under the given
43 137b80e4 2024-02-16 op .Ar name .
44 137b80e4 2024-02-16 op If
45 137b80e4 2024-02-16 op .Ar type
46 137b80e4 2024-02-16 op is
47 137b80e4 2024-02-16 op .Dq RSA ,
48 137b80e4 2024-02-16 op an RSA key with 4096 bit will be created.
49 137b80e4 2024-02-16 op By default it's an EC key with secp384r1.
50 137b80e4 2024-02-16 op .It Cm remove Ar name
51 137b80e4 2024-02-16 op Remove the
52 137b80e4 2024-02-16 op .Ar name
53 137b80e4 2024-02-16 op identity.
54 137b80e4 2024-02-16 op .It Cm import Fl C Ar cert Oo Fl K Ar key Oc Ar name
55 137b80e4 2024-02-16 op Imports a certificate as
56 137b80e4 2024-02-16 op .Ar name .
57 137b80e4 2024-02-16 op .Fl C
58 137b80e4 2024-02-16 op is the path to the certificate itself.
59 137b80e4 2024-02-16 op If the key is on a separate file, it needs to be passed with
60 137b80e4 2024-02-16 op .Fl K .
61 137b80e4 2024-02-16 op .It Cm export Fl C Ar cert Ar name
62 137b80e4 2024-02-16 op Exports the certificate for the identity
63 137b80e4 2024-02-16 op .Ar name .
64 137b80e4 2024-02-16 op The certificate and the key will be saved at
65 137b80e4 2024-02-16 op .Ar cert .
66 137b80e4 2024-02-16 op At the moment, it's not possible to export the certificate and the
67 137b80e4 2024-02-16 op private key in different files.
68 137b80e4 2024-02-16 op .It Cm list
69 137b80e4 2024-02-16 op Print one per line the available identities.
70 137b80e4 2024-02-16 op .It Cm mappings Op Ar name
71 137b80e4 2024-02-16 op Show on which servers and paths the identities are used.
72 137b80e4 2024-02-16 op The output consist of the identity name, a tab character, and the the
73 137b80e4 2024-02-16 op hostname, optional port number and path under which that identity will
74 137b80e4 2024-02-16 op be loaded by
75 137b80e4 2024-02-16 op .Xr telescope 1 .
76 137b80e4 2024-02-16 op .Pp
77 137b80e4 2024-02-16 op If
78 137b80e4 2024-02-16 op .Ar name
79 137b80e4 2024-02-16 op is given, limit the output only to the instances of that identity.
80 137b80e4 2024-02-16 op .It Cm use Ar name Ar host Ns Oo : Ns Ar port Oc Ns Op / Ns Ar path
81 137b80e4 2024-02-16 op Save the a new mapping for the given identity
82 137b80e4 2024-02-16 op .Ar name .
83 137b80e4 2024-02-16 op .It Cm forget Ar name Ar host Ns Oo : Ns Ar port Oc Ns Op / Ns Ar path
84 137b80e4 2024-02-16 op Remove the mapping for the given identity
85 137b80e4 2024-02-16 op .Ar name .
86 137b80e4 2024-02-16 op .El
87 137b80e4 2024-02-16 op .Sh SEE ALSO
88 137b80e4 2024-02-16 op .Xr telescope 1
89 137b80e4 2024-02-16 op .Sh AUTHORS
90 137b80e4 2024-02-16 op .An -nosplit
91 137b80e4 2024-02-16 op The
92 137b80e4 2024-02-16 op .Nm
93 137b80e4 2024-02-16 op utility was written by
94 137b80e4 2024-02-16 op .An Omar Polo Aq Mt op@omarpolo.com .