GitHub-Spring
/
spring-authorization-server
mirror of https://github.com/spring-projects/spring-authorization-server.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
Browse Source

Polish Antora migration 

Issue gh-1292
Closes gh-1295
pull/1297/head
Steve Riesenberg 2 years ago
parent
0f0424ad2a
commit
ac441e60bd
No known key found for this signature in database
GPG Key ID: 5F311AB48A55D521
19 changed files with 149 additions and 149 deletions
Whitespace
Show all changes Ignore whitespace when comparing lines Ignore changes in amount of whitespace Ignore changes in whitespace at EOL
Unified View
Diff Options
Show Stats Download Patch File Download Diff File
  1. 4
      docs/antora-playbook.yml
  2. 2
      docs/modules/ROOT/nav.adoc
  3. 2
      docs/modules/ROOT/pages/getting-started.adoc
  4. 14
      docs/modules/ROOT/pages/guides/how-to-jpa.adoc
  5. 2
      docs/modules/ROOT/pages/guides/how-to-userinfo.adoc
  6. 103
      docs/modules/ROOT/pages/index.adoc
  7. 94
      docs/modules/ROOT/pages/overview.adoc
  8. 12
      docs/spring-authorization-server-docs.gradle
  9. 0
      docs/src/docs/asciidoc/examples/spring-authorization-server-docs-examples.gradle
  10. 8
      docs/src/docs/asciidoc/index-docinfo-footer.html
  11. 13
      docs/src/docs/asciidoc/index-docinfo.xml
  12. 2
      docs/src/main/java/sample/jpa/entity/authorizationconsent/AuthorizationConsent.java
  13. 4
      docs/src/main/java/sample/jpa/repository/authorizationconsent/AuthorizationConsentRepository.java
  14. 6
      docs/src/main/java/sample/jpa/service/authorizationconsent/JpaOAuth2AuthorizationConsentService.java
  15. 2
      docs/src/test/java/sample/jpa/JpaTests.java
  16. 5
      etc/checkstyle/suppressions.xml
  17. 1
      etc/nohttp/allowlist.lines
  18. 15
      etc/nohttp/checkstyle.xml
  19. 7
      etc/nohttp/suppressions.xml

4
docs/antora-playbook.yml
Unescape View File

@ -11,11 +11,11 @@ antora:
- '@antora/atlas-extension' - '@antora/atlas-extension'
site: site:
title: Spring Authorization Server title: Spring Authorization Server
url: https://https://rwinch.github.io/spring-authorization-server/ url: https://docs.spring.io/spring-authorization-server/
content: content:
sources: sources:
- url: .. - url: ..
branches: antora branches: HEAD
start_path: docs start_path: docs
worktrees: true worktrees: true
asciidoc: asciidoc:

2
docs/modules/ROOT/nav.adoc
Unescape View File

@ -1,4 +1,4 @@
* xref:index.adoc[] * xref:overview.adoc[]
* xref:getting-help.adoc[] * xref:getting-help.adoc[]
* xref:getting-started.adoc[] * xref:getting-started.adoc[]
* xref:configuration-model.adoc[] * xref:configuration-model.adoc[]

2
docs/modules/ROOT/pages/getting-started.adoc
Unescape View File

