Skip to content

Documentation of OpenSAML 5.x is not correct #16191

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
mathewm3 opened this issue Nov 30, 2024 · 0 comments · Fixed by #16195
Closed

Documentation of OpenSAML 5.x is not correct #16191

mathewm3 opened this issue Nov 30, 2024 · 0 comments · Fixed by #16195
Labels
status: waiting-for-triage An issue we've not yet triaged type: bug A general bug

Comments

@mathewm3
Copy link

Describe the bug
The details provided in the spring security page to use Open Saml 5.x has issues:
https://docs.spring.io/spring-security/reference/servlet/saml2/opensaml.html

To Reproduce
Navigate to page: https://docs.spring.io/spring-security/reference/servlet/saml2/opensaml.html

  • Maven details does not have proper dependency XML tag ending (XML is invalid).
  • There is not artifcat with name opensaml-saml-imple
  • "opensaml-saml-api" has fourth party dependency for "opensaml-core-api". So there is no need to explicitly mentioned it.
  • "spring-security-saml2-service-provider" has direct dependency only with "opensaml-saml-api" and "opensaml-saml-impl"

Expected behavior
Modify maven details in the page: https://docs.spring.io/spring-security/reference/servlet/saml2/opensaml.html

       <dependency>
            <groupId>org.springframework.security</groupId>
            <artifactId>spring-security-saml2-service-provider</artifactId>
            <version>${org.spring-security-core.version}</version>
            <exclusions>
                <exclusion>
                    <groupId>org.opensaml</groupId>
                    <artifactId>*</artifactId>
                </exclusion>
            </exclusions>
        </dependency>

        <dependency>
            <groupId>org.opensaml</groupId>
            <artifactId>opensaml-saml-api</artifactId>
            <version>${opensaml.version}</version>
        </dependency>
        <dependency>
            <groupId>org.opensaml</groupId>
            <artifactId>opensaml-saml-impl</artifactId>
            <version>${opensaml.version}</version>
        </dependency>
@mathewm3 mathewm3 added status: waiting-for-triage An issue we've not yet triaged type: bug A general bug labels Nov 30, 2024
harpreets789 added a commit to harpreets789/spring-security that referenced this issue Dec 1, 2024
- Fixed invalid XML tags in dependency examples.
- Corrected typo in `<artifactId>` ("opensaml-saml-imple" -> "opensaml-saml-impl").
- Excluded all OpenSAML 4.x dependencies.
- Removed redundant dependencies (`opensaml-core-api` and `opensaml-core-impl`) as they are transitively included in `opensaml-saml-api` and `opensaml-saml-impl`.

Closes spring-projectsgh-16191
@jzheaux jzheaux closed this as completed in cc2506b Dec 4, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
status: waiting-for-triage An issue we've not yet triaged type: bug A general bug
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant