Skip to content

Commit a9d16fd

Browse files
authored
Fix Readme titles
1 parent e8a2f49 commit a9d16fd

File tree

1 file changed

+26
-26
lines changed

1 file changed

+26
-26
lines changed

README.md

Lines changed: 26 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -144,7 +144,7 @@ the classes and methods that are described in a later section.
144144

145145
This folder contains a Django project that will be used as demo to show how to add SAML support to the Django Framework. 'demo' is the main folder of the django project (with its settings.py, views.py, urls.py), 'templates' is the django templates of the project and 'saml' is a folder that contains the 'certs' folder that could be used to store the x509 public and private key, and the saml toolkit settings (settings.json and advanced_settings.json).
146146

147-
***Notice about certs***
147+
*** Notice about certs ***
148148

149149
SAML requires a x.509 cert to sign and encrypt elements like NameID, Message, Assertion, Metadata.
150150

@@ -572,7 +572,7 @@ auth.get_last_request_id()
572572
Related to the SP there are 3 important endpoints: The metadata view, the ACS view and the SLS view.
573573
The toolkit provides examples of those views in the demos, but lets see an example.
574574

575-
***SP Metadata***
575+
*** SP Metadata ***
576576

577577
This code will provide the XML metadata file of our SP, based on the info that we provided in the settings files.
578578

