Commit 530675a1 authored by Steve Holme's avatar Steve Holme
Browse files

DOCS: Added IMAP and LDAP sections 

Added new sections 11. IMAP and 12. LDAP to document adding SASL based
authentication.

Renumbered current sections 11 to 17 as 13 to 19.

Additionally added 19.10 Add CURLOPT_MAIL_CLIENT option.
parent 273e9afc

docs/TODO

+120 −84
Original line number Diff line number Diff line
@@ -69,49 +69,56 @@ 
 

 10. POP3

 10.1 APOP Authentication

 10.2 Other authentication mechanisms

 10.2 SASL based authentication mechanisms

 10.3 auth= in URLs

 

 11. Other protocols



 12. New protocols

 12.1 RSYNC



 13. Client

 13.1 sync

 13.2 glob posts

 13.3 prevent file overwriting

 13.4 simultaneous parallel transfers

 13.5 provide formpost headers

 13.6 url-specific options

 13.7 metalink support

 13.8 warning when setting an option

 13.9 IPv6 addresses with globbing



 14. Build

 14.1 roffit



 15. Test suite

 15.1 SSL tunnel

 15.2 nicer lacking perl message

 15.3 more protocols supported

 15.4 more platforms supported



 16. Next SONAME bump

 16.1 http-style HEAD output for ftp

 16.2 combine error codes

 16.3 extend CURLOPT_SOCKOPTFUNCTION prototype



 17. Next major release

 17.1 cleanup return codes

 17.2 remove obsolete defines

 17.3 size_t

 17.4 remove several functions

 17.5 remove CURLOPT_FAILONERROR

 17.6 remove CURLOPT_DNS_USE_GLOBAL_CACHE

 17.7 remove progress meter from libcurl

 17.8 remove 'curl_httppost' from public

 17.9 have form functions use CURL handle argument

 11. IMAP

 11.1 SASL based authentication mechanisms

 

 12. LDAP

 12.1 SASL based authentication mechanisms

 

 13. Other protocols



 14. New protocols

 14.1 RSYNC



 15. Client

 15.1 sync

 15.2 glob posts

 15.3 prevent file overwriting

 15.4 simultaneous parallel transfers

 15.5 provide formpost headers

 15.6 url-specific options

 15.7 metalink support

 15.8 warning when setting an option

 15.9 IPv6 addresses with globbing



 16. Build

 16.1 roffit



 17. Test suite

 17.1 SSL tunnel

 17.2 nicer lacking perl message

 17.3 more protocols supported

 17.4 more platforms supported



 18. Next SONAME bump

 18.1 http-style HEAD output for ftp

 18.2 combine error codes

 186.3 extend CURLOPT_SOCKOPTFUNCTION prototype



 19. Next major release

 19.1 cleanup return codes

 19.2 remove obsolete defines

 19.3 size_t

 19.4 remove several functions

 19.5 remove CURLOPT_FAILONERROR

 19.6 remove CURLOPT_DNS_USE_GLOBAL_CACHE

 19.7 remove progress meter from libcurl

 19.8 remove 'curl_httppost' from public

 19.9 have form functions use CURL handle argument

 19.10 Add CURLOPT_MAIL_CLIENT option



==============================================================================
@@ -405,7 +412,7 @@ to provide the data to send. 
 is specified as "APOP <username> <md5 password>", however, it isn't

 supported by all mail servers.



10.2 Other authentication mechanisms

10.2 SASL authentication mechanisms



 SASL offers support for additional authentication mechanisms via the AUTH

 command. Detection of an email server's support for SASL authentication
@@ -414,21 +421,39 @@ to provide the data to send. 


