diff --git a/doc/howto.rst b/doc/howto.rst new file mode 100644 index 0000000..a902391 --- /dev/null +++ b/doc/howto.rst @@ -0,0 +1,31 @@ +.. _howto: + +How to use PySAML2 +=================== + +Before you can use Pysaml2, you'll need to get it installed. +If you have done it yet, read :ref:`install` + +Well, now you have it installed and you want to do something. + +And I'm sorry to tell you this; but there isn't really a lot you can do with +this code on it's own. + +Sure you can send a AuthenticationRequest to an IdentityProvider or a +AttributeQuery to an AttributeAuthority but in order to get what they +return you have to sit behind a Web server. Well that is not really true since +the AttributeQuery would be over SOAP and you would get the result over the +conenction you have to the AttributeAuthority. + +But anyway, you get may get my point. This is middleware stuff here ! + +Supposted to be used built-in in a webapplication. +To be more specific it is built to fit into a +`WSGI `_ application + +So to get an example of where PySAML2 could fit in, you should download +my repoze.who.plugin.saml2 package which you can find here: + +bzr branch lp:~roland-hedberg/repoze.who.plugins.saml2/main + +and go from there. diff --git a/doc/index.rst b/doc/index.rst index e62c3ce..ac24faa 100644 --- a/doc/index.rst +++ b/doc/index.rst @@ -5,8 +5,8 @@ You can adapt this file completely to your liking, but it should at least contain the root `toctree` directive. -Welcome to pysaml2's documentation! -=================================== +Welcome to the documentation of pysaml2! +======================================== :Release: |version| :Date: |today| @@ -14,10 +14,11 @@ Welcome to pysaml2's documentation! Contents: .. toctree:: - :maxdepth: 2 + :maxdepth: 1 + install + howto saml2 - xmldsig Indices and tables ================== diff --git a/doc/install.rst b/doc/install.rst index 799f8c9..9d2dda8 100644 --- a/doc/install.rst +++ b/doc/install.rst @@ -15,8 +15,14 @@ a 2.X version, where X > 4 . Prerequisites ^^^^^^^^^^^^^ -You have to download and install the following packages. +You have to have ElementTree, which is either part of your Python distribution +if it's recent enough. Or if the Python is too old you have to install it, +for instance by getting it from the Python Package Instance by using +easy_install. +You also need xmlsec which you can download from http://www.aleksey.com/xmlsec/ + +If you're on OS X you can get it from MacPorts or Fink. Quick build instructions @@ -33,5 +39,5 @@ Quick build instructions py.test tests - is what you should use. + is what you should use. If you don't have py.test, get it ! It's good ! diff --git a/doc/metadata.rst b/doc/metadata.rst new file mode 100644 index 0000000..fcb268c --- /dev/null +++ b/doc/metadata.rst @@ -0,0 +1,18 @@ +.. _metadata: + +*************************************************** +Base classes representing Saml2.0 protocol elements +*************************************************** + +:Author: Roland Hedberg +:Version: |version| + +.. module:: MetaData + :synopsis: Base classes representing Saml2.0 metadata elements. + +Module +========== + +.. automodule:: saml2.metadata + :members: + diff --git a/doc/saml.rst b/doc/saml.rst new file mode 100644 index 0000000..377758b --- /dev/null +++ b/doc/saml.rst @@ -0,0 +1,18 @@ +.. _saml: + +****************************************** +Base classes representing Saml2.0 elements +****************************************** + +:Author: Roland Hedberg +:Version: |version| + +.. module:: SAML2 + :synopsis: Base classes representing Saml2.0 elements. + +Module +========== + +.. automodule:: saml2.saml + :members: + diff --git a/doc/saml2.rst b/doc/saml2.rst index 9bca727..9e22472 100644 --- a/doc/saml2.rst +++ b/doc/saml2.rst @@ -1,20 +1,27 @@ -****************************************** -Base classes representing Saml2.0 elements -****************************************** +.. _base: -:mod: 'saml2' -- saml2 - -===================================================== +**************************************** +Base classes representing basic elements +**************************************** :Author: Roland Hedberg :Version: |version| -.. module:: saml2 - :synopsis: Base classes representing Saml2.0 elements. +.. module:: Base + :synopsis: Base classes. +.. toctree:: + :maxdepth: 2 + + saml + samlp + metadata + xmldsig + xmlenc + Module ========== -.. automodule:: pysaml.saml2 +.. automodule:: saml2 :members: diff --git a/doc/samlp.rst b/doc/samlp.rst new file mode 100644 index 0000000..09cf5dc --- /dev/null +++ b/doc/samlp.rst @@ -0,0 +1,18 @@ +.. _samlp: + +*************************************************** +Base classes representing Saml2.0 protocol elements +*************************************************** + +:Author: Roland Hedberg +:Version: |version| + +.. module:: SAMLP + :synopsis: Base classes representing Saml2.0 protocol elements. + +Module +========== + +.. automodule:: saml2.samlp + :members: + diff --git a/doc/xmldsig.rst b/doc/xmldsig.rst index 174202c..101e7ad 100644 --- a/doc/xmldsig.rst +++ b/doc/xmldsig.rst @@ -1,20 +1,18 @@ +.. _xmldsig: + ************************************* Classes representing xmldsig elements ************************************* -:mod: 'xmldsig' -- xmldsig - -===================================================== - :Author: Roland Hedberg :Version: |version| -.. module:: xmldsig +.. module:: XmlDsig :synopsis: Classes representing xmldsig elements. Module ========== -.. automodule:: pysaml.xmldsig +.. automodule:: xmldsig :members: diff --git a/doc/xmlenc.rst b/doc/xmlenc.rst new file mode 100644 index 0000000..9f83077 --- /dev/null +++ b/doc/xmlenc.rst @@ -0,0 +1,22 @@ +.. _xmlenc: + +************************************* +Classes representing xmlenc elements +************************************* + +#:mod: 'XmlEnc' -- xmlenc + +===================================================== + +:Author: Roland Hedberg +:Version: |version| + +.. module:: XmlEnc + :synopsis: Classes representing xmlenc elements. + +Module +========== + +.. automodule:: xmlenc + :members: +