@@ -598,7 +598,7 @@ saml_settings = OneLogin_Saml2_Settings(settings=None, custom_base_path=None, sp
598598
```
599599
to get the settings object and with the sp_validation_only=True parameter we will avoid the IdP Settings validation.
600600

601-
***Attribute Consumer Service(ACS)***
601+
*** Attribute Consumer Service(ACS) ***
602602

603603
This code handles the SAML response that the IdP forwards to the SP through the user's client.
604604

@@ -664,7 +664,7 @@ print auth.get_attribute('cn')
664664
Before trying to get an attribute, check that the user is authenticated. If the user isn't authenticated, an empty dict will be returned. For example, if we call to get_attributes before a auth.process_response, the get_attributes() will return an empty dict.
665665

666666

667-
***Single Logout Service (SLS)***
667+
*** Single Logout Service (SLS) ***
668668

669669
This code handles the Logout Request and the Logout Responses.
670670

@@ -765,7 +765,7 @@ If a match on the LogoutResponse ID and the LogoutRequest ID to be sent is requi
765765
auth.get_last_request_id()
766766
```
767767

768-
####Example of a view that initiates the SSO request and handles the response (is the acs target)####
768+
#### Example of a view that initiates the SSO request and handles the response (is the acs target) ####
769769

770770
We can code a unique file that initiates the SSO process, handle the response, get the attributes, initiate the slo and processes the logout response.
771771

@@ -820,7 +820,7 @@ else:
820820

821821
Described below are the main classes and methods that can be invoked from the SAML2 library.
822822

823-
####OneLogin_Saml2_Auth - auth.py####
823+
#### OneLogin_Saml2_Auth - auth.py ####
824824

825825
Main class of OneLogin Python Toolkit
826826

@@ -848,7 +848,7 @@ Main class of OneLogin Python Toolkit
848848
* ***get_last_request_xml*** Returns the most recently-constructed/processed XML SAML request (AuthNRequest, LogoutRequest)
849849
* ***get_last_response_xml*** Returns the most recently-constructed/processed XML SAML response (SAMLResponse, LogoutResponse). If the SAMLResponse had an encrypted assertion, decrypts it.
850850

851-
####OneLogin_Saml2_Auth - authn_request.py####
851+
#### OneLogin_Saml2_Auth - authn_request.py ####
852852

853853
SAML 2 Authentication Request class
854854

@@ -857,7 +857,7 @@ SAML 2 Authentication Request class
857857
* ***get_id*** Returns the AuthNRequest ID.
858858
* ***get_xml*** Returns the XML that will be sent as part of the request.
859859

860-
####OneLogin_Saml2_Response - response.py####
860+
#### OneLogin_Saml2_Response - response.py ####
861861

862862
SAML 2 Authentication Response class
863863

@@ -876,7 +876,7 @@ SAML 2 Authentication Response class
876876
* ***get_error*** After execute a validation process, if fails this method returns the cause
877877
* ***get_xml_document*** Returns the SAML Response document (If contains an encrypted assertion, decrypts it).
878878

879-
####OneLogin_Saml2_LogoutRequest - logout_request.py####
879+
#### OneLogin_Saml2_LogoutRequest - logout_request.py ####
880880

881881
SAML 2 Logout Request class
882882

@@ -891,7 +891,7 @@ SAML 2 Logout Request class
891891
* ***get_error*** After execute a validation process, if fails this method returns the cause.
892892
* ***get_xml*** Returns the XML that will be sent as part of the request or that was received at the SP
893893

894-
####OneLogin_Saml2_LogoutResponse - logout_response.py####
894+
#### OneLogin_Saml2_LogoutResponse - logout_response.py ####
895895

896896
SAML 2 Logout Response class
897897

@@ -905,7 +905,7 @@ SAML 2 Logout Response class
905905
* ***get_xml*** Returns the XML that will be sent as part of the response or that was received at the SP
906906

907907

908-
####OneLogin_Saml2_Settings - settings.py####
908+
#### OneLogin_Saml2_Settings - settings.py ####
909909

910910
Configuration of the OneLogin Python Toolkit
911911

@@ -937,15 +937,15 @@ Configuration of the OneLogin Python Toolkit
937937
* ***is_strict*** Returns if the 'strict' mode is active.
938938
* ***is_debug_active*** Returns if the debug is active.
939939

940-
####OneLogin_Saml2_Metadata - metadata.py####
940+
#### OneLogin_Saml2_Metadata - metadata.py ####
941941

942942
A class that contains functionality related to the metadata of the SP
943943

944944
* ***builder*** Generates the metadata of the SP based on the settings.
945945
* ***sign_metadata*** Signs the metadata with the key/cert provided.
946946
* ***add_x509_key_descriptors*** Adds the x509 descriptors (sign/encriptation) to the metadata
947947

948-
####OneLogin_Saml2_Utils - utils.py####
948+
#### OneLogin_Saml2_Utils - utils.py ####
949949

950950
Auxiliary class that contains several methods
951951

@@ -981,7 +981,7 @@ Auxiliary class that contains several methods
981981
* ***def get_encoded_parameter*** Return an url encoded get parameter value
982982
* ***extract_raw_query_parameter***
983983

984-
####OneLogin_Saml2_IdPMetadataParser - idp_metadata_parser.py####
984+
#### OneLogin_Saml2_IdPMetadataParser - idp_metadata_parser.py ####
985985

986986
A class that contains methods to obtain and parse metadata from IdP
987987

@@ -1006,7 +1006,7 @@ how it deployed. New demos using other python frameworks are welcome as a contri
10061006
We said that this toolkit includes a django application demo and a flask applicacion demo,
10071007
lets see how fast is deploy them.
10081008

1009-
***Virtualenv***
1009+
*** Virtualenv ***
10101010

10111011
The use of a [virtualenv](http://virtualenv.readthedocs.org/en/latest/) is
10121012
highly recommended.
@@ -1051,7 +1051,7 @@ Now, with the virtualenv loaded, you can run the demo like this:
10511051

10521052
You'll have the demo running at http://localhost:8000
10531053

1054-
####Content####
1054+
#### Content ####
10551055

10561056
The flask project contains:
10571057

@@ -1063,19 +1063,19 @@ The flask project contains:
10631063
* ***saml*** Is a folder that contains the 'certs' folder that could be used to store the x509 public and private key, and the saml toolkit settings (settings.json and advanced_settings.json).
10641064

10651065

1066-
####SP setup####
1066+
#### SP setup ####
10671067

10681068
The Onelogin's Python Toolkit allows you to provide the settings info in 2 ways: settings files or define a setting dict. In the demo-flask it used the first method.
10691069

10701070
In the index.py file we define the app.config['SAML_PATH'], that will target to the 'saml' folder. We require it in order to load the settings files.
10711071

10721072
First we need to edit the saml/settings.json, configure the SP part and review the metadata of the IdP and complete the IdP info. Later edit the saml/advanced_settings.json files and configure the how the toolkit will work. Check the settings section of this document if you have any doubt.
10731073

1074-
####IdP setup####
1074+
#### IdP setup ####
10751075

10761076
Once the SP is configured, the metadata of the SP is published at the /metadata url. Based on that info, configure the IdP.
10771077

1078-
####How it works####
1078+
#### How it works ####
10791079

10801080
1. First time you access to the main view 'http://localhost:8000', you can select to login and return to the same view or login and be redirected to /?attrs (attrs view).
10811081

@@ -1120,7 +1120,7 @@ Note that many of the configuration files expect HTTPS. This is not required by
11201120

11211121
If you want to integrate a production django application, take a look on this SAMLServiceProviderBackend that uses our toolkit to add SAML support: https://github.com/KristianOellegaard/django-saml-service-provider
11221122

1123-
####Content####
1123+
#### Content ####
11241124

11251125
The django project contains:
11261126

@@ -1136,19 +1136,19 @@ The django project contains:
11361136

11371137
* ***templates***. Is the folder where django stores the templates of the project. It was implemented a base.html template that is extended by index.html and attrs.html, the templates of our simple demo that shows messages, user attributes when available and login and logout links.
11381138

1139-
####SP setup####
1139+
#### SP setup ####
11401140

11411141
The Onelogin's Python Toolkit allows you to provide the settings info in 2 ways: settings files or define a setting dict. In the demo-django it used the first method.
11421142

11431143
After set the SAML_FOLDER in the demo/settings.py, the settings of the python toolkit will be loaded on the django web.
11441144

11451145
First we need to edit the saml/settings.json, configure the SP part and review the metadata of the IdP and complete the IdP info. Later edit the saml/advanced_settings.json files and configure the how the toolkit will work. Check the settings section of this document if you have any doubt.
11461146

1147-
####IdP setup####
1147+
#### IdP setup ####
11481148

11491149
Once the SP is configured, the metadata of the SP is published at the /metadata url. Based on that info, configure the IdP.
11501150

1151-
####How it works####
1151+
#### How it works ####
11521152

11531153
This demo works very similar to the flask-demo (We did it intentionally).
11541154

@@ -1177,7 +1177,7 @@ Now you can run the demo like this:
11771177

11781178
If that worked, the demo is now running at http://localhost:6543.
11791179

1180-
####Content####
1180+
#### Content ####
11811181

11821182
The Pyramid project contains:
11831183

@@ -1191,7 +1191,7 @@ The Pyramid project contains:
11911191
* ***saml*** is a folder that contains the 'certs' folder that could be used to store the x509 public and private key, and the saml toolkit settings (settings.json and advanced_settings.json).
11921192

11931193

1194-
####SP setup####
1194+
#### SP setup ####
11951195

11961196
The Onelogin's Python Toolkit allows you to provide the settings info in 2 ways: settings files or define a setting dict. In demo_pyramid the first method is used.
11971197

@@ -1203,7 +1203,7 @@ First we need to edit the saml/settings.json, configure the SP part and review t
12031203

12041204
Once the SP is configured, the metadata of the SP is published at the /metadata/ url. Based on that info, configure the IdP.
12051205

1206-
####How it works####
1206+
#### How it works ####
12071207

12081208
1. First time you access to the main view 'http://localhost:6543', you can select to login and return to the same view or login and be redirected to /?attrs (attrs view).
12091209

0 commit comments

Comments
 (0)