--- /dev/null
+
+<html>
+<head>
+ <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-a" />
+ <meta http-equiv="Content-Language" content="en" />
+ <meta name="description" content="SILC Secure Internet Live Conferencing" />
+ <meta name="keywords" content="SILC, secure, chat, protocol, cipher, encrypt, SKE" />
+ <meta content="INDEX, FOLLOW" name="ROBOTS" />
+ <style type="text/css">
+ <!--
+ body { color: #000000; background: #f0f0f0; font-family: Helvetica, Arial, Sans-serif; }
+ a:link { text-decoration: none; color: #2f488f; }
+ a:visited { text-decoration: none;color: #2f488f; }
+ a:active { text-decoration: none; color: #2f488f; }
+ -->
+ </style>
+</head>
+
+<body topmargin="0" leftmargin="0" marginheight="0" marginwidth="0">
+
+<table border="0" cellspacing="0" cellpadding="6" width="100%">
+ <tr valign="top" bgcolor="#dddddd">
+ <td><small>Copyright © 2001 - 2007 SILC Project<br />
+ <a href="http://silcnet.org">SILC Project Website</a></small></td>
+ <td align="right"><small>
+ <a href="index.html">SILC Toolkit Reference Manual</a><br />
+ <a href="toolkit_index.html">Index</a></small></td>
+ </small></td>
+ </tr>
+</table>
+<table border="0" cellspacing="0" cellpadding="0" width="100%">
+<tr bgcolor="#444444"><td><img src="space.gif" width="1" height="1"border="0" alt="" ></td></tr>
+</table>
+
+<table cellpadding="0" cellspacing="0" border="0">
+ <tr valign="top">
+
+ <td width="200" bgcolor="#f0f0f0">
+ <img src="space.gif" width="1" height="1" border="0" alt="">
+ <table width="100%" cellpadding="2" cellspacing="2" border="0">
+ <tr valign="top"><td>
+<br />
+<small>
+<!-- Template file for the big index that appears in the Toolkit reference
+manual on the left side. With this file it is possible to add other than
+automatically generated links to that list. -->
+
+<a href="index.html"><img src="box.gif" border="0" alt="">SILC Toolkit Reference Manual</a><br />
+
+
+<a href=silccryptlib.html><img src=box.gif border=0 alt=>SILC Crypto Library</a><br />
+ <a href=silcrng_intro.html><img src=box2.gif border=0 alt=>Introduction to SILC RNG</a><br />
+ <a href=silcrng.html><img src=box2.gif border=0 alt=>SILC RNG Interface</a><br />
+ <a href=silccipher.html><img src=box2.gif border=0 alt=>SILC Cipher API</a><br />
+ <a href=silcpkcs.html><img src=box2.gif border=0 alt=>SILC PKCS API</a><br />
+ <a href=silcpk.html><img src=box2.gif border=0 alt=>SILC Public Key API</a><br />
+ <a href=silcpkcs1.html><img src=box2.gif border=0 alt=>SILC PKCS #1 API</a><br />
+ <a href=silchash.html><img src=box2.gif border=0 alt=>SILC Hash Interface</a><br />
+ <a href=silchmac.html><img src=box2.gif border=0 alt=>SILC HMAC Interface</a><br />
+<a href=silccorelib.html><img src=box.gif border=0 alt=>SILC Core Library</a><br />
+ <a href=silcauth.html><img src=box2.gif border=0 alt=>SILC Authentication Interface</a><br />
+ <a href=silcmessage.html><img src=box2.gif border=0 alt=>SILC Message Interface</a><br />
+ <a href=silcchannel.html><img src=box2.gif border=0 alt=>SILC Channel Interface</a><br />
+ <a href=silccommand.html><img src=box2.gif border=0 alt=>SILC Command Interface</a><br />
+ <a href=silcnotify.html><img src=box2.gif border=0 alt=>SILC Notify Interface</a><br />
+ <a href=silcstatus.html><img src=box2.gif border=0 alt=>SILC Status Types</a><br />
+ <a href=silcmode.html><img src=box2.gif border=0 alt=>SILC Modes</a><br />
+ <a href=silcid.html><img src=box2.gif border=0 alt=>SILC ID Interface</a><br />
+ <a href=silcargument.html><img src=box2.gif border=0 alt=>SILC Argument Interface</a><br />
+ <a href=silcattrs.html><img src=box2.gif border=0 alt=>SILC Attributes Interface</a><br />
+ <a href=silcpacket.html><img src=box2.gif border=0 alt=>Packet Engine Interface</a><br />
+ <a href=silcpubkey.html><img src=box2.gif border=0 alt=>SILC Public Key Payload Interface</a><br />
+<a href=silcskelib.html><img src=box.gif border=0 alt=>SILC Key Exchange Library</a><br />
+ <a href=silcske.html><img src=box2.gif border=0 alt=>SILC SKE Interface</a><br />
+ <a href=silcconnauth.html><img src=box2.gif border=0 alt=>SILC Connection Authentication Interface</a><br />
+<a href=silcvcardlib.html><img src=box.gif border=0 alt=>SILC VCard Library</a><br />
+ <a href=silcvcard.html><img src=box2.gif border=0 alt=>SILC VCard Interface</a><br />
+<a href=silcmathlib.html><img src=box.gif border=0 alt=>SILC Math Library</a><br />
+ <a href=silcmp.html><img src=box2.gif border=0 alt=>SILC MP Interface</a><br />
+ <a href=silcmath.html><img src=box2.gif border=0 alt=>SILC Math Interface</a><br />
+<a href=silcclientlib.html><img src=box.gif border=0 alt=>SILC Client Library</a><br />
+ <a href=silcclient_using.html><img src=box2.gif border=0 alt=>Using SILC Client Library Tutorial</a><br />
+ <a href=command_reply_args.html><img src=box2.gif border=0 alt=>Arguments for <b>command_reply</b> Client Operation</a><br />
+ <a href=silcstatus_args.html><img src=box2.gif border=0 alt=>SilcStatus Error Arguments in <b>command_reply</b> Client Operation</a><br />
+ <a href=notifyargs.html><img src=box2.gif border=0 alt=>Arguments for <b>notify</b> Client Operation</a><br />
+ <a href=silcclient_unicode.html><img src=box2.gif border=0 alt=>Unicode and UTF-8 Strings in Client Library</a><br />
+ <a href=silcclient.html><img src=box2.gif border=0 alt=>Client Library Interface Reference</a><br />
+ <a href=silcclient_entry.html><img src=box2.gif border=0 alt=>Client Entry Interface Reference</a><br />
+<a href=silcasn1lib.html><img src=box.gif border=0 alt=>SILC ASN.1 Library</a><br />
+ <a href=silcasn1.html><img src=box2.gif border=0 alt=>SILC ASN.1 Interface</a><br />
+ <a href=silcber.html><img src=box2.gif border=0 alt=>SILC BER interface</a><br />
+<a href=silchttplib.html><img src=box.gif border=0 alt=>SILC HTTP Library</a><br />
+ <a href=silchttpserver.html><img src=box2.gif border=0 alt=>SILC HTTP Server Interface</a><br />
+ <a href=silchttpphp.html><img src=box2.gif border=0 alt=>SILC HTTP PHP Translator</a><br />
+<a href=silcutillib.html><img src=box.gif border=0 alt=>SILC Utility Library</a><br />
+ <a href=silctypes.html><img src=box2.gif border=0 alt=>Basic Types and Definitions</a><br />
+ <a href=silcbuffer.html><img src=box2.gif border=0 alt=>Data Buffer Interface</a><br />
+ <a href=silcbuffmt.html><img src=box2.gif border=0 alt=>Data Buffer Format Interface</a><br />
+ <a href=silchashtable.html><img src=box2.gif border=0 alt=>Hash Table Interface</a><br />
+ <a href=silcmemory.html><img src=box2.gif border=0 alt=>Memory Allocation Interface</a><br />
+ <a href=silcstack.html><img src=box2.gif border=0 alt=>Data Stack (memory pool) Interface</a><br />
+ <a href=silcfsm.html><img src=box2.gif border=0 alt=>Finite State Machine Interface</a><br />
+ <a href=silcthread.html><img src=box2.gif border=0 alt=>Thread Interface</a><br />
+ <a href=silcmutex.html><img src=box2.gif border=0 alt=>Mutual Exclusion Lock Interface</a><br />
+ <a href=silccond.html><img src=box2.gif border=0 alt=>Condition Variable Interface</a><br />
+ <a href=silcatomic.html><img src=box2.gif border=0 alt=>Atomic Operations Interface</a><br />
+ <a href=silcnet.html><img src=box2.gif border=0 alt=>Network (TCP and UDP) Interface</a><br />
+ <a href=silcschedule.html><img src=box2.gif border=0 alt=>Scheduler Interface</a><br />
+ <a href=silcasync.html><img src=box2.gif border=0 alt=>Asynchronous Operation Interface</a><br />
+ <a href=silcstream.html><img src=box2.gif border=0 alt=>Abstract Stream Interface</a><br />
+ <a href=silcsocketstream.html><img src=box2.gif border=0 alt=>Socket Stream Interface</a><br />
+ <a href=silcfdstream.html><img src=box2.gif border=0 alt=>File Descriptor Stream Interface</a><br />
+ <a href=silcfileutil.html><img src=box2.gif border=0 alt=>File Utility Functions</a><br />
+ <a href=silcstrutil.html><img src=box2.gif border=0 alt=>String Utility Interface</a><br />
+ <a href=silcsnprintf.html><img src=box2.gif border=0 alt=>Snprintf Interface</a><br />
+ <a href=silcutf8.html><img src=box2.gif border=0 alt=>UTF-8 String Interface</a><br />
+ <a href=silcstringprep.html><img src=box2.gif border=0 alt=>Stringprep Interface</a><br />
+ <a href=silcutil.html><img src=box2.gif border=0 alt=>Utility Functions</a><br />
+ <a href=silclist.html><img src=box2.gif border=0 alt=>List Interface</a><br />
+ <a href=silcdlist.html><img src=box2.gif border=0 alt=>Dynamic List Interface</a><br />
+ <a href=silcmime.html><img src=box2.gif border=0 alt=>MIME Interface</a><br />
+ <a href=silctime.html><img src=box2.gif border=0 alt=>Time Utility Functions</a><br />
+ <a href=silclog.html><img src=box2.gif border=0 alt=>Logging Interface</a><br />
+ <a href=silcconfig.html><img src=box2.gif border=0 alt=>Config File Interface</a><br />
+<a href=silcskrlib.html><img src=box.gif border=0 alt=>SILC Key Repository Library</a><br />
+ <a href=silcskr.html><img src=box2.gif border=0 alt=>SILC SKR Interface</a><br />
+<a href=silcaputillib.html><img src=box.gif border=0 alt=>SILC Application Utility Library</a><br />
+ <a href=silcapputil.html><img src=box2.gif border=0 alt=>SILC Application Utilities</a><br />
+ <a href=silcidcache.html><img src=box2.gif border=0 alt=>SILC ID Cache Interface</a><br />
+<a href=silcsftplib.html><img src=box.gif border=0 alt=>SILC SFTP Library</a><br />
+ <a href=silcsftp.html><img src=box2.gif border=0 alt=>SILC SFTP Interface</a><br />
+ <a href=silcsftp_fs.html><img src=box2.gif border=0 alt=>SFTP Filesystems Interface</a><br />
+
+<br />
+<b>Resource Links</b>
+<br />
+<a href="http://silcnet.org"><img src="box.gif" border="0" alt="">SILC Project Website</a><br />
+<a href="http://silcnet.org/support/documentation/"><img src="box.gif" border="0" alt="">SILC Protocol Documentation</a><br />
+<a href="http://silcnet.org/support/documentation/wp/"><img src="box.gif" border="0" alt="">SILC White Paper</a><br />
+<a href="http://silcnet.org/support/faq/"><img src="box.gif" border="0" alt="">SILC FAQs</a><br />
+
+</small>
+<br /><br /><br /><br />
+ </td></tr>
+ </table>
+ </td>
+
+ <td bgcolor="#cccccc" background="dot.gif">
+ <img src="space.gif" width="1" height="1" border="0" alt=""></td>
+
+ <td width="720" bgcolor="#ffffff">
+ <img src="space.gif" width="1" height="1" border="0" alt="">
+ <table cellpadding="2" cellspacing="6" width="100%">
+ <tr><td valign="top">
+<br />
+<big><b>Using SILC Client Library</b></big>
+
+<br /> <br /> <br />
+<b>Introduction</b>
+
+<br /> <br />
+SILC Client library is a full featured SILC Client protocol implementation.
+The library has been designed to be complete SILC client without actual
+user interface. The library provides the API for the appliation which
+it can use to implement generally whatever user interface it wants. The
+SILC Client Library recides in the lib/silcclient/ directory. It uses
+common and core component of SILC protocol from the lib/silccore, SKE
+from lib/silcske and general utility routines from lib/silcutil.
+
+<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
+interface routines in the functions and display the data whatever way
+it wants. The library is entirely transparent to the user interface and
+it does not include any user interface specific issues such as window
+handling or item handling on the screen etc. These does not interest
+the library. The `silcclient.h' and `silcclient_entry.h' also defines the
+client libary interface the application can call. The interface includes
+for example functions for sending channel and private messages, client and
+channel retrieval and other utility functions.
+
+<br /> <br /> <br />
+<b>Including Library Headers</b>
+
+<br /> <br />
+Your application must include the following includes in your sources to
+get access all SILC Client Library routines:
+
+<br /> <br />
+<tt>
+#include "silc.h"<br />
+#include "silcclient.h"
+</tt>
+
+
+<br /> <br /> <br />
+<b>Creating Client</b>
+
+<br /> <br />
+The client is context or entity based, so several client entitites can
+be created in the application if needed. However, it should be noted
+that they are completely independent from each other and can be seen
+as different applications. Usually only one client entity is needed
+per application.
+
+<br /> <br />
+The client object is SilcClient which is usually allocated in following
+manner:
+
+<br /> <br />
+<tt> SilcClient client = silc_client_alloc(&ops, params, context, NULL);</tt>
+
+<br /> <br />
+`ops' is the static structure of client operations that library will call.
+`context' can be some application specific context that will be saved into
+the SilcClient object. It is up to the caller to free this context.
+SilcClient is always passed to the application thus the application
+specific context can be retrieved from the SilcClient object.
+
+<br /> <br />
+`ops' can be defined for example as follows:
+
+<br /> <br />
+<tt>
+SilcClientOperations ops = {<br />
+ silc_say,<br />
+ silc_channel_message,<br />
+ silc_private_message,<br />
+ silc_notify,<br />
+ silc_command,<br />
+ silc_command_reply,<br />
+ silc_get_auth_method,<br />
+ silc_verify_public_key,<br />
+ silc_ask_passphrase,<br />
+ silc_key_agreement,<br />
+ silc_file_transfer,<br />
+};<br />
+</tt>
+
+<br /> <br />
+Please see the `client_ops_example.c' source file in lib/silcclient/
+directory for predefined structure and stub functions for your
+convenience. It is provided for programmers so that they can copy
+it and use it directly in their application.
+
+
+<br /> <br /> <br />
+<b>Initializing the Client</b>
+
+<br /> <br />
+The client must be initialized before running. The client is initialized
+simply by calling silc_client_init function:
+
+<br /> <br />
+<tt> silc_client_init(client, username, hostname, realname,
+ foo_client_running, foo_ctx);</tt>
+
+<br /> <br />
+which then initializes the client library for the `client'. The `username'
+and `hostname' pointers are required. The `foo_client_running' with
+`foo_ctx' in this example will be called by the client library after the
+client is up and running. After you receive this callback you may start
+using other API functions, such as creating connection to remote server.
+
+
+<br /> <br /> <br />
+<b>Running the Client</b>
+
+<br /> <br />
+The client is run by calling silc_client_run. The function will call
+the scheduler from utility library that will be run until the program is
+ended. When silc_client_run returns the application is ended. Thus,
+to run the client, call:
+
+<br /> <br />
+<tt> silc_client_run(client);</tt>
+
+<br /> <br />
+Usually application may do some other initializations before calling
+this function. For example before calling this function application
+should initialize the user interface.
+
+
+<br /> <br /> <br />
+<b>Running the Client in GUI application</b>
+
+<br /> <br />
+Many GUI applications has their own main loop or event loop, which they
+would like to use or are forced to use by the underlaying system. If you
+are developing for example GUI application on Unix system, and you are
+using GTK+ or QT as GUI library you would probably like to use their own
+main loop. SILC Client can be run under external main loop as well. The
+interface provides a function silc_client_run_one which will run the
+client library once, and returns immediately. During that running it can
+process incoming data and send outgoing data, but it is guaranteed that it
+will not block the calling process.
+
+<br /> <br />
+It is suggested that you would call this function as many times in a
+second as possible to provide smooth action for the client library. You
+can use an timeout task, or an idle task provided by your GUI library to
+accomplish this. After you have initialized the client library with
+silc_client_init, you should register the timeout task or idle task that
+will call the silc_client_run_one periodically.
+
+<br /> <br />
+For Win32 the silc_client_run can be used instead of using the Windows's
+own event loop. However, if you would like to use the silc_client_run_one
+also on Win32 system it is possible.
+
+
+<br /> <br /> <br />
+<b>Running Client in GTK--</b>
+
+<br /> <br />
+Here is a short example how to run the SILC Client libary under the
+Gnome/GTK--'s main loop:
+
+<br /> <br />
+<tt>
+gint YourClass::silc_scheduler()<br />
+{<br />
+ // Run the SILC client once, and return immediately. This function<br />
+ // is called every 50 milliseconds by the Gnome main loop, to process<br />
+ // SILC stuff. This function will read data, and write data to network,<br />
+ // etc. Makes the client library tick! :)<br />
+ silc_client_run_one(silc_client);<br />
+ return 1;<br />
+}<br />
+</tt>
+
+<br /> <br />
+then, during initialization of the SILC Client call:
+
+<br /> <br />
+<tt>
+// Setup SILC scheduler as timeout task. This will handle the SILC<br />
+// client library every 50 milliseconds. It will actually make the<br />
+// SILC client work on background.<br />
+Gnome::Main::timeout.connect(slot(this, &YourClass::silc_scheduler), 50);<br />
+</tt>
+
+<br /> <br />
+This will call the function silc_scheduler every 50 millisecconds, which
+on the otherhand will call silc_client_run_one, which will make the SILC
+Client library work on the background of the GUI application.
+
+
+<br /> <br /> <br />
+<b>Creating Connection to Server</b>
+
+<br /> <br />
+After your client is up and running you may create connection to remote
+SILC server. It is done simply by calling:
+
+<br /> <br />
+<tt> silc_client_connect_to_server(client, ¶ms,
+ public_key, private_key,
+ remote_host, remote_port,
+ foo_connected_cb, foo_ctx);</tt>
+
+<br /> <br />
+The function will create the connection asynchronously to the server, ie.
+the function will return before the actual connection is created. The
+`foo_connected_cb' will be called once the connection has been established.
+The `params' may be NULL but it may be used to provide additional parameters
+to the connecting. For example it is possible to set the initial nickname
+you would like to use into the `params'.
+
+
+<br /> <br /> <br />
+<b>Debugging</b>
+
+<br /> <br />
+Being able to debug what you have coded is important when troubles occurs
+during coding, and they always do. SILC supports extensive debugging
+capabilities which are also available for client library user. You should
+have compiled the Toolkit with --enable-debug option so that run-time
+debugging is enabled.
+
+<br /> <br />
+Then, to say in your application you would like to use the debugging use
+the SILC_DEBUG macro. Put this macro to your main header file, or
+some other file that needs the debugging enabled. After using this macro
+you are able to use the debugging routines provided by the SILC Toolkit.
+Note that, the Toolkit library must be compiled with --enable-debug for
+this macro to have any effect.
+
+<br /> <br />
+To turn on the run-time debugging call function silc_log_debug with TRUE
+value. To see packet hexdumps you can call also silc_log_debug_hexdump
+with TRUE value. Hexdumps can create more debug log so not setting it
+to TRUE by default is probably best. To get debug messages out of specific
+modules you can set a debug string with silc_log_set_debug_string function.
+The function takes regex string as argument, for example:
+
+<br /> <br />
+<tt>
+ silc_log_debug(TRUE);<br />
+ silc_log_set_debug_string("*");<br />
+</tt>
+
+<br /> <br />
+This piece of code turns on the debugging and sets "*" as debug string. This
+means that all debug messages are printed. To get debugging out of only
+for example SILC Client Library the debug string could be "silc_client*".
+The debug string matches to function names and filenames so it is possible
+to get debugging out of specific files, and specific functions. Other
+examples could be:
+
+<br /> <br />
+<tt>
+ silc_log_set_debug_string("silc_client*,*sock*,*ske*");<br />
+</tt>
+
+<br /> <br />
+By default, all debug messages are printed to standard error output (stderr).
+If you want to redirect the debug messages somewhere else you can set your
+own debug callback with silc_log_set_debug_callbacks function:
+
+<br /> <br />
+<tt>
+ silc_log_set_debug_callbacks(my_debug_callback, my_context, my_hexdump_callback, my_context);<br />
+</tt>
+
+<br /> <br />
+See the lib/silcutil/silclog.h for definition of the callbacks. See the
+same file for other logging and debugging information.
+
+<br /> <br />
+You can also use SILC debugging capabilities in your own application. To
+produce debug messages you can use SILC_LOG_DEBUG and SILC_LOG_HEXDUMP
+macros in your application. The SILC_LOG_DEBUG can print out normal debug
+messages with variable argument list, for example:
+
+<br /> <br />
+<tt>
+ SILC_LOG_DEBUG(("Start"));<br />
+ SILC_LOG_DEBUG(("Packet length %d", packet_len));<br />
+ SILC_LOG_DEBUG(("The remote is %s on %d", sock->ip, sock->port));
+</tt>
+
+<br /> <br />
+The SILC_LOG_HEXDUMP macro can be used dump data which couldn't be printed
+out otherwise, for example binary data.
+
+<br /> <br />
+<tt>
+ SILC_LOG_HEXDUMP(("Packet"), packet->data, packet->len);<br />
+ SILC_LOG_HEXDUMP(("Packet, size=%d", size), packet->data, packet->len);
+</tt>
+
+<br /> <br />
+Note that the variable arguments in SILC_LOG_HEXDUMP are before the second
+last parenthesis, and the last two arguments are the data, and its length that
+are hexdumped.
+<br /><br /><br /><br />
+ </td></tr>
+ </table>
+ </td>
+
+ <td bgcolor="#cccccc" background="dot.gif">
+ <img src="space.gif" width="1" height="1" border="0" alt=""></td>
+
+ <td width="180" bgcolor="#f0f0f0">
+ <img src="space.gif" width="1" height="1" border="0" alt="">
+ <table width="100%" cellpadding="4" cellspacing="0">
+ <tr valign="top"><td>
+<br />
+<font face="Helvetica,Arial,Sans-serif" size="1">
+</font>
+
+<br /><br /><br /><br />
+ </td></tr>
+ </table>
+ </td>
+</tr>
+</table>
+
+<table border="0" cellspacing="0" cellpadding="0" width="100%">
+<tr bgcolor="#444444"><td><img src="space.gif" width="1" height="1"border="0" alt="" ></td></tr>
+</table>
+<table border="0" cellspacing="0" cellpadding="6" width="100%">
+ <tr valign="top" bgcolor="#dddddd">
+ <td><small>Copyright © 2001 - 2007 SILC Project<br />
+ <a href="http://silcnet.org">SILC Project Website</a></small></td>
+ <td align="right"><small>
+ <a href="index.html">SILC Toolkit Reference Manual</a><br />
+ <a href="toolkit_index.html">Index</a></small></td>
+ </small></td>
+ </tr>
+</table>
+
+</body>
+</html>
projects / website.git / blobdiff