summaryrefslogtreecommitdiff
path: root/src/gnutls-serv-options.json
blob: ef074385b0280fe73601d1b58687994b6c6d0144 (plain)
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
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
[
  {
    "meta": {
      "desc": "",
      "prog-desc": "Simple server program to act as an HTTPS or TLS echo service.",
      "explain": "",
      "short-usage": "Usage: gnutls-serv [options]\ngnutls-serv --help for usage instructions.\n",
      "detail": "Server program that listens to incoming TLS connections.",
      "prog-name": "gnutls-serv",
      "prog-title": "GnuTLS server"
    },
    "options": [
      {
        "arg-type": "number",
        "arg-max": " 9999",
        "arg-min": "0 ",
        "short-option": "d",
        "detail": "Specifies the debug level.",
        "long-option": "debug",
        "desc": "Enable debugging"
      },
      {
        "arg-type": "string",
        "detail": "Server name of type host_name that the server will recognise as its own. If the server receives client hello with different name, it will send a warning-level unrecognized_name alert.",
        "desc": "Server's hostname for server name extension",
        "long-option": "sni-hostname"
      },
      {
        "long-option": "sni-hostname-fatal",
        "desc": "Send fatal alert on sni-hostname mismatch",
        "detail": ""
      },
      {
        "max": "NOLIMIT",
        "detail": "Specify the (textual) ALPN protocol for the server to use.",
        "desc": "Specify ALPN protocol to be enabled by the server",
        "long-option": "alpn",
        "arg-type": "string",
        "stack-arg": ""
      },
      {
        "detail": "",
        "long-option": "alpn-fatal",
        "desc": "Send fatal alert on non-matching ALPN name"
      },
      {
        "desc": "Don't accept session tickets",
        "detail": "",
        "long-option": "noticket"
      },
      {
        "detail": "",
        "long-option": "earlydata",
        "desc": "Accept early data"
      },
      {
        "arg-type": "number",
        "desc": "The maximum early data size to accept",
        "detail": "",
        "arg-max": "",
        "long-option": "maxearlydata",
        "arg-min": "1"
      },
      {
        "long-option": "nocookie",
        "detail": "",
        "desc": "Don't require cookie on DTLS sessions"
      },
      {
        "detail": "",
        "long-option": "generate",
        "short-option": "g",
        "desc": "Generate Diffie-Hellman parameters"
      },
      {
        "short-option": "q",
        "desc": "Suppress some messages",
        "long-option": "quiet",
        "detail": ""
      },
      {
        "long-option": "nodb",
        "desc": "Do not use a resumption database",
        "detail": ""
      },
      {
        "desc": "Act as an HTTP server",
        "long-option": "http",
        "detail": ""
      },
      {
        "desc": "Act as an Echo server",
        "detail": "",
        "long-option": "echo"
      },
      {
        "long-option": "crlf",
        "desc": "Do not replace CRLF by LF in Echo server mode",
        "detail": ""
      },
      {
        "desc": "Use DTLS (datagram TLS) over UDP",
        "short-option": "u",
        "long-option": "udp",
        "detail": ""
      },
      {
        "arg-type": "number",
        "desc": "Set MTU for datagram TLS",
        "arg-min": "0",
        "detail": "",
        "arg-max": "17000",
        "long-option": "mtu"
      },
      {
        "detail": "",
        "long-option": "srtp-profiles",
        "desc": "Offer SRTP profiles",
        "arg-type": "string"
      },
      {
        "desc": "Do not request a client certificate",
        "short-option": "a",
        "conflicts": "require-client-cert",
        "detail": "",
        "long-option": "disable-client-cert"
      },
      {
        "disabled": "",
        "detail": "This option before 3.6.0 used to imply --verify-client-cert.\nSince 3.6.0 it will no longer verify the certificate by default.",
        "long-option": "require-client-cert",
        "desc": "Require a client certificate",
        "short-option": "r"
      },
      {
        "disabled": "",
        "desc": "If a client certificate is sent then verify it.",
        "detail": "Do not require, but if a client certificate is sent then verify it and close the connection if invalid.",
        "long-option": "verify-client-cert"
      },
      {
        "long-option": "heartbeat",
        "desc": "Activate heartbeat support",
        "detail": "Regularly ping client via heartbeat extension messages",
        "short-option": "b"
      },
      {
        "desc": "Use DER format for certificates to read from",
        "detail": "",
        "long-option": "x509fmtder"
      },
      {
        "detail": "TLS algorithms and protocols to enable. You can\nuse predefined sets of ciphersuites such as PERFORMANCE,\nNORMAL, SECURE128, SECURE256. The default is NORMAL.\n\nCheck  the  GnuTLS  manual  on  section  ``Priority strings'' for more\ninformation on allowed keywords",
        "arg-type": "string",
        "long-option": "priority",
        "desc": "Priorities string"
      },
      {
        "detail": "",
        "long-option": "dhparams",
        "arg-type": "file",
        "file-exists": "yes",
        "desc": "DH params file to use"
      },
      {
        "arg-type": "string",
        "desc": "Certificate file or PKCS #11 URL to use",
        "detail": "",
        "long-option": "x509cafile"
      },
      {
        "desc": "CRL file to use",
        "detail": "",
        "arg-type": "file",
        "file-exists": "yes",
        "long-option": "x509crlfile"
      },
      {
        "detail": "",
        "deprecated": "",
        "long-option": "pgpkeyfile",
        "file-exists": "yes",
        "desc": "PGP Key file to use",
        "arg-type": "file"
      },
      {
        "stack-arg": "",
        "max": "NOLIMIT",
        "long-option": "x509keyfile",
        "detail": "Specify the private key file or URI to use; it must correspond to\nthe certificate specified in --x509certfile. Multiple keys and certificates\ncan be specified with this option and in that case each occurrence of keyfile\nmust be followed by the corresponding x509certfile or vice-versa.",
        "desc": "X.509 key file or PKCS #11 URL to use",
        "arg-type": "string"
      },
      {
        "detail": "Specify the certificate file or URI to use; it must correspond to\nthe key specified in --x509keyfile. Multiple keys and certificates\ncan be specified with this option and in that case each occurrence of keyfile\nmust be followed by the corresponding x509certfile or vice-versa.",
        "arg-type": "string",
        "stack-arg": "",
        "max": "NOLIMIT",
        "long-option": "x509certfile",
        "desc": "X.509 Certificate file or PKCS #11 URL to use"
      },
      {
        "aliases": "x509keyfile",
        "long-option": "x509dsakeyfile",
        "desc": "Alternative X.509 key file or PKCS #11 URL to use",
        "deprecated": ""
      },
      {
        "long-option": "x509dsacertfile",
        "desc": "Alternative X.509 Certificate file or PKCS #11 URL to use",
        "deprecated": "",
        "aliases": "x509certfile"
      },
      {
        "deprecated": "",
        "long-option": "x509ecckeyfile",
        "aliases": "x509keyfile",
        "desc": "Alternative X.509 key file or PKCS #11 URL to use"
      },
      {
        "desc": "Alternative X.509 Certificate file or PKCS #11 URL to use",
        "aliases": "x509certfile",
        "deprecated": "",
        "long-option": "x509ecccertfile"
      },
      {
        "stack-arg": "",
        "long-option": "rawpkkeyfile",
        "max": "NOLIMIT",
        "desc": "Private key file (PKCS #8 or PKCS #12) or PKCS #11 URL to use",
        "arg-type": "string",
        "detail": "Specify the private key file or URI to use; it must correspond to\nthe raw public-key specified in --rawpkfile. Multiple key pairs\ncan be specified with this option and in that case each occurrence of keyfile\nmust be followed by the corresponding rawpkfile or vice-versa.\n\nIn order to instruct the application to negotiate raw public keys one\nmust enable the respective certificate types via the priority strings (i.e. CTYPE-CLI-*\nand CTYPE-SRV-* flags).\n\nCheck  the  GnuTLS  manual  on  section  ``Priority strings'' for more\ninformation on how to set certificate types."
      },
      {
        "detail": "Specify the raw public-key file to use; it must correspond to\nthe private key specified in --rawpkkeyfile. Multiple key pairs\ncan be specified with this option and in that case each occurrence of keyfile\nmust be followed by the corresponding rawpkfile or vice-versa.\n\nIn order to instruct the application to negotiate raw public keys one\nmust enable the respective certificate types via the priority strings (i.e. CTYPE-CLI-*\nand CTYPE-SRV-* flags).\n\nCheck  the  GnuTLS  manual  on  section  ``Priority strings'' for more\ninformation on how to set certificate types.",
        "requires": "rawpkkeyfile",
        "desc": "Raw public-key file to use",
        "stack-arg": "",
        "max": "NOLIMIT",
        "long-option": "rawpkfile",
        "arg-type": "string"
      },
      {
        "detail": "",
        "desc": "SRP password file to use",
        "long-option": "srppasswd",
        "file-exists": "yes",
        "arg-type": "file"
      },
      {
        "desc": "SRP password configuration file to use",
        "long-option": "srppasswdconf",
        "file-exists": "yes",
        "arg-type": "file",
        "detail": ""
      },
      {
        "detail": "",
        "file-exists": "yes",
        "desc": "PSK password file to use",
        "arg-type": "file",
        "long-option": "pskpasswd"
      },
      {
        "arg-type": "string",
        "desc": "PSK identity hint to use",
        "detail": "",
        "long-option": "pskhint"
      },
      {
        "desc": "The OCSP response to send to client",
        "max": "NOLIMIT",
        "detail": "If the client requested an OCSP response, return data from this file to the client.",
        "long-option": "ocsp-response",
        "stack-arg": "",
        "arg-type": "string"
      },
      {
        "long-option": "ignore-ocsp-response-errors",
        "desc": "Ignore any errors when setting the OCSP response",
        "detail": "That option instructs gnutls to not attempt to match the provided OCSP responses with the certificates."
      },
      {
        "desc": "The port to connect to",
        "detail": "",
        "arg-type": "number",
        "short-option": "p",
        "long-option": "port"
      },
      {
        "desc": "Print a list of the supported algorithms and modes",
        "detail": "Print a list of the supported algorithms and modes. If a priority string is given then only the enabled ciphersuites are shown.",
        "short-option": "l",
        "long-option": "list"
      },
      {
        "desc": "Specify the PKCS #11 provider library",
        "file-exists": "yes",
        "arg-type": "file",
        "detail": "This will override the default options in /etc/gnutls/pkcs11.conf",
        "long-option": "provider"
      },
      {
        "arg-type": "string",
        "long-option": "keymatexport",
        "detail": "",
        "desc": "Label used for exporting keying material"
      },
      {
        "desc": "Size of the exported keying material",
        "long-option": "keymatexportsize",
        "arg-type": "number",
        "detail": ""
      },
      {
        "desc": "The maximum record size to advertise",
        "arg-max": "16384",
        "arg-type": "number",
        "detail": "",
        "long-option": "recordsize",
        "arg-min": "0"
      },
      {
        "detail": "",
        "arg-type": "file",
        "long-option": "httpdata",
        "file-exists": "yes",
        "desc": "The data used as HTTP response"
      }
    ]
  }
]