libssh2/TODO

Things TODO
===========

* make sure the windowing code adapts better to slow situations so that it
  doesn't then use as much memory as today. Possibly by an app-controllable
  "Window mode"?

* Introduce a function that can free data that is returned allocated from the
  lib, like when libssh2_session_last_error() is asked to return the string
  with 'want_buf' set to non-zero.

* Add more info to the man pages.

* Decrease the number of mallocs. Everywhere.

* Use SO_NOSIGPIPE for Mac OS/BSD systems where MSG_NOSIGNAL doesn't exist/work

* Extend the test suite to actually test lots of aspects of libssh2

* Fix all compiler warnings (some can't be done without API changes)

* Expose error messages sent by the server

At next SONAME bump
===================

* stop using #defined macros as part of the official API. The macros should
  either be turned into real functions or discarded from the API.

* fix the parts of the API where object pointers and function pointers are
  mixed like libssh2_session_callback_set()

* remove the following functions from the API/ABI

  libssh2_base64_decode()
  libssh2_session_flag()
  libssh2_channel_handle_extended_data()
  libssh2_channel_receive_window_adjust()
  libssh2_poll()
  libssh2_poll_channel_read()

* Rename a few function:

  libssh2_hostkey_hash => libssh2_session_hostkey_hash
  libssh2_banner_set => libssh2_session_banner_set

* change 'int' to 'libssh2_socket_t' in the public API for sockets.

* Use 'size_t' for string lengths in all functions.

* Add a comment field to struct libssh2_knownhost.

* remove the existing libssh2_knownhost_add() function and rename
  libssh2_knownhost_addc to become the new libssh2_knownhost_add instead

* remove the existing libssh2_scp_send_ex() function and rename
  libssh2_scp_send64 to become the new libssh2_scp_send instead.

* remove the existing libssh2_knownhost_check() functin and rename
  libssh2_knownhost_checkp() to become the new libssh2_knownhost_check instead
Added 'TODO' file (again) with some fresh things I could think of right now 2008-12-26 10:54:08 +03:00			`Things TODO`
			`===========`

added two new issues to fix: socket type and better windowing * make sure the windowing code adapts better to slow situations so that it doesn't then use as much memory as today * Introduce a 'libssh2_socket_t' type for sockets in internal code 2009-07-28 01:58:06 +04:00			`* make sure the windowing code adapts better to slow situations so that it`
libssh2_socket_t is done, a library-free function is needed 2010-02-21 21:20:07 +03:00			`doesn't then use as much memory as today. Possibly by an app-controllable`
			`"Window mode"?`
added two new issues to fix: socket type and better windowing * make sure the windowing code adapts better to slow situations so that it doesn't then use as much memory as today * Introduce a 'libssh2_socket_t' type for sockets in internal code 2009-07-28 01:58:06 +04:00
libssh2_socket_t is done, a library-free function is needed 2010-02-21 21:20:07 +03:00			`* Introduce a function that can free data that is returned allocated from the`
			`lib, like when libssh2_session_last_error() is asked to return the string`
			`with 'want_buf' set to non-zero.`
added two new issues to fix: socket type and better windowing * make sure the windowing code adapts better to slow situations so that it doesn't then use as much memory as today * Introduce a 'libssh2_socket_t' type for sockets in internal code 2009-07-28 01:58:06 +04:00
edited 2009-04-15 01:43:39 +04:00			`* Add more info to the man pages.`
Added 'TODO' file (again) with some fresh things I could think of right now 2008-12-26 10:54:08 +03:00
			`* Decrease the number of mallocs. Everywhere.`

			`* Use SO_NOSIGPIPE for Mac OS/BSD systems where MSG_NOSIGNAL doesn't exist/work`

			`* Extend the test suite to actually test lots of aspects of libssh2`

edited 2009-04-15 01:43:39 +04:00			`* Fix all compiler warnings (some can't be done without API changes)`
Added 'TODO' file (again) with some fresh things I could think of right now 2008-12-26 10:54:08 +03:00
Add TODO: Expose error messages sent by the server 2009-12-24 02:11:40 +03:00			`* Expose error messages sent by the server`

Added 'TODO' file (again) with some fresh things I could think of right now 2008-12-26 10:54:08 +03:00			`At next SONAME bump`
			`===================`

I want to remove all those macros from the official API at next soname bump 2009-01-02 01:52:46 +03:00			`* stop using #defined macros as part of the official API. The macros should`
			`either be turned into real functions or discarded from the API.`

edited 2009-04-15 01:43:39 +04:00			`* fix the parts of the API where object pointers and function pointers are`
			`mixed like libssh2_session_callback_set()`

* Renamed the functions in src/transport.c to be _libssh2_transport_ prefixed and introduced a transport.h header. * Fixed the blocking mode to only change behavior not the actual underlying socket mode so we now always work with non-blocking sockets. This also introduces a new rule of thumb in libssh2 code: we don't call the external function calls internally. We use the internal (non-blocking) ones! * libssh2_channel_receive_window_adjust2 was added and libssh2_channel_receive_window_adjust is now deprecated * Introduced "local" header files with prototypes etc for different parts instead of cramming everything into libssh2_priv.h. channel.h is the first. 2009-03-26 18:41:14 +03:00			`* remove the following functions from the API/ABI`
one function to remove, one proto to correct 2009-03-23 16:54:16 +03:00
			`libssh2_base64_decode()`
			`libssh2_session_flag()`
* Renamed the functions in src/transport.c to be _libssh2_transport_ prefixed and introduced a transport.h header. * Fixed the blocking mode to only change behavior not the actual underlying socket mode so we now always work with non-blocking sockets. This also introduces a new rule of thumb in libssh2 code: we don't call the external function calls internally. We use the internal (non-blocking) ones! * libssh2_channel_receive_window_adjust2 was added and libssh2_channel_receive_window_adjust is now deprecated * Introduced "local" header files with prototypes etc for different parts instead of cramming everything into libssh2_priv.h. channel.h is the first. 2009-03-26 18:41:14 +03:00			`libssh2_channel_handle_extended_data()`
			`libssh2_channel_receive_window_adjust()`
libssh2_poll() and libssh2_poll_channel_read() are now considered and documented deprecated and they will be removed at next soname bump. It also saves us from fixing some rather quirky bugs in libssh2_poll()... 2009-04-15 01:38:36 +04:00			`libssh2_poll()`
			`libssh2_poll_channel_read()`
My knownhost work as of right now. It works at least partly. More tests and tweaks will come. 2009-05-07 17:09:48 +04:00
			`* Rename a few function:`

			`libssh2_hostkey_hash => libssh2_session_hostkey_hash`
change 'int' to 'libssh2_socket_t' in the public API for sockets 2010-03-06 21:51:37 +03:00			`libssh2_banner_set => libssh2_session_banner_set`

			`* change 'int' to 'libssh2_socket_t' in the public API for sockets.`
Add. 2010-03-10 20:50:29 +03:00
			`* Use 'size_t' for string lengths in all functions.`
Add libssh2_knownhost_addc to handle comments. Comments in known_hosts file were not handle properly. They were parsed as part of the key causing key matching to return a mismatch if the entry had a comment. This adds a new API function that takes an optional comment and changes libssh2_knownhost_readline to parse the comment as pass it to the new function. Fixes #164. 2010-03-14 22:52:00 +03:00
			`* Add a comment field to struct libssh2_knownhost.`
at next soname bump remove libssh2_knownhost_add() 2010-03-24 17:39:13 +03:00
			`* remove the existing libssh2_knownhost_add() function and rename`
			`libssh2_knownhost_addc to become the new libssh2_knownhost_add instead`
libssh2_scp_send64: added to API to provide large file transfers The previously existing libssh2_scp_send_ex() function has no way to send files that are larger than 'size_t' which on 32bit systems mean 4GB. This new API uses a libssh2_int64_t type and should thus on most modern systems be able to send enormous files. 2010-04-17 21:47:50 +04:00
			`* remove the existing libssh2_scp_send_ex() function and rename`
			`libssh2_scp_send64 to become the new libssh2_scp_send instead.`
knownhost: support [host]:port in knownhost file OpenSSH has ways to add hosts to the knownhosts file that include a specific port number which makes the key associated with only that specific host+port pair. libssh2 previously did not support this, and I was forced to add a new function to the API to properly expose this ability to applications: libssh2_knownhost_checkp() To add such hosts to the knownhosts file, you make sure to pass on the host name in that manner to the libssh2_knownhost_addc() function. 2010-05-02 18:56:31 +04:00
			`* remove the existing libssh2_knownhost_check() functin and rename`
			`libssh2_knownhost_checkp() to become the new libssh2_knownhost_check instead`