VERSION 1.1.1
December 17, 2007

Welcome
Contents
Requirements
Bugs
Support
Documentation


Welcome to Internet2's OpenSAML
-------------------------------
OpenSAML is an implementation of SAML 1.0 and 1.1
(http://www.oasis-open.org/committees/security/).
Java and C++ APIs are provided.

Please review the terms described in the LICENSE file before
using this code. It is now the Apache 2.0 license.


Contents:
---------
A source distribution can be found at
http://shibboleth.internet2.edu/downloads/

The C++ source distribution is a standard configure/make/install package
with a prebuilt configure script and Makefiles. RPMs may also be available
for certain platforms and we encourage donation of additional packaging
scripts or platform maintainers.


Requirements:
-------------
The INSTALL.txt file contains information on how to build the C++ code.
The following is a list of the basic dependent libraries and suggested
versions needed:

gcc/g++ GNU compiler 3+     http://www.gnu.org/software/gcc/
OpenSSL 0.9.8               http://www.openssl.org/
libcurl	7.17.1              http://curl.haxx.se/libcurl/
(*) log4shib 1.0            http://shibboleth.internet2.edu/downloads/
Xerces-C 2.8.0              http://xerces.apache.org/
xml-security-c 1.4.0        http://xml.apache.org/security/

(*) As of this release, OpenSAML supports both the original log4cpp
library and a forked version called log4shib, which is recommended.
Many versions of log4cpp contain thread safety bugs that will cause
crashes, and have packaging and portability problems.


Reporting Bugs:
---------------
A Jira instance is available at https://bugs.internet2.edu/


Support:
--------
A mailing list for users is available. Subscription instructions are
provided at http://www.opensaml.org/index.html#mailing


Documentation:
--------------
There are no explicit samples, but there are test programs and higher level
code in the Shibboleth codebase that would help a novice see what some of the
classes do. An understanding of SAML also helps.
