File: danetool-args.def

package info (click to toggle)
gnutls28 3.6.7-4
  • links: PTS, VCS
  • area: main
  • in suites: buster
  • size: 67,368 kB
  • sloc: ansic: 295,691; asm: 70,637; sh: 15,067; makefile: 6,288; yacc: 1,840; lisp: 1,371; cpp: 1,358; perl: 1,030; sed: 16
file content (230 lines) | stat: -rw-r--r-- 7,091 bytes parent folder | download | duplicates (3)
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
AutoGen Definitions options;
prog-name     = danetool;
prog-title    = "GnuTLS DANE tool";
prog-desc     = "Generate DANE TLSA RR entries.";
detail    = "Tool to generate and check DNS resource records for the DANE protocol.";
short-usage   = "danetool --[tlsa-rr|check] [options]
danetool --help for additional usage instructions.\n";
explain       = "";

#define  INFILE_OPT    0
#define  OUTFILE_OPT   1
#define  VERBOSE_OPT 1
#include args-std.def

flag = {
    name      = load-pubkey;
    descrip   = "Loads a public key file";
    arg-type  = string;
    doc = "This can be either a file or a PKCS #11 URL";
};

flag = {
    name      = load-certificate;
    descrip   = "Loads a certificate file";
    arg-type  = string;
    doc = "This can be either a file or a PKCS #11 URL";
};

flag = {
    name      = dlv;
    descrip   = "Sets a DLV file";
    arg-type  = string;
    doc = "This sets a DLV file to be used for DNSSEC verification.";
};

flag = {
    name      = hash;
    arg-type  = string;
    descrip   = "Hash algorithm to use for signing";
    doc = "Available hash functions are SHA1, RMD160, SHA256, SHA384, SHA512.";
};

flag = {
    name      = check;
    arg-type  = string;
    descrip   = "Check a host's DANE TLSA entry";
    doc = "Obtains the DANE TLSA entry from the given hostname and prints information. Note that the actual certificate of the host can be provided using --load-certificate, otherwise danetool will connect to the server to obtain it. The exit code on verification success will be zero.";
};

flag = {
    name      = check-ee;
    descrip   = "Check only the end-entity's certificate";
    doc = "Checks the end-entity's certificate only. Trust anchors or CAs are not considered.";
};

flag = {
    name      = check-ca;
    descrip   = "Check only the CA's certificate";
    doc = "Checks the trust anchor's and CA's certificate only. End-entities are not considered.";
};

flag = {
    name      = tlsa-rr;
    descrip   = "Print the DANE RR data on a certificate or public key";
    flags_must = host;
    doc = "This command prints the DANE RR data needed to enable DANE on a DNS server.";
};

flag = {
    name      = host;
    descrip   = "Specify the hostname to be used in the DANE RR";
    arg-type  = string;
    arg-name  = "Hostname";
    doc = "This command sets the hostname for the DANE RR.";
};

flag = {
    name      = proto;
    descrip   = "The protocol set for DANE data (tcp, udp etc.)";
    arg-type  = string;
    arg-name  = "Protocol";
    doc = "This command specifies the protocol for the service set in the DANE data.";
};

flag = {
    name      = port;
    arg-type  = string;
    descrip   = "The port or service to connect to, for DANE data";
    default-value = "443";
    doc      = "";
};

flag = {
    name      = app-proto;
    aliases   = starttls-proto;
};

flag = {
    name      = starttls-proto;
    descrip   = "The application protocol to be used to obtain the server's certificate (https, ftp, smtp, imap, ldap, xmpp, lmtp, pop3, nntp, sieve, postgres)";
    arg-type  = string;
    doc = "When the server's certificate isn't provided danetool will connect to the server to obtain the certificate. In that case it is required to know the protocol to talk with the server prior to initiating the TLS handshake.";
};

flag = {
    name      = ca;
    descrip   = "Whether the provided certificate or public key is a Certificate Authority";
    doc      = "Marks the DANE RR as a CA certificate if specified.";
};

flag = {
    name      = x509;
    descrip   = "Use the hash of the X.509 certificate, rather than the public key";
    doc      = "This option forces the generated record to contain the hash of the full X.509 certificate. By default only the hash of the public key is used.";
};

flag = {
    name      = local;
    aliases   = domain;
};

flag = {
    name      = domain;
    descrip   = "The provided certificate or public key is issued by the local domain";
    enabled;
    disable   = "no";
    doc      = "DANE distinguishes certificates and public keys offered via the DNSSEC to trusted and local entities. This flag indicates that this is a domain-issued certificate, meaning that there could be no CA involved.";
};

flag = {
    name      = local-dns;
    descrip   = "Use the local DNS server for DNSSEC resolving";
    disabled;
    disable   = "no";
    doc       = "This option will use the local DNS server for DNSSEC.
This is disabled by default due to many servers not allowing DNSSEC.";
};

flag = {
    name      = insecure;
    descrip   = "Do not verify any DNSSEC signature";
    doc = "Ignores any DNSSEC signature verification results.";
};

flag = {
    name      = inder;
    descrip   = "Use DER format for input certificates and private keys";
    disabled;
    disable   = "no";
    doc       = "The input files will be assumed to be in DER or RAW format. 
Unlike options that in PEM input would allow multiple input data (e.g. multiple 
certificates), when reading in DER format a single data structure is read.";
};

flag = {
    name      = inraw;
    aliases   = inder;
};

flag = {
    name      = print-raw;
    descrip   = "Print the received DANE data in raw format";
    disabled;
    disable   = "no";
    doc = "This option will print the received DANE data.";
};

flag = {
    name      = quiet;
    descrip   = "Suppress several informational messages";
    doc      = "In that case on the exit code can be used as an indication of verification success";
};



doc-section = {
  ds-type = 'SEE ALSO';
  ds-format = 'texi';
  ds-text   = <<-_EOT_
    certtool (1)
_EOT_;
};

doc-section = {
  ds-type = 'EXAMPLES';
  ds-format = 'texi';
  ds-text   = <<-_EOT_
@subheading DANE TLSA RR generation

To create a DANE TLSA resource record for a certificate (or public key) 
that was issued localy and may or may not be signed by a CA use the following command.
@example
$ danetool --tlsa-rr --host www.example.com --load-certificate cert.pem
@end example

To create a DANE TLSA resource record for a CA signed certificate, which will
be marked as such use the following command.
@example
$ danetool --tlsa-rr --host www.example.com --load-certificate cert.pem \
  --no-domain
@end example

The former is useful to add in your DNS entry even if your certificate is signed 
by a CA. That way even users who do not trust your CA will be able to verify your
certificate using DANE.

In order to create a record for the CA signer of your certificate use the following.
@example
$ danetool --tlsa-rr --host www.example.com --load-certificate cert.pem \
  --ca --no-domain
@end example

To read a server's DANE TLSA entry, use:
@example
$ danetool --check www.example.com --proto tcp --port 443
@end example

To verify an HTTPS server's DANE TLSA entry, use:
@example
$ danetool --check www.example.com --proto tcp --port 443 --load-certificate chain.pem
@end example

To verify an SMTP server's DANE TLSA entry, use:
@example
$ danetool --check www.example.com --proto tcp --starttls-proto=smtp --load-certificate chain.pem
@end example
_EOT_;
};