Added SILC Thread Queue API
[silc.git] / public_html / html / docs.php
1 &nbsp;<br />
2 <b><big>SILC Documentation</big></b>
3 <br />&nbsp;<br />
4
5 README file from packages: <a href="docs/README" class="normal">README</a>
6 <br />&nbsp;<br />
7 Software manual: <i>Coming later</i>
8
9 <br />&nbsp;<br />&nbsp;<br />
10
11 <b>Installation Instructions</b>
12 <br />&nbsp;<br />
13 General installation instructions are available in all SILC distributions 
14 in the INSTALL file.
15 <br />&nbsp;<br />
16 <a href="?page=install" class="normal">Installation instructions</a>
17
18 <br />&nbsp;<br />&nbsp;<br />
19
20 <b><big>Technical Documentation</big></b>
21 <br />&nbsp;<br />
22
23 <b>SILC Toolkit Reference Manual</b>
24 <br />&nbsp;<br />
25 SILC Toolkit Reference Manual includes documentation for the SILC Toolkit 
26 package.  It includes interface references to all interfaces found in 
27 various SILC libraries.  The reference manual is automatically generated 
28 from the source code.  Note that this version is preliminary and does not 
29 include references to all interfaces.
30 <br />&nbsp;<br />
31 <a href="docs/toolkit/" class="normal">HTML version</a>, 
32 <a href="docs/toolkit.html.tar.gz" class="normal">html.tar.gz</a>
33
34 <br />&nbsp;<br />&nbsp;<br />
35
36 <b>Coding Conventions</b>
37 <br />&nbsp;<br />
38 If you would like to submit code to the SILC Project we would like you to 
39 first check out these coding conventions.  They are here for the benefit 
40 of all who read the code and is involved in the development of the SILC.
41 <br />&nbsp;<br />
42 <a href="docs/CodingStyle" class="normal">CodingStyle</a>
43
44 <br />&nbsp;<br />&nbsp;<br />
45
46 <b><big>SILC Protocol Documentation</big></b>
47 <br />&nbsp;<br />
48
49 <b>SILC Protocol White Paper</b>
50 <br />&nbsp;<br />
51 SILC Protocol White Paper gives short but deep enough introduction to the 
52 SILC Protocol. Note that this is for those who would like to know how the 
53 protocol works. For more detailed description of the protocol we suggest 
54 reading the protocol specifications.
55 <br />&nbsp;<br />
56
57 <a href="?page=whitepaper" class="normal">HTML version</a>,
58 <a href="docs/silc_protocol.pdf.gz" class="normal">gzipped PDF</a>,
59 <a href="docs/silc_protocol.ps.gz" class="normal">gzipped PostScript</a>
60
61 <br />&nbsp;<br />&nbsp;<br />
62
63 <b>SILC Protocol Internet Drafts</b>
64 <br />&nbsp;<br />
65 SILC Protocol is documented and four Internet Drafts exist. These 
66 Internet Drafts are also available from the
67 <a href="http://www.ietf.org/" class="normal">IETF</a>.
68 <br />&nbsp;<br />
69
70 <b>Secure Internet Live Conferencing (SILC), Protocol Specification</b>
71 <br />&nbsp;<br />
72 Abstract
73 <br />&nbsp;<br />
74    This memo describes a Secure Internet Live Conferencing (SILC)
75    protocol which provides secure conferencing services over insecure
76    network channel. SILC is IRC [IRC] like protocol, however, it is
77    not equivalent to IRC and does not support IRC. Strong cryptographic
78    methods are used to protect SILC packets inside the SILC network.
79    Three other Internet Drafts relates very closely to this memo;
80    SILC Packet Protocol [SILC2], SILC Key Exchange and Authentication
81    Protocols [SILC3] and SILC Commands [SILC4].
82 <br />&nbsp;<br />
83 <a href="docs/draft-riikonen-silc-spec-04.txt" class="normal">
84 draft-riikonen-silc-spec-04.txt</a>
85 <br />&nbsp;<br />&nbsp;<br />
86
87 <b>SILC Packet Protocol</b>
88 <br />&nbsp;<br />
89 Abstract
90 <br />&nbsp;<br />
91    This memo describes a Packet Protocol used in the Secure Internet Live
92    Conferencing (SILC) protocol, specified in the Secure Internet Live
93    Conferencing, Protocol Specification Internet Draft [SILC1].  This
94    protocol describes the packet types and packet payloads which defines
95    the contents of the packets. It provides secure binary packet protocol
96    that assures that the content of the packets is secured and authenticated.
97 <br />&nbsp;<br />
98 <a href="docs/draft-riikonen-silc-pp-04.txt" class="normal">
99 draft-riikonen-silc-pp-04.txt</a>
100 <br />&nbsp;<br />&nbsp;<br />
101
102 <b>SILC Key Exchange and Authentication Protocols</b>
103 <br />&nbsp;<br />
104 Abstract
105 <br />&nbsp;<br />
106    This memo describes two protocols used in the Secure Internet Live  
107    Conferencing (SILC) protocol, specified in the Secure Internet Live 
108    Conferencing, Protocol Specification internet-draft [SILC1].  The   
109    SILC Key Exchange (SKE) protocol provides secure key exchange between
110    two parties resulting into shared secret key material. The protocol
111    is based on Diffie-Hellman key exchange algorithm and its functionality
112    is derived from several key exchange protocols. SKE uses best parts
113    of the SSH2 Key Exchange protocol, Station-To-Station (STS) protocol 
114    and the OAKLEY Key Determination protocol [OAKLEY].
115 <br />&nbsp;<br />
116    The SILC Connection Authentication protocol provides user level
117    authentication used when creating connections in SILC network. The 
118    protocol is transparent to the authentication data which means that it
119    can be used to authenticate the user with, for example, passphrase  
120    (pre-shared-secret) or public key (and certificate).
121 <br />&nbsp;<br />
122 <a href="docs/draft-riikonen-silc-ke-auth-04.txt" class="normal">
123 draft-riikonen-silc-ke-auth-04.txt</a>
124 <br />&nbsp;<br />&nbsp;<br />
125
126 <b>SILC Commands</b>
127 <br />&nbsp;<br />
128 Abstract
129 <br />&nbsp;<br />
130    This memo describes the commands used in the Secure Internet Live
131    Conferencing (SILC) protocol, specified in the Secure Internet Live
132    Conferencing, Protocol Specification Internet Draft [SILC1].  The
133    SILC Commands are very important part of the SILC protocol.  Usually
134    the commands are used by SILC clients to manage the SILC session, but
135    also SILC servers may use the commands.  This memo specifies detailed
136    command messages and command reply messages.
137 <br />&nbsp;<br />
138 <a href="docs/draft-riikonen-silc-commands-02.txt" class="normal">
139 draft-riikonen-silc-commands-02.txt</a>