summaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorMikaël Ates <mates@entrouvert.com>2011-12-08 14:15:09 (GMT)
committerMikaël Ates <mates@entrouvert.com>2011-12-08 14:15:09 (GMT)
commit65f78286861dc67677d51a14bbf4be59485355d3 (patch)
tree238da4d2428e6b6e222e5861b449e6c8eabe91f7 /doc
parent3081e04df468dc759409737d19048db924075a11 (diff)
downloadauthentic-65f78286861dc67677d51a14bbf4be59485355d3.zip
authentic-65f78286861dc67677d51a14bbf4be59485355d3.tar.gz
authentic-65f78286861dc67677d51a14bbf4be59485355d3.tar.bz2
[doc] Update index, center images, add logo.
Diffstat (limited to 'doc')
-rw-r--r--doc/attribute_management.rst27
-rw-r--r--doc/conf.py8
-rw-r--r--doc/config_saml2_idp.rst11
-rw-r--r--doc/config_saml2_sp.rst8
-rw-r--r--doc/index.rst20
-rw-r--r--doc/pictures/eo_logo.pngbin0 -> 12237 bytes
-rw-r--r--doc/pictures/eo_logo_t.pngbin0 -> 15745 bytes
7 files changed, 63 insertions, 11 deletions
diff --git a/doc/attribute_management.rst b/doc/attribute_management.rst
index 8efa26b..93b6ac3 100644
--- a/doc/attribute_management.rst
+++ b/doc/attribute_management.rst
@@ -67,11 +67,13 @@ Add an attribute source named USER_PROFILE with namespace 'Default'.
.. image:: pictures/user_profile_source.png
:width: 800 px
+ :align: center
3. Save
.. image:: pictures/user_profile_source_saved.png
:width: 800 px
+ :align: center
Add an LDAP Source
__________________
@@ -93,11 +95,13 @@ namespace is based on LDAP.**
.. image:: pictures/ldapsource.png
:width: 800 px
+ :align: center
3. Save
.. image:: pictures/ldapsource_saved.png
:width: 800 px
+ :align: center
Manage user distinguished names in LDAP directories
___________________________________________________
@@ -117,11 +121,13 @@ user alias in source is created for the user:
.. image:: pictures/alias_in_source.png
:width: 800 px
+ :align: center
3. Save
.. image:: pictures/alias_in_source_saved.png
:width: 800 px
+ :align: center
Configure attributes from local sources pushed to SAML2 service providers in SSO response
-----------------------------------------------------------------------------------------
@@ -150,11 +156,13 @@ ______________________
.. image:: pictures/attribute_item.png
:width: 800 px
+ :align: center
3. Save
.. image:: pictures/attribute_item_saved.png
:width: 800 px
+ :align: center
Create a named list of attribute items
______________________________________
@@ -165,11 +173,13 @@ ______________________________________
.. image:: pictures/attribute_list.png
:width: 800 px
+ :align: center
3. Save
.. image:: pictures/attribute_list_saved.png
:width: 800 px
+ :align: center
Create or modify an attribute policy
____________________________________
@@ -183,11 +193,13 @@ Or you can create a regular policy and associate it to a service provider.
.. image:: pictures/policy_pull.png
:width: 800 px
+ :align: center
3. Save
.. image:: pictures/policy_pull_saved.png
:width: 800 px
+ :align: center
Associate the policy to a service provider
__________________________________________
@@ -198,16 +210,19 @@ __________________________________________
.. image:: pictures/sp_policy_pull.png
:width: 800 px
+ :align: center
3. Save
.. image:: pictures/sp_policy_pull_saved.png
:width: 800 px
+ :align: center
4. The display name of the policy has changed
.. image:: pictures/policy_pull_renamed.png
:width: 800 px
+ :align: center
Handle attributes provided by other Identity providers and pushed to SAML2 service providers in SSO response (proxy attributes)
-------------------------------------------------------------------------------------------------------------------------------
@@ -225,6 +240,7 @@ Create or modify an attribute policy activating the option 'Forward attributes f
.. image:: pictures/attr_policy_forward.png
:width: 800 px
+ :align: center
**Attach policy to the service provider if it is not yet the case.**
@@ -247,17 +263,20 @@ identity provider.**
.. image:: pictures/attr_source_idp.png
:width: 800 px
+ :align: center
3. Save
.. image:: pictures/attr_source_idp_saved.png
:width: 800 px
+ :align: center
Then create or modify an attribute policy activating the option **'Forward attributes from push sources'**.
You then select the source you want to forward attributes through the selection box and you save.
.. image:: pictures/attr_policy_filter_source.png
:width: 800 px
+ :align: center
**Attach policy to the service provider if it is not yet the case.**
@@ -279,6 +298,7 @@ http://schemas.xmlsoap.org/ws/2005/05/identity/claims.
.. image:: pictures/attr_source_idp_claims.png
:width: 800 px
+ :align: center
Then create or modify an attribute policy activating the options 'Forward attributes from push sources',
**'Map attributes from push sources'**. You also choose the output namespace expected with the
@@ -286,6 +306,7 @@ parameters **'Output name format'** and **'Output namespace'**.
.. image:: pictures/attr_policy_map_ns.png
:width: 800 px
+ :align: center
Remind that the default namespace is X500/LDAP + edu* + supann and the only other supported namespace is
http://schemas.xmlsoap.org/ws/2005/05/identity/claims.
@@ -308,6 +329,7 @@ http://schemas.xmlsoap.org/ws/2005/05/identity/claims.
.. image:: pictures/attr_source_idp_claims.png
:width: 800 px
+ :align: center
You then create an attribute list as described in section *'Create a named list of attribute items'*.
@@ -316,15 +338,18 @@ You then associate the list of attributes.
.. image:: pictures/attr_policy_filter_attributes.png
:width: 800 px
+ :align: center
If you want to also filter according to the source you can configure it as defined in section *'Filter attributes from source only'*. You can also choose to filter
with the source indicate per attribute item of the list. For this select the option **'Filter source of filtered attributes'**.
.. image:: pictures/attr_policy_filter_attributes_source.png
:width: 800 px
+ :align: center
.. image:: pictures/attribute_item.png
:width: 800 px
+ :align: center
The default name format is URI. You can however change the name format and namespace with the option **'Map attributes from push sources'** and the parameters **'Output name format'** and **'Output namespace'**.
@@ -332,9 +357,11 @@ Using the option **'Map attributes of filtered attributes'** the output name for
.. image:: pictures/attr_policy_filter_attributes_map.png
:width: 800 px
+ :align: center
.. image:: pictures/attribute_item.png
:width: 800 px
+ :align: center
Push manually (writing bits of code) attributes to SAML2 service providers in SSO response
diff --git a/doc/conf.py b/doc/conf.py
index abfa809..4da734f 100644
--- a/doc/conf.py
+++ b/doc/conf.py
@@ -41,7 +41,7 @@ master_doc = 'index'
# General information about the project.
project = u'Authentic2'
-copyright = u'2011, Mikaël Ates'
+copyright = u'2011, Entr\'ouvert'
# The version info for the project you're documenting, acts as replacement for
# |version| and |release|, also used in various other places throughout the
@@ -110,7 +110,7 @@ html_theme = 'default'
# The name of an image file (relative to this directory) to place at the top
# of the sidebar.
-#html_logo = None
+html_logo = 'pictures/eo_logo_t.png'
# The name of an image file (within the static path) to use as favicon of the
# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
@@ -184,12 +184,12 @@ latex_elements = {
# (source start file, target name, title, author, documentclass [howto/manual]).
latex_documents = [
('index', 'Authentic2.tex', u'Authentic2 Documentation',
- u'Mikaël Ates', 'manual'),
+ u'Entr\'ouvert', 'manual'),
]
# The name of an image file (relative to this directory) to place at the top of
# the title page.
-#latex_logo = None
+latex_logo = 'pictures/eo_logo.png'
# For "manual" documents, if this is true, then toplevel headings are parts,
# not chapters.
diff --git a/doc/config_saml2_idp.rst b/doc/config_saml2_idp.rst
index 8fbdeee..fafd5aa 100644
--- a/doc/config_saml2_idp.rst
+++ b/doc/config_saml2_idp.rst
@@ -43,9 +43,11 @@ the SAML2 metadata of the identity provider.
.. image:: pictures/new_saml2_idp_1.png
:width: 800 px
+ :align: center
.. image:: pictures/new_saml2_idp_2.png
:width: 800 px
+ :align: center
**The identity provider must be enabled.**
@@ -57,6 +59,7 @@ See below about configuring the identity provider with policies:
.. image:: pictures/new_saml2_idp_saved.png
:width: 800 px
+ :align: center
Configure the SAML2 identity provider options
---------------------------------------------
@@ -74,28 +77,34 @@ Go to:
.. image:: pictures/sp_options_regular.png
:width: 800 px
+ :align: center
.. image:: pictures/sp_options_regular_saved.png
:width: 800 px
+ :align: center
.. image:: pictures/sp_options_regular_modify_sp.png
:width: 800 px
+ :align: center
Exemple with a policy 'Default':
.. image:: pictures/sp_options_default.png
:width: 800 px
+ :align: center
Exemple with a policy 'All':
.. image:: pictures/sp_options_all.png
:width: 800 px
+ :align: center
If no policy is found for the configuration of the SAML2 options of an identity
provider, the following error is displayed when a SSO request is initiated.
.. image:: pictures/error_no_idp_options.png
:width: 800 px
+ :align: center
How to refresh metadata of an identity provider hosted at a Well-Known Location?
--------------------------------------------------------------------------------
@@ -108,9 +117,11 @@ the menu 'Update metadata', then click on 'Go'.
.. image:: pictures/update_metadata.png
:width: 800 px
+ :align: center
.. image:: pictures/update_metadata_done.png
:width: 800 px
+ :align: center
How to create in bulk identity providers with the sync-metadata script?
-----------------------------------------------------------------------
diff --git a/doc/config_saml2_sp.rst b/doc/config_saml2_sp.rst
index 2ff5349..1533edc 100644
--- a/doc/config_saml2_sp.rst
+++ b/doc/config_saml2_sp.rst
@@ -55,6 +55,7 @@ See below about configuring the service provider with policies:
.. image:: pictures/new_saml2_sp_saved.png
:width: 800 px
+ :align: center
Configure the SAML2 service provider options
--------------------------------------------
@@ -72,28 +73,34 @@ Go to:
.. image:: pictures/sp_options_regular.png
:width: 800 px
+ :align: center
.. image:: pictures/sp_options_regular_modify_sp.png
:width: 800 px
+ :align: center
Exemple with a policy 'Default':
.. image:: pictures/sp_options_default.png
:width: 800 px
+ :align: center
.. image:: pictures/sp_options_default_saved.png
:width: 800 px
+ :align: center
Exemple with a policy 'All':
.. image:: pictures/sp_options_all.png
:width: 800 px
+ :align: center
If no policy is found for the configuration of the SAML2 options of a service
provider, the following error is displayed when a SSO request is received.
.. image:: pictures/error_no_sp_options.png
:width: 800 px
+ :align: center
Configure the SAML2 service provider protocol options
-----------------------------------------------------
@@ -119,6 +126,7 @@ the menu 'Update metadata', then click on 'Go'.
.. image:: pictures/update_metadata.png
:width: 800 px
+ :align: center
How to create in bulk service providers with the sync-metadata script?
----------------------------------------------------------------------
diff --git a/doc/index.rst b/doc/index.rst
index cf4a2a0..e3c5d90 100644
--- a/doc/index.rst
+++ b/doc/index.rst
@@ -9,7 +9,7 @@ Authentic2's documentation
Authentic2 is a versatile identity provider addressing a broad
range of needs, from simple to advanced setups, around web authentication,
-attribute sharing, namespace mapping and authorization management.
+attribute sharing and namespace mapping.
Authentic2 supports many protocols and standards, including SAML2, CAS, OpenID,
LDAP, X509, OATH, and can bridge between them.
@@ -20,9 +20,11 @@ It has support for SAMLv2 thanks to `Lasso <http://lasso.entrouvert.org>`_,
a free (GNU GPL) implementation of the Liberty Alliance and OASIS
specifications of SAML2, ID-FF1.2 and ID-WSF2.
+The Documentation is under the licence Creative Commons `CC BY-SA 2.0 <http://creativecommons.org/licenses/by-sa/2.0/>`_.
+
- `Authentic2 project site <http://dev.entrouvert.org/projects/authentic>`_
- `Authentic2 roadmap <http://dev.entrouvert.org/projects/authentic/roadmap>`_
-- `Documentation in PDF <http://dev.entrouvert.org/attachments/147/Authentic2.pdf>`_
+- `Documentation in PDF <http://dev.entrouvert.org/attachments/148/Authentic2.pdf>`_
Documentation content
=====================
@@ -48,12 +50,12 @@ Documentation content
config_saml2_idp
+ saml2_slo
+
sync-metadata_script
config_cas_sp
- config_cas_idp
-
attribute_management
attribute_management_explained
@@ -63,15 +65,19 @@ Documentation content
Copyright
=========
-Authentic and Authentic2 are copyrighted by Entr'ouvert and are licensed through the GNU General
-Public Licence, version 2 or later. A copy of the whole license text is available in the COPYING file.
+Authentic and Authentic2 are copyrighted by Entr'ouvert and are licensed
+through the GNU AFFERO GENERAL PUBLIC LICENSE, version 3 or later. A copy of
+the whole license text is available in the COPYING file.
The OpenID IdP originates in the project django_openid_provider by Roman
-Barczy¿ski, which is under the Apache 2.0 licence. This imply that you must
+Barczyski, which is under the Apache 2.0 licence. This imply that you must
distribute authentic2 under the AGPL3 licence when distributing this part of the
project which is the only AGPL licence version compatible with the Apache 2.0
licence.
+The Documentation is under the licence Creative Commons
+`CC BY-SA 2.0 <http://creativecommons.org/licenses/by-sa/2.0/>`_.
+
.. Indices and tables
.. ==================
diff --git a/doc/pictures/eo_logo.png b/doc/pictures/eo_logo.png
new file mode 100644
index 0000000..2568e23
--- /dev/null
+++ b/doc/pictures/eo_logo.png
Binary files differ
diff --git a/doc/pictures/eo_logo_t.png b/doc/pictures/eo_logo_t.png
new file mode 100644
index 0000000..54e9663
--- /dev/null
+++ b/doc/pictures/eo_logo_t.png
Binary files differ