From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from firstgate.proxmox.com (firstgate.proxmox.com [212.224.123.68]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (2048 bits)) (No client certificate requested) by lists.proxmox.com (Postfix) with ESMTPS id 280269A0BB for ; Tue, 14 Nov 2023 15:14:35 +0100 (CET) Received: from firstgate.proxmox.com (localhost [127.0.0.1]) by firstgate.proxmox.com (Proxmox) with ESMTP id 1170E1CD8E for ; Tue, 14 Nov 2023 15:14:35 +0100 (CET) Received: from proxmox-new.maurer-it.com (proxmox-new.maurer-it.com [94.136.29.106]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (2048 bits)) (No client certificate requested) by firstgate.proxmox.com (Proxmox) with ESMTPS for ; Tue, 14 Nov 2023 15:14:33 +0100 (CET) Received: from proxmox-new.maurer-it.com (localhost.localdomain [127.0.0.1]) by proxmox-new.maurer-it.com (Proxmox) with ESMTP id 5338E42A24 for ; Tue, 14 Nov 2023 15:14:33 +0100 (CET) From: Folke Gleumes To: pmg-devel@lists.proxmox.com Date: Tue, 14 Nov 2023 15:14:07 +0100 Message-Id: <20231114141408.228705-9-f.gleumes@proxmox.com> X-Mailer: git-send-email 2.39.2 In-Reply-To: <20231114141408.228705-1-f.gleumes@proxmox.com> References: <20231114141408.228705-1-f.gleumes@proxmox.com> MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-SPAM-LEVEL: Spam detection results: 0 AWL -0.134 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 POISEN_SPAM_PILL 0.1 Meta: its spam POISEN_SPAM_PILL_1 0.1 random spam to be learned in bayes POISEN_SPAM_PILL_3 0.1 random spam to be learned in bayes SPF_HELO_NONE 0.001 SPF: HELO does not publish an SPF Record SPF_PASS -0.001 SPF: sender matches SPF record T_SCC_BODY_TEXT_LINE -0.01 - Subject: [pmg-devel] [PATCH pmg-api 7/8] api: acme: deprecate tos endpoint in favor of new meta endpoint X-BeenThere: pmg-devel@lists.proxmox.com X-Mailman-Version: 2.1.29 Precedence: list List-Id: Proxmox Mail Gateway development discussion List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Tue, 14 Nov 2023 14:14:35 -0000 The ToS endpoint ignored data that is needed to detect if EAB needs to be used. Instead of adding a new endpoint that does the same request, the tos endpoint is deprecated and replaced by the meta endpoint, that returns all information returned by the directory. Signed-off-by: Folke Gleumes --- src/PMG/API2/ACME.pm | 59 +++++++++++++++++++++++++++++++++++++++++++- 1 file changed, 58 insertions(+), 1 deletion(-) diff --git a/src/PMG/API2/ACME.pm b/src/PMG/API2/ACME.pm index 9e3eb8d..8795c33 100644 --- a/src/PMG/API2/ACME.pm +++ b/src/PMG/API2/ACME.pm @@ -67,6 +67,7 @@ __PACKAGE__->register_method ({ return [ { name => 'account' }, { name => 'tos' }, + { name => 'meta' }, { name => 'directories' }, { name => 'plugins' }, { name => 'challenge-schema' }, @@ -353,11 +354,12 @@ __PACKAGE__->register_method ({ return $update_account->($param, 'deactivate', $force_deactivate, status => 'deactivated'); }}); +# TODO: deprecated, remove with pmg 9 __PACKAGE__->register_method ({ name => 'get_tos', path => 'tos', method => 'GET', - description => "Retrieve ACME TermsOfService URL from CA.", + description => "Retrieve ACME TermsOfService URL from CA. Deprecated, please use /config/acme/meta.", permissions => { user => 'all' }, parameters => { additionalProperties => 0, @@ -384,6 +386,61 @@ __PACKAGE__->register_method ({ return $meta ? $meta->{termsOfService} : undef; }}); +__PACKAGE__->register_method ({ + name => 'get_meta', + path => 'meta', + method => 'GET', + description => "Retrieve ACME Directory Meta Information", + permissions => { user => 'all' }, + parameters => { + additionalProperties => 0, + properties => { + directory => get_standard_option('pmg-acme-directory-url', { + default => $acme_default_directory_url, + optional => 1, + }), + }, + }, + returns => { + type => 'object', + additionalProperties => 1, + properties => { + termsOfService => { + description => 'ACME TermsOfService URL.', + type => 'string', + optional => 1, + }, + externalAccountRequired => { + description => 'EAB Required', + type => 'boolean', + optional => 1, + }, + website => { + description => 'URL to more information about the ACME server.', + type => 'string', + optional => 1, + }, + caaIdentities => { + description => 'Hostnames referring to the ACME servers.', + type => 'array', + items => { + type => 'string', + }, + optional => 1, + }, + }, + }, + code => sub { + my ($param) = @_; + + my $directory = extract_param($param, 'directory') // $acme_default_directory_url; + + my $acme = PVE::ACME->new(undef, $directory); + my $meta = $acme->get_meta(); + + return $meta; + }}); + __PACKAGE__->register_method ({ name => 'get_directories', path => 'directories', -- 2.39.2