From mboxrd@z Thu Jan  1 00:00:00 1970
Return-Path: <pmg-devel-bounces@lists.proxmox.com>
Received: from firstgate.proxmox.com (firstgate.proxmox.com [212.224.123.68])
	by lore.proxmox.com (Postfix) with ESMTPS id 975AC1FF1A5
	for <inbox@lore.proxmox.com>; Mon, 11 Nov 2024 10:32:35 +0100 (CET)
Received: from firstgate.proxmox.com (localhost [127.0.0.1])
	by firstgate.proxmox.com (Proxmox) with ESMTP id 6F9243E60B;
	Mon, 11 Nov 2024 10:32:34 +0100 (CET)
From: Maximiliano Sandoval <m.sandoval@proxmox.com>
To: pmg-devel@lists.proxmox.com
Date: Mon, 11 Nov 2024 10:32:30 +0100
Message-Id: <20241111093231.120597-1-m.sandoval@proxmox.com>
X-Mailer: git-send-email 2.39.5
MIME-Version: 1.0
X-SPAM-LEVEL: Spam detection results:  0
 AWL -0.154 Adjusted score from AWL reputation of From: address
 BAYES_00                 -1.9 Bayes spam probability is 0 to 1%
 DMARC_MISSING             0.1 Missing DMARC policy
 KAM_DMARC_STATUS 0.01 Test Rule for DKIM or SPF Failure with Strict Alignment
 KAM_NUMSUBJECT 0.5 Subject ends in numbers excluding current years
 SPF_HELO_NONE           0.001 SPF: HELO does not publish an SPF Record
 SPF_PASS               -0.001 SPF: sender matches SPF record
Subject: [pmg-devel] [PATCH pmg-api v3 1/2] api: document that fingerprints
 are a SHA 256
X-BeenThere: pmg-devel@lists.proxmox.com
X-Mailman-Version: 2.1.29
Precedence: list
List-Id: Proxmox Mail Gateway development discussion
 <pmg-devel.lists.proxmox.com>
List-Unsubscribe: <https://lists.proxmox.com/cgi-bin/mailman/options/pmg-devel>, 
 <mailto:pmg-devel-request@lists.proxmox.com?subject=unsubscribe>
List-Archive: <http://lists.proxmox.com/pipermail/pmg-devel/>
List-Post: <mailto:pmg-devel@lists.proxmox.com>
List-Help: <mailto:pmg-devel-request@lists.proxmox.com?subject=help>
List-Subscribe: <https://lists.proxmox.com/cgi-bin/mailman/listinfo/pmg-devel>, 
 <mailto:pmg-devel-request@lists.proxmox.com?subject=subscribe>
Content-Type: text/plain; charset="us-ascii"
Content-Transfer-Encoding: 7bit
Errors-To: pmg-devel-bounces@lists.proxmox.com
Sender: "pmg-devel" <pmg-devel-bounces@lists.proxmox.com>

We use the description from the standard option 'fingerprint-sha256'.
The option itself cannot be used as the regex allows lowercase
characters which don't work here.

Signed-off-by: Maximiliano Sandoval <m.sandoval@proxmox.com>
---

Differences from v2:
 - Use the same docstring as in pve-common
 - Add regex pattern into the same patch

 src/PMG/API2/Cluster.pm  | 2 +-
 src/PMG/CLI/pmgcm.pm     | 2 +-
 src/PMG/ClusterConfig.pm | 2 +-
 3 files changed, 3 insertions(+), 3 deletions(-)

diff --git a/src/PMG/API2/Cluster.pm b/src/PMG/API2/Cluster.pm
index 84dafabb..6d776548 100644
--- a/src/PMG/API2/Cluster.pm
+++ b/src/PMG/API2/Cluster.pm
@@ -409,7 +409,7 @@ __PACKAGE__->register_method({
 		type => 'string', format => 'ip',
 	    },
 	    fingerprint => {
-		description => "SSL certificate fingerprint.",
+		description => "Certificate SHA 256 fingerprint.",
 		type => 'string',
 		pattern => '^(:?[A-Z0-9][A-Z0-9]:){31}[A-Z0-9][A-Z0-9]$',
 	    },
diff --git a/src/PMG/CLI/pmgcm.pm b/src/PMG/CLI/pmgcm.pm
index ecf9cc76..b4601de4 100644
--- a/src/PMG/CLI/pmgcm.pm
+++ b/src/PMG/CLI/pmgcm.pm
@@ -167,7 +167,7 @@ __PACKAGE__->register_method({
 		type => 'string', format => 'ip',
 	    },
 	    fingerprint => {
-		description => "SSL certificate fingerprint.",
+		description => "Certificate SHA 256 fingerprint.",
 		type => 'string',
 		pattern => '^(:?[A-Z0-9][A-Z0-9]:){31}[A-Z0-9][A-Z0-9]$',
 		optional => 1,
diff --git a/src/PMG/ClusterConfig.pm b/src/PMG/ClusterConfig.pm
index c52508dc..ad4acd05 100644
--- a/src/PMG/ClusterConfig.pm
+++ b/src/PMG/ClusterConfig.pm
@@ -73,7 +73,7 @@ sub properties {
 	    pattern => valid_ssh_pubkey_regex(),
 	},
 	fingerprint => {
-	    description => "SSL certificate fingerprint.",
+	    description => "Certificate SHA 256 fingerprint.",
 	    type => 'string',
 	    pattern => '^(:?[A-Z0-9][A-Z0-9]:){31}[A-Z0-9][A-Z0-9]$',
 	},
-- 
2.39.5



_______________________________________________
pmg-devel mailing list
pmg-devel@lists.proxmox.com
https://lists.proxmox.com/cgi-bin/mailman/listinfo/pmg-devel