[java-metadata-aggregator] 03/03: MDA-297 - Better handling of example secrets files

Ian Young ian at iay.org.uk
Mon Oct 23 16:49:44 UTC 2023


This is an automated email from the git hooks/post-receive script.

iay pushed a commit to branch main
in repository java-metadata-aggregator.

View the commit online:
http://git.shibboleth.net/view/?p=java-metadata-aggregator.git;a=commit;h=ed29ab9e74ff621011adf30b32cc613c2d3fd912

commit ed29ab9e74ff621011adf30b32cc613c2d3fd912
Author: Ian Young <ian at iay.org.uk>
AuthorDate: Mon Oct 23 17:49:34 2023 +0100

    MDA-297 - Better handling of example secrets files
    
    https://shibboleth.atlassian.net/browse/MDA-297
---
 doc/wiki/.gitignore                                 | 5 ++---
 doc/wiki/aggregate-and-republish.xml                | 2 +-
 doc/wiki/aggregate-and-sign.xml                     | 2 +-
 doc/wiki/make-keys.sh                               | 6 +++---
 doc/wiki/path/to/secrets/.gitkeep                   | 0
 doc/wiki/setup-softhsm.sh                           | 2 +-
 doc/wiki/sign-using-token.xml                       | 2 +-
 mda-distribution/src/main/assembly/assembly-tgz.xml | 6 ++++--
 mda-distribution/src/main/assembly/assembly-zip.xml | 6 ++++--
 9 files changed, 17 insertions(+), 14 deletions(-)

diff --git a/doc/wiki/.gitignore b/doc/wiki/.gitignore
index 944e8b6..c155e7f 100644
--- a/doc/wiki/.gitignore
+++ b/doc/wiki/.gitignore
@@ -1,8 +1,7 @@
 .bash_history
 .rnd
