`--enable-ipv6'
The `configure' will attempt to check for IPv6 support in your system.
- However, if it fails, but you still want to compile in the IPv6 support
- you can give --enable-ipv6 option to force the IPv6 support.
+However, if it fails, but you still want to compile in the IPv6 support
+you can give --enable-ipv6 option to force the IPv6 support.
Basic Installation
==================
TODO/bugs In SILC Libraries
===========================
+ o Fix possible buffer overflows in silc_id_render function.
+
o WIN32 silc_net_create_connection_async does not work the same way
than on Unix. Do it with threads on WIN32. The function works but
is not actually async currently.
Host = "10.2.1.7";
Passphrase = "verysecret";
#Publickey = "/path/to/the/public.key";
- VersionID = 1;
Params = "normal";
Backup = false;
};
Port = 706;
Passphrase = "verysecret";
#Publickey = "/path/to/the/public.key";
- VersionID = 1;
Params = "normal";
Initiator = true;
#BackupHost = "10.2.1.6";
<br /><br /><br />
<li><a href="intro_reference.html">Introduction to the Manual</a><br />
<li><a href="programming_conv.html">Programming Conventions</a><br />
+<li><a href="building.html">Building the Toolkit</a>
+
+<br /><br />
+<b>Toolkit Reference</b>
+<br /><br />
@BODY@
-<br /><br /><br />
+<br /><br />
<b>Resource Links</b>
<br /><br />
Please refer to these outside links for more information about the SILC
project and SILC Protocol.
-<br /><br /><br />
+<br /><br />
<li><a href="http://silcnet.org">SILC Project Website</a><br />
<li><a href="http://silcnet.org/?page=docs">SILC Protocol Documentation</a><br />
<li><a href="http://silcnet.org/?page=whitepaper">SILC White Paper</a><br />
--- /dev/null
+<big><b>Building the Toolkit</b></big>
+
+<br /> <br />
+SILC Toolkit works on various platforms, such as on several Unix systems and
+on Windows. Building of the Toolkit on some platform may differ from the
+other. This document describes how to build the Toolkit from the sources,
+to create linkable libraries and binaries, on all platforms the Toolkit
+support.
+
+<br /> <br />
+The building instructions for all platforms are also included in the Toolkit
+package. Please refer to the INSTALL file for general building instructions
+for Unix systems, README.WIN32 for building on Windows systems, and
+README.MACOSX for building on Mac OS X.
+
+<br /> <br />
+<li><a href="#unix">Building on Unix & Linux</a><br />
+<li><a href="#windows">Building on Windows</a><br />
+<li><a href="#macosx">Building on Mac OS X</a>
+
+<br /> <br /> <br />
+<b><a name="unix"></a>Building on Unix & Linux</b>
+
+<br /> <br />
+Building the Toolkit on Unix will produce binaries of all libraries, and
+SILC Client and SILC Server. The Toolkit package includes also Client and
+Server as an example applications, and they are compiled automatically.
+The libraries are compiled to provide staticly linkable libraries. Two
+libraries are produced: libsilc.a and libsilcclient.a. The libsilc.a includes
+everything else except the Client library. The libsilcclient.a includes
+only the Client library.
+
+<br /> <br />
+To build Toolkit on Unix systems, give commands:
+
+<br /> <br />
+<tt>
+./configure<br />
+make
+</tt>
+
+<br /> <br />
+On some systems you may need to give "gmake" command instead of "make". The
+./configure can take several options as arguments. To see them all give
+command:
+
+<br /> <br />
+<tt>./configure --help</tt>
+
+<br /> <br />
+The most important configuration options you may consider to use are:
+
+<br /> <br />
+<tt>--enable-debug</tt>
+
+<br /> <br />
+If you would like to enable the debugging for the compiled binaries
+you can give this option to the `configure'. It is recommended to use
+this option when you are doing development with Toolkit. It is helpful
+to enable run-time debugging.
+
+<br /> <br />
+<tt>--with-gmp=PATH</tt>
+
+<br /> <br />
+If you wish to use GMP library for arbitrary precision arithmetic
+library instead of using the MPI library included in the package, you can
+give the --with-gmp=PATH option to the `configure'. The PATH is the path
+to the GMP library in your system.
+
+<br /> <br />
+<tt>--disable-asm</tt>
+
+<br /> <br />
+If you have trouble compiling the assembler optimized code in the
+package or does not want to use them, you can give the --disable-asm
+option to the `configure' script. This will assure that assembler
+optimized code is not compiled in.
+
+<br /> <br />
+<tt>--disable-threads</tt>
+
+<br /> <br />
+If you do not want to compile the programs with multi threads support
+you can give --disable-threads option. This will disable the SILC Thread
+API and SILC Mutex API. Furthermore if SILC Thread API is used when this
+option is used, the routines work, but do not work in threads (are run
+in the calling process and can block the process).
+
+<br /> <br />
+<tt>--enable-ipv6</tt>
+
+<br /> <br />
+The `configure' will attempt to check for IPv6 support in your system.
+However, if it fails, but you still want to compile in the IPv6 support
+you can give --enable-ipv6 option to force the IPv6 support.
+
+<br /> <br />
+After compilation you can install the Toolkit into your system by giving
+the command:
+
+<br /> <br />
+<tt>make install</tt>
+
+
+<br /> <br /> <br />
+<b><a name="windows"></a>Building on Windows</b>
+
+<br /> <br />
+The Toolkit can be compiled several different ways on Windows. However,
+this document describes the method to build the Toolkit to produce native
+Win32 binaries. The Toolkit package can also be compiled on Cygwin and
+MinGW. For these systems please refer to the README.WIN32 file in the
+Toolkit package.
+
+<br /> <br />
+The Toolkit package includes ready MSVC++ Workspace files, that will
+automatically compile the Toolkit. The MSVC++ workspace and project files
+resides in the win32/ subdirectory of the Toolkit package. The `silc.dsw'
+file is the workspace file that automatically supports compiling the Toolkit
+and to generate the SILC Core DLL and SILC Client DLL libraries.
+
+<br /> <br />
+The SILC Core DLL is named as libsilc and will generate libsilc.dll, and
+the SILC Client DLL is named as libsilcclient and will generate
+libsilcclient.dll. Both of the projects also automatically generates
+libsilc.lib and libsilcclient.lib import libraries that may be used to
+link against a client application.
+
+<br /> <br />
+Generally you do not need to do any specific settings to compile the
+Toolkit. However, you must compile the libsilc before compiling the
+libsilclient, since the SILC Client DLL depends on the SILC Core DLL.
+You may compile the DLLs as either Release or Debug version. Just select
+the preferred method of compilation. The Debug version will compile the
+SILC Toolkit with run-time debugging support, which is recommended when
+doing development with the Toolkit.
+
+<br /> <br /> <br />
+<b><a name="macosx"></a>Building on Mac OS X</b>
+
+<br /> <br />
+Building the Toolkit on Mac OS X is almost identical on compiling on Unix
+system. The reason for this is that the Mac OS X is Unix based operating
+system. To build the Toolkit on Mac OS X, give the following commands:
+
+<br /> <br />
+<tt>
+setenv CFLAGS -no-cpp-precomp<br />
+./configure powerpc<br />
+make
+</tt>
+
+<br /> <br />
+The ./configure can take several options as arguments. To see them all give
+command:
+
+<br /> <br />
+<tt>./configure --help</tt>
+
+<br /> <br />
+If you do not want to compile the applications, or they do not compile on
+your system, you can also choose to compile only the libraries, and skip
+all applications. In this case, before giving the "make" command, go
+to the lib/ subdirectory, and give "make" command there:
+
+<br /> <br />
+<tt>
+cd lib/<br />
+make
+</tt>
+
+<br /> <br />
+After compilation you can install the Toolkit into your system by giving
+the command:
+
+<br /> <br />
+<tt>make install</tt>
@LINK=silcclient.html:Client Library Interface
-->
-<BIG><B>SILC Client Library</B></BIG>
-<BR /><BR />
-<B>Introduction</B>
+<big><b>SILC Client Library</b></big>
+<br />
+<small>Directory: lib/silcclient/</small>
+<br />
+<small>Library: libsilcclient.a, libsilcclient.lib</small>
+<br /><br />
+<b>Introduction</b>
-<BR /><BR />
+<br /><br />
SILC Client Library is SILC Client implementation without the actual user
interface. The library uses common and core components of SILC protocol from
lib/silccore library and normal utility routines from lib/silcutil library.
application which it can use to implement generally whatever user interface
it wants.
-<BR /><BR />
+<br /><br />
The `silcclient.h' file defines the function prototypes that application must
implement in order to be able to create the user interface with the
library. The idea is that the application can implement whatever user
handling or item handling on the screen etc. These does not interest
the library.
-<BR /><BR />
+<br /><br />
@LINKS@
*/
-/****h* silcclient/SilcClientAPI
+/****h* silcclient/Client Library Interface
*
* DESCRIPTION
*
@LINK=silcpacket.html:Packet Protocol Interface
-->
-<BIG><B>SILC Core Library</B></BIG>
-<BR /><BR />
-<B>Introduction</B>
+<big><b>SILC Core Library</b></big>
+<br />
+<small>Directory: lib/silccore/</small>
+<br />
+<small>Library: libsilc.a, libsilc.lib</small>
+<br /><br />
+<b>Introduction</b>
-<BR /><BR />
+<br /><br />
SILC Core Library includes all the core components of the SILC Protocol.
It provides routines to encode and decode all SILC packet payloads defined
in the protocol specification. It provides packet assembling and parsing
routines, and routines for sending private message and channel messages.
-<BR /><BR />
+<br /><br />
@LINKS@
*/
-/****h* silccore/SilcArgumentAPI
+/****h* silccore/SILC Argument Interface
*
* DESCRIPTION
*
*/
-/****h* silccore/SilcAuthAPI
+/****h* silccore/SILC Authentication Interface
*
* DESCRIPTION
*
*/
-/****h* silccore/SilcChannelAPI
+/****h* silccore/SILC Channel Interface
*
* DESCRIPTION
*
*/
-/****h* silccore/SilcCommandAPI
+/****h* silccore/SILC Command Interface
*
* DESCRIPTION
*
*/
-/****h* silccore/SilcIDAPI
+/****h* silccore/SILC ID Interface
*
* DESCRIPTION
*
*/
-/****h* silccore/SilcIDCacheAPI
+/****h* silccore/SILC ID Cache Interface
*
* DESCRIPTION
*
*/
-/****h* silccore/SilcMode
+/****h* silccore/SILC Modes
*
* DESCRIPTION
*
*/
-/****h* silccore/SilcNotifyAPI
+/****h* silccore/SILC Notify Interface
*
* DESCRIPTION
*
*/
-/****h* silccore/SilcPacketAPI
+/****h* silccore/Packet Protocol Interface
*
* DESCRIPTION
*
*/
-/****h* silccore/SilcPrivateAPI
+/****h* silccore/SILC Private Message Interface
*
* DESCRIPTION
*
@FILENAME=silccryptlib.html
@LINK=silcrng_intro.html:Introduction to SILC RNG
@LINK=silcrng.html:SILC RNG Interface
+@LINK=silchmac.html:SILC HMAC Interface
@LINK=silccipher.html:SILC Cipher API
@LINK=silchash.html:SILC Hash API
-@LINK=silchmac.html:SILC HMAC API
@LINK=silcpkcs.html:SILC PKCS API
-->
-<BIG><B>SILC Crypto Library</B></BIG>
-<BR /><BR />
-<B>Introduction</B>
+<big><b>SILC Crypto Library</b></big>
+<br />
+<small>Directory: lib/silccrypt/</small>
+<br />
+<small>Library: libsilc.a, libsilc.lib</small>
+<br /><br />
+<b>Introduction</b>
-<BR /><BR />
+<br /><br />
SILC Crypto Library provides cryptographic routines for applications. It
provides interfaces for ciphers, hash functions, HMACs and public key
cryptosystems. In addition is also provides interfaces for cryptographically
strong random number generator.
-<BR /><BR />
+<br /><br />
@LINKS@
#ifndef SILCHMAC_H
#define SILCHMAC_H
-/****h* silccrypt/SilcHMACAPI
+/****h* silccrypt/SILC HMAC Interface
*
* DESCRIPTION
*
*/
-/****h* silccrypt/SilcRNGAPI
+/****h* silccrypt/SILC RNG Interface
*
* DESCRIPTION
*
@LINK=silcmath.html:SILC Math Interface
-->
-<BIG><B>SILC Math Library</B></BIG>
-<BR /><BR />
+<big><b>SILC Math Library</b></big>
+<br />
+<small>Directory: lib/silcmath/</small>
+<br />
+<small>Library: libsilc.a, libsilc.lib</small>
+<br /><br />
<B>Introduction</B>
-<BR /><BR />
+<br /><br />
SILC Math Library provides arbitrary precision artichmetic routines for
public key cryptosystems, prime number generation routines, and other
math utility functions for applications.
-<BR /><BR />
+<br /><br />
@LINKS@
if SILC_MP_NSS_MPI
MP_SOURCE = mp_mpi.c
+if SILC_DIST_TOOLKIT
+MP_HEADERS = mpi/mpi.h mpi/mplogic.h mpi/mpprime.h mpi/mpi-config.h
+else
+MP_HEADERS =
+endif
else
MP_SOURCE = mp_gmp.c
+MP_HEADERS =
endif
libsilcmath_a_SOURCES = \
mp_gmp.h \
mp_mpi.h \
silcmath.h \
- silcmp.h
+ silcmp.h \
+ $(MP_HEADERS)
endif
EXTRA_DIST = *.h
*/
-/****h* silcmath/SilcMathAPI
+/****h* silcmath/SILC Math Interface
*
* DESCRIPTION
*
*/
-/****h* silcmath/SilcMPAPI
+/****h* silcmath/SILC MP Interface
*
* DESCRIPTION
*
@LINK=silcsftp_fs.html:SFTP Filesystems Interface
-->
-<BIG><B>SILC SFTP Library</B></BIG>
-<BR /><BR />
-<B>Introduction</B>
+<big><b>SILC SFTP Library</b></big>
+<br />
+<small>Directory: lib/silcsftp/</small>
+<br />
+<small>Library: libsilc.a, libsilc.lib</small>
+<br /><br />
+<b>Introduction</b>
-<BR /><BR />
+<br /><br />
SILC SFTP Library provides SSH File Transfer Protocol client and server
implementation. The SFTP protocol is the mandatory file transfer protocol
used for file transfers in the SILC protocol. The same interface is used
for SFTP client and SFTP server.
-<BR /><BR />
+<br /><br />
@LINKS@
#ifndef SILCSFTP_H
#define SILCSFTP_H
-/****h* silcsftp/SilcSFTPAPI
+/****h* silcsftp/SILC SFTP Interface
*
* DESCRIPTION
*
#ifndef SILCSFTP_FS_H
#define SILCSFTP_FS_H
-/****h* silcsftp/SilcSFTPFSAPI
+/****h* silcsftp/SFTP Filesystems Interface
*
* DESCRIPTION
*
@LINK=silcske_payload.html:SKE Payloads
-->
-<BIG><B>SILC Key Exchange Library</B></BIG>
-<BR /><BR />
-<B>Introduction</B>
+<big><b>SILC Key Exchange Library</b></big>
+<br />
+<small>Directory: lib/silcske/</small>
+<br />
+<small>Library: libsilc.a, libsilc.lib</small>
+<br /><br />
+<b>Introduction</b>
-<BR /><BR />
+<br /><br />
SILC Key Exchange (SKE) Library, is an implementation of the SKE protocol.
It provides the key exchange protocol for all SILC applications.
-<BR /><BR />
+<br /><br />
@LINKS@
#ifndef SILCSKE_H
#define SILCSKE_H
-/****h* silcske/SilcSKEAPI
+/****h* silcske/SILC SKE Interface
*
* DESCRIPTION
*
*/
-/****h* silcske/SilcSKEGroups
+/****h* silcske/SKE Diffie Hellman Groups
*
* DESCRIPTION
*
*/
-/****h* silcske/SilcSKEPayloads
+/****h* silcske/SKE Payloads
*
* DESCRIPTION
*
*/
-/****h* silcske/SilcSKEStatuses
+/****h* silcske/SKE Status Types
*
* DESCRIPTION
*
@LINK=silczip.html:SILC Zip API
-->
-<BIG><B>SILC Utility Library</B></BIG>
-<BR /><BR />
-<B>Introduction</B>
+<big><b>SILC Utility Library</b></big>
+<br />
+<small>Directory: lib/silcutil/</small>
+<br />
+<small>Library: libsilc.a, libsilc.lib</small>
+<br /><br />
+<b>Introduction</b>
-<BR /><BR />
+<br /><br />
SILC Utility Library provides various utility routines for the applications.
For example, it provides the application's main loop, called the SILC
Scheduler. It can handle all kinds of tasks, like socket connections and
management routines. All of these routines work on multiple platforms
such as Unix and WIN32.
-<BR /><BR />
+<br /><br />
@LINKS@
*/
-/****h* silcutil/SilcBufferFormatAPI
+/****h* silcutil/SILC Buffer Format Interface
*
* DESCRIPTION
*
*/
-/****h* silcutil/SilcConfigAPI
+/****h* silcutil/SILC Config Interface
*
* DESCRIPTION
*
*/
-/****h* silcutil/SilcFileUtilAPI
+/****h* silcutil/Silc File Util Interface
*
* DESCRIPTION
*
*/
-/****h* silcutil/SilcHashTableAPI
+/****h* silcutil/SILC Hash Table Interface
*
* DESCRIPTION
*
* an extended interface where caller can specify its own hash and comparison
* functions.
*
- * There are two ways tro traverse the entire hash table if this feature
+ * There are two ways to traverse the entire hash table if this feature
* is needed. There exists a foreach function that calls a foreach
* callback for each entry in the hash table. Other way is to use
* SilcHashTableList structure and traverse the hash table inside while()
*/
-/****h* silcutil/SilcListAPI
+/****h* silcutil/SILC List Interface
*
* DESCRIPTION
*
*/
-/****h* silcutil/SilcLogAPI
+/****h* silcutil/SILC Logging Interface
*
* DESCRIPTION
*
*/
-/****h* silcutil/SilcMemoryAPI
+/****h* silcutil/SILC Memory Interface
*
* DESCRIPTION
*
*/
-/****h* silcutil/SilcMutexAPI
+/****h* silcutil/SILC Mutex Interface
*
* DESCRIPTION
*
*/
-/****h* silcutil/SilcNetAPI
+/****h* silcutil/SILC Net Interface
*
* DESCRIPTION
*
*/
-/****h* silccore/silcprotocol.h
+/****h* silccore/SILC Protocol Interface
*
* DESCRIPTION
*
*/
-/****h* silcutil/SilcScheduleAPI
+/****h* silcutil/SILC Schedule Interface
*
* DESCRIPTION
*
*/
-/****h* silcutil/SilcSocketConnectionAPI
+/****h* silcutil/SILC Socket Interface
*
* DESCRIPTION
*
*/
-/****h* silcutil/SilcThreadAPI
+/****h* silcutil/SILC Thread Interface
*
* DESCRIPTION
*
{
RB_Say ("found header [line %5d]: \"%s\"\n",
line_number, new_header->name);
+#if 0
if ((new_header->function_name
= RB_Function_Name (new_header->name)) == NULL)
+#endif
+ if ((new_header->function_name
+ = RB_Function_Name (line_buffer)) == NULL)
{
RB_Panic ("Can't determine the \"function\" name.\n");
}
skip_while (isspace (*cur_char));
if (*cur_char)
{
- char *end_char, old_char;
-
- end_char = cur_char + RB_WordLen (cur_char);
- old_char = *end_char;
- *end_char = '\0';
- cur_char = RB_StrDup (cur_char);
- *end_char = old_char;
- return (cur_char);
+ char *n;
+ int len;
+
+ if (strchr(cur_char, '\n'))
+ *strchr(cur_char, '\n') = '\0';
+
+ len = RB_WordLen(cur_char);
+
+ n = calloc(len + 1, sizeof(*cur_char));
+ strncpy(n, cur_char, len);
+ return n;
}
return (NULL);
}
}
}
- RB_Generate_Header_Start (dest_doc, cur_header);
+ RB_Generate_Header_Start (dest_doc, cur_header, src_name);
next_line = cur_header->contents;
item_type = RB_Find_Item (&next_line, &item_line);
int item_type;
char *next_line, *item_line = NULL;
- RB_Generate_Header_Start (dest_doc, cur_header);
+ RB_Generate_Header_Start (dest_doc, cur_header,
+ src_name);
next_line = cur_header->contents;
item_type = RB_Find_Item (&next_line, &item_line);
*/
void
-RB_Generate_Header_Start (FILE * dest_doc, struct RB_header *cur_header)
+RB_Generate_Header_Start (FILE * dest_doc, struct RB_header *cur_header,
+ const char *src_name)
{
char *cook_link;
"</FONT></B><BR><BR>\n\n",
cur_header->function_name,
cur_header->function_name);
+ else if (cur_header->type == MAIN_HEADER)
+ fprintf (dest_doc,
+ "\n<FONT SIZE=\"+2\" COLOR=\"#000055\"><B>"
+ "<A NAME=\"%s\">%s</A>"
+ "</FONT></B><BR><SMALL>Header: %s</SMALL><BR><BR>\n\n",
+ cur_header->function_name,
+ cur_header->function_name, src_name);
else
fprintf (dest_doc,
"\n<FONT SIZE=\"+2\" COLOR=\"#000055\"><B>"
void RB_Generate_Item_Name (FILE *, int);
void RB_Generate_Doc_Start (FILE *, char *, char *, char);
void RB_Generate_Doc_End (FILE *, char *);
-void RB_Generate_Header_Start (FILE *, struct RB_header *);
+void RB_Generate_Header_Start (FILE *, struct RB_header *, const char *);
void RB_Generate_Header_End (FILE *, struct RB_header *);
int RB_HTML_Extra (FILE * dest_doc, int item_type, char *cur_char);
void RB_Generate_Index (FILE * dest, char *name);