10.3 auth= in URLs



 Being able to specify the preferred authentication mechanim in the URL as

 per RFC-2384 (http://tools.ietf.org/html/rfc2384).

 Being able to specify the preferred authentication mechanism in the URL as

 per RFC2384.



11. Other protocols

11. IMAP



12. New protocols

11.1 SASL based authentication mechanisms



12.1 RSYNC

 Like POP3 curl currently sends usernames and passwords as clear text.

 Support should also be added to support SASL based authentication mechanisms

 as these are more secure.



12. LDAP



12.1 SASL based authentication mechansims



 Currently the LDAP module only supports ldap_simple_bind_s() in order to bind

 to an LDAP server. However, this function sends username and password details

 using the simple authentication mechanism (as clear text). However, it should

 be possible to use ldap_bind_s() instead specifing the security context

 information ourselves.



13. Other protocols



14. New protocols



14.1 RSYNC



 There's no RFC for the protocol or an URI/URL format.  An implementation

 should most probably use an existing rsync library, such as librsync.



13. Client

15. Client



13.1 sync

15.1 sync



 "curl --sync http://example.com/feed[1-100].rss" or

 "curl --sync http://example.net/{index,calendar,history}.html"
@@ -437,12 +462,12 @@ to provide the data to send. 
 remote file is newer than the local file. A Last-Modified HTTP date header

 should also be used to set the mod date on the downloaded file.



13.2 glob posts

15.2 glob posts



 Globbing support for -d and -F, as in 'curl -d "name=foo[0-9]" URL'.

 This is easily scripted though.



13.3 prevent file overwriting

15.3 prevent file overwriting



 Add an option that prevents cURL from overwriting existing local files. When

 used, and there already is an existing file with the target file name
@@ -450,14 +475,14 @@ to provide the data to send. 
 existing). So that index.html becomes first index.html.1 and then

 index.html.2 etc.



13.4 simultaneous parallel transfers

15.4 simultaneous parallel transfers



 The client could be told to use maximum N simultaneous parallel transfers and

 then just make sure that happens. It should of course not make more than one

 connection to the same remote host. This would require the client to use the

 multi interface. http://curl.haxx.se/bug/feature.cgi?id=1558595



13.5 provide formpost headers

15.5 provide formpost headers



 Extending the capabilities of the multipart formposting. How about leaving

 the ';type=foo' syntax as it is and adding an extra tag (headers) which
@@ -471,7 +496,7 @@ to provide the data to send. 
 which should overwrite the program reasonable defaults (plain/text,

 8bit...)



13.6 url-specific options

15.6 url-specific options



 Provide a way to make options bound to a specific URL among several on the

 command line. Possibly by letting ':' separate options between URLs,
@@ -485,62 +510,62 @@ to provide the data to send. 


 The example would do a POST-GET-POST combination on a single command line.



13.7 metalink support

