forked from letoams/hash-slinger
-
Notifications
You must be signed in to change notification settings - Fork 0
/
openpgpkey.1
105 lines (105 loc) · 3.9 KB
/
openpgpkey.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
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
'\" t
.\" Title: openpgpkey
.\" Author: [see the "AUTHORS" section]
.\" Generator: DocBook XSL Stylesheets v1.78.1 <http://docbook.sf.net/>
.\" Date: December 30, 2013
.\" Manual: Internet / DNS
.\" Source: Paul Wouters
.\" Language: English
.\"
.TH "OPENPGPKEY" "1" "December 30, 2013" "Paul Wouters" "Internet / DNS"
.\" -----------------------------------------------------------------
.\" * 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"
openpgpkey \- Create and verify RFC\-TBD OPENPGPKEY DNS records
.SH "SYNTAX"
.PP
openpgpkey [\fB\-\-fetch\fR
|
\fB\-\-verify\fR] [\fB\-\-insecure\fR] [\fB\-\-resolv\&.conf /PATH/TO/RESOLV\&.CONF\fR]
\fIuser@domain\fR
.PP
openpgpkey [\fB\-\-create\fR] [\fB\-\-insecure\fR] [\fB\-\-resolv\&.conf /PATH/TO/RESOLV\&.CONF\fR] [\fB\-\-output {rfc,generic,both}\fR] [\fB\-\-uid <uid>\fR] [\fB\-\-keyid <keyid>\fR]
\fIuser@domain\fR
.SH "DESCRIPTION"
.PP
openpgpkey generates RFC\-7929 OPENPGPKEY DNS records\&. To generate these records for older nameserver implementations that do not yet support the OPENPGPKEY record, specify
\fI\-\-output generic\fR
to output the openpgpkey data in Generic Record (RFC\-3597) format\&. Records are generated by taking all keys with the specified email address associated with it from the user\*(Aqs local GnuPG keychain\&.
.PP
Verification of OPENPGPKEY records is done by comparing the keyid and fingerprint of the OPENPGPKEY obtained from DNS with the version in the local GnuPG keychain\&.
.SH "OPTIONS"
.PP
\fB\-\-fetch\fR
.RS 4
Fetch an OPENPGPKEY public key record from DNS
.RE
.PP
\fB\-\-create\fR
.RS 4
Create an OPENPGPKEY DNS record
.RE
.PP
\fB\-\-verify\fR
.RS 4
Verify a public key from the local GPG keyring with the OPENPGPKEY DNS record
.RE
.PP
\fB\-\-resolvconf\fR FILE
.RS 4
Specify a custom resolv\&.conf file (default: /etc/resolv\&.conf)
.RE
.PP
\fB\-\-output\fR rfc | generic | both
.RS 4
Output format of OPENPGPKEY record\&. "OPENPGPKEY" for rfc, "TYPE61" for generic (default: generic)
.RE
.PP
If neither create or verify is specified, create is used\&.
.SH "REQUIREMENTS"
.PP
openpgpkey requires the following python libraries: unbound, gnupg and argparse\&. It also requires gnupg which provides the gpg command\&.
.SH "BUGS"
.PP
none known
.SH "EXAMPLES"
.PP
typical usage:
.PP
openpgpkey \-\-fetch paul@nohats\&.ca > paul\&.pubkey
.PP
openpgpkey \-\-verify paul@nohats\&.ca
.PP
openpgpkey \-\-create paul@nohats\&.ca
.SH "SEE ALSO"
.PP
RFC-7929
.PP
\m[blue]\fBhttps://github\&.com/letoams/hash\-slinger\fR\m[]
.SH "AUTHORS"
.PP
Paul Wouters <pwouters@redhat\&.com>
.SH "COPYRIGHT"
.PP
Copyright 2014\-2022
.PP
This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version\&. See <\m[blue]\fBhttp://www\&.fsf\&.org/copyleft/gpl\&.txt\fR\m[]>\&.
.PP
This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE\&. See the GNU General Public License (file COPYING in the distribution) for more details\&.