-path/to/input/private-key.pem
-path/to/input/self-signed.pem
-path/to/input/self-signed.p12
+path/to/secrets/*
+!path/to/secrets/.gitkeep
 path/to/output/*
 !path/to/output/.gitkeep
 softhsm
diff --git a/doc/wiki/aggregate-and-republish.xml b/doc/wiki/aggregate-and-republish.xml
index 5db264b..65cb636 100644
--- a/doc/wiki/aggregate-and-republish.xml
+++ b/doc/wiki/aggregate-and-republish.xml
@@ -61,7 +61,7 @@
         <constructor-arg value="path/to/input/entities"/>
     </bean>
     <bean id="signingKeyFile" class="java.io.File">
-        <constructor-arg value="path/to/input/private-key.pem"/>
+        <constructor-arg value="path/to/secrets/private-key.pem"/>
     </bean>
     <bean id="allEntitiesOutputFile" class="java.io.File">
         <constructor-arg value="path/to/output/all-metadata.xml"/>
diff --git a/doc/wiki/aggregate-and-sign.xml b/doc/wiki/aggregate-and-sign.xml
index c045be2..d01ad87 100644
--- a/doc/wiki/aggregate-and-sign.xml
+++ b/doc/wiki/aggregate-and-sign.xml
@@ -47,7 +47,7 @@
                     <bean class="org.springframework.core.io.FileSystemResource">
                         <constructor-arg>
                             <bean class="java.io.File">
-                                <constructor-arg value="path/to/input/private-key.pem"/>
+                                <constructor-arg value="path/to/secrets/private-key.pem"/>
                             </bean>
                         </constructor-arg>
                     </bean>
diff --git a/doc/wiki/make-keys.sh b/doc/wiki/make-keys.sh
index 743ad60..25e439b 100755
--- a/doc/wiki/make-keys.sh
+++ b/doc/wiki/make-keys.sh
@@ -1,8 +1,8 @@
 #!/usr/bin/sh
 
-KEYFILE=path/to/input/private-key.pem
-CERTFILE=path/to/input/self-signed.pem
-P12FILE=path/to/input/self-signed.p12
+KEYFILE=path/to/secrets/private-key.pem
+CERTFILE=path/to/secrets/self-signed.pem
+P12FILE=path/to/secrets/self-signed.p12
 
 # Generate an RSA private key
 openssl genrsa >$KEYFILE
diff --git a/doc/wiki/path/to/secrets/.gitkeep b/doc/wiki/path/to/secrets/.gitkeep
new file mode 100644
index 0000000..e69de29
diff --git a/doc/wiki/setup-softhsm.sh b/doc/wiki/setup-softhsm.sh
index 1543e0a..19e59fb 100755
--- a/doc/wiki/setup-softhsm.sh
+++ b/doc/wiki/setup-softhsm.sh
@@ -15,7 +15,7 @@ softhsm2-util --init-token --slot 0 --label "test" \
 
 # Load the credential
 keytool -importkeystore --addprovider SunPKCS11 -providerarg path/to/input/pkcs11-softhsm.cfg \
-    -srcstoretype pkcs12 -srckeystore path/to/input/self-signed.p12 -srcstorepass password \
+    -srcstoretype pkcs12 -srckeystore path/to/secrets/self-signed.p12 -srcstorepass password \
     -deststoretype PKCS11 -destkeystore NONE -deststorepass 12341234
 
 keytool -list --addprovider SunPKCS11 -providerarg path/to/input/pkcs11-softhsm.cfg \
diff --git a/doc/wiki/sign-using-token.xml b/doc/wiki/sign-using-token.xml
index cdf61db..06eccb4 100644
--- a/doc/wiki/sign-using-token.xml
+++ b/doc/wiki/sign-using-token.xml
@@ -28,7 +28,7 @@
         <property name="id" value="signMetadata"/>
         <property name="certificates">
             <bean class="net.shibboleth.shared.spring.security.factory.X509CertificateFactoryBean">
-                <property name="resource" value="file:path/to/input/self-signed.pem"/>
+                <property name="resource" value="file:path/to/secrets/self-signed.pem"/>
             </bean>
         </property>
         <property name="privateKey">
diff --git a/mda-distribution/src/main/assembly/assembly-tgz.xml b/mda-distribution/src/main/assembly/assembly-tgz.xml
index abc241c..6a5284d 100644
--- a/mda-distribution/src/main/assembly/assembly-tgz.xml
+++ b/mda-distribution/src/main/assembly/assembly-tgz.xml
@@ -50,8 +50,10 @@
                 <!-- Allow development within the documentation tree. -->
                 <exclude>**/.gitignore</exclude>
                 <exclude>**/.bash_history</exclude>
-                <!-- Don't ship private keys. -->
-                <exclude>wiki/path/to/input/private-key.pem</exclude>
+                <exclude>**/.rnd</exclude>
+                <!-- Don't ship documentation environment private keys. -->
+                <exclude>wiki/path/to/secrets/*</exclude>
+                <exclude>wiki/softhsm/**</exclude>
                 <!-- Do not ship example OUTPUT files. -->
                 <exclude>wiki/path/to/output/*.json</exclude>
                 <exclude>wiki/path/to/output/*.xml</exclude>
diff --git a/mda-distribution/src/main/assembly/assembly-zip.xml b/mda-distribution/src/main/assembly/assembly-zip.xml
index 599d804..b201636 100644
--- a/mda-distribution/src/main/assembly/assembly-zip.xml
+++ b/mda-distribution/src/main/assembly/assembly-zip.xml
@@ -50,8 +50,10 @@
                 <!-- Allow development within the documentation tree. -->
                 <exclude>**/.gitignore</exclude>
                 <exclude>**/.bash_history</exclude>
-                <!-- Don't ship private keys. -->
-                <exclude>wiki/path/to/input/private-key.pem</exclude>
+                <exclude>**/.rnd</exclude>
+                <!-- Don't ship documentation environment private keys. -->
+                <exclude>wiki/path/to/secrets/*</exclude>
+                <exclude>wiki/softhsm/**</exclude>
                 <!-- Do not ship example OUTPUT files. -->
                 <exclude>wiki/path/to/output/*.json</exclude>
                 <exclude>wiki/path/to/output/*.xml</exclude>

-- 
To stop receiving notification emails like this one, please contact
the administrator of this repository.


More information about the commits mailing list