summaryrefslogtreecommitdiff
path: root/README
blob: 6d86df87171d28ffe45b335165ce7deedd68c532 (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
tlsd - a TLS daemon
===================
TLSd is a daemon that both accepts and initiates TLS connections, runs
processes, and provides peer certificate's fingerprint as an
environment variable for them. The intent is to facilitate creation
and usage of simple services for peer-to-peer networking.


Examples
--------
An echo server on a random port:

    $ tlsd -e cat

Authentication:

    $ tlsd -p 5556 -- sh -c 'echo "Hello, ${SHA256}! I am a ${SIDE}."'

Connection initiation:

    $ echo 'localhost 5600' | tlsd -e echo 'hello'

Per-connection FIFO pairs:

    $ tlsd -p 5601 -e -- std2fifo -e ~/.chat/


Installation
------------
Dependencies: GnuTLS. To install from a tarball distribution:

    $ ./configure && make && make install

It uses GNU Build System, so the standard options and targets are
present.

Generated files are not included into the DVCS repository. To generate
them, use:

    $ aclocal && autoconf && autoheader && automake --add-missing

X.509 certificates can be generated with GnuTLS's certtool or
OpenSSL's req command.


Documentation
-------------
An info manual and man pages are provided.