You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@shiro.apache.org by bm...@apache.org on 2022/01/15 12:40:57 UTC
[shiro-site] branch jbake updated: Check for mandatory files used elsewhere.
This is an automated email from the ASF dual-hosted git repository.
bmarwell pushed a commit to branch jbake
in repository https://gitbox.apache.org/repos/asf/shiro-site.git
The following commit(s) were added to refs/heads/jbake by this push:
new 83817b2 Check for mandatory files used elsewhere.
83817b2 is described below
commit 83817b2271942904d9e469e11f9d3b58d31744b1
Author: Benjamin Marwell <bm...@apache.org>
AuthorDate: Sat Jan 15 13:40:44 2022 +0100
Check for mandatory files used elsewhere.
---
.github/workflows/mandatory_files.yml | 40 +++++++++++++++++++++
jbake/assets/.htaccess | 2 +-
jbake/assets/css/base.css | 18 +++++-----
jbake/assets/{img => images}/ShiroArchitecture.png | Bin
.../ShiroAuthenticationSequence.png | Bin
.../{img => images}/ShiroAuthorizationSequence.png | Bin
.../{img => images}/ShiroBasicArchitecture.png | Bin
jbake/assets/{img => images}/ShiroFeatures.png | Bin
.../ShiroFeatures_Authentication.png | Bin
.../ShiroFeatures_Authorization.png | Bin
jbake/assets/{img => images}/apache-shiro-logo.png | Bin
jbake/assets/{img => images}/authentication.png | Bin
jbake/assets/{img => images}/authorization.png | Bin
jbake/assets/{img => images}/crypt.png | Bin
jbake/assets/{img => images}/favicon.ico | 0
jbake/assets/{img => images}/footer-shield.png | Bin
jbake/assets/{img => images}/integration.png | Bin
.../{img => images}/powered-by-shiro-vertical.png | Bin
.../{img => images}/powered_by_apache_shiro.svg | 0
jbake/assets/{img => images}/session.png | Bin
.../{img => images}/shiro-featured-image.png | Bin
jbake/assets/{img => images}/topbar.jpg | Bin
jbake/assets/{img => images}/web-integration.png | Bin
jbake/content/architecture.adoc | 4 +--
jbake/content/authentication.adoc | 4 +--
jbake/content/introduction.adoc | 4 +--
jbake/content/overview.adoc | 6 ++--
jbake/content/powered-by-shiro.adoc | 2 +-
jbake/templates/header.ftl | 4 +--
29 files changed, 62 insertions(+), 22 deletions(-)
diff --git a/.github/workflows/mandatory_files.yml b/.github/workflows/mandatory_files.yml
new file mode 100644
index 0000000..b887aad
--- /dev/null
+++ b/.github/workflows/mandatory_files.yml
@@ -0,0 +1,40 @@
+# Licensed to the Apache Software Foundation (ASF) under one
+# or more contributor license agreements. See the NOTICE file
+# distributed with this work for additional information
+# regarding copyright ownership. The ASF licenses this file
+# to you under the Apache License, Version 2.0 (the
+# "License"); you may not use this file except in compliance
+# with the License. You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied. See the License for the
+# specific language governing permissions and limitations
+# under the License.
+
+name: Mandatory files
+
+# checks for mandatory files which are used elsewhere, e.g. in Javadocs, the site, etc.
+
+on:
+ workflow_dispatch: {}
+ push: {}
+ pull_request:
+ branches: [ main, jbake ]
+
+
+jobs:
+ build:
+ runs-on: ubuntu-latest
+
+ steps:
+ - uses: actions/checkout@v2
+
+ - run: cd jbake && file assets/images/apache-shiro-logo.png
+ shell: bash
+
+ - run: cd jbake && file assets/images/asf_logo.png
+ shell: bash
diff --git a/jbake/assets/.htaccess b/jbake/assets/.htaccess
index 7283453..121e76e 100644
--- a/jbake/assets/.htaccess
+++ b/jbake/assets/.htaccess
@@ -1,4 +1,4 @@
-RedirectMatch ^/favicon.ico /img/favicon.ico
+RedirectMatch ^/favicon.ico /images/favicon.ico
RedirectMatch ^/shiro-all(.*) /static/current/shiro-all/$1
RedirectMatch ^/shiro-core(.*) /static/current/shiro-core/$1
diff --git a/jbake/assets/css/base.css b/jbake/assets/css/base.css
index ba2f896..1c93c31 100644
--- a/jbake/assets/css/base.css
+++ b/jbake/assets/css/base.css
@@ -62,7 +62,7 @@ a:visited {
#top-bar {
- background:url('/img/topbar.jpg');
+ background:url('/images/topbar.jpg');
height:6px;
width:100%;
}
@@ -99,7 +99,7 @@ a:visited {
height: 113px;
right: 40px;
top: -100px;
- background:url('/img/footer-shield.png') no-repeat;
+ background:url('/images/footer-shield.png') no-repeat;
}
}
@@ -154,22 +154,22 @@ a:visited {
/** ======================================================= **/
.authentication {
- background:url(../img/authentication.png) no-repeat #f2f2f2 right 10px top 5px;
+ background:url(../images/authentication.png) no-repeat #f2f2f2 right 10px top 5px;
}
.authorization {
- background:url(../img/authorization.png) no-repeat #f2f2f2 right 10px top 5px;
+ background:url(../images/authorization.png) no-repeat #f2f2f2 right 10px top 5px;
}
.cryptography {
- background:url(../img/crypt.png) no-repeat #f2f2f2 right 10px top 5px;
+ background:url(../images/crypt.png) no-repeat #f2f2f2 right 10px top 5px;
}
.session-management {
- background:url(../img/session.png) no-repeat #f2f2f2 right 10px top 5px;
+ background:url(../images/session.png) no-repeat #f2f2f2 right 10px top 5px;
}
.web-integration {
- background:url(../img/web-integration.png) no-repeat #f2f2f2 right 10px top 5px;
+ background:url(../images/web-integration.png) no-repeat #f2f2f2 right 10px top 5px;
}
.integrations {
- background:url(../img/integration.png) no-repeat #f2f2f2 right 10px top 5px;
+ background:url(../images/integration.png) no-repeat #f2f2f2 right 10px top 5px;
}
h2.panel-title {
@@ -212,4 +212,4 @@ div.related-content {
.related-content .read-more {
font-size: 11px;
-}
\ No newline at end of file
+}
diff --git a/jbake/assets/img/ShiroArchitecture.png b/jbake/assets/images/ShiroArchitecture.png
similarity index 100%
rename from jbake/assets/img/ShiroArchitecture.png
rename to jbake/assets/images/ShiroArchitecture.png
diff --git a/jbake/assets/img/ShiroAuthenticationSequence.png b/jbake/assets/images/ShiroAuthenticationSequence.png
similarity index 100%
rename from jbake/assets/img/ShiroAuthenticationSequence.png
rename to jbake/assets/images/ShiroAuthenticationSequence.png
diff --git a/jbake/assets/img/ShiroAuthorizationSequence.png b/jbake/assets/images/ShiroAuthorizationSequence.png
similarity index 100%
rename from jbake/assets/img/ShiroAuthorizationSequence.png
rename to jbake/assets/images/ShiroAuthorizationSequence.png
diff --git a/jbake/assets/img/ShiroBasicArchitecture.png b/jbake/assets/images/ShiroBasicArchitecture.png
similarity index 100%
rename from jbake/assets/img/ShiroBasicArchitecture.png
rename to jbake/assets/images/ShiroBasicArchitecture.png
diff --git a/jbake/assets/img/ShiroFeatures.png b/jbake/assets/images/ShiroFeatures.png
similarity index 100%
rename from jbake/assets/img/ShiroFeatures.png
rename to jbake/assets/images/ShiroFeatures.png
diff --git a/jbake/assets/img/ShiroFeatures_Authentication.png b/jbake/assets/images/ShiroFeatures_Authentication.png
similarity index 100%
rename from jbake/assets/img/ShiroFeatures_Authentication.png
rename to jbake/assets/images/ShiroFeatures_Authentication.png
diff --git a/jbake/assets/img/ShiroFeatures_Authorization.png b/jbake/assets/images/ShiroFeatures_Authorization.png
similarity index 100%
rename from jbake/assets/img/ShiroFeatures_Authorization.png
rename to jbake/assets/images/ShiroFeatures_Authorization.png
diff --git a/jbake/assets/img/apache-shiro-logo.png b/jbake/assets/images/apache-shiro-logo.png
similarity index 100%
rename from jbake/assets/img/apache-shiro-logo.png
rename to jbake/assets/images/apache-shiro-logo.png
diff --git a/jbake/assets/img/authentication.png b/jbake/assets/images/authentication.png
similarity index 100%
rename from jbake/assets/img/authentication.png
rename to jbake/assets/images/authentication.png
diff --git a/jbake/assets/img/authorization.png b/jbake/assets/images/authorization.png
similarity index 100%
rename from jbake/assets/img/authorization.png
rename to jbake/assets/images/authorization.png
diff --git a/jbake/assets/img/crypt.png b/jbake/assets/images/crypt.png
similarity index 100%
rename from jbake/assets/img/crypt.png
rename to jbake/assets/images/crypt.png
diff --git a/jbake/assets/img/favicon.ico b/jbake/assets/images/favicon.ico
similarity index 100%
rename from jbake/assets/img/favicon.ico
rename to jbake/assets/images/favicon.ico
diff --git a/jbake/assets/img/footer-shield.png b/jbake/assets/images/footer-shield.png
similarity index 100%
rename from jbake/assets/img/footer-shield.png
rename to jbake/assets/images/footer-shield.png
diff --git a/jbake/assets/img/integration.png b/jbake/assets/images/integration.png
similarity index 100%
rename from jbake/assets/img/integration.png
rename to jbake/assets/images/integration.png
diff --git a/jbake/assets/img/powered-by-shiro-vertical.png b/jbake/assets/images/powered-by-shiro-vertical.png
similarity index 100%
rename from jbake/assets/img/powered-by-shiro-vertical.png
rename to jbake/assets/images/powered-by-shiro-vertical.png
diff --git a/jbake/assets/img/powered_by_apache_shiro.svg b/jbake/assets/images/powered_by_apache_shiro.svg
similarity index 100%
rename from jbake/assets/img/powered_by_apache_shiro.svg
rename to jbake/assets/images/powered_by_apache_shiro.svg
diff --git a/jbake/assets/img/session.png b/jbake/assets/images/session.png
similarity index 100%
rename from jbake/assets/img/session.png
rename to jbake/assets/images/session.png
diff --git a/jbake/assets/img/shiro-featured-image.png b/jbake/assets/images/shiro-featured-image.png
similarity index 100%
rename from jbake/assets/img/shiro-featured-image.png
rename to jbake/assets/images/shiro-featured-image.png
diff --git a/jbake/assets/img/topbar.jpg b/jbake/assets/images/topbar.jpg
similarity index 100%
rename from jbake/assets/img/topbar.jpg
rename to jbake/assets/images/topbar.jpg
diff --git a/jbake/assets/img/web-integration.png b/jbake/assets/images/web-integration.png
similarity index 100%
rename from jbake/assets/img/web-integration.png
rename to jbake/assets/images/web-integration.png
diff --git a/jbake/content/architecture.adoc b/jbake/content/architecture.adoc
index 13d90ff..346a20b 100644
--- a/jbake/content/architecture.adoc
+++ b/jbake/content/architecture.adoc
@@ -16,7 +16,7 @@ Shiro reflects these concepts in its own design. By matching what is already int
At the highest conceptual level, Shiro's architecture has 3 primary concepts: the `Subject`, `SecurityManager` and `Realms`. The following diagram is a high-level overview of how these components interact, and we'll cover each concept below:
-image::/img/ShiroBasicArchitecture.png[Shiro Basic Architecture Diagram, align="center"]
+image::/images/ShiroBasicArchitecture.png[Shiro Basic Architecture Diagram, align="center"]
* *Subject*: As we've mentioned in our link:tutorial.html[Tutorial], the `Subject` is essentially a security specific 'view' of the the currently executing user. Whereas the word 'User' often implies a human being, a `Subject` can be a person, but it could also represent a 3rd-party service, daemon account, cron job, or anything similar - basically anything that is currently interacting with the software.
+
@@ -34,7 +34,7 @@ In this sense a Realm is essentially a security-specific https://en.wikipedia.or
The following diagram shows Shiro's core architectural concepts followed by short summaries of each:
-image::/img/ShiroArchitecture.png[Shiro Architecture Diagram, align="center"]
+image::/images/ShiroArchitecture.png[Shiro Architecture Diagram, align="center"]
* *Subject* (link:static/current/apidocs/org/apache/shiro/subject/Subject.html[`org.apache.shiro.subject.Subject`])
A security-specific 'view' of the entity (user, 3rd-party service, cron job, etc) currently interacting with the software.
diff --git a/jbake/content/authentication.adoc b/jbake/content/authentication.adoc
index 6e4aa56..86b8ba4 100644
--- a/jbake/content/authentication.adoc
+++ b/jbake/content/authentication.adoc
@@ -7,7 +7,7 @@
:icons: font
:toc:
-image::/img/ShiroFeatures_Authentication.png[Shiro features authentication graphic, align="center"]
+image::/images/ShiroFeatures_Authentication.png[Shiro features authentication graphic, align="center"]
Authentication is the process of identity verification - that is, proving a user actually is who they say they are.
@@ -211,7 +211,7 @@ Now we'll cover what happens inside Shiro when an authentication attempt occurs.
We've taken our previous architecture diagram from the link:/architecture.html[Architecture] chapter, and left only the components relevant to authentication highlighted.
Each number represents a step during an authentication attempt:
-image::/img/ShiroAuthenticationSequence.png[authentication flow diagram, align="center"]
+image::/images/ShiroAuthenticationSequence.png[authentication flow diagram, align="center"]
*Step 1*: Application code invokes the `Subject.login` method, passing in the constructed `AuthenticationToken` instance representing the end-user's principals and credentials.
diff --git a/jbake/content/introduction.adoc b/jbake/content/introduction.adoc
index 117e51c..da8db07 100644
--- a/jbake/content/introduction.adoc
+++ b/jbake/content/introduction.adoc
@@ -33,8 +33,8 @@ Apache Shiro is a comprehensive application security framework with many feature
[#img-shiro-features]
.Apache Shiro Features
-[link=img/ShiroFeatures.png]
-image::img/ShiroFeatures.png["Apache Shiro Features",align="center"]
+[link=images/ShiroFeatures.png]
+image::images/ShiroFeatures.png["Apache Shiro Features",align="center"]
Shiro targets what the Shiro development team calls "the four cornerstones of application security" - Authentication, Authorization, Session Management, and Cryptography:
diff --git a/jbake/content/overview.adoc b/jbake/content/overview.adoc
index 7a53348..d6bd3cf 100644
--- a/jbake/content/overview.adoc
+++ b/jbake/content/overview.adoc
@@ -30,7 +30,7 @@ Shiro attempts to achieve these goals for all application environments - from th
Apache Shiro is a comprehensive application security framework with many features. The following diagram shows where Shiro focuses its energy, and this reference manual will be organized similarly:
-image::img/ShiroFeatures.png["Apache Shiro Features",align="center"]
+image::images/ShiroFeatures.png["Apache Shiro Features",align="center"]
Shiro targets what the Shiro development team calls "the four cornerstones of application security" - Authentication, Authorization, Session Management, and Cryptography:
@@ -65,7 +65,7 @@ Shiro largely reflects these concepts in its own design. By matching what is alr
Shiro's architecture has 3 primary concepts: the `Subject`, `SecurityManager` and `Realm` s. The following diagram is a high-level overview of how these concepts interact, and we'll cover each concept below:
-image::img/ShiroArchitecture.png["Apache Shiro Architecture",align="center"]
+image::images/ShiroArchitecture.png["Apache Shiro Architecture",align="center"]
==== Subject
@@ -104,4 +104,4 @@ In this sense a Realm is essentially a security-specific https://en.wikipedia.or
Shiro provides out-of-the-box Realms to connect to a number of security data sources (aka directories) such as LDAP, relational databases (JDBC), text configuration sources like INI and properties files, and more. You can plug-in your own Realm implementations to represent custom data sources if the default Realms do not meet your needs.
-Like other internal components, the Shiro `SecurityManager` manages how Realms are used to acquire security data and then represented as `Subject` instances.
\ No newline at end of file
+Like other internal components, the Shiro `SecurityManager` manages how Realms are used to acquire security data and then represented as `Subject` instances.
diff --git a/jbake/content/powered-by-shiro.adoc b/jbake/content/powered-by-shiro.adoc
index 19c32b2..9c0c741 100644
--- a/jbake/content/powered-by-shiro.adoc
+++ b/jbake/content/powered-by-shiro.adoc
@@ -10,7 +10,7 @@
Feel free to use our "powered by" logo.
-image::/img/powered_by_apache_shiro.svg[title="Powered by Apache Shiro Logo",width=480,height=480,fallback=/img/powered-by-shiro-vertical.png]
+image::/images/powered_by_apache_shiro.svg[title="Powered by Apache Shiro Logo",width=480,height=480,fallback=/images/powered-by-shiro-vertical.png]
[#PoweredbyShiro-OrganizationsusingApacheShiro]
diff --git a/jbake/templates/header.ftl b/jbake/templates/header.ftl
index 467bc37..4ca5268 100644
--- a/jbake/templates/header.ftl
+++ b/jbake/templates/header.ftl
@@ -124,7 +124,7 @@
<meta property="og:image:height" content="${content.featuredimageheight}"/>
</#if>
<#else>
- <meta property="og:image" content='${content.rootpath!""}img/shiro-featured-image.png'/>
+ <meta property="og:image" content='${content.rootpath!""}images/shiro-featured-image.png'/>
<meta property="og:image:width" content='1200'/>
<meta property="og:image:height" content='628'/>
</#if>
@@ -153,7 +153,7 @@
<div class="masthead">
<p class="lead">
- <a href="<#if (content.rootpath)??>${content.rootpath}<#else></#if>index.html"><img src="<#if (content.rootpath)??>${content.rootpath}<#else></#if>img/apache-shiro-logo.png" style="height:100px; width:auto; vertical-align: bottom; margin-top: 20px;" alt="Apache Shiro Logo"></a>
+ <a href="<#if (content.rootpath)??>${content.rootpath}<#else></#if>index.html"><img src="<#if (content.rootpath)??>${content.rootpath}<#else></#if>images/apache-shiro-logo.png" style="height:100px; width:auto; vertical-align: bottom; margin-top: 20px;" alt="Apache Shiro Logo"></a>
<span class="tagline">Simple. Java. Security.</span>
<a class="pull-right" href="https://www.apache.org/events/current-event.html">
<img style="padding-top: 8px" src="https://www.apache.org/events/current-event-125x125.png" alt="Apache Software Foundation Event Banner"/>