1 AutoGen Definitions options
;
2 prog
-name
= gnutls
-serv
;
3 prog
-title
= "GnuTLS server";
4 prog
-desc
= "Simple server program to act as an HTTPS or TLS echo service.";
5 short
-usage
= "Usage: gnutls-serv [options]\ngnutls-serv --help for usage instructions.\n";
7 detail
= "Server program that listens to incoming TLS connections.";
13 descrip
= "Don't accept session tickets";
20 descrip
= "Generate Diffie-Hellman and RSA-export parameters";
27 descrip
= "Suppress some messages";
33 descrip
= "Do not use a resumption database";
39 descrip
= "Act as an HTTP server";
45 descrip
= "Act as an Echo server";
52 descrip
= "Use DTLS (datagram TLS) over UDP";
59 arg
-range
= "0->17000";
60 descrip
= "Set MTU for datagram TLS";
65 name
= disable
-client
-cert
;
67 descrip
= "Do not request a client certificate";
72 name
= require
-client
-cert
;
74 descrip
= "Require a client certificate";
80 descrip
= "Use DER format for certificates to read from";
87 descrip
= "Priorities string";
88 doc
= "TLS algorithms and protocols to enable. You can
89 use predefined sets of ciphersuites such as PERFORMANCE,
90 NORMAL, SECURE128, SECURE256.
92 Check the GnuTLS manual on section ``Priority strings'' for more
93 information on allowed keywords";
100 descrip
= "DH params file to use";
107 descrip
= "Certificate file or PKCS #11 URL to use";
115 descrip
= "CRL file to use";
123 descrip
= "PGP Key file to use";
131 descrip
= "PGP Key ring file to use";
139 descrip
= "PGP Public Key (certificate) file to use";
146 descrip
= "X.509 key file or PKCS #11 URL to use";
153 descrip
= "X.509 Certificate file or PKCS #11 URL to use";
158 name
= x509dsakeyfile
;
160 descrip
= "Alternative X.509 key file or PKCS #11 URL to use";
165 name
= x509dsacertfile
;
167 descrip
= "Alternative X.509 Certificate file or PKCS #11 URL to use";
172 name
= x509ecckeyfile
;
174 descrip
= "Alternative X.509 key file or PKCS #11 URL to use";
179 name
= x509ecccertfile
;
181 descrip
= "Alternative X.509 Certificate file or PKCS #11 URL to use";
188 descrip
= "PGP subkey to use (hex or auto)";
196 descrip
= "SRP password file to use";
201 name
= srppasswdconf
;
204 descrip
= "SRP password configuration file to use";
212 descrip
= "PSK password file to use";
219 descrip
= "PSK identity hint to use";
227 descrip
= "The port to connect to";
234 descrip
= "Print a list of the supported algorithms and modes";
235 doc
= "Print a list of the supported algorithms and modes. If a priority string is given then only the enabled ciphersuites are shown.";
239 ds
-type
= 'SEE ALSO'; // or anything else
240 ds
-format
= 'texi'; // or texi or mdoc format
241 ds
-text
= <<-_EOText_
242 gnutls
-cli
-debug(1), gnutls
-cli(1)
247 ds
-type
= 'EXAMPLES';
250 Running your own TLS server based on GnuTLS can be useful when
251 debugging clients and
/or GnuTLS itself. This section describes how to
252 use @code
{gnutls
-serv
} as a simple HTTPS server.
254 The most basic server can be started as
:
260 It will only support anonymous ciphersuites
, which many TLS clients
263 The next step is to add support for X
.509. First we generate a CA
:
266 $ certtool
--generate
-privkey
> x509
-ca
-key.pem
267 $ echo
'cn = GnuTLS test CA' > ca.tmpl
268 $ echo
'ca' >> ca.tmpl
269 $ echo
'cert_signing_key' >> ca.tmpl
270 $ certtool
--generate
-self
-signed
--load
-privkey x509
-ca
-key.pem \
271 --template ca.tmpl
--outfile x509
-ca.pem
275 Then generate a server certificate. Remember to change the dns_name
276 value to the name of your server host
, or skip that command to avoid
280 $ certtool
--generate
-privkey
> x509
-server
-key.pem
281 $ echo
'organization = GnuTLS test server' > server.tmpl
282 $ echo
'cn = test.gnutls.org' >> server.tmpl
283 $ echo
'tls_www_server' >> server.tmpl
284 $ echo
'encryption_key' >> server.tmpl
285 $ echo
'signing_key' >> server.tmpl
286 $ echo
'dns_name = test.gnutls.org' >> server.tmpl
287 $ certtool
--generate
-certificate
--load
-privkey x509
-server
-key.pem \
288 --load
-ca
-certificate x509
-ca.pem
--load
-ca
-privkey x509
-ca
-key.pem \
289 --template server.tmpl
--outfile x509
-server.pem
293 For use in the client
, you may want to generate a client certificate
297 $ certtool
--generate
-privkey
> x509
-client
-key.pem
298 $ echo
'cn = GnuTLS test client' > client.tmpl
299 $ echo
'tls_www_client' >> client.tmpl
300 $ echo
'encryption_key' >> client.tmpl
301 $ echo
'signing_key' >> client.tmpl
302 $ certtool
--generate
-certificate
--load
-privkey x509
-client
-key.pem \
303 --load
-ca
-certificate x509
-ca.pem
--load
-ca
-privkey x509
-ca
-key.pem \
304 --template client.tmpl
--outfile x509
-client.pem
308 To be able to import the client key
/certificate into some
309 applications
, you will need to convert them into a PKCS#
12 structure.
310 This also encrypts the security sensitive key with a password.
313 $ certtool
--to
-p12
--load
-ca
-certificate x509
-ca.pem \
314 --load
-privkey x509
-client
-key.pem
--load
-certificate x509
-client.pem \
315 --outder
--outfile x509
-client.p12
318 For icing
, we
'll create a proxy certificate for the client too.
321 $ certtool --generate-privkey > x509-proxy-key.pem
322 $ echo 'cn
= GnuTLS test client proxy
' > proxy.tmpl
323 $ certtool --generate-proxy --load-privkey x509-proxy-key.pem \
324 --load-ca-certificate x509-client.pem --load-ca-privkey x509-client-key.pem \
325 --load-certificate x509-client.pem --template proxy.tmpl \
326 --outfile x509-proxy.pem
330 Then start the server again:
333 $ gnutls-serv --http \
334 --x509cafile x509-ca.pem \
335 --x509keyfile x509-server-key.pem \
336 --x509certfile x509-server.pem
339 Try connecting to the server using your web browser. Note that the
340 server listens to port 5556 by default.
342 While you are at it, to allow connections using DSA, you can also
343 create a DSA key and certificate for the server. These credentials
344 will be used in the final example below.
347 $ certtool --generate-privkey --dsa > x509-server-key-dsa.pem
348 $ certtool --generate-certificate --load-privkey x509-server-key-dsa.pem \
349 --load-ca-certificate x509-ca.pem --load-ca-privkey x509-ca-key.pem \
350 --template server.tmpl --outfile x509-server-dsa.pem
354 The next step is to create OpenPGP credentials for the server.
358 ...enter whatever details you want, use 'test.gnutls.org
' as name...
361 Make a note of the OpenPGP key identifier of the newly generated key,
362 here it was @code{5D1D14D8}. You will need to export the key for
363 GnuTLS to be able to use it.
366 gpg -a --export 5D1D14D8 > openpgp-server.txt
367 gpg --export 5D1D14D8 > openpgp-server.bin
368 gpg --export-secret-keys 5D1D14D8 > openpgp-server-key.bin
369 gpg -a --export-secret-keys 5D1D14D8 > openpgp-server-key.txt
372 Let's start the server with support for OpenPGP credentials
:
376 --pgpkeyfile openpgp
-server
-key.txt \
377 --pgpcertfile openpgp
-server.txt
380 The next step is to add support for SRP authentication. This requires
381 an SRP password file created with @code
{srptool
}.
382 To start the server with SRP support
:
386 --srppasswdconf srp
-tpasswd.conf \
387 --srppasswd srp
-passwd.txt
390 Let
's also start a server with support for PSK. This would require
391 a password file created with @code{psktool}.
395 --pskpasswd psk-passwd.txt
398 Finally, we start the server with all the earlier parameters and you
403 --x509cafile x509-ca.pem \
404 --x509keyfile x509-server-key.pem \
405 --x509certfile x509-server.pem \
406 --x509dsakeyfile x509-server-key-dsa.pem \
407 --x509dsacertfile x509-server-dsa.pem \
408 --pgpkeyfile openpgp-server-key.txt \
409 --pgpcertfile openpgp-server.txt \
410 --srppasswdconf srp-tpasswd.conf \
411 --srppasswd srp-passwd.txt \
412 --pskpasswd psk-passwd.txt