├── .gitignore
├── LICENSE
├── README.md
├── build.gradle
├── examples
└── helloworld
│ ├── .gitignore
│ ├── app
│ ├── bin
│ │ └── helloworld.sh
│ └── dsm
│ │ ├── config
│ │ ├── images
│ │ ├── icon_256.png
│ │ └── icon_64.png
│ │ └── index.html
│ ├── build.xml
│ ├── ivy.xml
│ ├── makefile
│ └── spk
│ ├── scripts
│ ├── postinst
│ ├── postuninst
│ ├── postupgrade
│ ├── preinst
│ ├── preuninst
│ ├── preupgrade
│ └── start-stop-status
│ └── wizard
│ └── install_uifile
├── makefile
└── src
└── main
├── java
└── net
│ └── filebot
│ └── ant
│ └── spk
│ ├── CodeSignTask.java
│ ├── Compression.java
│ ├── Icon.java
│ ├── Info.java
│ ├── PackageTask.java
│ ├── RepositoryTask.java
│ ├── SPK.java
│ ├── pgp
│ ├── OpenPGPSecretKey.java
│ └── OpenPGPSignature.java
│ └── util
│ └── Digest.java
└── resources
└── net
└── filebot
└── ant
└── spk
└── antlib.xml
/.gitignore:
--------------------------------------------------------------------------------
1 | bin
2 | build
3 |
4 | .gradle
5 | .settings
6 | .project
7 | .classpath
8 |
9 | *.gpg
10 | *.properties
11 |
--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
1 |
2 | Apache License
3 | Version 2.0, January 2004
4 | http://www.apache.org/licenses/
5 |
6 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
7 |
8 | 1. Definitions.
9 |
10 | "License" shall mean the terms and conditions for use, reproduction,
11 | and distribution as defined by Sections 1 through 9 of this document.
12 |
13 | "Licensor" shall mean the copyright owner or entity authorized by
14 | the copyright owner that is granting the License.
15 |
16 | "Legal Entity" shall mean the union of the acting entity and all
17 | other entities that control, are controlled by, or are under common
18 | control with that entity. For the purposes of this definition,
19 | "control" means (i) the power, direct or indirect, to cause the
20 | direction or management of such entity, whether by contract or
21 | otherwise, or (ii) ownership of fifty percent (50%) or more of the
22 | outstanding shares, or (iii) beneficial ownership of such entity.
23 |
24 | "You" (or "Your") shall mean an individual or Legal Entity
25 | exercising permissions granted by this License.
26 |
27 | "Source" form shall mean the preferred form for making modifications,
28 | including but not limited to software source code, documentation
29 | source, and configuration files.
30 |
31 | "Object" form shall mean any form resulting from mechanical
32 | transformation or translation of a Source form, including but
33 | not limited to compiled object code, generated documentation,
34 | and conversions to other media types.
35 |
36 | "Work" shall mean the work of authorship, whether in Source or
37 | Object form, made available under the License, as indicated by a
38 | copyright notice that is included in or attached to the work
39 | (an example is provided in the Appendix below).
40 |
41 | "Derivative Works" shall mean any work, whether in Source or Object
42 | form, that is based on (or derived from) the Work and for which the
43 | editorial revisions, annotations, elaborations, or other modifications
44 | represent, as a whole, an original work of authorship. For the purposes
45 | of this License, Derivative Works shall not include works that remain
46 | separable from, or merely link (or bind by name) to the interfaces of,
47 | the Work and Derivative Works thereof.
48 |
49 | "Contribution" shall mean any work of authorship, including
50 | the original version of the Work and any modifications or additions
51 | to that Work or Derivative Works thereof, that is intentionally
52 | submitted to Licensor for inclusion in the Work by the copyright owner
53 | or by an individual or Legal Entity authorized to submit on behalf of
54 | the copyright owner. For the purposes of this definition, "submitted"
55 | means any form of electronic, verbal, or written communication sent
56 | to the Licensor or its representatives, including but not limited to
57 | communication on electronic mailing lists, source code control systems,
58 | and issue tracking systems that are managed by, or on behalf of, the
59 | Licensor for the purpose of discussing and improving the Work, but
60 | excluding communication that is conspicuously marked or otherwise
61 | designated in writing by the copyright owner as "Not a Contribution."
62 |
63 | "Contributor" shall mean Licensor and any individual or Legal Entity
64 | on behalf of whom a Contribution has been received by Licensor and
65 | subsequently incorporated within the Work.
66 |
67 | 2. Grant of Copyright License. Subject to the terms and conditions of
68 | this License, each Contributor hereby grants to You a perpetual,
69 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable
70 | copyright license to reproduce, prepare Derivative Works of,
71 | publicly display, publicly perform, sublicense, and distribute the
72 | Work and such Derivative Works in Source or Object form.
73 |
74 | 3. Grant of Patent License. Subject to the terms and conditions of
75 | this License, each Contributor hereby grants to You a perpetual,
76 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable
77 | (except as stated in this section) patent license to make, have made,
78 | use, offer to sell, sell, import, and otherwise transfer the Work,
79 | where such license applies only to those patent claims licensable
80 | by such Contributor that are necessarily infringed by their
81 | Contribution(s) alone or by combination of their Contribution(s)
82 | with the Work to which such Contribution(s) was submitted. If You
83 | institute patent litigation against any entity (including a
84 | cross-claim or counterclaim in a lawsuit) alleging that the Work
85 | or a Contribution incorporated within the Work constitutes direct
86 | or contributory patent infringement, then any patent licenses
87 | granted to You under this License for that Work shall terminate
88 | as of the date such litigation is filed.
89 |
90 | 4. Redistribution. You may reproduce and distribute copies of the
91 | Work or Derivative Works thereof in any medium, with or without
92 | modifications, and in Source or Object form, provided that You
93 | meet the following conditions:
94 |
95 | (a) You must give any other recipients of the Work or
96 | Derivative Works a copy of this License; and
97 |
98 | (b) You must cause any modified files to carry prominent notices
99 | stating that You changed the files; and
100 |
101 | (c) You must retain, in the Source form of any Derivative Works
102 | that You distribute, all copyright, patent, trademark, and
103 | attribution notices from the Source form of the Work,
104 | excluding those notices that do not pertain to any part of
105 | the Derivative Works; and
106 |
107 | (d) If the Work includes a "NOTICE" text file as part of its
108 | distribution, then any Derivative Works that You distribute must
109 | include a readable copy of the attribution notices contained
110 | within such NOTICE file, excluding those notices that do not
111 | pertain to any part of the Derivative Works, in at least one
112 | of the following places: within a NOTICE text file distributed
113 | as part of the Derivative Works; within the Source form or
114 | documentation, if provided along with the Derivative Works; or,
115 | within a display generated by the Derivative Works, if and
116 | wherever such third-party notices normally appear. The contents
117 | of the NOTICE file are for informational purposes only and
118 | do not modify the License. You may add Your own attribution
119 | notices within Derivative Works that You distribute, alongside
120 | or as an addendum to the NOTICE text from the Work, provided
121 | that such additional attribution notices cannot be construed
122 | as modifying the License.
123 |
124 | You may add Your own copyright statement to Your modifications and
125 | may provide additional or different license terms and conditions
126 | for use, reproduction, or distribution of Your modifications, or
127 | for any such Derivative Works as a whole, provided Your use,
128 | reproduction, and distribution of the Work otherwise complies with
129 | the conditions stated in this License.
130 |
131 | 5. Submission of Contributions. Unless You explicitly state otherwise,
132 | any Contribution intentionally submitted for inclusion in the Work
133 | by You to the Licensor shall be under the terms and conditions of
134 | this License, without any additional terms or conditions.
135 | Notwithstanding the above, nothing herein shall supersede or modify
136 | the terms of any separate license agreement you may have executed
137 | with Licensor regarding such Contributions.
138 |
139 | 6. Trademarks. This License does not grant permission to use the trade
140 | names, trademarks, service marks, or product names of the Licensor,
141 | except as required for reasonable and customary use in describing the
142 | origin of the Work and reproducing the content of the NOTICE file.
143 |
144 | 7. Disclaimer of Warranty. Unless required by applicable law or
145 | agreed to in writing, Licensor provides the Work (and each
146 | Contributor provides its Contributions) on an "AS IS" BASIS,
147 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
148 | implied, including, without limitation, any warranties or conditions
149 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
150 | PARTICULAR PURPOSE. You are solely responsible for determining the
151 | appropriateness of using or redistributing the Work and assume any
152 | risks associated with Your exercise of permissions under this License.
153 |
154 | 8. Limitation of Liability. In no event and under no legal theory,
155 | whether in tort (including negligence), contract, or otherwise,
156 | unless required by applicable law (such as deliberate and grossly
157 | negligent acts) or agreed to in writing, shall any Contributor be
158 | liable to You for damages, including any direct, indirect, special,
159 | incidental, or consequential damages of any character arising as a
160 | result of this License or out of the use or inability to use the
161 | Work (including but not limited to damages for loss of goodwill,
162 | work stoppage, computer failure or malfunction, or any and all
163 | other commercial damages or losses), even if such Contributor
164 | has been advised of the possibility of such damages.
165 |
166 | 9. Accepting Warranty or Additional Liability. While redistributing
167 | the Work or Derivative Works thereof, You may choose to offer,
168 | and charge a fee for, acceptance of support, warranty, indemnity,
169 | or other liability obligations and/or rights consistent with this
170 | License. However, in accepting such obligations, You may act only
171 | on Your own behalf and on Your sole responsibility, not on behalf
172 | of any other Contributor, and only if You agree to indemnify,
173 | defend, and hold each Contributor harmless for any liability
174 | incurred by, or claims asserted against, such Contributor by reason
175 | of your accepting any such warranty or additional liability.
176 |
177 | END OF TERMS AND CONDITIONS
178 |
179 | APPENDIX: How to apply the Apache License to your work.
180 |
181 | To apply the Apache License to your work, attach the following
182 | boilerplate notice, with the fields enclosed by brackets "[]"
183 | replaced with your own identifying information. (Don't include
184 | the brackets!) The text should be enclosed in the appropriate
185 | comment syntax for the file format. We also recommend that a
186 | file or class name and description of purpose be included on the
187 | same "printed page" as the copyright notice for easier
188 | identification within third-party archives.
189 |
190 | Copyright [yyyy] [name of copyright owner]
191 |
192 | Licensed under the Apache License, Version 2.0 (the "License");
193 | you may not use this file except in compliance with the License.
194 | You may obtain a copy of the License at
195 |
196 | http://www.apache.org/licenses/LICENSE-2.0
197 |
198 | Unless required by applicable law or agreed to in writing, software
199 | distributed under the License is distributed on an "AS IS" BASIS,
200 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
201 | See the License for the specific language governing permissions and
202 | limitations under the License.
203 |
--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
1 | # ant-spk
2 | [](https://github.com/rednoah/ant-spk/releases)
3 | [](https://github.com/rednoah/ant-spk/releases)
4 |
5 | Ant Task for creating SPK packages for Synology NAS.
6 |
7 | ## Introduction
8 | I've found the Synology SDK tools for creating and signing SPK packages overly difficult to use and and terrible to automate. So here's an Apache Ant task to handle build automation of SPK packages in an easy to maintain and completely platform-independent manner.
9 |
10 | __Ant SPK Task__
11 | * Much more easy to use than whats in the official Synology SDK docs & tools
12 | * Automatically create and sign your SPK packages in your automated Ant build
13 | * Works on Windows, Mac and Linux (including Synology DSM) and any other device that can run Java 8
14 |
15 | Have a quick look at the [Synology DSM 3rd Party Apps Developer Guide](https://global.download.synology.com/download/Document/DeveloperGuide/DSM_Developer_Guide.pdf) and read the **Package Structure** section to learn more on how SPK packages work.
16 |
17 | ## Example
18 | ```xml
19 |
20 |
21 |
22 |
23 |
24 |
25 |
26 |
27 |
28 |
29 |
30 |
31 |
32 |
33 |
34 |
35 |
36 |
37 |
38 |
39 |
40 |
41 |
42 |
43 |
44 |
45 |
46 | ```
47 |
48 | ## Downloads
49 | [ant-spk](https://github.com/rednoah/ant-spk) is available on [Maven Central](https://mvnrepository.com/artifact/net.filebot/ant-spk). Use [Apache Ivy](http://ant.apache.org/ivy/) to retrieve all the dependencies:
50 | ```xml
51 |
52 | ```
53 |
54 | ## Build
55 | [ant-spk](https://github.com/rednoah/ant-spk) uses the [Gradle 6.9](https://gradle.org/gradle-download/) build tool. Call `gradle example` to fetch all dependencies and build the example project.
56 |
57 | ## Real World Examples
58 | [ant-spk](https://github.com/rednoah/ant-spk) is used to automatically build `.spk` packages for the [FileBot](http://www.filebot.net/) project, so check out [filebot-node](https://github.com/filebot/filebot-node) [build.xml](https://github.com/filebot/filebot-node/blob/master/build.xml) or [java-installer](https://github.com/rednoah/java-installer) [build.xml](https://github.com/rednoah/java-installer/blob/master/build.xml) for a set of more comprehensive examples. 🚀
59 |
--------------------------------------------------------------------------------
/build.gradle:
--------------------------------------------------------------------------------
1 | apply plugin: 'eclipse'
2 | apply plugin: 'java'
3 | apply plugin: 'maven'
4 | apply plugin: 'signing'
5 |
6 |
7 |
8 | group = 'net.filebot'
9 | archivesBaseName = 'ant-spk'
10 | version = '0.7.1'
11 |
12 |
13 |
14 | compileJava {
15 | sourceCompatibility = '1.8'
16 | targetCompatibility = '1.8'
17 | }
18 |
19 | task javadocJar(type: Jar) {
20 | classifier = 'javadoc'
21 | from javadoc
22 | }
23 |
24 | task sourcesJar(type: Jar) {
25 | classifier = 'sources'
26 | from sourceSets.main.allSource
27 | }
28 |
29 | artifacts {
30 | archives javadocJar, sourcesJar
31 | }
32 |
33 | if (project.hasProperty('signing.keyId')) {
34 | signing {
35 | sign configurations.archives
36 | }
37 | }
38 |
39 |
40 |
41 | repositories {
42 | mavenCentral()
43 | }
44 |
45 | dependencies {
46 | compileOnly 'org.apache.ant:ant:1.10.10'
47 | compile 'org.bouncycastle:bcprov-jdk15on:1.69'
48 | compile 'org.bouncycastle:bcpg-jdk15on:1.69'
49 | compile 'org.apache.httpcomponents:httpcore:4.4.14'
50 | compile 'org.apache.httpcomponents:httpmime:4.5.13'
51 | compile 'org.apache.httpcomponents:httpclient:4.5.13'
52 | compile 'org.glassfish:javax.json:1.1.4'
53 | }
54 |
55 |
56 |
57 | if (project.hasProperty('ossrhUsername')) {
58 | uploadArchives {
59 | repositories {
60 | mavenDeployer {
61 | beforeDeployment { MavenDeployment deployment ->
62 | signing.signPom(deployment)
63 | }
64 |
65 | repository(url: 'https://oss.sonatype.org/service/local/staging/deploy/maven2/') {
66 | authentication(userName: ossrhUsername, password: ossrhPassword)
67 | }
68 |
69 | snapshotRepository(url: 'https://oss.sonatype.org/content/repositories/snapshots/') {
70 | authentication(userName: ossrhUsername, password: ossrhPassword)
71 | }
72 |
73 | pom.project {
74 | name 'ant-spk'
75 | packaging 'jar'
76 | description 'Ant Task for creating SPK packages for Synology NAS'
77 | url 'https://github.com/rednoah/ant-spk'
78 |
79 | scm {
80 | url 'https://github.com/rednoah/ant-spk'
81 | connection 'scm:git:git://github.com/rednoah/ant-spk.git'
82 | developerConnection 'scm:git:git@github.com:rednoah/ant-spk.git'
83 | }
84 |
85 | licenses {
86 | license {
87 | name 'The Apache License, Version 2.0'
88 | url 'http://www.apache.org/licenses/LICENSE-2.0.txt'
89 | }
90 | }
91 |
92 | developers {
93 | developer {
94 | id 'rednoah'
95 | name 'Reinhard Pointner'
96 | email 'rednoah@filebot.net'
97 | }
98 | }
99 | }
100 | }
101 | }
102 | }
103 | }
104 |
105 |
106 |
107 | task example(type: Exec, dependsOn: build) {
108 | workingDir 'examples/helloworld'
109 | executable 'ant'
110 | args configurations.runtime.plus(libsDir).collectMany{ jar -> ['-lib', jar] }
111 | }
112 |
--------------------------------------------------------------------------------
/examples/helloworld/.gitignore:
--------------------------------------------------------------------------------
1 | dist/
2 | lib/
3 |
--------------------------------------------------------------------------------
/examples/helloworld/app/bin/helloworld.sh:
--------------------------------------------------------------------------------
1 | #!/bin/sh
2 | echo "Hello World!"
3 |
--------------------------------------------------------------------------------
/examples/helloworld/app/dsm/config:
--------------------------------------------------------------------------------
1 | {
2 | ".url": {
3 | "org.example.HelloWorld": {
4 | "type": "legacy",
5 | "title": "Hello World",
6 | "icon": "images/icon_{0}.png",
7 | "url": "/webman/3rdparty/helloworld/index.html"
8 | }
9 | }
10 | }
--------------------------------------------------------------------------------
/examples/helloworld/app/dsm/images/icon_256.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/rednoah/ant-spk/c45566ef692f1653a1cff7a69de24db3c116755d/examples/helloworld/app/dsm/images/icon_256.png
--------------------------------------------------------------------------------
/examples/helloworld/app/dsm/images/icon_64.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/rednoah/ant-spk/c45566ef692f1653a1cff7a69de24db3c116755d/examples/helloworld/app/dsm/images/icon_64.png
--------------------------------------------------------------------------------
/examples/helloworld/app/dsm/index.html:
--------------------------------------------------------------------------------
1 |
2 |
3 | Hello World!
4 |
5 |
--------------------------------------------------------------------------------
/examples/helloworld/build.xml:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 |
5 |
6 |
7 |
8 |
9 |
10 |
11 |
12 |
13 |
14 |
15 |
16 |
17 |
18 |
19 |
20 |
21 |
22 |
23 |
24 |
25 |
26 |
27 |
28 |
29 |
30 |
31 |
32 |
33 |
34 |
35 |
36 |
37 |
38 |
39 |
40 |
41 |
42 |
--------------------------------------------------------------------------------
/examples/helloworld/ivy.xml:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 |
5 |
6 |
7 |
8 |
--------------------------------------------------------------------------------
/examples/helloworld/makefile:
--------------------------------------------------------------------------------
1 | ANT := ant -lib lib
2 |
3 | build:
4 | $(ANT) retrieve
5 | $(ANT) spk
6 |
--------------------------------------------------------------------------------
/examples/helloworld/spk/scripts/postinst:
--------------------------------------------------------------------------------
1 | #!/bin/sh
2 | exit 0
3 |
--------------------------------------------------------------------------------
/examples/helloworld/spk/scripts/postuninst:
--------------------------------------------------------------------------------
1 | #!/bin/sh
2 | exit 0
3 |
--------------------------------------------------------------------------------
/examples/helloworld/spk/scripts/postupgrade:
--------------------------------------------------------------------------------
1 | #!/bin/sh
2 | exit 0
3 |
--------------------------------------------------------------------------------
/examples/helloworld/spk/scripts/preinst:
--------------------------------------------------------------------------------
1 | #!/bin/sh
2 | exit 0
3 |
--------------------------------------------------------------------------------
/examples/helloworld/spk/scripts/preuninst:
--------------------------------------------------------------------------------
1 | #!/bin/sh
2 | exit 0
3 |
--------------------------------------------------------------------------------
/examples/helloworld/spk/scripts/preupgrade:
--------------------------------------------------------------------------------
1 | #!/bin/sh
2 | exit 0
3 |
--------------------------------------------------------------------------------
/examples/helloworld/spk/scripts/start-stop-status:
--------------------------------------------------------------------------------
1 | #!/bin/sh
2 |
3 | case "$1" in
4 | start)
5 | exit 0
6 | ;;
7 |
8 | stop)
9 | exit 0
10 | ;;
11 |
12 | status)
13 | exit 0
14 | ;;
15 |
16 | log)
17 | exit 0
18 | ;;
19 |
20 | *)
21 | exit 1
22 | ;;
23 | esac
24 |
--------------------------------------------------------------------------------
/examples/helloworld/spk/wizard/install_uifile:
--------------------------------------------------------------------------------
1 | [{
2 | "step_title": "Step 1",
3 | "items": [{
4 | "type": "textfield",
5 | "desc": "Please enter your Hello World message.",
6 | "subitems": [{
7 | "key": "HELLO_WORLD",
8 | "desc": "Message",
9 | "defaultValue": "Hello World!",
10 | "validator": {
11 | "minLength": 5
12 | }
13 | }]
14 | }]
15 | }]
--------------------------------------------------------------------------------
/makefile:
--------------------------------------------------------------------------------
1 | GRADLE := docker run --rm -v "$(PWD)":/ant-spk -w /ant-spk gradle:6-jdk11 gradle
2 |
3 | jar:
4 | $(GRADLE) clean build
5 |
6 | example:
7 | cd "$(PWD)/examples/helloworld" && ant -lib "$(PWD)/build/libs" -lib "lib"
8 |
9 | deploy:
10 | $(GRADLE) clean uploadArchives
11 | # open "https://oss.sonatype.org/#stagingRepositories"
12 |
13 | eclipse:
14 | $(GRADLE) cleanEclipse eclipse
15 |
16 | clean:
17 | git reset --hard
18 | git pull
19 | git --no-pager log -1
20 |
--------------------------------------------------------------------------------
/src/main/java/net/filebot/ant/spk/CodeSignTask.java:
--------------------------------------------------------------------------------
1 | package net.filebot.ant.spk;
2 |
3 | import static net.filebot.ant.spk.PackageTask.*;
4 |
5 | import java.io.File;
6 | import java.io.IOException;
7 | import java.io.InputStream;
8 | import java.nio.ByteBuffer;
9 | import java.nio.charset.StandardCharsets;
10 | import java.nio.file.Files;
11 | import java.nio.file.StandardCopyOption;
12 | import java.security.SignatureException;
13 | import java.util.ArrayList;
14 | import java.util.List;
15 | import java.util.TreeMap;
16 | import java.util.UUID;
17 |
18 | import org.apache.http.HttpEntity;
19 | import org.apache.http.HttpResponse;
20 | import org.apache.http.client.methods.HttpPost;
21 | import org.apache.http.entity.ContentType;
22 | import org.apache.http.entity.mime.MultipartEntityBuilder;
23 | import org.apache.http.impl.client.CloseableHttpClient;
24 | import org.apache.http.impl.client.HttpClientBuilder;
25 | import org.apache.tools.ant.BuildException;
26 | import org.apache.tools.ant.Task;
27 | import org.apache.tools.ant.taskdefs.Tar.TarFileSet;
28 | import org.apache.tools.ant.types.Resource;
29 | import org.bouncycastle.openpgp.PGPException;
30 |
31 | import net.filebot.ant.spk.pgp.OpenPGPSignature;
32 |
33 | public class CodeSignTask extends Task {
34 |
35 | String keyId;
36 | File secring;
37 |
38 | char[] password = new char[0]; // empty password by default
39 | String timestamp = "http://timestamp.synology.com/timestamp.php"; // default Synology signature server
40 |
41 | public void setKeyId(String keyId) {
42 | this.keyId = keyId;
43 | }
44 |
45 | public void setSecring(File secring) {
46 | this.secring = secring;
47 | }
48 |
49 | public void setPassword(String password) {
50 | this.password = password.toCharArray();
51 | }
52 |
53 | public void setTimestamp(String timestamp) {
54 | this.timestamp = timestamp;
55 | }
56 |
57 | File token = new File(SYNO_SIGNATURE);
58 | List cats = new ArrayList();
59 |
60 | public void setToken(File token) {
61 | this.token = token;
62 | }
63 |
64 | public void addConfiguredCat(TarFileSet files) {
65 | cats.add(files);
66 | }
67 |
68 | @Override
69 | public void execute() {
70 | byte[] asciiArmoredSignatureFile;
71 |
72 | // compute PGP signature
73 | log("GPG: sign with key " + keyId);
74 |
75 | try {
76 | OpenPGPSignature signature = OpenPGPSignature.createSignatureGenerator(keyId, secring, password);
77 |
78 | // cat files in case-sensitive alphabetical tar entry path order
79 | byte[] buffer = new byte[64 * 1024];
80 | int length = 0;
81 | for (Resource r : getTarOrderCatResources()) {
82 | try (InputStream in = r.getInputStream()) {
83 | while ((length = in.read(buffer, 0, buffer.length)) != -1) {
84 | signature.update(buffer, 0, length);
85 | }
86 | }
87 | }
88 |
89 | asciiArmoredSignatureFile = signature.generate();
90 | } catch (IOException | SignatureException | PGPException e) {
91 | throw new BuildException("Failed to compute PGP signature: " + e);
92 | }
93 |
94 | // sign the signature
95 | log("SYNO: Submit signature to " + timestamp);
96 |
97 | try (CloseableHttpClient httpClient = HttpClientBuilder.create().build()) {
98 | HttpPost httpPost = new HttpPost(timestamp);
99 |
100 | // timestamp.synology.com requires the full Content-Disposition head to be sent, including the filename section, e.g. Content-Disposition: form-data; name="file"; filename="ALLCAT.dat.asc"
101 | HttpEntity pastData = MultipartEntityBuilder.create().addBinaryBody("file", asciiArmoredSignatureFile, ContentType.DEFAULT_BINARY, UUID.randomUUID().toString()).build();
102 | httpPost.setEntity(pastData);
103 |
104 | HttpResponse response = httpClient.execute(httpPost);
105 | Files.copy(response.getEntity().getContent(), token.toPath(), StandardCopyOption.REPLACE_EXISTING);
106 | dumpSignature(Files.readAllBytes(token.toPath()));
107 | } catch (IOException e) {
108 | throw new BuildException("Failed to retrieve signature: " + e.getMessage());
109 | }
110 | }
111 |
112 | protected void dumpSignature(byte[] bytes) {
113 | log(StandardCharsets.UTF_8.decode(ByteBuffer.wrap(bytes)).toString());
114 | }
115 |
116 | protected Resource[] getTarOrderCatResources() {
117 | TreeMap sortedCats = new TreeMap();
118 | cats.forEach(fs -> {
119 | fs.forEach(r -> {
120 | sortedCats.put(getTarEntryName(r.getName(), fs), r);
121 | });
122 | });
123 | return sortedCats.values().toArray(new Resource[0]);
124 | }
125 |
126 | protected String getTarEntryName(String vPath, TarFileSet tarFileSet) {
127 | if (vPath.isEmpty() || vPath.startsWith("/")) {
128 | throw new IllegalArgumentException("Illegal tar entry: " + vPath);
129 | }
130 |
131 | String fullpath = tarFileSet.getFullpath(getProject());
132 | if (fullpath.length() > 0) {
133 | return fullpath;
134 | }
135 |
136 | String prefix = tarFileSet.getPrefix(getProject());
137 | if (prefix.length() > 0) {
138 | if (prefix.endsWith("/")) {
139 | return prefix + vPath;
140 | } else {
141 | return prefix + '/' + vPath;
142 | }
143 | }
144 |
145 | return vPath;
146 | }
147 | }
148 |
--------------------------------------------------------------------------------
/src/main/java/net/filebot/ant/spk/Compression.java:
--------------------------------------------------------------------------------
1 | package net.filebot.ant.spk;
2 |
3 | import org.apache.tools.ant.taskdefs.Tar.TarCompressionMethod;
4 |
5 | /**
6 | * In DSM 5.2 or older, package.tgz must be tgz format. In DSM 6.0 or newer, package.tgz can be tgz or xz format, but the file name must be package.tgz.
7 | */
8 | public enum Compression {
9 |
10 | none, gzip, xz;
11 |
12 | public TarCompressionMethod getTarCompressionMethod() {
13 | TarCompressionMethod compression = new TarCompressionMethod();
14 | compression.setValue(name());
15 | return compression;
16 | }
17 |
18 | }
19 |
--------------------------------------------------------------------------------
/src/main/java/net/filebot/ant/spk/Icon.java:
--------------------------------------------------------------------------------
1 | package net.filebot.ant.spk;
2 |
3 | import java.io.File;
4 |
5 | public class Icon {
6 |
7 | Integer size;
8 | File file;
9 |
10 | public void setSize(Integer size) {
11 | this.size = size;
12 | }
13 |
14 | public void setFile(File file) {
15 | this.file = file;
16 | }
17 |
18 | public String getPackageName() {
19 | if (size == null || size.equals(64) || size.equals(72)) {
20 | return "PACKAGE_ICON.PNG";
21 | } else {
22 | return "PACKAGE_ICON_" + size + ".PNG";
23 | }
24 | }
25 |
26 | }
27 |
--------------------------------------------------------------------------------
/src/main/java/net/filebot/ant/spk/Info.java:
--------------------------------------------------------------------------------
1 | package net.filebot.ant.spk;
2 |
3 | public class Info {
4 |
5 | public static final String NAME = "package";
6 | public static final String VERSION = "version";
7 | public static final String ARCH = "arch";
8 |
9 | String name;
10 | String value;
11 |
12 | public void setName(String name) {
13 | this.name = name;
14 | }
15 |
16 | public void setValue(String value) {
17 | this.value = value;
18 | }
19 |
20 | }
21 |
--------------------------------------------------------------------------------
/src/main/java/net/filebot/ant/spk/PackageTask.java:
--------------------------------------------------------------------------------
1 | package net.filebot.ant.spk;
2 |
3 | import static java.nio.charset.StandardCharsets.*;
4 | import static net.filebot.ant.spk.Info.*;
5 | import static net.filebot.ant.spk.util.Digest.*;
6 |
7 | import java.io.File;
8 | import java.nio.file.Files;
9 | import java.util.ArrayList;
10 | import java.util.LinkedHashMap;
11 | import java.util.List;
12 | import java.util.Map;
13 |
14 | import org.apache.tools.ant.BuildException;
15 | import org.apache.tools.ant.Task;
16 | import org.apache.tools.ant.taskdefs.Delete;
17 | import org.apache.tools.ant.taskdefs.Tar;
18 | import org.apache.tools.ant.taskdefs.Tar.TarFileSet;
19 | import org.apache.tools.ant.taskdefs.Tar.TarLongFileMode;
20 | import org.apache.tools.ant.types.FileSet;
21 |
22 | public class PackageTask extends Task {
23 |
24 | public static final String INFO = "INFO";
25 | public static final String SYNO_SIGNATURE = "syno_signature.asc";
26 |
27 | File destDir;
28 |
29 | Map infoList = new LinkedHashMap();
30 |
31 | List packageFiles = new ArrayList();
32 | List spkFiles = new ArrayList();
33 |
34 | Compression compression = Compression.gzip; // use GZIP by default, XZ requires DSM 6 or higher
35 |
36 | CodeSignTask codesign;
37 |
38 | public void setDestdir(File value) {
39 | destDir = value;
40 | }
41 |
42 | public void setCompression(Compression value) {
43 | compression = value;
44 | }
45 |
46 | public void setName(String value) {
47 | infoList.put(NAME, value);
48 | }
49 |
50 | public void setVersion(String value) {
51 | infoList.put(VERSION, value);
52 | }
53 |
54 | public void setArch(String value) {
55 | infoList.put(ARCH, value);
56 | }
57 |
58 | public void addConfiguredInfo(Info info) {
59 | infoList.put(info.name, info.value);
60 | }
61 |
62 | public void addConfiguredPackage(TarFileSet files) {
63 | packageFiles.add(files);
64 | }
65 |
66 | public void addConfiguredScripts(TarFileSet files) {
67 | files.setPrefix("scripts");
68 | spkFiles.add(files);
69 | }
70 |
71 | public void addConfiguredWizard(TarFileSet files) {
72 | files.setPrefix("WIZARD_UIFILES");
73 | spkFiles.add(files);
74 | }
75 |
76 | public void addConfiguredConf(TarFileSet files) {
77 | files.setPrefix("conf");
78 | spkFiles.add(files);
79 | }
80 |
81 | public void addConfiguredIcon(Icon icon) {
82 | TarFileSet files = new TarFileSet();
83 | files.setFullpath(icon.getPackageName());
84 | files.setFile(icon.file);
85 | spkFiles.add(files);
86 | }
87 |
88 | public void setLicense(File file) {
89 | TarFileSet files = new TarFileSet();
90 | files.setFullpath("LICENSE");
91 | files.setFile(file);
92 | spkFiles.add(files);
93 | }
94 |
95 | public void addConfiguredCodeSign(CodeSignTask codesign) {
96 | this.codesign = codesign;
97 | }
98 |
99 | @Override
100 | public void execute() throws BuildException {
101 | if (destDir == null || !infoList.containsKey(NAME) || !infoList.containsKey(VERSION) || !infoList.containsKey(ARCH))
102 | throw new BuildException("Required attributes: destdir, name, version, arch");
103 |
104 | if (packageFiles.isEmpty() || spkFiles.isEmpty())
105 | throw new BuildException("Required elements: package, scripts");
106 |
107 | String spkName = String.format("%s-%s-%s", infoList.get(NAME), infoList.get(VERSION), infoList.get(ARCH));
108 |
109 | File spkStaging = new File(destDir, spkName);
110 | File spkFile = new File(destDir, spkName + ".spk");
111 |
112 | // make sure staging folder exists
113 | spkStaging.mkdirs();
114 |
115 | // generate info and package files and add to spk fileset
116 | preparePackage(spkStaging);
117 | prepareInfo(spkStaging);
118 | prepareSignature(spkStaging);
119 |
120 | // spk must be an uncompressed tar
121 | tar(spkFile, Compression.none, spkFiles);
122 |
123 | // make sure staging folder is clean for next time
124 | clean(spkStaging);
125 | }
126 |
127 | private void prepareSignature(File tempDirectory) {
128 | if (codesign != null) {
129 | // select files that need to be signed
130 | spkFiles.forEach((fs) -> {
131 | fs.setProject(getProject());
132 | codesign.addConfiguredCat(fs);
133 | });
134 |
135 | // create signature file
136 | File signatureFile = new File(tempDirectory, SYNO_SIGNATURE);
137 | codesign.setToken(signatureFile);
138 |
139 | codesign.bindToOwner(this);
140 | codesign.execute();
141 |
142 | // add signature file to output package
143 | TarFileSet syno_signature = new TarFileSet();
144 | syno_signature.setFullpath(signatureFile.getName());
145 | syno_signature.setFile(signatureFile);
146 | spkFiles.add(syno_signature);
147 | }
148 | }
149 |
150 | private void preparePackage(File tempDirectory) {
151 | File packageFile = new File(tempDirectory, "package.tgz");
152 | tar(packageFile, compression, packageFiles);
153 |
154 | infoList.put("checksum", md5(packageFile));
155 |
156 | TarFileSet package_tgz = new TarFileSet();
157 | package_tgz.setFullpath(packageFile.getName());
158 | package_tgz.setFile(packageFile);
159 | spkFiles.add(package_tgz);
160 | }
161 |
162 | private void prepareInfo(File tempDirectory) {
163 | StringBuilder infoText = new StringBuilder();
164 | infoList.forEach((k, v) -> {
165 | infoText.append(k).append('=').append('"').append(v).append('"').append('\n');
166 | });
167 |
168 | File infoFile = new File(tempDirectory, INFO);
169 | log("Generating INFO: " + infoFile);
170 | try {
171 | Files.write(infoFile.toPath(), infoText.toString().getBytes(UTF_8));
172 | } catch (Exception e) {
173 | throw new BuildException("Failed to write INFO", e);
174 | }
175 |
176 | TarFileSet info = new TarFileSet();
177 | info.setFullpath(infoFile.getName());
178 | info.setFile(infoFile);
179 | spkFiles.add(info);
180 | }
181 |
182 | private void tar(File destFile, Compression compression, List files) {
183 | Tar tar = new Tar();
184 | tar.setProject(getProject());
185 | tar.setLocation(getLocation());
186 | tar.setTaskName(getTaskName());
187 | tar.setEncoding("utf-8");
188 |
189 | TarLongFileMode longFileMode = new TarLongFileMode();
190 | longFileMode.setValue("posix");
191 | tar.setLongfile(longFileMode);
192 |
193 | tar.setCompression(compression.getTarCompressionMethod());
194 |
195 | tar.setDestFile(destFile);
196 | for (FileSet fileset : files) {
197 | if (fileset != null) {
198 | // make sure the tarfileset element is initialized with all the project information it may need
199 | fileset.setProject(tar.getProject());
200 | fileset.setLocation(tar.getLocation());
201 | tar.add(fileset);
202 | }
203 | }
204 |
205 | tar.perform();
206 | }
207 |
208 | private void clean(File tempDirectory) {
209 | Delete cleanupTask = new Delete();
210 | cleanupTask.setProject(getProject());
211 | cleanupTask.setTaskName(getTaskName());
212 | cleanupTask.setLocation(getLocation());
213 | cleanupTask.setDir(tempDirectory);
214 | cleanupTask.perform();
215 | }
216 |
217 | }
218 |
--------------------------------------------------------------------------------
/src/main/java/net/filebot/ant/spk/RepositoryTask.java:
--------------------------------------------------------------------------------
1 | package net.filebot.ant.spk;
2 |
3 | import static java.nio.charset.StandardCharsets.*;
4 | import static java.util.Collections.*;
5 | import static net.filebot.ant.spk.PackageTask.*;
6 | import static net.filebot.ant.spk.util.Digest.*;
7 |
8 | import java.io.File;
9 | import java.io.InputStreamReader;
10 | import java.io.StringWriter;
11 | import java.nio.file.Files;
12 | import java.util.ArrayList;
13 | import java.util.LinkedHashMap;
14 | import java.util.LinkedHashSet;
15 | import java.util.List;
16 | import java.util.Map;
17 | import java.util.Set;
18 | import java.util.regex.Pattern;
19 |
20 | import javax.json.Json;
21 | import javax.json.JsonArrayBuilder;
22 | import javax.json.JsonObject;
23 | import javax.json.JsonObjectBuilder;
24 | import javax.json.JsonReader;
25 | import javax.json.JsonString;
26 | import javax.json.JsonValue;
27 | import javax.json.JsonWriter;
28 | import javax.json.stream.JsonGenerator;
29 |
30 | import org.apache.tools.ant.BuildException;
31 | import org.apache.tools.ant.Project;
32 | import org.apache.tools.ant.Task;
33 | import org.apache.tools.ant.taskdefs.Get;
34 | import org.apache.tools.ant.types.FileSet;
35 | import org.apache.tools.ant.types.Resource;
36 | import org.apache.tools.ant.types.ResourceCollection;
37 | import org.apache.tools.ant.types.TarFileSet;
38 | import org.apache.tools.ant.types.resources.URLResource;
39 | import org.apache.tools.ant.types.resources.Union;
40 | import org.apache.tools.ant.util.FileUtils;
41 |
42 | public class RepositoryTask extends Task {
43 |
44 | File index;
45 |
46 | Union keyrings = new Union();
47 | List spks = new ArrayList();
48 | List sources = new ArrayList();
49 |
50 | public void setFile(File file) {
51 | this.index = file;
52 | }
53 |
54 | public void addConfiguredKeyRing(FileSet key) {
55 | keyrings.add(key);
56 | }
57 |
58 | public void addConfiguredKeyRing(ResourceCollection key) {
59 | keyrings.add(key);
60 | }
61 |
62 | public void addConfiguredSource(URLResource source) {
63 | sources.add(source);
64 | }
65 |
66 | public void addConfiguredSPK(SPK spk) {
67 | if (spk.file == null) {
68 | throw new BuildException("Required attributes: [file] or [url, file]");
69 | }
70 |
71 | spks.add(spk);
72 | }
73 |
74 | public static final String KEYRINGS = "keyrings";
75 | public static final String PACKAGES = "packages";
76 |
77 | @Override
78 | public void execute() throws BuildException {
79 | if (index == null) {
80 | throw new BuildException("Required attributes: file");
81 | }
82 |
83 | try {
84 | // generate package source for spk files
85 | JsonArrayBuilder jsonPackages = Json.createArrayBuilder();
86 | getPackages().forEach((p) -> {
87 | JsonObjectBuilder jsonPackage = Json.createObjectBuilder();
88 | p.forEach((k, v) -> {
89 | if (v instanceof Boolean) {
90 | jsonPackage.add(k, (Boolean) v); // Boolean
91 | } else if (v instanceof Number) {
92 | jsonPackage.add(k, ((Number) v).longValue()); // Integer
93 | } else if (v instanceof String[]) {
94 | JsonArrayBuilder array = Json.createArrayBuilder(); // String Array
95 | for (String s : (String[]) v) {
96 | array.add(s);
97 | }
98 | jsonPackage.add(k, array);
99 | } else if (v == null) {
100 | jsonPackage.addNull(k); // null
101 | } else {
102 | jsonPackage.add(k, v.toString()); // String
103 | }
104 | });
105 | jsonPackages.add(jsonPackage);
106 | });
107 |
108 | // collect public keys and omit duplicates
109 | Set keyrings = new LinkedHashSet();
110 | keyrings.addAll(getKeyRings());
111 |
112 | // include keyrings and packages from external package sources
113 | for (URLResource source : sources) {
114 | try (JsonReader reader = Json.createReader(source.getInputStream())) {
115 | JsonObject json = reader.readObject();
116 |
117 | if (json.getJsonArray(KEYRINGS) != null) {
118 | for (JsonValue k : json.getJsonArray(KEYRINGS)) {
119 | log("Import keyring: " + source);
120 | keyrings.add(normalizeKey(((JsonString) k).getString()));
121 | }
122 | }
123 |
124 | if (json.getJsonArray(PACKAGES) != null) {
125 | for (JsonValue p : json.getJsonArray(PACKAGES)) {
126 | log("Import package: " + (((JsonString) ((JsonObject) p).get(PACKAGE))).getString());
127 | jsonPackages.add(p);
128 | }
129 | }
130 | } catch (Exception e) {
131 | throw new BuildException(e);
132 | }
133 | }
134 |
135 | JsonObjectBuilder jsonRoot = Json.createObjectBuilder();
136 | if (keyrings.size() > 0) {
137 | JsonArrayBuilder jsonKeyrings = Json.createArrayBuilder();
138 | keyrings.forEach(jsonKeyrings::add);
139 | jsonRoot.add(KEYRINGS, jsonKeyrings);
140 | }
141 | jsonRoot.add(PACKAGES, jsonPackages);
142 |
143 | log("Write Package Source: " + index);
144 | StringWriter json = new StringWriter();
145 | try (JsonWriter writer = Json.createWriterFactory(singletonMap(JsonGenerator.PRETTY_PRINTING, true)).createWriter(json)) {
146 | writer.writeObject(jsonRoot.build());
147 | }
148 | Files.write(index.toPath(), json.toString().trim().getBytes(UTF_8));
149 | } catch (Exception e) {
150 | throw new BuildException(e);
151 | }
152 | }
153 |
154 | public List getKeyRings() throws Exception {
155 | List keys = new ArrayList();
156 | for (Resource resource : keyrings) {
157 | log("Include keyring: " + resource.getName());
158 | String key = FileUtils.readFully(new InputStreamReader(resource.getInputStream(), US_ASCII));
159 | if (key != null) {
160 | keys.add(normalizeKey(key)); // make sure to normalize line endings
161 | }
162 | }
163 | return keys;
164 | }
165 |
166 | private static final Pattern NEWLINE = Pattern.compile("\\R");
167 | private static final String UNIX_NEWLINE = "\n";
168 |
169 | private String normalizeKey(String key) {
170 | return NEWLINE.matcher(key).replaceAll(UNIX_NEWLINE).trim();
171 | }
172 |
173 | public static final String PACKAGE = "package";
174 | public static final String VERSION = "version";
175 |
176 | public static final String LINK = "link";
177 | public static final String MD5 = "md5";
178 | public static final String SHA256 = "sha256"; // NOT SUPPORTED BY SYNOLOGY DSM
179 | public static final String SIZE = "size";
180 | public static final String THUMBNAIL = "thumbnail";
181 | public static final String SNAPSHOT = "snapshot";
182 |
183 | public List