nginx-proxy-manager/backend/routes/nginx/certificates.js

import express from "express";
import internalCertificate from "../../internal/certificate.js";
import errs from "../../lib/error.js";
import jwtdecode from "../../lib/express/jwt-decode.js";
import apiValidator from "../../lib/validator/api.js";
import validator from "../../lib/validator/index.js";
import { getValidationSchema } from "../../schema/index.js";

const router = express.Router({
	caseSensitive: true,
	strict: true,
	mergeParams: true,
});

/**
 * /api/nginx/certificates
 */
router
	.route("/")
	.options((_, res) => {
		res.sendStatus(204);
	})
	.all(jwtdecode())

	/**
	 * GET /api/nginx/certificates
	 *
	 * Retrieve all certificates
	 */
	.get((req, res, next) => {
		validator(
			{
				additionalProperties: false,
				properties: {
					expand: {
						$ref: "common#/properties/expand",
					},
					query: {
						$ref: "common#/properties/query",
					},
				},
			},
			{
				expand: typeof req.query.expand === "string" ? req.query.expand.split(",") : null,
				query: typeof req.query.query === "string" ? req.query.query : null,
			},
		)
			.then((data) => {
				return internalCertificate.getAll(res.locals.access, data.expand, data.query);
			})
			.then((rows) => {
				res.status(200).send(rows);
			})
			.catch(next);
	})

	/**
	 * POST /api/nginx/certificates
	 *
	 * Create a new certificate
	 */
	.post((req, res, next) => {
		apiValidator(getValidationSchema("/nginx/certificates", "post"), req.body)
			.then((payload) => {
				req.setTimeout(900000); // 15 minutes timeout
				return internalCertificate.create(res.locals.access, payload);
			})
			.then((result) => {
				res.status(201).send(result);
			})
			.catch(next);
	});

/**
 * Test HTTP challenge for domains
 *
 * /api/nginx/certificates/test-http
 */
router
	.route("/test-http")
	.options((_, res) => {
		res.sendStatus(204);
	})
	.all(jwtdecode())

	/**
	 * GET /api/nginx/certificates/test-http
	 *
	 * Test HTTP challenge for domains
	 */
	.get((req, res, next) => {
		if (req.query.domains === undefined) {
			next(new errs.ValidationError("Domains are required as query parameters"));
			return;
		}

		internalCertificate
			.testHttpsChallenge(res.locals.access, JSON.parse(req.query.domains))
			.then((result) => {
				res.status(200).send(result);
			})
			.catch(next);
	});

/**
 * Specific certificate
 *
 * /api/nginx/certificates/123
 */
router
	.route("/:certificate_id")
	.options((_, res) => {
		res.sendStatus(204);
	})
	.all(jwtdecode())

	/**
	 * GET /api/nginx/certificates/123
	 *
	 * Retrieve a specific certificate
	 */
	.get((req, res, next) => {
		validator(
			{
				required: ["certificate_id"],
				additionalProperties: false,
				properties: {
					certificate_id: {
						$ref: "common#/properties/id",
					},
					expand: {
						$ref: "common#/properties/expand",
					},
				},
			},
			{
				certificate_id: req.params.certificate_id,
				expand: typeof req.query.expand === "string" ? req.query.expand.split(",") : null,
			},
		)
			.then((data) => {
				return internalCertificate.get(res.locals.access, {
					id: Number.parseInt(data.certificate_id, 10),
					expand: data.expand,
				});
			})
			.then((row) => {
				res.status(200).send(row);
			})
			.catch(next);
	})

	/**
	 * DELETE /api/nginx/certificates/123
	 *
	 * Update and existing certificate
	 */
	.delete((req, res, next) => {
		internalCertificate
			.delete(res.locals.access, { id: Number.parseInt(req.params.certificate_id, 10) })
			.then((result) => {
				res.status(200).send(result);
			})
			.catch(next);
	});

/**
 * Upload Certs
 *
 * /api/nginx/certificates/123/upload
 */
router
	.route("/:certificate_id/upload")
	.options((_, res) => {
		res.sendStatus(204);
	})
	.all(jwtdecode())

	/**
	 * POST /api/nginx/certificates/123/upload
	 *
	 * Upload certificates
	 */
	.post((req, res, next) => {
		if (!req.files) {
			res.status(400).send({ error: "No files were uploaded" });
		} else {
			internalCertificate
				.upload(res.locals.access, {
					id: Number.parseInt(req.params.certificate_id, 10),
					files: req.files,
				})
				.then((result) => {
					res.status(200).send(result);
				})
				.catch(next);
		}
	});

/**
 * Renew LE Certs
 *
 * /api/nginx/certificates/123/renew
 */
router
	.route("/:certificate_id/renew")
	.options((_, res) => {
		res.sendStatus(204);
	})
	.all(jwtdecode())

	/**
	 * POST /api/nginx/certificates/123/renew
	 *
	 * Renew certificate
	 */
	.post((req, res, next) => {
		req.setTimeout(900000); // 15 minutes timeout
		internalCertificate
			.renew(res.locals.access, {
				id: Number.parseInt(req.params.certificate_id, 10),
			})
			.then((result) => {
				res.status(200).send(result);
			})
			.catch(next);
	});

/**
 * Download LE Certs
 *
 * /api/nginx/certificates/123/download
 */
router
	.route("/:certificate_id/download")
	.options((_req, res) => {
		res.sendStatus(204);
	})
	.all(jwtdecode())

	/**
	 * GET /api/nginx/certificates/123/download
	 *
	 * Renew certificate
	 */
	.get((req, res, next) => {
		internalCertificate
			.download(res.locals.access, {
				id: Number.parseInt(req.params.certificate_id, 10),
			})
			.then((result) => {
				res.status(200).download(result.fileName);
			})
			.catch(next);
	});

/**
 * Validate Certs before saving
 *
 * /api/nginx/certificates/validate
 */
router
	.route("/validate")
	.options((_, res) => {
		res.sendStatus(204);
	})
	.all(jwtdecode())

	/**
	 * POST /api/nginx/certificates/validate
	 *
	 * Validate certificates
	 */
	.post((req, res, next) => {
		if (!req.files) {
			res.status(400).send({ error: "No files were uploaded" });
		} else {
			internalCertificate
				.validate({
					files: req.files,
				})
				.then((result) => {
					res.status(200).send(result);
				})
				.catch(next);
		}
	});

export default router;