README

   1 liboauth is a collection of c functions implementing the http://oauth.net API.
   2
   3 liboauth provides functions to escape and encode stings according to
   4 OAuth specifications and offers high-level functionality built on top to sign
   5 requests or verify signatures using either NSS or OpenSSL for calculating
   6 the hash/signatures.
   7
   8 The included documentation in the doc/ folder and example code from tests/
   9 can also be found online at http://liboauth.sourceforge.net/
  10
  11 Send bug-reports, patches or suggestions to robin@gareus.org.
  12 or inquire information at http://groups.google.com/group/oauth/
  13
  14  == License and Notes ==
  15
  16 The source-code of liboauth can be distributed under MIT License,
  17 or at your option: in terms of the the GNU General Public License.
  18 see COPYING.MIT or COPYING.GPL for details.
  19
  20 Note: OpenSSL is not strictly compatible with the GPL license.
  21 An exemption (to the GPL) allowing to link and redistribute
  22 liboauth with the OpenSSL library is is included in the source files.
  23 for more information, see LICENSE.OpenSSL and
  24 http://lists.debian.org/debian-legal/2004/05/msg00595.html
  25
  26 You can avoid this whole issue by using NSS instead of OpenSSL;
  27 configure with '--enable-nss'.
  28
  29 The Debian packaging that comes with the source-code is licensed under
  30 the GNU General Public License.
  31
  32  == Test and Example Code ==
  33
  34 After compilation `make check` can be used to perform a off-line self-test.
  35
  36 There is also example code to perform and verify OAuth requests online,
  37 but they are not run automatically.
  38
  39
  40  tests/oauthexample.c  - CONNECTS TO INTERNET
  41      walk-though http://term.ie/oauth/example
  42
  43  tests/oauthtest.c     - CONNECTS TO INTERNET
  44      gets a request-token from http://term.ie test-server
  45
  46  tests/oauthtest2.c    - CONNECTS TO INTERNET
  47      gets a request-token from http://term.ie test-server
  48      using OAuth HTTP Authorization header:
  49      see http://oauth.net/core/1.0a/#auth_header
  50      and http://oauth.net/core/1.0a/#consumer_req_param
  51
  52  tests/selftest_wiki.c
  53  tests/selftest_eran.c
  54      Test-Cases for parameter encoding, signatures, etc
  55
  56  tests/commontest.c
  57      Common Test-Case functions exercising the low-level API used by self-tests.
  58
  59  tests/oauthdatapost.c - CONNECTS TO INTERNET
  60      Experimental code to sign data uploads
  61      Note: The example keys have since been deleted from the test-server.
  62      Code remains for inspiration/example purposes.
  63