15.7 metalink support



 Add metalink support to curl (http://www.metalinker.org/). This is most useful

 with simultaneous parallel transfers (11.6) but not necessary.



13.8 warning when setting an option

15.8 warning when setting an option



  Display a warning when libcurl returns an error when setting an option.

  This can be useful to tell when support for a particular feature hasn't been

  compiled into the library.



13.9 IPv6 addresses with globbing

15.9 IPv6 addresses with globbing



  Currently the command line client needs to get url globbing disabled (with

  -g) for it to support IPv6 numerical addresses. This is a rather silly flaw

  that should be corrected. It probably involves a smarter detection of the

  '[' and ']' letters.



14. Build

16. Build



14.1 roffit

16.1 roffit



 Consider extending 'roffit' to produce decent ASCII output, and use that

 instead of (g)nroff when building src/hugehelp.c



15. Test suite

17. Test suite



15.1 SSL tunnel

17.1 SSL tunnel



 Make our own version of stunnel for simple port forwarding to enable HTTPS

 and FTP-SSL tests without the stunnel dependency, and it could allow us to

 provide test tools built with either OpenSSL or GnuTLS



15.2 nicer lacking perl message

17.2 nicer lacking perl message



 If perl wasn't found by the configure script, don't attempt to run the tests

 but explain something nice why it doesn't.



15.3 more protocols supported

17.3 more protocols supported



 Extend the test suite to include more protocols. The telnet could just do ftp

 or http operations (for which we have test servers).



15.4 more platforms supported

17.4 more platforms supported



 Make the test suite work on more platforms. OpenBSD and Mac OS. Remove

 fork()s and it should become even more portable.



16. Next SONAME bump

18. Next SONAME bump



16.1 http-style HEAD output for ftp

18.1 http-style HEAD output for ftp



 #undef CURL_FTP_HTTPSTYLE_HEAD in lib/ftp.c to remove the HTTP-style headers

 from being output in NOBODY requests over ftp



16.2 combine error codes

18.2 combine error codes



 Combine some of the error codes to remove duplicates.  The original

 numbering should not be changed, and the old identifiers would be
@@ -558,29 +583,29 @@ to provide the data to send. 
    CURLE_TFTP_NOTFOUND => CURLE_REMOTE_FILE_NOT_FOUND

    CURLE_TFTP_PERM => CURLE_REMOTE_ACCESS_DENIED



16.3 extend CURLOPT_SOCKOPTFUNCTION prototype

18.3 extend CURLOPT_SOCKOPTFUNCTION prototype



 The current prototype only provides 'purpose' that tells what the

 connection/socket is for, but not any protocol or similar. It makes it hard

 for applications to differentiate on TCP vs UDP and even HTTP vs FTP and

 similar.



17. Next major release

18. Next major release



17.1 cleanup return codes

19.1 cleanup return codes



 curl_easy_cleanup() returns void, but curl_multi_cleanup() returns a

 CURLMcode. These should be changed to be the same.



17.2 remove obsolete defines

19.2 remove obsolete defines



 remove obsolete defines from curl/curl.h



17.3 size_t

19.3 size_t



 make several functions use size_t instead of int in their APIs



17.4 remove several functions

19.4 remove several functions



 remove the following functions from the public API:
@@ -601,18 +626,18 @@ to provide the data to send. 


 curl_multi_socket_all



17.5 remove CURLOPT_FAILONERROR

19.5 remove CURLOPT_FAILONERROR



 Remove support for CURLOPT_FAILONERROR, it has gotten too kludgy and weird

 internally. Let the app judge success or not for itself.



17.6 remove CURLOPT_DNS_USE_GLOBAL_CACHE

19.6 remove CURLOPT_DNS_USE_GLOBAL_CACHE



 Remove support for a global DNS cache. Anything global is silly, and we

 already offer the share interface for the same functionality but done

 "right".



17.7 remove progress meter from libcurl

19.7 remove progress meter from libcurl



 The internally provided progress meter output doesn't belong in the library.

 Basically no application wants it (apart from curl) but instead applications
@@ -622,7 +647,7 @@ to provide the data to send. 
 variable types passed to it instead of doubles so that big files work

 correctly.



17.8 remove 'curl_httppost' from public

19.8 remove 'curl_httppost' from public



 curl_formadd() was made to fill in a public struct, but the fact that the

 struct is public is never really used by application for their own advantage
@@ -631,10 +656,21 @@ to provide the data to send. 
 Changing them to return a private handle will benefit the implementation and

 allow us much greater freedoms while still maintining a solid API and ABI.



17.9 have form functions use CURL handle argument

19.9 have form functions use CURL handle argument



 curl_formadd() and curl_formget() both currently have no CURL handle

 argument, but both can use a callback that is set in the easy handle, and

 thus curl_formget() with callback cannot function without first having

 curl_easy_perform() (or similar) called - which is hard to grasp and a design

 mistake.



19.10 Add CURLOPT_MAIL_CLIENT option



 Rather than use the URL to specify the mail client string to present in the

 HELO and EHLO commands, libcurl should support a new CURLOPT specifically for

 specifing this data as the URL is non-standard and to be honest a bit of a

 hack ;-)



 Please see the following thread for more information:

 http://curl.haxx.se/mail/lib-2012-05/0178.html

 
 No newline at end of file