updated documentation

diff --git a/doc/API b/doc/API
index c3ad779bca4389c0324c6a018631103f7015c9da..dbdee81298fb4d03a450af02cd29adbbcb86d020 100644 (file)
--- a/doc/API
+++ b/doc/API
@@ -1 +1,97 @@
-This is not complete yet. Check at gnutls.h for current information.
\ No newline at end of file
+This may not be complete yet. Check at gnutls.h for current information.
+
+All functions return >=0 if everything is ok, or a negative value in case
+of a failure.
+
+int gnutls_init(GNUTLS_STATE * state, ConnectionEnd con_end);
+       This function just initializes a gnutls state to null. 
+
+int gnutls_deinit(GNUTLS_STATE * state);
+       This function clears all buffers associated with the state.
+       
+int gnutls_handshake(int cd, GNUTLS_STATE state);
+       This function does the handshake of the TLS/SSL protocol.
+       It accepts a TCP connection descriptor and a GNUTLS state.
+       This function will fail if any problem is encountered,
+       and the connection should be terminated.
+
+int gnutls_handshake_begin(int cd, GNUTLS_STATE state);
+       This function does the handshake of the TLS/SSL protocol.
+       This function will fail if any problem is encountered.
+       However this failure will not be fatal. You may choose to
+       continue the handshake - eg. even if the certificate cannot
+       be verified- by calling gnutls_handshake_finish()
+
+int gnutls_handshake_finish(int cd, GNUTLS_STATE state);
+       This function does the final stuff of the handshake protocol.
+       This function will fail if any problem is encountered.
+
+int gnutls_close(int cd, GNUTLS_STATE state);
+       Terminates the current TLS/SSL connection. If it returns 0
+       you may continue using the TCP connection.
+
+BulkCipherAlgorithm gnutls_get_current_cipher( GNUTLS_STATE state);
+       Returns the currently used cipher.
+
+MACAlgorithm gnutls_get_current_mac_algorithm( GNUTLS_STATE state);
+       Returns the mac algorithm used.
+
+CompressionMethod gnutls_get_current_compression_method( GNUTLS_STATE state);
+       Returns the compression algorithm used.
+
+int gnutls_is_fatal_error( int error);
+       If a function returns a negative value you may feed that value
+       to this function to see if it is fatal. Returns 1 for a fatal
+       error 0 otherwise.
+
+void gnutls_perror( int error);
+char* gnutls_strerror(int error);
+       These funtions are like perror() and strerror().
+       gnutls_strerror() returns a malloc'ed value thus it must be
+       freed.
+
+ssize_t gnutls_send(int cd, GNUTLS_STATE state, void* data, int sizeofdata);
+       This function has the same semantics as write() has. The only
+       difference is that is accepts a GNUTLS state.
+       
+ssize_t gnutls_recv(int cd, GNUTLS_STATE state, void* data, int sizeofdata);
+       This function has the same semantics as read() has. The only
+       difference is that is accepts a GNUTLS state.
+
+int gnutls_check_pending(GNUTLS_STATE state);
+       This function checks if there are any data to receive 
+       in the gnutls buffers. Returns the size of that data or 0.
+       Notice that you may use select to check for data in
+       the TCP connection, instead of this function.
+
+void gnutls_set_cipher_priority( GNUTLS_STATE state, int num, ...);
+       Sets the priority on the ciphers supported by gnutls. The num
+       is the number of the ciphers specified. After num you should
+       specify the ciphers you want.
+
+void gnutls_set_kx_priority( GNUTLS_STATE state, int num, ...);
+       like gnutls_set_cipher_priority, but for key exchange methods.
+
+void gnutls_set_mac_priority( GNUTLS_STATE state, int num, ...);
+       like gnutls_set_cipher_priority, but for mac algorithms.
+
+void gnutls_set_compression_priority( GNUTLS_STATE state, int num, ...);
+       like gnutls_set_cipher_priority, but for compression algorithms.
+
+void gnutls_set_current_version(GNUTLS_STATE state, GNUTLS_Version version); 
+       Sets the current SSL/TLS version. Accepted values are GNUTLS_SSL3
+       and GNUTLS_TLS1.
+
+int gnutls_get_current_session( GNUTLS_STATE state, void* session, int *session_size);
+       Returns all session parameters - in order to support resuming.
+       The client should call this - and keep the returned session - if he wants to
+       resume that current version later by calling gnutls_set_current_session().
+       This function must be called after a successful handshake.
+
+int gnutls_set_current_session( GNUTLS_STATE state, void* session, int session_size);
+       Sets all session parameters - in order to support resuming 
+       session must be the one returned by get_current_session();
+       This function should be called before gnutls_handshake_begin.
+       Keep in mind that session resuming is advisory. The server may
+       choose not to resume the session, thus a full handshake will be
+       performed.

diff --git a/doc/TODO b/doc/TODO
index 02a4a212eeab041853cc795d02fe0f4f5b23102c..b6af153a064d9ed8ffcc4873471d3e53137f14be 100644 (file)
--- a/doc/TODO
+++ b/doc/TODO
@@ -1,14 +1,6 @@
 * x509 Certificate API
 * OpenPGP certificate support (through libgcrypt)
-* Add a transparent support for multiple versions (so we can add SSL 3.0
-  and future versions of TLS or even WTLS)
 * Make server work (we need certificate API for that!)
-* Add support for v2.0 init packet
-* Resume old sessions
-* Add support for compression algorithms (zlib)
+* Add support for v2.0 init packet (why do that anyway ???)
+* Resume old sessions (server side)
 
-- functions needed:
-* gnutls_get_current_cipher();
-* gnutls_get_current_kx_method();
-* gnutls_get_current_compression_method();
-* gnutls_check_pending(); - if data exist in the buffer