@ -88,7 +88,7 @@ If you want to customize the default configuration (regardless of whether you're
These components can be defined as follows: These components can be defined as follows:
[[sample.gettingStarted]] [[sample.gettingstarted]]
.SecurityConfig.java .SecurityConfig.java
[source,java] [source,java]
---- ----

14
docs/modules/ROOT/pages/guides/how-to-jpa.adoc
Unescape View File

@ -112,7 +112,7 @@ CREATE TABLE authorization (
=== Authorization Consent Schema === Authorization Consent Schema
The xref:core-model-components.adoc#oauth2-authorization-consent[`OAuth2AuthorizationConsent`] domain object is the simplest to model and contains only a single multi-valued field in addition to a composite key. The xref:core-model-components.adoc#oauth2-authorization-consent[`OAuth2AuthorizationConsent`] domain object is the simplest to model and contains only a single multi-valued field in addition to a composite key.
The following listing shows the `authorizationConsent` schema. The following listing shows the `authorizationconsent` schema.
.Authorization Consent Schema .Authorization Consent Schema
[source,sql] [source,sql]
@ -167,11 +167,11 @@ include::{examples-dir}/main/java/sample/jpa/entity/authorization/Authorization.
The following listing shows the `AuthorizationConsent` entity, which is used to persist information mapped from the xref:core-model-components.adoc#oauth2-authorization-consent[`OAuth2AuthorizationConsent`] domain object. The following listing shows the `AuthorizationConsent` entity, which is used to persist information mapped from the xref:core-model-components.adoc#oauth2-authorization-consent[`OAuth2AuthorizationConsent`] domain object.
[[sample.jpa.entity.authorizationConsent]] [[sample.jpa.entity.authorizationconsent]]
.Authorization Consent Entity .Authorization Consent Entity
[source,java] [source,java]
---- ----
include::{examples-dir}/main/java/sample/jpa/entity/authorizationConsent/AuthorizationConsent.java[] include::{examples-dir}/main/java/sample/jpa/entity/authorizationconsent/AuthorizationConsent.java[]
---- ----
[[create-spring-data-repositories]] [[create-spring-data-repositories]]
@ -213,11 +213,11 @@ include::{examples-dir}/main/java/sample/jpa/repository/authorization/Authorizat
The following listing shows the `AuthorizationConsentRepository`, which is able to find and delete an xref:guides/how-to-jpa.adoc#authorization-consent-entity[`AuthorizationConsent`] by the `registeredClientId` and `principalName` fields that form a composite primary key. The following listing shows the `AuthorizationConsentRepository`, which is able to find and delete an xref:guides/how-to-jpa.adoc#authorization-consent-entity[`AuthorizationConsent`] by the `registeredClientId` and `principalName` fields that form a composite primary key.
[[sample.jpa.repository.authorizationConsent]] [[sample.jpa.repository.authorizationconsent]]
.Authorization Consent Repository .Authorization Consent Repository
[source,java] [source,java]
---- ----
include::{examples-dir}/main/java/sample/jpa/repository/authorizationConsent/AuthorizationConsentRepository.java[] include::{examples-dir}/main/java/sample/jpa/repository/authorizationconsent/AuthorizationConsentRepository.java[]
---- ----
[[implement-core-services]] [[implement-core-services]]
@ -263,9 +263,9 @@ include::{examples-dir}/main/java/sample/jpa/service/authorization/JpaOAuth2Auth
The following listing shows the `JpaOAuth2AuthorizationConsentService`, which uses an xref:guides/how-to-jpa.adoc#authorization-consent-repository[`AuthorizationConsentRepository`] for persisting an xref:guides/how-to-jpa.adoc#authorization-consent-entity[`AuthorizationConsent`] and maps to and from the xref:core-model-components.adoc#oauth2-authorization-consent[`OAuth2AuthorizationConsent`] domain object. The following listing shows the `JpaOAuth2AuthorizationConsentService`, which uses an xref:guides/how-to-jpa.adoc#authorization-consent-repository[`AuthorizationConsentRepository`] for persisting an xref:guides/how-to-jpa.adoc#authorization-consent-entity[`AuthorizationConsent`] and maps to and from the xref:core-model-components.adoc#oauth2-authorization-consent[`OAuth2AuthorizationConsent`] domain object.
[[sample.jpa.service.authorizationConsent]] [[sample.jpa.service.authorizationconsent]]
.`OAuth2AuthorizationConsentService` Implementation .`OAuth2AuthorizationConsentService` Implementation
[source,java] [source,java]
---- ----
include::{examples-dir}/main/java/sample/jpa/service/authorizationConsent/JpaOAuth2AuthorizationConsentService.java[] include::{examples-dir}/main/java/sample/jpa/service/authorizationconsent/JpaOAuth2AuthorizationConsentService.java[]
---- ----

2
docs/modules/ROOT/pages/guides/how-to-userinfo.adoc
Unescape View File

@ -83,7 +83,7 @@ The following listing shows how to use the customization option that is availabl
include::{examples-dir}/main/java/sample/userinfo/jwt/JwtUserInfoMapperSecurityConfig.java[] include::{examples-dir}/main/java/sample/userinfo/jwt/JwtUserInfoMapperSecurityConfig.java[]
---- ----
This configuration maps claims from the access token (which is a JWT when using the xref:getting-started.adoc#sample.gettingStarted[Getting Started config]) to populate the user info response and provides the following: This configuration maps claims from the access token (which is a JWT when using the xref:getting-started.adoc#sample.gettingstarted[Getting Started config]) to populate the user info response and provides the following:
<1> A Spring Security filter chain for the xref:{docs-dir}/protocol-endpoints.adoc[Protocol Endpoints]. <1> A Spring Security filter chain for the xref:{docs-dir}/protocol-endpoints.adoc[Protocol Endpoints].
<2> A user info mapper that maps claims in a domain-specific way. <2> A user info mapper that maps claims in a domain-specific way.

103
docs/modules/ROOT/pages/index.adoc
Unescape View File

@ -1,109 +1,12 @@
:noheader:
[[top]] [[top]]
= Overview = Spring Authorization Server Reference
:page-section-summary-toc: 1
Joe Grandja, Steve Riesenberg
v{spring-authorization-server-version}
:docinfo: private-footer
:nofooter:
This site contains reference documentation and how-to guides for Spring Authorization Server.
[horizontal] [horizontal]
xref:index.adoc#introducing-spring-authorization-server[Introduction] :: Introduction and feature list xref:overview.adoc[Overview] :: Introduction and feature list
xref:getting-help.adoc[Getting Help] :: Links to samples, questions and issues xref:getting-help.adoc[Getting Help] :: Links to samples, questions and issues
xref:getting-started.adoc[Getting Started] :: System requirements, dependencies and developing your first application xref:getting-started.adoc[Getting Started] :: System requirements, dependencies and developing your first application
xref:configuration-model.adoc[Configuration Model] :: Default configuration and customizing the configuration xref:configuration-model.adoc[Configuration Model] :: Default configuration and customizing the configuration
xref:core-model-components.adoc[Core Model / Components] :: Core domain model and component interfaces xref:core-model-components.adoc[Core Model / Components] :: Core domain model and component interfaces
xref:protocol-endpoints.adoc[Protocol Endpoints] :: OAuth2 and OpenID Connect 1.0 protocol endpoint implementations xref:protocol-endpoints.adoc[Protocol Endpoints] :: OAuth2 and OpenID Connect 1.0 protocol endpoint implementations
xref:how-to.adoc[How-to Guides] :: Guides to get the most from Spring Authorization Server xref:how-to.adoc[How-to Guides] :: Guides to get the most from Spring Authorization Server
[[introducing-spring-authorization-server]]
== Introducing Spring Authorization Server
Spring Authorization Server is a framework that provides implementations of the https://datatracker.ietf.org/doc/html/draft-ietf-oauth-v2-1-07[OAuth 2.1] and https://openid.net/specs/openid-connect-core-1_0.html[OpenID Connect 1.0] specifications and other related specifications.
It is built on top of https://spring.io/projects/spring-security[Spring Security] to provide a secure, light-weight, and customizable foundation for building OpenID Connect 1.0 Identity Providers and OAuth2 Authorization Server products.
[[feature-list]]
== Feature List
Spring Authorization Server supports the following features:
[cols="2a,4a,6a"]
|===
|Category |Feature |Related specifications
|xref:protocol-endpoints.adoc#oauth2-token-endpoint[Authorization Grant]
|
* Authorization Code
** xref:protocol-endpoints.adoc#oauth2-authorization-endpoint[User Consent]
* Client Credentials
* Refresh Token
* Device Code
** xref:protocol-endpoints.adoc#oauth2-device-verification-endpoint[User Consent]
|
* The OAuth 2.1 Authorization Framework (https://datatracker.ietf.org/doc/html/draft-ietf-oauth-v2-1-07[draft])
** https://datatracker.ietf.org/doc/html/draft-ietf-oauth-v2-1-07#section-4.1[Authorization Code Grant]
** https://datatracker.ietf.org/doc/html/draft-ietf-oauth-v2-1-07#section-4.2[Client Credentials Grant]
** https://datatracker.ietf.org/doc/html/draft-ietf-oauth-v2-1-07#section-4.3[Refresh Token Grant]
* OpenID Connect Core 1.0 (https://openid.net/specs/openid-connect-core-1_0.html[spec])
** https://openid.net/specs/openid-connect-core-1_0.html#CodeFlowAuth[Authorization Code Flow]
* OAuth 2.0 Device Authorization Grant
(https://tools.ietf.org/html/rfc8628[spec])
** https://tools.ietf.org/html/rfc8628#section-3[Device Flow]
|xref:core-model-components.adoc#oauth2-token-generator[Token Formats]
|
* Self-contained (JWT)
* Reference (Opaque)
|
* JSON Web Token (JWT) (https://tools.ietf.org/html/rfc7519[RFC 7519])
* JSON Web Signature (JWS) (https://tools.ietf.org/html/rfc7515[RFC 7515])
|xref:configuration-model.adoc#configuring-client-authentication[Client Authentication]
|
* `client_secret_basic`
* `client_secret_post`
* `client_secret_jwt`
* `private_key_jwt`
* `none` (public clients)
|
* The OAuth 2.1 Authorization Framework (https://datatracker.ietf.org/doc/html/draft-ietf-oauth-v2-1-07#section-2.4[Client Authentication])
* JSON Web Token (JWT) Profile for OAuth 2.0 Client Authentication (https://tools.ietf.org/html/rfc7523[RFC 7523])
* Proof Key for Code Exchange by OAuth Public Clients (PKCE) (https://tools.ietf.org/html/rfc7636[RFC 7636])
|xref:protocol-endpoints.adoc[Protocol Endpoints]
|
* xref:protocol-endpoints.adoc#oauth2-authorization-endpoint[OAuth2 Authorization Endpoint]
* xref:protocol-endpoints.adoc#oauth2-device-authorization-endpoint[OAuth2 Device Authorization Endpoint]
* xref:protocol-endpoints.adoc#oauth2-device-verification-endpoint[OAuth2 Device Verification Endpoint]
* xref:protocol-endpoints.adoc#oauth2-token-endpoint[OAuth2 Token Endpoint]
* xref:protocol-endpoints.adoc#oauth2-token-introspection-endpoint[OAuth2 Token Introspection Endpoint]
* xref:protocol-endpoints.adoc#oauth2-token-revocation-endpoint[OAuth2 Token Revocation Endpoint]
* xref:protocol-endpoints.adoc#oauth2-authorization-server-metadata-endpoint[OAuth2 Authorization Server Metadata Endpoint]
* xref:protocol-endpoints.adoc#jwk-set-endpoint[JWK Set Endpoint]
* xref:protocol-endpoints.adoc#oidc-provider-configuration-endpoint[OpenID Connect 1.0 Provider Configuration Endpoint]
* xref:protocol-endpoints.adoc#oidc-logout-endpoint[OpenID Connect 1.0 Logout Endpoint]
* xref:protocol-endpoints.adoc#oidc-user-info-endpoint[OpenID Connect 1.0 UserInfo Endpoint]
* xref:protocol-endpoints.adoc#oidc-client-registration-endpoint[OpenID Connect 1.0 Client Registration Endpoint]
|
* The OAuth 2.1 Authorization Framework (https://datatracker.ietf.org/doc/html/draft-ietf-oauth-v2-1-07[draft])
** https://datatracker.ietf.org/doc/html/draft-ietf-oauth-v2-1-07#section-3.1[Authorization Endpoint]
** https://datatracker.ietf.org/doc/html/draft-ietf-oauth-v2-1-07#section-3.2[Token Endpoint]
* OAuth 2.0 Device Authorization Grant (https://tools.ietf.org/html/rfc8628[RFC 8628])
** https://tools.ietf.org/html/rfc8628#section-3.1[Device Authorization Endpoint]
** https://tools.ietf.org/html/rfc8628#section-3.3[Device Verification Endpoint]
* OAuth 2.0 Token Introspection (https://tools.ietf.org/html/rfc7662[RFC 7662])
* OAuth 2.0 Token Revocation (https://tools.ietf.org/html/rfc7009[RFC 7009])
* OAuth 2.0 Authorization Server Metadata (https://tools.ietf.org/html/rfc8414[RFC 8414])
* JSON Web Key (JWK) (https://tools.ietf.org/html/rfc7517[RFC 7517])
* OpenID Connect Discovery 1.0 (https://openid.net/specs/openid-connect-discovery-1_0.html[spec])
** https://openid.net/specs/openid-connect-discovery-1_0.html#ProviderConfig[Provider Configuration Endpoint]
* OpenID Connect RP-Initiated Logout 1.0 (https://openid.net/specs/openid-connect-rpinitiated-1_0.html[spec])
** https://openid.net/specs/openid-connect-rpinitiated-1_0.html#RPLogout[Logout Endpoint]
* OpenID Connect Core 1.0 (https://openid.net/specs/openid-connect-core-1_0.html[spec])
** https://openid.net/specs/openid-connect-core-1_0.html#UserInfo[UserInfo Endpoint]
* OpenID Connect Dynamic Client Registration 1.0 (https://openid.net/specs/openid-connect-registration-1_0.html[spec])
** https://openid.net/specs/openid-connect-registration-1_0.html#ClientRegistration[Client Registration Endpoint]
** https://openid.net/specs/openid-connect-registration-1_0.html#ClientConfigurationEndpoint[Client Configuration Endpoint]
|===

94
docs/modules/ROOT/pages/overview.adoc
Unescape View File

@ -0,0 +1,94 @@
[[overview]]
= Overview
This site contains reference documentation and how-to guides for Spring Authorization Server.
[[introducing-spring-authorization-server]]
== Introducing Spring Authorization Server
Spring Authorization Server is a framework that provides implementations of the https://datatracker.ietf.org/doc/html/draft-ietf-oauth-v2-1-07[OAuth 2.1] and https://openid.net/specs/openid-connect-core-1_0.html[OpenID Connect 1.0] specifications and other related specifications.
It is built on top of https://spring.io/projects/spring-security[Spring Security] to provide a secure, light-weight, and customizable foundation for building OpenID Connect 1.0 Identity Providers and OAuth2 Authorization Server products.
[[feature-list]]
== Feature List
Spring Authorization Server supports the following features:
[cols="2a,4a,6a"]
|===
|Category |Feature |Related specifications
|xref:protocol-endpoints.adoc#oauth2-token-endpoint[Authorization Grant]
|
* Authorization Code
** xref:protocol-endpoints.adoc#oauth2-authorization-endpoint[User Consent]
* Client Credentials
* Refresh Token
* Device Code
** xref:protocol-endpoints.adoc#oauth2-device-verification-endpoint[User Consent]
|
* The OAuth 2.1 Authorization Framework (https://datatracker.ietf.org/doc/html/draft-ietf-oauth-v2-1-07[draft])
** https://datatracker.ietf.org/doc/html/draft-ietf-oauth-v2-1-07#section-4.1[Authorization Code Grant]
** https://datatracker.ietf.org/doc/html/draft-ietf-oauth-v2-1-07#section-4.2[Client Credentials Grant]
** https://datatracker.ietf.org/doc/html/draft-ietf-oauth-v2-1-07#section-4.3[Refresh Token Grant]
* OpenID Connect Core 1.0 (https://openid.net/specs/openid-connect-core-1_0.html[spec])
** https://openid.net/specs/openid-connect-core-1_0.html#CodeFlowAuth[Authorization Code Flow]
* OAuth 2.0 Device Authorization Grant
(https://tools.ietf.org/html/rfc8628[spec])
** https://tools.ietf.org/html/rfc8628#section-3[Device Flow]
|xref:core-model-components.adoc#oauth2-token-generator[Token Formats]
|
* Self-contained (JWT)
* Reference (Opaque)
|
* JSON Web Token (JWT) (https://tools.ietf.org/html/rfc7519[RFC 7519])
* JSON Web Signature (JWS) (https://tools.ietf.org/html/rfc7515[RFC 7515])
|xref:configuration-model.adoc#configuring-client-authentication[Client Authentication]
|
* `client_secret_basic`
* `client_secret_post`
* `client_secret_jwt`
* `private_key_jwt`
* `none` (public clients)
|
* The OAuth 2.1 Authorization Framework (https://datatracker.ietf.org/doc/html/draft-ietf-oauth-v2-1-07#section-2.4[Client Authentication])
* JSON Web Token (JWT) Profile for OAuth 2.0 Client Authentication (https://tools.ietf.org/html/rfc7523[RFC 7523])
* Proof Key for Code Exchange by OAuth Public Clients (PKCE) (https://tools.ietf.org/html/rfc7636[RFC 7636])
|xref:protocol-endpoints.adoc[Protocol Endpoints]
|
* xref:protocol-endpoints.adoc#oauth2-authorization-endpoint[OAuth2 Authorization Endpoint]
* xref:protocol-endpoints.adoc#oauth2-device-authorization-endpoint[OAuth2 Device Authorization Endpoint]
* xref:protocol-endpoints.adoc#oauth2-device-verification-endpoint[OAuth2 Device Verification Endpoint]
* xref:protocol-endpoints.adoc#oauth2-token-endpoint[OAuth2 Token Endpoint]
* xref:protocol-endpoints.adoc#oauth2-token-introspection-endpoint[OAuth2 Token Introspection Endpoint]
* xref:protocol-endpoints.adoc#oauth2-token-revocation-endpoint[OAuth2 Token Revocation Endpoint]
* xref:protocol-endpoints.adoc#oauth2-authorization-server-metadata-endpoint[OAuth2 Authorization Server Metadata Endpoint]
* xref:protocol-endpoints.adoc#jwk-set-endpoint[JWK Set Endpoint]
* xref:protocol-endpoints.adoc#oidc-provider-configuration-endpoint[OpenID Connect 1.0 Provider Configuration Endpoint]
* xref:protocol-endpoints.adoc#oidc-logout-endpoint[OpenID Connect 1.0 Logout Endpoint]
* xref:protocol-endpoints.adoc#oidc-user-info-endpoint[OpenID Connect 1.0 UserInfo Endpoint]
* xref:protocol-endpoints.adoc#oidc-client-registration-endpoint[OpenID Connect 1.0 Client Registration Endpoint]
|
* The OAuth 2.1 Authorization Framework (https://datatracker.ietf.org/doc/html/draft-ietf-oauth-v2-1-07[draft])
** https://datatracker.ietf.org/doc/html/draft-ietf-oauth-v2-1-07#section-3.1[Authorization Endpoint]
** https://datatracker.ietf.org/doc/html/draft-ietf-oauth-v2-1-07#section-3.2[Token Endpoint]
* OAuth 2.0 Device Authorization Grant (https://tools.ietf.org/html/rfc8628[RFC 8628])
** https://tools.ietf.org/html/rfc8628#section-3.1[Device Authorization Endpoint]
** https://tools.ietf.org/html/rfc8628#section-3.3[Device Verification Endpoint]
* OAuth 2.0 Token Introspection (https://tools.ietf.org/html/rfc7662[RFC 7662])
* OAuth 2.0 Token Revocation (https://tools.ietf.org/html/rfc7009[RFC 7009])
* OAuth 2.0 Authorization Server Metadata (https://tools.ietf.org/html/rfc8414[RFC 8414])
* JSON Web Key (JWK) (https://tools.ietf.org/html/rfc7517[RFC 7517])
* OpenID Connect Discovery 1.0 (https://openid.net/specs/openid-connect-discovery-1_0.html[spec])
** https://openid.net/specs/openid-connect-discovery-1_0.html#ProviderConfig[Provider Configuration Endpoint]
* OpenID Connect RP-Initiated Logout 1.0 (https://openid.net/specs/openid-connect-rpinitiated-1_0.html[spec])
** https://openid.net/specs/openid-connect-rpinitiated-1_0.html#RPLogout[Logout Endpoint]
* OpenID Connect Core 1.0 (https://openid.net/specs/openid-connect-core-1_0.html[spec])
** https://openid.net/specs/openid-connect-core-1_0.html#UserInfo[UserInfo Endpoint]
* OpenID Connect Dynamic Client Registration 1.0 (https://openid.net/specs/openid-connect-registration-1_0.html[spec])
** https://openid.net/specs/openid-connect-registration-1_0.html#ClientRegistration[Client Registration Endpoint]
** https://openid.net/specs/openid-connect-registration-1_0.html#ClientConfigurationEndpoint[Client Configuration Endpoint]
|===

12
docs/spring-authorization-server-docs.gradle
Unescape View File

@ -1,7 +1,7 @@
plugins { plugins {
id "io.spring.convention.docs" id "io.spring.convention.docs"
id 'io.spring.antora.generate-antora-yml' version '0.0.1' id "io.spring.antora.generate-antora-yml" version "0.0.1"
id 'org.antora' version '1.0.0' id "org.antora" version "1.0.0"
id "java" id "java"
} }
@ -10,11 +10,11 @@ version = project.rootProject.version
sourceCompatibility = "17" sourceCompatibility = "17"
antora { antora {
playbook = 'cached-antora-playbook.yml' playbook = "cached-antora-playbook.yml"
playbookProvider { playbookProvider {
repository = 'rwinch/spring-authorization-server' repository = "spring-projects/spring-authorization-server"
branch = 'docs-build' branch = "docs-build"
path = 'lib/antora/templates/per-branch-antora-playbook.yml' path = "lib/antora/templates/per-branch-antora-playbook.yml"
checkLocalBranch = true checkLocalBranch = true
} }
options = [clean: true, fetch: !project.gradle.startParameter.offline, stacktrace: true] options = [clean: true, fetch: !project.gradle.startParameter.offline, stacktrace: true]

0
docs/src/docs/asciidoc/examples/spring-authorization-server-docs-examples.gradle
Unescape View File

8
docs/src/docs/asciidoc/index-docinfo-footer.html
Unescape View File

@ -1,8 +0,0 @@
<div id="footer">
<div id="footer-text">
Version {spring-authorization-server-version}<br>
Last updated {docdatetime}<br>
Copyright &copy; 2020-{docyear}
<p class="paragraph">Copies of this document may be made for your own use and for distribution to others, provided that you do not charge any fee for such copies and further provided that each copy contains this Copyright Notice, whether distributed in print or electronically.</p>
</div>
</div>

13
docs/src/docs/asciidoc/index-docinfo.xml
Unescape View File

@ -1,13 +0,0 @@
<productname>Spring Authorization Server</productname>
<releaseinfo>{spring-authorization-server-version}</releaseinfo>
<copyright>
<year>2020-{docyear}</year>
</copyright>
<legalnotice>
<para>
Copies of this document may be made for your own use and for distribution to
others, provided that you do not charge any fee for such copies and further provided
that each copy contains this Copyright Notice, whether distributed in print or
electronically.
</para>
</legalnotice>

2
docs/src/main/java/sample/jpa/entity/authorizationConsent/AuthorizationConsent.java → docs/src/main/java/sample/jpa/entity/authorizationconsent/AuthorizationConsent.java
Unescape View File

@ -13,7 +13,7 @@
* See the License for the specific language governing permissions and * See the License for the specific language governing permissions and
* limitations under the License. * limitations under the License.
*/ */
package sample.jpa.entity.authorizationConsent; package sample.jpa.entity.authorizationconsent;
import java.io.Serializable; import java.io.Serializable;
import java.util.Objects; import java.util.Objects;

4
docs/src/main/java/sample/jpa/repository/authorizationConsent/AuthorizationConsentRepository.java → docs/src/main/java/sample/jpa/repository/authorizationconsent/AuthorizationConsentRepository.java
Unescape View File

@ -13,11 +13,11 @@
* See the License for the specific language governing permissions and * See the License for the specific language governing permissions and
* limitations under the License. * limitations under the License.
*/ */
package sample.jpa.repository.authorizationConsent; package sample.jpa.repository.authorizationconsent;
import java.util.Optional; import java.util.Optional;
import sample.jpa.entity.authorizationConsent.AuthorizationConsent; import sample.jpa.entity.authorizationconsent.AuthorizationConsent;
import org.springframework.data.jpa.repository.JpaRepository; import org.springframework.data.jpa.repository.JpaRepository;
import org.springframework.stereotype.Repository; import org.springframework.stereotype.Repository;

6
docs/src/main/java/sample/jpa/service/authorizationConsent/JpaOAuth2AuthorizationConsentService.java → docs/src/main/java/sample/jpa/service/authorizationconsent/JpaOAuth2AuthorizationConsentService.java
Unescape View File

@ -13,13 +13,13 @@
* See the License for the specific language governing permissions and * See the License for the specific language governing permissions and
* limitations under the License. * limitations under the License.
*/ */
package sample.jpa.service.authorizationConsent; package sample.jpa.service.authorizationconsent;
import java.util.HashSet; import java.util.HashSet;
import java.util.Set; import java.util.Set;
import sample.jpa.entity.authorizationConsent.AuthorizationConsent; import sample.jpa.entity.authorizationconsent.AuthorizationConsent;
import sample.jpa.repository.authorizationConsent.AuthorizationConsentRepository; import sample.jpa.repository.authorizationconsent.AuthorizationConsentRepository;
import org.springframework.dao.DataRetrievalFailureException; import org.springframework.dao.DataRetrievalFailureException;
import org.springframework.security.core.GrantedAuthority; import org.springframework.security.core.GrantedAuthority;

2
docs/src/test/java/sample/jpa/JpaTests.java
Unescape View File

@ -28,7 +28,7 @@ import sample.AuthorizationCodeGrantFlow;
import sample.DeviceAuthorizationGrantFlow; import sample.DeviceAuthorizationGrantFlow;
import sample.jose.TestJwks; import sample.jose.TestJwks;
import sample.jpa.service.authorization.JpaOAuth2AuthorizationService; import sample.jpa.service.authorization.JpaOAuth2AuthorizationService;
import sample.jpa.service.authorizationConsent.JpaOAuth2AuthorizationConsentService; import sample.jpa.service.authorizationconsent.JpaOAuth2AuthorizationConsentService;
import sample.jpa.service.client.JpaRegisteredClientRepository; import sample.jpa.service.client.JpaRegisteredClientRepository;
import sample.test.SpringTestContext; import sample.test.SpringTestContext;
import sample.test.SpringTestContextExtension; import sample.test.SpringTestContextExtension;

5
etc/checkstyle/suppressions.xml
Unescape View File

@ -1,6 +1,7 @@
<?xml version="1.0"?> <?xml version="1.0"?>
<!DOCTYPE suppressions PUBLIC "-//Puppy Crawl//DTD Suppressions 1.1//EN" <!DOCTYPE suppressions PUBLIC
"https://www.puppycrawl.com/dtds/suppressions_1_1.dtd"> "-//Checkstyle//DTD SuppressionFilter Configuration 1.2//EN"
"https://checkstyle.org/dtds/suppressions_1_2.dtd">
<suppressions> <suppressions>
<suppress files=".+Application\.java" checks="HideUtilityClassConstructor"/> <suppress files=".+Application\.java" checks="HideUtilityClassConstructor"/>
<suppress files=".+Configuration\.java" checks="HideUtilityClassConstructor"/> <suppress files=".+Configuration\.java" checks="HideUtilityClassConstructor"/>

1
etc/nohttp/allowlist.lines
Unescape View File

@ -6,3 +6,4 @@
^http://webblaze.cs.berkeley.edu/.* ^http://webblaze.cs.berkeley.edu/.*
^http://www.w3.org/2000/09/xmldsig.* ^http://www.w3.org/2000/09/xmldsig.*
^http://www.gnu.org/.* ^http://www.gnu.org/.*
^http://www.gradle.org

15
etc/nohttp/checkstyle.xml
Unescape View File

@ -0,0 +1,15 @@
<!DOCTYPE module PUBLIC "-//Puppy Crawl//DTD Check Configuration 1.3//EN"
"https://www.puppycrawl.com/dtds/configuration_1_3.dtd">
<module name="Checker">
<property name="charset" value="UTF-8"/>
<property name="fileExtensions" value=""/>
<module name="io.spring.nohttp.checkstyle.check.NoHttpCheck">
<!-- Workaround for https://github.com/spring-io/nohttp/issues/55 -->
<property name="allowlistFileName" value="${config_loc}/allowlist.lines" default=""/>
</module>
<module name="SuppressionFilter">
<property name="file" value="${config_loc}/suppressions.xml" default=""/>
<property name="optional" value="true"/>
</module>
<module name="SuppressWithPlainTextCommentFilter"/>
</module>

7
etc/nohttp/suppressions.xml
Unescape View File

@ -0,0 +1,7 @@
<?xml version="1.0"?>
<!DOCTYPE suppressions PUBLIC
"-//Checkstyle//DTD SuppressionFilter Configuration 1.2//EN"
"https://checkstyle.org/dtds/suppressions_1_2.dtd">
<suppressions>
<suppress files="[\\/]docs[\\/].gradle[\\/]" checks="NoHttp" />
</suppressions>
Write Preview
Loading…
Cancel
Save