Initial revision
[silc.git] / README
1 SILC - Secure Internet Live Conferencing
2 ========================================
3
4 [NOTE: SILC is still in middle of development and this package is known
5 as Developer's Version which means that the package is in no means stable
6 or ready to be in production use.  This package is for those who wants
7 to test SILC, find bugs and maybe contribute some time and code for the
8 SILC project.  There is no guarantees that this package even compiles and
9 even if it compiles there is no guarantees that it would work, and even
10 if it works there is no guarantees that it would work correctly, and even
11 if it seems to work correctly it may be just plain luck.]
12
13
14 Description
15 ===========
16
17 SILC (Secure Internet Live Conferencing) is a protocol which provides
18 secure conferencing services in the Internet over insecure channel.
19 SILC is IRC like softwarre although internally they are very different.
20 Biggest similiarity between SILC and IRC is that they both provide
21 conferencing services and that SILC has almost same commands as IRC.  Other
22 than that they are nothing alike.  Biggest differences are that SILC is 
23 secure what IRC is not in any way.  The network model is also entirely
24 different compared to IRC.
25
26
27 Features
28 ========
29
30 Features to be included into the final release of SILC.  [Note that the
31 current Developer's Version does not include all of these features, read
32 TODO file for more information.]
33
34  o Normal conferencing services such as private messages, channels,
35    channel messages, etc.  All traffic is secured and authenticated.
36
37  o No unique nicknames.  There can same nicknames in SILC without
38    collisions.  SILC has unique Client ID's, Server ID's and Channel ID's
39    to assure that there are no collisions.
40
41  o Secure key exchange and authentication protocol.  SILC Key Exchange
42    protocol provides key material used in the SILC sessions in secure
43    manner.  The protocol is immune for example to man-in-the-middle 
44    attacks.  The SILC Authentication protocol provides strong 
45    authentication.  Authentication may be based on passphrase or public
46    key (RSA) authentication.  For clients there is an option not to
47    use authentication when connecting to servers.
48
49  o All traffic is encrypted and authenticated using the best cryptographic
50    algorithms out there.  Command messages, private messages and channel
51    messages are all protected by encryption.  User can set private keys
52    for both private message and for channels so that even SILC servers do
53    not know the keys.  Cipher keys are, by default, 128 bits in length and
54    public keys, by default, 1024 bits in length.
55
56  o Supports data compression with GZIP to improve performance.
57
58  o SIM (SILC Module) support.  Support for loading of shared objects at 
59    run-time that provides new and extended features to both SILC client
60    and server.  These can provide extra ciphers and extra features to
61    the software.
62
63  o SILC client can be installed and used without root privileges.
64
65  o SILC client can be configured by system wide configuration files but
66    with user specific configuration files as well.
67
68
69 History
70 =======
71
72 Even though SILC were just released to the public the idea and the protocol
73 itself is quite old.  I got the idea about SILC in its current form in
74 the year 1996 and first lines of codes were written in early 1997.  This
75 release is now third rewrite of the SILC.  The very first version were
76 written in 1997 and it included SILC client and very very preliminary
77 SILC server.  The server actually weren't usable but the client looked
78 pretty much the same as it does now.  At that time the SILC also included
79 RSA implementation and 3DES implementation.  The random number generator
80 that exists in this current release is actually based on the RNG written
81 in 1997.  The RNG written in 1997, on the other hand, were based on
82 the SSH's random number generator.  The RNG has been rewritten twice
83 since the first version.
84
85 I stopped writing the SILC later in 1997 when I got busy at school and
86 in work.  The pause lasted several months.  The development resumed in
87 1998 when my friend (Juha Räsänen) and I implemented ElGamal algorithm.
88 I rewrote some other parts as well.  However, for the same reasons as
89 previously the development stopped again.  I resumed the development
90 later in 1998 by doing rewrite of the SILC in C++.  This was obviously 
91 a mistake but at that time it seemed like a good idea.  Again, in the 
92 winter 1999 I got very busy writing my thesis and was forced to stop the 
93 development again.  I also, started a new job in the spring.
94
95 Later, in 1999, I decided that this time I'm going to make it the right
96 way.  C++ was obviously a bad choice so I decided to fall back to plain
97 C language.  I also decided to do complete rewrite and started doing
98 more thorough planning of what the SILC actually should include.  I also
99 decided that this time it is going to kill me before I stop the 
100 development.  I started writing SILC in the weekends and actually 
101 everytime I had some spare time.  I also started a new job but I didn't
102 let that get to my way.  The result of this development effort is the
103 release now in public.
104
105 I've learned a lot by doing the SILC.  I guess, when I started it I wasn't
106 that good of a C programmer.  That alone was a reason why SILC hasn't
107 seen the day of light before now.  My programming style has also changed 
108 dramatically during these years.  Actually, it has changed couple times 
109 since this last rewrite as well.  However, the code style of current SILC 
110 release is quite consistent (actually the coding style SILC has been 
111 written now I've learned in my current job).
112
113 There is probably over 85% of new code in this third rewrite.  Rest has 
114 just been copied from the old versions and only minor changes has been
115 made (like changed function names and overall coding style).  I've 
116 preserved the dates of the old files (dating back to 1997) that has 
117 existed in some forms in the old versions.  There is a lot of new code but
118 already I see a lot that needs rewriting.  The development continues.
119
120
121 Contact
122 =======
123
124 Feedback and comments are welcome.  You can reach me in the following
125 Address. 
126
127 [Note that generally bug reports should not be sent just yet as the 
128 Developer's Version is full of them and the bug hunt has not even started 
129 yet.]
130
131                                 Pekka Riikonen <priikone@poseidon.pspt.fi>