← Back to branch summary

~ubuntu-branches/ubuntu/saucy/gnutls28/saucy

« back to all changes in this revision

Viewing changes to src/danetool-args.def

  • Committer: Package Import Robot
  • Author(s): Jeremy Bicha
  • Date: 2013-07-30 21:40:07 UTC
  • mfrom: (14.1.9 saucy-proposed)
  • Revision ID: package-import@ubuntu.com-20130730214007-9mrd08xo61kla008
Tags: 3.2.3-1ubuntu1
https://launchpad.net/bugs/1068029
* Sync with Debian (LP: #1068029). Remaining change:
  - Drop gnutls-bin and -doc since we want to use the versions
    in gnutls26 as the defaults instead

Show diffs side-by-side

added added

removed removed

Lines of Context:
src/danetool-args.def
 
1
AutoGen Definitions options;
 
2
prog-name     = danetool;
 
3
prog-title    = "GnuTLS DANE tool";
 
4
prog-desc     = "Generate DANE TLSA RR entries.";
 
5
detail    = "Tool to generate and check DNS resource records for the DANE protocol.";
 
6
short-usage   = "danetool [options]\ndanetool --help for usage instructions.\n";
 
7
explain       = "";
 
8
 
 
9
#define  INFILE_OPT    0
 
10
#define  OUTFILE_OPT   1
 
11
#define  VERBOSE_OPT 1
 
12
#include args-std.def
 
13
 
 
14
flag = {
 
15
    name      = load-pubkey;
 
16
    descrip   = "Loads a public key file";
 
17
    arg-type  = string;
 
18
    doc = "This can be either a file or a PKCS #11 URL";
 
19
};
 
20
 
 
21
flag = {
 
22
    name      = load-certificate;
 
23
    descrip   = "Loads a certificate file";
 
24
    arg-type  = string;
 
25
    doc = "This can be either a file or a PKCS #11 URL";
 
26
};
 
27
 
 
28
flag = {
 
29
    name      = dlv;
 
30
    descrip   = "Sets a DLV file";
 
31
    arg-type  = string;
 
32
    doc = "This sets a DLV file to be used for DNSSEC verification.";
 
33
};
 
34
 
 
35
flag = {
 
36
    name      = hash;
 
37
    arg-type  = string;
 
38
    descrip   = "Hash algorithm to use for signing.";
 
39
    doc = "Available hash functions are SHA1, RMD160, SHA256, SHA384, SHA512.";
 
40
};
 
41
 
 
42
flag = {
 
43
    name      = check;
 
44
    arg-type  = string;
 
45
    descrip   = "Check a host's DANE TLSA entry.";
 
46
    doc = "Obtains the DANE TLSA entry from the given hostname and prints information. Note that the actual certificate of the host has to be provided using --load-certificate.";
 
47
};
 
48
 
 
49
flag = {
 
50
    name      = check-ee;
 
51
    descrip   = "Check only the end-entity's certificate.";
 
52
    doc = "Checks the end-entity's certificate only. Trust anchors or CAs are not considered.";
 
53
};
 
54
 
 
55
flag = {
 
56
    name      = check-ca;
 
57
    descrip   = "Check only the CA's certificate.";
 
58
    doc = "Checks the trust anchor's and CA's certificate only. End-entities are not considered.";
 
59
};
 
60
 
 
61
flag = {
 
62
    name      = insecure;
 
63
    descrip   = "Do not verify any DNSSEC signature.";
 
64
    doc = "Ignores any DNSSEC signature verification results.";
 
65
};
 
66
 
 
67
flag = {
 
68
    name      = local-dns;
 
69
    descrip   = "Use the local DNS server for DNSSEC resolving.";
 
70
    disabled;
 
71
    disable   = "no";
 
72
    doc       = "This option will use the local DNS server for DNSSEC.
 
73
This is disabled by default due to many servers not allowing DNSSEC.";
 
74
};
 
75
 
 
76
flag = {
 
77
    name      = inder;
 
78
    descrip   = "Use DER format for input certificates and private keys.";
 
79
    disabled;
 
80
    disable   = "no";
 
81
    doc       = "The input files will be assumed to be in DER or RAW format. 
 
82
Unlike options that in PEM input would allow multiple input data (e.g. multiple 
 
83
certificates), when reading in DER format a single data structure is read.";
 
84
};
 
85
 
 
86
flag = {
 
87
    name      = inraw;
 
88
    aliases   = inder;
 
89
};
 
90
 
 
91
flag = {
 
92
    name      = tlsa-rr;
 
93
    descrip   = "Print the DANE RR data on a certificate or public key";
 
94
    flags_must = host;
 
95
    doc = "This command prints the DANE RR data needed to enable DANE on a DNS server.";
 
96
};
 
97
 
 
98
flag = {
 
99
    name      = host;
 
100
    descrip   = "Specify the hostname to be used in the DANE RR";
 
101
    arg-type  = string;
 
102
    arg-name  = "Hostname";
 
103
    doc = "This command sets the hostname for the DANE RR.";
 
104
};
 
105
 
 
106
flag = {
 
107
    name      = proto;
 
108
    descrip   = "The protocol set for DANE data (tcp, udp etc.)";
 
109
    arg-type  = string;
 
110
    arg-name  = "Protocol";
 
111
    doc = "This command specifies the protocol for the service set in the DANE data.";
 
112
};
 
113
 
 
114
flag = {
 
115
    name      = port;
 
116
    arg-type  = number;
 
117
    descrip   = "Specify the port number for the DANE data.";
 
118
    default-value = 443;
 
119
    doc      = "";
 
120
};
 
121
 
 
122
flag = {
 
123
    name      = ca;
 
124
    descrip   = "Whether the provided certificate or public key is a Certificate Authority.";
 
125
    doc      = "Marks the DANE RR as a CA certificate if specified.";
 
126
};
 
127
 
 
128
flag = {
 
129
    name      = x509;
 
130
    descrip   = "Use the hash of the X.509 certificate, rather than the public key.";
 
131
    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.";
 
132
};
 
133
 
 
134
flag = {
 
135
    name      = local;
 
136
    aliases   = domain;
 
137
};
 
138
 
 
139
flag = {
 
140
    name      = domain;
 
141
    descrip   = "The provided certificate or public key is issued by the local domain.";
 
142
    enabled;
 
143
    disable   = "no";
 
144
    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.";
 
145
};
 
146
 
 
147
doc-section = {
 
148
  ds-type = 'SEE ALSO';
 
149
  ds-format = 'texi';
 
150
  ds-text   = <<-_EOT_
 
151
    certtool (1)
 
152
_EOT_;
 
153
};
 
154
 
 
155
doc-section = {
 
156
  ds-type = 'EXAMPLES';
 
157
  ds-format = 'texi';
 
158
  ds-text   = <<-_EOT_
 
159
@subheading DANE TLSA RR generation
 
160
 
 
161
To create a DANE TLSA resource record for a certificate (or public key) 
 
162
that was issued localy and may or may not be signed by a CA use the following command.
 
163
@example
 
164
$ danetool --tlsa-rr --host www.example.com --load-certificate cert.pem
 
165
@end example
 
166
 
 
167
To create a DANE TLSA resource record for a CA signed certificate, which will
 
168
be marked as such use the following command.
 
169
@example
 
170
$ danetool --tlsa-rr --host www.example.com --load-certificate cert.pem \
 
171
  --no-domain
 
172
@end example
 
173
 
 
174
The former is useful to add in your DNS entry even if your certificate is signed 
 
175
by a CA. That way even users who do not trust your CA will be able to verify your
 
176
certificate using DANE.
 
177
 
 
178
In order to create a record for the CA signer of your certificate use the following.
 
179
@example
 
180
$ danetool --tlsa-rr --host www.example.com --load-certificate cert.pem \
 
181
  --ca --no-domain
 
182
@end example
 
183
 
 
184
To read a server's DANE TLSA entry, use:
 
185
@example
 
186
$ danetool --check www.example.com --proto tcp --port 443
 
187
@end example
 
188
 
 
189
To verify a server's DANE TLSA entry, use:
 
190
@example
 
191
$ danetool --check www.example.com --proto tcp --port 443 --load-certificate chain.pem
 
192
@end example
 
193
_EOT_;
 
194
};
 
195
 
 
196