From 6c9531ef4fe092a80746c8e468930e0ba5c7fa65 Mon Sep 17 00:00:00 2001 From: Ruman Saleem Date: Sun, 9 Mar 2025 02:09:22 +0530 Subject: [PATCH] Adds feature to Edit Custom certificates. --- backend/internal/certificate.js | 4 +- backend/routes/nginx/certificates.js | 18 +++++ .../paths/nginx/certificates/certID/put.json | 77 +++++++++++++++++++ backend/schema/swagger.json | 3 + frontend/js/app/nginx/certificates/form.ejs | 18 +++-- frontend/js/app/nginx/certificates/form.js | 35 ++++++--- .../js/app/nginx/certificates/list/item.ejs | 4 + .../js/app/nginx/certificates/list/item.js | 6 ++ frontend/js/i18n/messages.json | 3 +- frontend/js/models/certificate.js | 7 ++ 10 files changed, 158 insertions(+), 17 deletions(-) create mode 100644 backend/schema/paths/nginx/certificates/certID/put.json diff --git a/backend/internal/certificate.js b/backend/internal/certificate.js index f2e845a24..74041e095 100644 --- a/backend/internal/certificate.js +++ b/backend/internal/certificate.js @@ -272,7 +272,9 @@ const internalCertificate = { .then(utils.omitRow(omissions())) .then((saved_row) => { saved_row.meta = internalCertificate.cleanMeta(saved_row.meta); - data.meta = internalCertificate.cleanMeta(data.meta); + if (data.meta) { + data.meta = internalCertificate.cleanMeta(data.meta); + } // Add row.nice_name for custom certs if (saved_row.provider === 'other') { diff --git a/backend/routes/nginx/certificates.js b/backend/routes/nginx/certificates.js index bf47c03fc..95a23c283 100644 --- a/backend/routes/nginx/certificates.js +++ b/backend/routes/nginx/certificates.js @@ -147,6 +147,24 @@ router .catch(next); }) + /** + * PUT /api/nginx/certificates/123 + * + * Updates a specific certificate + */ + .put((req, res, next) => { + const data = { id: req.params.certificate_id, ...req.body }; + apiValidator(schema.getValidationSchema('/nginx/certificates/{certID}', 'put'), data) + .then((data) => { + return internalCertificate.update(res.locals.access, data); + }) + .then((result) => { + res.status(201) + .send(result); + }) + .catch(next); + }) + /** * DELETE /api/nginx/certificates/123 * diff --git a/backend/schema/paths/nginx/certificates/certID/put.json b/backend/schema/paths/nginx/certificates/certID/put.json new file mode 100644 index 000000000..2c50a8c96 --- /dev/null +++ b/backend/schema/paths/nginx/certificates/certID/put.json @@ -0,0 +1,77 @@ +{ + "operationId": "updateCertificate", + "summary": "Update a Certificate", + "tags": ["Certificates"], + "security": [ + { + "BearerAuth": ["certificates"] + } + ], + "parameters": [ + { + "in": "path", + "name": "certID", + "schema": { + "type": "integer", + "minimum": 1 + }, + "required": true, + "example": 1 + } + ], + "requestBody": { + "description": "Certificate Payload", + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "additionalProperties": false, + "required": ["provider"], + "properties": { + "id": { + "$ref": "../../../../common.json#/properties/id" + }, + "provider": { + "$ref": "../../../../components/certificate-object.json#/properties/provider" + }, + "nice_name": { + "$ref": "../../../../components/certificate-object.json#/properties/nice_name" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "200 response", + "content": { + "application/json": { + "examples": { + "default": { + "value": { + "id": 4, + "created_on": "2024-10-09T05:31:58.000Z", + "modified_on": "2024-10-09T05:32:11.000Z", + "owner_user_id": 1, + "provider": "letsencrypt", + "nice_name": "test.example.com", + "domain_names": ["test.example.com"], + "expires_on": "2025-01-07T04:34:18.000Z", + "meta": { + "letsencrypt_email": "jc@jc21.com", + "letsencrypt_agree": true, + "dns_challenge": false + } + } + } + }, + "schema": { + "$ref": "../../../../components/certificate-object.json" + } + } + } + } + } +} diff --git a/backend/schema/swagger.json b/backend/schema/swagger.json index 4a502b4e4..2be151b96 100644 --- a/backend/schema/swagger.json +++ b/backend/schema/swagger.json @@ -70,6 +70,9 @@ "get": { "$ref": "./paths/nginx/certificates/certID/get.json" }, + "put": { + "$ref": "./paths/nginx/certificates/certID/put.json" + }, "delete": { "$ref": "./paths/nginx/certificates/certID/delete.json" } diff --git a/frontend/js/app/nginx/certificates/form.ejs b/frontend/js/app/nginx/certificates/form.ejs index 6adb4b01c..e75593af0 100644 --- a/frontend/js/app/nginx/certificates/form.ejs +++ b/frontend/js/app/nginx/certificates/form.ejs @@ -1,6 +1,6 @@
-
<%- i18n('certificates', 'form-title', {provider: provider}) %>
+
<%- i18n('certificates', 'form-title' , {provider: provider, id: id}) %>
@@ -148,18 +148,26 @@
-
<%- i18n('certificates', 'other-certificate-key') %>*
+
<%- i18n('certificates', 'other-certificate-key') %> + <% if (isNew()) { %> + * + <% } %> +
- + >
-
<%- i18n('certificates', 'other-certificate') %>*
+
<%- i18n('certificates', 'other-certificate') %> + <% if (isNew()) { %> + * + <% } %> +
- + >
diff --git a/frontend/js/app/nginx/certificates/form.js b/frontend/js/app/nginx/certificates/form.js index cab09155f..e48bd90f3 100644 --- a/frontend/js/app/nginx/certificates/form.js +++ b/frontend/js/app/nginx/certificates/form.js @@ -90,6 +90,7 @@ module.exports = Mn.View.extend({ } let data = this.ui.form.serializeJSON(); + data.id = this.model.get('id'); data.provider = this.model.get('provider'); let ssl_files = []; @@ -125,30 +126,38 @@ module.exports = Mn.View.extend({ if (typeof data.domain_names === 'string' && data.domain_names) { data.domain_names = data.domain_names.split(','); } - } else if (data.provider === 'other' && !this.model.hasSslFiles()) { + } else if (data.provider === 'other') { + const isNew = data.id == null; // check files are attached - if (!this.ui.other_certificate[0].files.length || !this.ui.other_certificate[0].files[0].size) { + // Check Certificate + const hasCertificateFile = this.ui.other_certificate[0].files.length && this.ui.other_certificate[0].files[0].size + if (isNew && !hasCertificateFile) { alert('Certificate file is not attached'); return; - } else { + } + if (hasCertificateFile) { if (this.ui.other_certificate[0].files[0].size > this.max_file_size) { alert('Certificate file is too large (> 100kb)'); return; } - ssl_files.push({name: 'certificate', file: this.ui.other_certificate[0].files[0]}); + ssl_files.push({ name: 'certificate', file: this.ui.other_certificate[0].files[0] }); } - if (!this.ui.other_certificate_key[0].files.length || !this.ui.other_certificate_key[0].files[0].size) { + // Check Certificate Key + const hasCertificateKeyFile = this.ui.other_certificate_key[0].files.length && this.ui.other_certificate_key[0].files[0].size + if (isNew && !hasCertificateKeyFile) { alert('Certificate key file is not attached'); return; - } else { + } + if (hasCertificateKeyFile) { if (this.ui.other_certificate_key[0].files[0].size > this.max_file_size) { alert('Certificate key file is too large (> 100kb)'); return; } - ssl_files.push({name: 'certificate_key', file: this.ui.other_certificate_key[0].files[0]}); + ssl_files.push({ name: 'certificate_key', file: this.ui.other_certificate_key[0].files[0] }); } + // Check Intermediate Certificate if (this.ui.other_intermediate_certificate[0].files.length && this.ui.other_intermediate_certificate[0].files[0].size) { if (this.ui.other_intermediate_certificate[0].files[0].size > this.max_file_size) { alert('Intermediate Certificate file is too large (> 100kb)'); @@ -170,20 +179,23 @@ module.exports = Mn.View.extend({ } new Promise(resolve => { - if (data.provider === 'other') { + if (data.provider === 'other' && ssl_files.length) { resolve(App.Api.Nginx.Certificates.validate(form_data)); } else { resolve(); } }) .then(() => { - return App.Api.Nginx.Certificates.create(data); + return data.id == null + ? App.Api.Nginx.Certificates.create(data) + : App.Api.Nginx.Certificates.update(data); }) .then(result => { this.model.set(result); // Now upload the certs if we need to - if (data.provider === 'other') { + const hasCertificateFiles = form_data.has('certificate') || form_data.has('certificate_key') || form_data.has('intermediate_certificate'); + if (data.provider === 'other' && hasCertificateFiles) { return App.Api.Nginx.Certificates.upload(this.model.get('id'), form_data) .then(result => { this.model.set('meta', _.assign({}, this.model.get('meta'), result)); @@ -240,6 +252,9 @@ module.exports = Mn.View.extend({ this.getUI(ui).text(e.target.files[0].name) }, templateContext: { + isNew: function () { + return this.isNew(); + }, getLetsencryptEmail: function () { return typeof this.meta.letsencrypt_email !== 'undefined' ? this.meta.letsencrypt_email : App.Cache.User.get('email'); }, diff --git a/frontend/js/app/nginx/certificates/list/item.ejs b/frontend/js/app/nginx/certificates/list/item.ejs index 179a81955..85f76a12a 100644 --- a/frontend/js/app/nginx/certificates/list/item.ejs +++ b/frontend/js/app/nginx/certificates/list/item.ejs @@ -53,6 +53,10 @@ <%- i18n('certificates', 'test-reachability') %> <% } %>
+ <% } else { %> + + <%- i18n('certificates', 'edit') %> +
<% } %> <%- i18n('str', 'delete') %> <% if (active_domain_names().length > 0) { %> diff --git a/frontend/js/app/nginx/certificates/list/item.js b/frontend/js/app/nginx/certificates/list/item.js index b9a927adc..df3de7e67 100644 --- a/frontend/js/app/nginx/certificates/list/item.js +++ b/frontend/js/app/nginx/certificates/list/item.js @@ -11,6 +11,7 @@ module.exports = Mn.View.extend({ ui: { host_link: '.host-link', renew: 'a.renew', + replace: 'a.replace', delete: 'a.delete', download: 'a.download', test: 'a.test' @@ -22,6 +23,11 @@ module.exports = Mn.View.extend({ App.Controller.showNginxCertificateRenew(this.model); }, + 'click @ui.replace': function (e) { + e.preventDefault(); + App.Controller.showNginxCertificateForm(this.model); + }, + 'click @ui.delete': function (e) { e.preventDefault(); App.Controller.showNginxCertificateDeleteConfirm(this.model); diff --git a/frontend/js/i18n/messages.json b/frontend/js/i18n/messages.json index a154921b5..52dc4c511 100644 --- a/frontend/js/i18n/messages.json +++ b/frontend/js/i18n/messages.json @@ -187,7 +187,7 @@ "title": "SSL Certificates", "empty": "There are no SSL Certificates", "add": "Add SSL Certificate", - "form-title": "Add {provider, select, letsencrypt{Let's Encrypt} other{Custom}} Certificate", + "form-title": "{id, select, undefined{Add} other{Edit}} {provider, select, letsencrypt{Let's Encrypt} other{Custom}} Certificate", "delete": "Delete SSL Certificate", "delete-confirm": "Are you sure you want to delete this SSL Certificate? Any hosts using it will need to be updated later.", "help-title": "SSL Certificates", @@ -196,6 +196,7 @@ "other-certificate-key": "Certificate Key", "other-intermediate-certificate": "Intermediate Certificate", "force-renew": "Renew Now", + "edit": "Edit", "test-reachability": "Test Server Reachability", "reachability-title": "Test Server Reachability", "reachability-info": "Test whether the domains are reachable from the public internet using Site24x7. This is not necessary when using the DNS Challenge.", diff --git a/frontend/js/models/certificate.js b/frontend/js/models/certificate.js index c7d0b2d97..774ddf34f 100644 --- a/frontend/js/models/certificate.js +++ b/frontend/js/models/certificate.js @@ -21,6 +21,13 @@ const model = Backbone.Model.extend({ }; }, + /** + * @returns {Boolean} + */ + isNew: function () { + return this.get('id') == null; + }, + /** * @returns {Boolean} */