Skip to content

Commit f588237

Browse files
committed
docs: update to use 2.8.0
Signed-off-by: Rui Chen <rui@chenrui.dev>
1 parent 836c4df commit f588237

File tree

1 file changed

+18
-18
lines changed

1 file changed

+18
-18
lines changed

README.md

Lines changed: 18 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -17,17 +17,17 @@ Version 2.0.0 - 2.4.0, compatible with java7 / java8.
1717

1818
We [introduced some incompatibilities](https://github.com/onelogin/java-saml/issues/90), that could be fixed and make it compatible with java6.
1919

20-
Version 1.1.2 is considered to be deprecated. If you have used it, we strongly recommend that you migrate to the new version.
20+
Version 1.1.2 is considered to be deprecated. If you have used it, we strongly recommend that you migrate to the new version.
2121
We rebuilt the toolkit on 2.0.0, so code/settings that you had been using in the previous version will no longer be compatible.
2222

2323

2424
## Why add SAML support to my software?
2525

2626
SAML is an XML-based standard for web browser single sign-on and is defined by
27-
the OASIS Security Services Technical Committee. The standard has been around
27+
the OASIS Security Services Technical Committee. The standard has been around
2828
since 2002, but lately it has become popular due to its advantages as follows:
2929

30-
* **Usability** - One-click access from portals or intranets, deep linking,
30+
* **Usability** - One-click access from portals or intranets, deep linking,
3131
password elimination and automatically renewing sessions make life
3232
easier for the user.
3333
* **Security** - Based on strong digital signatures for authentication and
@@ -40,7 +40,7 @@ since 2002, but lately it has become popular due to its advantages as follows:
4040
* **IT Friendly** - SAML simplifies life for IT because it centralizes
4141
authentication, provides greater visibility and makes directory
4242
integration easier.
43-
* **Opportunity** - B2B cloud vendor should support SAML to facilitate the
43+
* **Opportunity** - B2B cloud vendor should support SAML to facilitate the
4444
integration of their product.
4545

4646

@@ -75,7 +75,7 @@ In production, the **onelogin.saml2.strict** setting parameter MUST be set as **
7575

7676
In production also we highly recommend to register on the settings the IdP certificate instead of using the fingerprint method. The fingerprint, is a hash, so at the end is open to a collision attack that can end on a signature validation bypass. Other SAML toolkits deprecated that mechanism, we maintain it for compatibility and also to be used on test environment.
7777

78-
The IdPMetadataParser class does not validate in any way the URL that is introduced in order to be parsed.
78+
The IdPMetadataParser class does not validate in any way the URL that is introduced in order to be parsed.
7979

8080
Usually the same administrator that handles the Service Provider also sets the URL to the IdP, which should be a trusted resource.
8181

@@ -97,7 +97,7 @@ Install it as a maven dependency:
9797
<dependency>
9898
<groupId>com.onelogin</groupId>
9999
<artifactId>java-saml</artifactId>
100-
<version>2.6.0</version>
100+
<version>2.8.0</version>
101101
</dependency>
102102
```
103103

@@ -246,12 +246,12 @@ onelogin.saml2.sp.x509cert =
246246
# Future SP certificate, to be used during SP Key roll over
247247
onelogin.saml2.sp.x509certNew =
248248

249-
# Requires Format PKCS#8 BEGIN PRIVATE KEY
249+
# Requires Format PKCS#8 BEGIN PRIVATE KEY
250250
# If you have PKCS#1 BEGIN RSA PRIVATE KEY convert it by openssl pkcs8 -topk8 -inform pem -nocrypt -in sp.rsa_key -outform pem -out sp.pem
251251
onelogin.saml2.sp.privatekey =
252252

253253
# Organization
254-
onelogin.saml2.organization.name = SP Java
254+
onelogin.saml2.organization.name = SP Java
255255
onelogin.saml2.organization.displayname = SP Java Example
256256
onelogin.saml2.organization.url = http://sp.example.com
257257
onelogin.saml2.organization.lang = en
@@ -269,7 +269,7 @@ onelogin.saml2.sp.contact[1].contactType=other
269269
onelogin.saml2.sp.contact[1].company=Big Corp
270270
onelogin.saml2.sp.contact[1].email_address=info@example.com
271271

272-
# Legacy contacts (legacy way to specify just a technical and a support contact with minimal info)
272+
# Legacy contacts (legacy way to specify just a technical and a support contact with minimal info)
273273
onelogin.saml2.contacts.technical.given_name = Technical Guy
274274
onelogin.saml2.contacts.technical.email_address = technical@example.com
275275
onelogin.saml2.contacts.support.given_name = Support Guy
@@ -284,7 +284,7 @@ onelogin.saml2.idp.entityid =
284284
# URL Target of the IdP where the SP will send the Authentication Request Message
285285
onelogin.saml2.idp.single_sign_on_service.url =
286286

287-
# SAML protocol binding to be used to deliver the <AuthnRequest> message
287+
# SAML protocol binding to be used to deliver the <AuthnRequest> message
288288
# to the IdP. Onelogin Toolkit supports for this endpoint the
289289
# HTTP-Redirect binding only
290290
onelogin.saml2.idp.single_sign_on_service.binding = urn:oasis:names:tc:SAML:2.0:bindings:HTTP-Redirect
@@ -316,7 +316,7 @@ onelogin.saml2.idp.x509cert =
316316
# If a fingerprint is provided, then the certFingerprintAlgorithm is required in order to
317317
# let the toolkit know which Algorithm was used. Possible values: sha1, sha256, sha384 or sha512
318318
# 'sha1' is the default value.
319-
# onelogin.saml2.idp.certfingerprint =
319+
# onelogin.saml2.idp.certfingerprint =
320320
# onelogin.saml2.idp.certfingerprint_algorithm = sha256
321321

322322
# Security settings
@@ -346,7 +346,7 @@ onelogin.saml2.security.want_messages_signed = false
346346
onelogin.saml2.security.want_assertions_signed = false
347347

348348
# Indicates a requirement for the Metadata of this SP to be signed.
349-
# Right now supported null (in order to not sign) or true (sign using SP private key)
349+
# Right now supported null (in order to not sign) or true (sign using SP private key)
350350
onelogin.saml2.security.sign_metadata =
351351

352352
# Indicates a requirement for the Assertions received by this SP to be encrypted
@@ -394,7 +394,7 @@ onelogin.saml2.security.reject_deprecated_alg = true
394394
# SAML specification states that no trimming for string elements should be performed, so no trimming will be
395395
# performed by default on extracted Name IDs and attribute values. However, some SAML implementations may add
396396
# undesirable surrounding whitespace when outputting XML (possibly due to formatting/pretty-printing).
397-
# These two options allow to optionally enable value trimming on extracted Name IDs (including issuers) and
397+
# These two options allow to optionally enable value trimming on extracted Name IDs (including issuers) and
398398
# attribute values.
399399
onelogin.saml2.parsing.trim_name_ids = false
400400
onelogin.saml2.parsing.trim_attribute_values = false
@@ -665,7 +665,7 @@ and later executing the redirection manually.
665665

666666
### Extending the provided implementation
667667

668-
All the provided SAML message classes (`AuthnRequest`, `SamlResponse`, `LogoutRequest`, `LogoutResponse`) can be extended to add or change the processing behavior.
668+
All the provided SAML message classes (`AuthnRequest`, `SamlResponse`, `LogoutRequest`, `LogoutResponse`) can be extended to add or change the processing behavior.
669669

670670
In particular, the classes used to produce outgoing messages (`AuthnRequest`, `LogoutRequest`, and `LogoutResponse`) also provide a `postProcessXml` method that can be overridden to customise the generation of the corresponding SAML message XML, along with the ability to pass in proper extensions of the input parameter classes (`AuthnRequestParams`, `LogoutRequestParams`, and `LogoutResponseParams` respectively).
671671

@@ -683,7 +683,7 @@ auth.setSamlMessageFactory(new SamlMessageFactory() {
683683
public SamlResponse createSamlResponse(Saml2Settings settings, HttpRequest request) throws Exception {
684684
return new SamlResponseEx(settings, request);
685685
}
686-
});
686+
});
687687
// then proceed with login...
688688
auth.login(relayState, new AuthnRequestParamsEx()); // the custom generation of AuthnReqeustEx will be executed
689689
// ... or process the response as usual
@@ -700,12 +700,12 @@ For Apache Tomcat this is done by setting the proxyName, proxyPort, scheme and s
700700

701701

702702
### IdP with multiple certificates
703-
703+
704704
In some scenarios the IdP uses different certificates for
705705
signing/encryption, or is under key rollover phase and more than one certificate is published on IdP metadata.
706-
706+
707707
In order to handle that the toolkit offers the `onelogin.saml2.idp.x509certMulti` parameters where you can set additional certificates that will be used to validate IdP signature. However just the certificate set in `onelogin.saml2.idp.x509cert` parameter will be used for encrypting.
708-
708+
709709

710710
### Replay attacks
711711

0 commit comments

Comments
 (0)