Scott Cantor
cantor.2@osu.edu

Welcome
Contents
Requirements
Bugs
Support
Documentation
Acknowledgements


Welcome to Internet2's OpenSAML
-------------------------------

OpenSAML is a partial implementation of the committee-specification
of SAML 1.1 (http://www.oasis-open.org/committees/security/), mainly
the parts needed to implement the Internet2 Shibboleth project. Java
and C++ APIs are provided.

Please review the terms described in the LICENSE file before using this
code. It is similar to the Apache 1.1 license.

Finally, be aware that RSA Security Inc. has asserted a patent claim
against all implementations of SAML. Their terms for licensing
can be found at http://www.rsasecurity.com/solutions/standards/saml/

As a SAML toolkit, OpenSAML is subject to this claim and developers
should obtain a royalty-free license from RSA directly. Internet2, UCAID,
and the OpenSAML developers are not responsible for anyone's failure to
do so.


Contents:
---------

OpenSAML can be obtained directly from anonymous CVS as described in
http://www.opensaml.org/cvs.html

Separate source distributions for Java and C++ also exist and can be found
at http://wayf.internet2.edu/shibboleth/

The CVS layout is as follows:

opensaml/
    c/
        bootstrap           (shell script to generate configure files)
        docs/				(documentation)
        saml/               (OpenSAML C++ source)
        schemas/            (XML schemas used)

The C++ source distribution is a standard configure/make/install package
with a prebuilt configure script and Makefiles.


Requirements:
-------------

The INSTALL.txt file contains great detail on how to build the C++ code.
The following is a list of the basic dependent libraries and minimum
versions needed:

gcc/g++ GNU compiler 3.x    http://www.gnu.org/software/gcc/
OpenSSL 0.9.6/0.9.7         http://www.openssl.org/
libcurl	7.10.3              http://curl.haxx.se/libcurl/
Xerces-C 2.2                http://xml.apache.org/xerces-c/
log4cpp 0.3.4b              http://wayf.internet2.edu/shibboleth/
xml-security 0.2.0          http://xml.apache.org/security/c/


Bugs:
-----

A bugzilla is now available at http://bugzilla.internet2.edu/


Support:
--------

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

Support will likely be informal and ad hoc for the time being. The
authors' focus is on completing Shibboleth. Most bugs are likely to
affect that goal and will be addressed quickly, however, at least for
now. Please do not e-mail the author directly. Use the mailing list
or bugzilla (preferably use that for bug reports).


Documentation:
--------------

There will hopefully be C++ docs via doxygen soon. There are no explicit
samples yet, 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.


Acknowledgements:
-----------------

We wish to acknowledge the following copyrighted works that make up
portions of this software:

This product includes software developed by the OpenSSL Project
for use in the OpenSSL Toolkit. (http://www.openssl.org/).

This product includes software developed by the Apache Software
Foundation (http://www.apache.org/).

This project uses libraries covered by the Lesser GNU Public License.
Source code for these libraries is available on request.