releases.php 8.6 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278
  1. <?php
  2. declare(strict_types=1);
  3. // Release storage and manifest handling.
  4. //
  5. // Two deliberate design decisions:
  6. // - the package filename prefix is configurable (MANAGE_PACKAGE_PREFIX)
  7. // - the package download URL is built from MANAGE_PUBLIC_URL instead of the
  8. // client-controlled Host header
  9. require_once __DIR__ . "/bootstrap.php";
  10. function manageReleaseReadManifest(): array
  11. {
  12. $file = manageManifestFile();
  13. if (!is_file($file)) {
  14. return ["latest" => "", "releases" => []];
  15. }
  16. $decoded = manageReadJsonFile($file);
  17. return [
  18. "latest" => trim((string) ($decoded["latest"] ?? "")),
  19. "releases" => isset($decoded["releases"]) && is_array($decoded["releases"])
  20. ? $decoded["releases"]
  21. : [],
  22. ];
  23. }
  24. function manageReleaseWriteManifest(array $manifest): void
  25. {
  26. manageEnsureDirectory(manageReleasesDir());
  27. manageWriteJsonFile(manageManifestFile(), [
  28. "latest" => (string) ($manifest["latest"] ?? ""),
  29. "releases" => isset($manifest["releases"]) && is_array($manifest["releases"])
  30. ? $manifest["releases"]
  31. : [],
  32. ]);
  33. }
  34. function manageReleasePackageFileName(string $version): string
  35. {
  36. $prefix = trim((string) MANAGE_PACKAGE_PREFIX);
  37. if ($prefix === "") {
  38. $prefix = "release";
  39. }
  40. return $prefix . "-" . $version . ".zip";
  41. }
  42. function manageReleasePackagePath(string $packageRelativePath): ?string
  43. {
  44. $packageRelativePath = trim($packageRelativePath);
  45. if (
  46. $packageRelativePath === "" ||
  47. str_contains($packageRelativePath, "\0") ||
  48. str_starts_with($packageRelativePath, "/")
  49. ) {
  50. return null;
  51. }
  52. $packagePath = realpath(manageReleasesDir() . $packageRelativePath);
  53. $packagesDir = realpath(managePackagesDir());
  54. if (
  55. $packagePath === false ||
  56. $packagesDir === false ||
  57. !str_starts_with($packagePath, rtrim($packagesDir, "/\\") . DIRECTORY_SEPARATOR) ||
  58. !is_file($packagePath)
  59. ) {
  60. return null;
  61. }
  62. return $packagePath;
  63. }
  64. // Absolute download URL handed to clients. Derived from the configured public
  65. // URL so a forged Host header cannot redirect a client to another server.
  66. function manageReleasePackageUrl(string $version): string
  67. {
  68. $base = rtrim(trim((string) MANAGE_PUBLIC_URL), "/");
  69. if ($base === "") {
  70. throw new RuntimeException(
  71. "MANAGE_PUBLIC_URL ist nicht konfiguriert. Ohne diesen Wert kann keine Paket-URL erzeugt werden.",
  72. );
  73. }
  74. return $base . "/api/v1/package.php?version=" . rawurlencode($version);
  75. }
  76. function manageReleaseUploadedFileIsZip(array $file): bool
  77. {
  78. $name = strtolower((string) ($file["name"] ?? ""));
  79. $tmpName = (string) ($file["tmp_name"] ?? "");
  80. if (!str_ends_with($name, ".zip") || !is_uploaded_file($tmpName)) {
  81. return false;
  82. }
  83. return manageFileIsZip($tmpName);
  84. }
  85. // Stores an uploaded package and publishes it as the new latest release.
  86. // The checksum and size are always computed server-side; the publisher never
  87. // supplies them.
  88. function manageReleasePublishUpload(string $version, array $file): array
  89. {
  90. $version = trim($version);
  91. if (!manageIsVersion($version)) {
  92. throw new RuntimeException("Version muss dem Format vX.Y.Z entsprechen.");
  93. }
  94. if (($file["error"] ?? UPLOAD_ERR_NO_FILE) !== UPLOAD_ERR_OK) {
  95. throw new RuntimeException(
  96. "Upload fehlgeschlagen (Fehlercode " . (string) ($file["error"] ?? "unbekannt") . ").",
  97. );
  98. }
  99. if (!manageReleaseUploadedFileIsZip($file)) {
  100. throw new RuntimeException("Die hochgeladene Datei muss ein ZIP-Paket sein.");
  101. }
  102. manageEnsureDirectory(managePackagesDir());
  103. $fileName = manageReleasePackageFileName($version);
  104. $targetPath = managePackagesDir() . $fileName;
  105. if (!move_uploaded_file((string) $file["tmp_name"], $targetPath)) {
  106. throw new RuntimeException("Das Paket konnte nicht gespeichert werden.");
  107. }
  108. @chmod($targetPath, 0664);
  109. $sha256 = strtolower(hash_file("sha256", $targetPath) ?: "");
  110. $size = filesize($targetPath);
  111. if (preg_match('/^[a-f0-9]{64}$/', $sha256) !== 1 || $size === false || $size <= 0) {
  112. @unlink($targetPath);
  113. throw new RuntimeException("Das gespeicherte Paket konnte nicht verifiziert werden.");
  114. }
  115. $manifest = manageReleaseReadManifest();
  116. $manifest["latest"] = $version;
  117. $manifest["releases"][$version] = [
  118. "version" => $version,
  119. "package" => "packages/" . $fileName,
  120. "sha256" => $sha256,
  121. "size" => $size,
  122. "published_at" => date(DATE_ATOM),
  123. ];
  124. uksort($manifest["releases"], static function (string $left, string $right): int {
  125. return version_compare(ltrim($left, "vV"), ltrim($right, "vV"));
  126. });
  127. manageReleaseWriteManifest($manifest);
  128. manageLogAccess("Release published", [
  129. "version" => $version,
  130. "size" => $size,
  131. "sha256" => $sha256,
  132. ]);
  133. return $manifest["releases"][$version];
  134. }
  135. function manageReleaseSetLatest(string $version): void
  136. {
  137. $version = trim($version);
  138. if (!manageIsVersion($version)) {
  139. throw new RuntimeException("Ungültige Release-Version.");
  140. }
  141. $manifest = manageReleaseReadManifest();
  142. if (!isset($manifest["releases"][$version])) {
  143. throw new RuntimeException("Dieses Release ist nicht im Manifest vorhanden.");
  144. }
  145. $manifest["latest"] = $version;
  146. manageReleaseWriteManifest($manifest);
  147. manageLogAccess("Latest release changed", ["version" => $version]);
  148. }
  149. function manageReleaseDelete(string $version): void
  150. {
  151. $version = trim($version);
  152. if (!manageIsVersion($version)) {
  153. throw new RuntimeException("Ungültige Release-Version.");
  154. }
  155. $manifest = manageReleaseReadManifest();
  156. if (!isset($manifest["releases"][$version])) {
  157. throw new RuntimeException("Dieses Release ist nicht im Manifest vorhanden.");
  158. }
  159. $package = trim((string) ($manifest["releases"][$version]["package"] ?? ""));
  160. unset($manifest["releases"][$version]);
  161. if ($manifest["latest"] === $version) {
  162. $manifest["latest"] = "";
  163. }
  164. manageReleaseWriteManifest($manifest);
  165. $packagePath = manageReleasePackagePath($package);
  166. if ($packagePath !== null) {
  167. @unlink($packagePath);
  168. }
  169. manageLogAccess("Release deleted", ["version" => $version]);
  170. }
  171. /**
  172. * Resolves one release into the payload a client receives. Every field is
  173. * re-validated here, because the manifest is the only thing standing between a
  174. * client and the code it will execute.
  175. *
  176. * @return array{version: string, package_url: string, sha256: string, size: int, published_at: string}
  177. */
  178. function manageReleaseResolve(string $version): array
  179. {
  180. $manifest = manageReleaseReadManifest();
  181. $releases = $manifest["releases"];
  182. if (!isset($releases[$version]) || !is_array($releases[$version])) {
  183. throw new RuntimeException("Release ist nicht konfiguriert.");
  184. }
  185. $release = $releases[$version];
  186. $releaseVersion = trim((string) ($release["version"] ?? $version));
  187. $sha256 = strtolower(trim((string) ($release["sha256"] ?? "")));
  188. $package = trim((string) ($release["package"] ?? ""));
  189. $size = isset($release["size"]) ? (int) $release["size"] : 0;
  190. $publishedAt = trim((string) ($release["published_at"] ?? ""));
  191. if ($releaseVersion !== $version || !manageIsVersion($releaseVersion)) {
  192. throw new RuntimeException("Release-Version ist ungültig.");
  193. }
  194. if (preg_match('/^[a-f0-9]{64}$/', $sha256) !== 1) {
  195. throw new RuntimeException("Release-Prüfsumme ist ungültig.");
  196. }
  197. $packagePath = manageReleasePackagePath($package);
  198. if ($packagePath === null) {
  199. throw new RuntimeException("Release-Paket fehlt.");
  200. }
  201. if (strtolower(pathinfo($packagePath, PATHINFO_EXTENSION)) !== "zip") {
  202. throw new RuntimeException("Release-Paket ist keine ZIP-Datei.");
  203. }
  204. if ($size <= 0) {
  205. $size = (int) (filesize($packagePath) ?: 0);
  206. }
  207. return [
  208. "version" => $releaseVersion,
  209. "package_path" => $packagePath,
  210. "package_url" => manageReleasePackageUrl($releaseVersion),
  211. "sha256" => $sha256,
  212. "size" => $size,
  213. "published_at" => $publishedAt,
  214. ];
  215. }
  216. function manageReleaseLatestVersion(): string
  217. {
  218. $latest = manageReleaseReadManifest()["latest"];
  219. return manageIsVersion($latest) ? $latest : "";
  220. }
  221. // Releases newest first, for the admin UI.
  222. function manageReleaseListDescending(): array
  223. {
  224. $releases = manageReleaseReadManifest()["releases"];
  225. uksort($releases, static function (string $left, string $right): int {
  226. return version_compare(ltrim($right, "vV"), ltrim($left, "vV"));
  227. });
  228. return $releases;
  229. }