Skip to content

Commit 488a00d

Browse files
Fix multiple spelling mistakes in README.md
1 parent 8571395 commit 488a00d

File tree

1 file changed

+21
-21
lines changed

1 file changed

+21
-21
lines changed

README.md

Lines changed: 21 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -172,7 +172,7 @@ A replay attack is basically try to reuse an intercepted valid SAML Message in o
172172
SAML Messages have a limited timelife (NotBefore, NotOnOrAfter) that
173173
make harder this kind of attacks, but they are still possible.
174174

175-
In order to avoid them, the SP can keep a list of SAML Messages or Assertion IDs alredy valdidated and processed. Those values only need
175+
In order to avoid them, the SP can keep a list of SAML Messages or Assertion IDs already valdidated and processed. Those values only need
176176
to be stored the amount of time of the SAML Message life time, so
177177
we don't need to store all processed message/assertion Ids, but the most recent ones.
178178

@@ -647,7 +647,7 @@ req = {
647647
```
648648

649649
Each Python framework built its own ``request`` object, you may map its data to match what the SAML toolkit expects.
650-
Let`s see some examples:
650+
Let's see some examples:
651651

652652
```python
653653
def prepare_from_django_request(request):
@@ -689,7 +689,7 @@ The ``AuthNRequest`` will be sent signed or unsigned based on the security info
689689

690690
The IdP will then return the SAML Response to the user's client. The client is then forwarded to the **Assertion Consumer Service (ACS)** of the SP with this information.
691691

692-
We can set a ``return_to`` url parameter to the login function and that will be converted as a ``RelayState`` parameter:
692+
We can set a ``return_to`` URL parameter to the login function and that will be converted as a ``RelayState`` parameter:
693693

694694
```python
695695
target_url = 'https://example.com'
@@ -711,7 +711,7 @@ auth.get_last_request_id()
711711
#### The SP Endpoints ####
712712

713713
Related to the SP there are 3 important endpoints: The metadata view, the ACS view and the SLS view.
714-
The toolkit provides examples of those views in the demos, but lets see an example.
714+
The toolkit provides examples of those views in the demos, but let's see an example.
715715

716716
*** SP Metadata ***
717717

@@ -891,7 +891,7 @@ The Logout Request will be sent signed or unsigned based on the security info of
891891

892892
The IdP will return the Logout Response through the user's client to the Single Logout Service (SLS) of the SP.
893893

894-
We can set a ``return_to`` url parameter to the logout function and that will be converted as a ``RelayState`` parameter:
894+
We can set a ``return_to`` URL parameter to the logout function and that will be converted as a ``RelayState`` parameter:
895895

896896
```python
897897
target_url = 'https://example.com'
@@ -1020,7 +1020,7 @@ Main class of SAML Python Toolkit
10201020
* ***logout*** Initiates the SLO process.
10211021
* ***process_response*** Process the SAML Response sent by the IdP.
10221022
* ***process_slo*** Process the SAML Logout Response / Logout Request sent by the IdP.
1023-
* ***redirect_to*** Redirects the user to the url past by parameter or to the url that we defined in our SSO Request.
1023+
* ***redirect_to*** Redirects the user to the URL passed by parameter or to the URL that we defined in our SSO Request.
10241024
* ***is_authenticated*** Checks if the user is authenticated or not.
10251025
* ***get_attributes*** Returns the set of SAML attributes.
10261026
* ***get_attribute*** Returns the requested SAML attribute.
@@ -1029,8 +1029,8 @@ Main class of SAML Python Toolkit
10291029
* ***get_session_expiration*** Gets the ``SessionNotOnOrAfter`` from the ``AuthnStatement``.
10301030
* ***get_errors*** Returns a list with code errors if something went wrong.
10311031
* ***get_last_error_reason*** Returns the reason of the last error
1032-
* ***get_sso_url*** Gets the SSO url.
1033-
* ***get_slo_url*** Gets the SLO url.
1032+
* ***get_sso_url*** Gets the SSO URL.
1033+
* ***get_slo_url*** Gets the SLO URL.
10341034
* ***get_last_request_id*** The ``ID`` of the last Request SAML message generated (``AuthNRequest``, ``LogoutRequest``).
10351035
* ***get_last_authn_contexts*** Returns the list of authentication contexts sent in the last SAML Response.
10361036
* ***build_request_signature*** Builds the Signature of the SAML Request.
@@ -1155,7 +1155,7 @@ Auxiliary class that contains several methods
11551155
* ***validate_xml*** Validates a xml against a schema.
11561156
* ***format_cert*** Returns a X.509 cert (adding header & footer if required).
11571157
* ***format_private_key*** Returns a private key (adding header & footer if required).
1158-
* ***redirect*** Executes a redirection to the provided url (or return the target url).
1158+
* ***redirect*** Executes a redirection to the provided URL (or return the target URL).
11591159
* ***get_self_url_host*** Returns the protocol + the current host + the port (if different than common ports).
11601160
* ***get_self_host*** Returns the current host.
11611161
* ***is_https*** Checks if https or http.
@@ -1179,7 +1179,7 @@ Auxiliary class that contains several methods
11791179
* ***add_sign*** Adds signature key and senders certificate to an element (Message or Assertion).
11801180
* ***validate_sign*** Validates a signature (Message or Assertion).
11811181
* ***validate_binary_sign*** Validates signed bynary data (Used to validate GET Signature).
1182-
* ***def get_encoded_parameter*** Return an url encoded get parameter value
1182+
* ***def get_encoded_parameter*** Return an URL encoded get parameter value
11831183
* ***extract_raw_query_parameter***
11841184

11851185
#### OneLogin_Saml2_IdPMetadataParser - idp_metadata_parser.py ####
@@ -1202,12 +1202,12 @@ Demos included in the toolkit
12021202
The toolkit includes 4 demos to teach how use the toolkit (Django, Flask, Pyramid and Bootle projects), take a look on them.
12031203
Demos require that SP and IdP are well configured before test it, so edit the settings files.
12041204

1205-
Notice that each python framework has it own way to handle routes/urls and process request, so focus on
1205+
Notice that each python framework has it own way to handle routes/URLs and process request, so focus on
12061206
how it deployed. New demos using other python frameworks are welcome as a contribution.
12071207

12081208
### Getting Started ###
12091209

1210-
We said that this toolkit includes a demos, lets see how fast is deploy some of them.
1210+
We said that this toolkit includes a demos, let's see how fast is deploy some of them.
12111211

12121212
*** Virtualenv ***
12131213

@@ -1276,23 +1276,23 @@ First we need to edit the ``saml/settings.json``, configure the SP part and rev
12761276

12771277
#### IdP setup ####
12781278

1279-
Once the SP is configured, the metadata of the SP is published at the ``/metadata`` url. Based on that info, configure the IdP.
1279+
Once the SP is configured, the metadata of the SP is published at the ``/metadata`` URL. Based on that info, configure the IdP.
12801280

12811281
#### How it works ####
12821282

12831283
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).
12841284

12851285
2. When you click:
12861286

1287-
2.1 in the first link, we access to ``/?sso`` (index view). An ``AuthNRequest`` is sent to the IdP, we authenticate at the IdP and then a Response is sent through the user's client to the SP, specifically the Assertion Consumer Service view: /?acs. Notice that a RelayState parameter is set to the url that initiated the process, the index view.
1287+
2.1 in the first link, we access to ``/?sso`` (index view). An ``AuthNRequest`` is sent to the IdP, we authenticate at the IdP and then a Response is sent through the user's client to the SP, specifically the Assertion Consumer Service view: /?acs. Notice that a RelayState parameter is set to the URL that initiated the process, the index view.
12881288

1289-
2.2 in the second link we access to ``/?attrs`` (attrs view), we will expetience have the same process described at 2.1 with the diference that as ``RelayState`` is set the attrs url.
1289+
2.2 in the second link we access to ``/?attrs`` (attrs view), we will experience the same process as described at 2.1 with the difference that as ``RelayState`` is set the attrs url.
12901290

12911291
3. The ``SAMLResponse`` is processed in the ACS ``/?acs``, if the Response is not valid, the process stops here and a message is shown. Otherwise we are redirected to the ``RelayState`` view. a) / or b) ``/?attrs``
12921292

12931293
4. We are logged in the app and the user attributes are showed. At this point, we can test the single log out functionality.
12941294

1295-
The single log out funcionality could be tested by 2 ways.
1295+
The single log out functionality could be tested by 2 ways.
12961296

12971297
5.1 SLO Initiated by SP. Click on the ``logout`` link at the SP, after that a Logout Request is sent to the IdP, the session at the IdP is closed and replies through the client to the SP with a Logout Response (sent to the Single Logout Service endpoint). The SLS endpoint ``/?sls`` of the SP process the Logout Response and if is valid, close the user session of the local app. Notice that the SLO Workflow starts and ends at the SP.
12981298

@@ -1333,7 +1333,7 @@ The django project contains:
13331333

13341334
* ***demo*** Is the main folder of the django project, that contains the typical files:
13351335
* ***settings.py*** Contains the default parameters of a django project except the SAML_FOLDER parameter, that may contain the path where is located the 'saml' folder.
1336-
* ***urls.py*** A file that define url routes. In the demo we defined ``/`` that is related to the index view, ``/attrs`` that is related with the attrs view and ``/metadata``, related to th metadata view.
1336+
* ***urls.py*** A file that defines URL routes. In the demo we defined ``/`` that is related to the index view, ``/attrs`` that is related with the attrs view and ``/metadata``, related to th metadata view.
13371337
* ***views.py*** This file contains the views of the django project and some aux methods.
13381338
* ***wsgi.py*** A file that let as deploy django using WSGI, the Python standard for web servers and applications.
13391339

@@ -1404,23 +1404,23 @@ First we need to edit the ``saml/settings.json``, configure the SP part and revi
14041404

14051405
#### IdP setup ####
14061406

1407-
Once the SP is configured, the metadata of the SP is published at the ``/metadata/`` url. Based on that info, configure the IdP.
1407+
Once the SP is configured, the metadata of the SP is published at the ``/metadata/`` URL. Based on that info, configure the IdP.
14081408

14091409
#### How it works ####
14101410

14111411
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).
14121412

14131413
2. When you click:
14141414

1415-
2.1 in the first link, we access to ``/?sso`` (index view). An ``AuthNRequest`` is sent to the IdP, we authenticate at the IdP and then a Response is sent through the user's client to the SP, specifically the Assertion Consumer Service view: ``/?acs``. Notice that a RelayState parameter is set to the url that initiated the process, the index view.
1415+
2.1 in the first link, we access to ``/?sso`` (index view). An ``AuthNRequest`` is sent to the IdP, we authenticate at the IdP and then a Response is sent through the user's client to the SP, specifically the Assertion Consumer Service view: ``/?acs``. Notice that a RelayState parameter is set to the URL that initiated the process, the index view.
14161416

1417-
2.2 in the second link we access to ``/?attrs`` (attrs view), we will expetience have the same process described at 2.1 with the diference that as ``RelayState`` is set the attrs url.
1417+
2.2 in the second link we access to ``/?attrs`` (attrs view), we will experience the same process as described at 2.1 with the difference that as ``RelayState`` is set the attrs URL.
14181418

14191419
3. The SAML Response is processed in the ACS ``/?acs``, if the Response is not valid, the process stops here and a message is shown. Otherwise we are redirected to the ``RelayState`` view. a) / or b) ``/?attrs``
14201420

14211421
4. We are logged in the app and the user attributes are showed. At this point, we can test the single log out functionality.
14221422

1423-
The single log out funcionality could be tested by 2 ways.
1423+
The single log out functionality could be tested by 2 ways.
14241424

14251425
5.1 SLO Initiated by SP. Click on the ``logout`` link at the SP, after that a Logout Request is sent to the IdP, the session at the IdP is closed and replies through the client to the SP with a Logout Response (sent to the Single Logout Service endpoint). The SLS endpoint ``/?sls`` of the SP process the Logout Response and if is valid, close the user session of the local app. Notice that the SLO Workflow starts and ends at the SP.
14261426

0 commit comments

Comments
 (0)