Skip to content
Snippets Groups Projects
Commit f2124094 authored by Andreas Åkre Solberg's avatar Andreas Åkre Solberg
Browse files

Adding table of content tag to documentation

git-svn-id: https://simplesamlphp.googlecode.com/svn/trunk@2206 44740490-163a-0410-bde0-09ae8108e29a
parent 1b369d06
No related branches found
No related tags found
No related merge requests found
Showing
with 32 additions and 1 deletion
...@@ -10,6 +10,8 @@ simpleSAMLphp Advanced Features ...@@ -10,6 +10,8 @@ simpleSAMLphp Advanced Features
* Version: `$Id$` * Version: `$Id$`
<!-- {{TOC}} -->
simpleSAMLphp documentation simpleSAMLphp documentation
--------------------------- ---------------------------
......
...@@ -9,6 +9,9 @@ Authentication Processing Filters in SimpleSAMLphp ...@@ -9,6 +9,9 @@ Authentication Processing Filters in SimpleSAMLphp
* Version: `$Id$` * Version: `$Id$`
<!-- {{TOC}} -->
In SimpleSAMLphp, there is an API where you can *do stuff* at the IdP after authentication is complete, and just before you are sent back to the SP. The same API is available on the SP, after you have received a successfull Authentication Response from the IdP and before you are sent back to the SP application. In SimpleSAMLphp, there is an API where you can *do stuff* at the IdP after authentication is complete, and just before you are sent back to the SP. The same API is available on the SP, after you have received a successfull Authentication Response from the IdP and before you are sent back to the SP application.
Authentication processing filters postprocesses authentication information received from authentication sources. It is possible to use this for additional authentication checks, requesting the users consent before delivering attributes to the user, modifying the users attributes, and other things which should be performed before returning the user to the service provider he came from. Authentication processing filters postprocesses authentication information received from authentication sources. It is possible to use this for additional authentication checks, requesting the users consent before delivering attributes to the user, modifying the users attributes, and other things which should be performed before returning the user to the service provider he came from.
......
...@@ -9,6 +9,7 @@ Automated Metadata Management ...@@ -9,6 +9,7 @@ Automated Metadata Management
* Version: `$Id$` * Version: `$Id$`
<!-- {{TOC}} -->
Introduction Introduction
------------ ------------
......
simpleSAMLphp changelog simpleSAMLphp changelog
======================= =======================
<!-- {{TOC}} -->
Here is changes between simpleSAMLphp versions. Look here if you are upgrading, to see if there are any changes to the config format. Here is changes between simpleSAMLphp versions. Look here if you are upgrading, to see if there are any changes to the config format.
......
...@@ -9,6 +9,8 @@ Exception and error handling in simpleSAMLphp ...@@ -9,6 +9,8 @@ Exception and error handling in simpleSAMLphp
* Version: `$Id$` * Version: `$Id$`
<!-- {{TOC}} -->
This document describes the way errors and exceptions are handled in authentication sources and authentication processing filters. This document describes the way errors and exceptions are handled in authentication sources and authentication processing filters.
The basic goal is to be able to throw an exception during authentication, and then have that exception transported back to the SP in a way that the SP understands. The basic goal is to be able to throw an exception during authentication, and then have that exception transported back to the SP in a way that the SP understands.
......
...@@ -9,6 +9,8 @@ SimpleSAMLphp Features ...@@ -9,6 +9,8 @@ SimpleSAMLphp Features
* Version: `$Id` * Version: `$Id`
<!-- {{TOC}} -->
## Automatic Metadata Retrieval ## Automatic Metadata Retrieval
SimpleSAMLphp supports regurlarly downloading SAML metadata form a HTTP location, optionally validating the signature on the metadata, and then cache the metadata to be used by a SP or IdP. Shibboleth introduced this functionality, and SimpleSAMLphp implements it in a compatible way. SimpleSAMLphp supports regurlarly downloading SAML metadata form a HTTP location, optionally validating the signature on the metadata, and then cache the metadata to be used by a SP or IdP. Shibboleth introduced this functionality, and SimpleSAMLphp implements it in a compatible way.
......
...@@ -10,6 +10,7 @@ Setting up a simpleSAMLphp SAML 2.0 IdP to use with Google Apps for Education ...@@ -10,6 +10,7 @@ Setting up a simpleSAMLphp SAML 2.0 IdP to use with Google Apps for Education
* Version: `$Id$` * Version: `$Id$`
<!-- {{TOC}} -->
simpleSAMLphp news and documentation simpleSAMLphp news and documentation
------------------------------------ ------------------------------------
......
...@@ -9,6 +9,7 @@ SimpleSAMLphp Identity Provider Advanced Topics ...@@ -9,6 +9,7 @@ SimpleSAMLphp Identity Provider Advanced Topics
* Version: `$Id$` * Version: `$Id$`
<!-- {{TOC}} -->
AJAX iFrame Single Log-Out AJAX iFrame Single Log-Out
-------------------------- --------------------------
......
...@@ -9,6 +9,8 @@ SimpleSAMLphp Identity Provider QuickStart ...@@ -9,6 +9,8 @@ SimpleSAMLphp Identity Provider QuickStart
* Version: `$Id$` * Version: `$Id$`
<!-- {{TOC}} -->
This guide will describe how to configure simpleSAMLphp as an identity provider (IdP). You should previously have installed simpleSAMLphp as described in [the simpleSAMLphp installation instructions](http://rnd.feide.no/content/installing-simplesamlphp) This guide will describe how to configure simpleSAMLphp as an identity provider (IdP). You should previously have installed simpleSAMLphp as described in [the simpleSAMLphp installation instructions](http://rnd.feide.no/content/installing-simplesamlphp)
......
...@@ -10,6 +10,7 @@ simpleSAMLphp Installation and Configuration ...@@ -10,6 +10,7 @@ simpleSAMLphp Installation and Configuration
* Version: `$Id$` * Version: `$Id$`
<!-- {{TOC}} -->
simpleSAMLphp news and documentation simpleSAMLphp news and documentation
------------------------------------ ------------------------------------
......
...@@ -9,7 +9,7 @@ simpleSAMLphp Maintenance ...@@ -9,7 +9,7 @@ simpleSAMLphp Maintenance
* Version: `$Id$` * Version: `$Id$`
<!-- {{TOC}} -->
simpleSAMLphp news and documentation simpleSAMLphp news and documentation
------------------------------------ ------------------------------------
......
...@@ -9,6 +9,7 @@ simpleSAMLphp modules ...@@ -9,6 +9,7 @@ simpleSAMLphp modules
* Version: `$Id$` * Version: `$Id$`
<!-- {{TOC}} -->
This document describes how the module system in simpleSAMLphp This document describes how the module system in simpleSAMLphp
works. It descibes what types of modules there are, how they are works. It descibes what types of modules there are, how they are
......
IdP hosted metadata reference IdP hosted metadata reference
============================= =============================
<!-- {{TOC}} -->
This is a reference for the metadata files This is a reference for the metadata files
`metadata/saml20-idp-hosted.php` and `metadata/shib13-idp-hosted.php`. `metadata/saml20-idp-hosted.php` and `metadata/shib13-idp-hosted.php`.
Both files have the following format: Both files have the following format:
......
IdP remote metadata reference IdP remote metadata reference
============================= =============================
<!-- {{TOC}} -->
This is a reference for metadata options available for `metadata/saml20-idp-remote.php` and `metadata/shib13-idp-remote.php`. Both files have the following format: This is a reference for metadata options available for `metadata/saml20-idp-remote.php` and `metadata/shib13-idp-remote.php`. Both files have the following format:
<?php <?php
......
SP hosted metadata reference SP hosted metadata reference
============================ ============================
<!-- {{TOC}} -->
This is a reference for the metadata files `metadata/saml20-sp-hosted.php` and `metadata/shib13-sp-hosted.php`. Both files have the following format: This is a reference for the metadata files `metadata/saml20-sp-hosted.php` and `metadata/shib13-sp-hosted.php`. Both files have the following format:
<?php <?php
......
SP remote metadata reference SP remote metadata reference
============================ ============================
<!-- {{TOC}} -->
This is a reference for metadata options available for This is a reference for metadata options available for
`metadata/saml20-sp-remote.php` and `metadata/shib13-sp-remote.php`. `metadata/saml20-sp-remote.php` and `metadata/shib13-sp-remote.php`.
Both files have the following format: Both files have the following format:
......
simpleSAMLphp SP API reference simpleSAMLphp SP API reference
============================== ==============================
<!-- {{TOC}} -->
This document describes the SimpleSAML_Auth_Simple API. This document describes the SimpleSAML_Auth_Simple API.
This is the preferred API for integrating simpleSAMLphp with other applications. This is the preferred API for integrating simpleSAMLphp with other applications.
......
Migrating to the `saml` module Migrating to the `saml` module
============================== ==============================
<!-- {{TOC}} -->
This document describes how you can migrate your code to use the `saml` module for authentication against SAML 2.0 and SAML 1.1 IdPs. This document describes how you can migrate your code to use the `saml` module for authentication against SAML 2.0 and SAML 1.1 IdPs.
It assumes that you have previously set up a SP by using redirects to `saml2/sp/initSSO.php`. It assumes that you have previously set up a SP by using redirects to `saml2/sp/initSSO.php`.
......
...@@ -9,6 +9,7 @@ SimpleSAMLphp Service Provider QuickStart ...@@ -9,6 +9,7 @@ SimpleSAMLphp Service Provider QuickStart
* Version: `$Id$` * Version: `$Id$`
<!-- {{TOC}} -->
This guide will describe how to configure simpleSAMLphp as a service provider (SP). You should previously have installed simpleSAMLphp as described in [the simpleSAMLphp installation instructions](http://rnd.feide.no/content/installing-simplesamlphp). This guide will describe how to configure simpleSAMLphp as a service provider (SP). You should previously have installed simpleSAMLphp as described in [the simpleSAMLphp installation instructions](http://rnd.feide.no/content/installing-simplesamlphp).
......
...@@ -9,6 +9,7 @@ Theming the user interface in SimpleSAMLphp ...@@ -9,6 +9,7 @@ Theming the user interface in SimpleSAMLphp
* Version: `$Id$` * Version: `$Id$`
<!-- {{TOC}} -->
In SimpleSAMLphp every part that needs to interact with the user by using a web page, uses templates to present the XHTML. SimpleSAMLphp comes with a default set of templates that presents a anonymous look. In SimpleSAMLphp every part that needs to interact with the user by using a web page, uses templates to present the XHTML. SimpleSAMLphp comes with a default set of templates that presents a anonymous look.
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment