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 ED64B9D22B for ; Wed, 25 Oct 2023 15:08:04 +0200 (CEST) Received: from firstgate.proxmox.com (localhost [127.0.0.1]) by firstgate.proxmox.com (Proxmox) with ESMTP id D01411435B for ; Wed, 25 Oct 2023 15:07:34 +0200 (CEST) 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 ; Wed, 25 Oct 2023 15:07:33 +0200 (CEST) Received: from proxmox-new.maurer-it.com (localhost.localdomain [127.0.0.1]) by proxmox-new.maurer-it.com (Proxmox) with ESMTP id 5774E45F47 for ; Wed, 25 Oct 2023 15:07:33 +0200 (CEST) From: Folke Gleumes To: pve-devel@lists.proxmox.com Date: Wed, 25 Oct 2023 15:07:18 +0200 Message-Id: <20231025130720.195478-4-f.gleumes@proxmox.com> X-Mailer: git-send-email 2.39.2 In-Reply-To: <20231025130720.195478-1-f.gleumes@proxmox.com> References: <20231025130720.195478-1-f.gleumes@proxmox.com> MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-SPAM-LEVEL: Spam detection results: 0 AWL -0.135 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 URIBL_BLOCKED 0.001 ADMINISTRATOR NOTICE: The query to URIBL was blocked. See http://wiki.apache.org/spamassassin/DnsBlocklists#dnsbl-block for more information. [acmeaccount.pm] Subject: [pve-devel] [PATCH manager v2 3/5] api/acme: deprecate tos endpoint in favor of meta X-BeenThere: pve-devel@lists.proxmox.com X-Mailman-Version: 2.1.29 Precedence: list List-Id: Proxmox VE development discussion List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Wed, 25 Oct 2023 13:08:05 -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 --- Changes v1 -> v2: * Include additional possible return values in api definition PVE/API2/ACMEAccount.pm | 56 ++++++++++++++++++++++++++++++++++++++++- 1 file changed, 55 insertions(+), 1 deletion(-) diff --git a/PVE/API2/ACMEAccount.pm b/PVE/API2/ACMEAccount.pm index 994d2b49..aac3f527 100644 --- a/PVE/API2/ACMEAccount.pm +++ b/PVE/API2/ACMEAccount.pm @@ -62,6 +62,7 @@ __PACKAGE__->register_method ({ return [ { name => 'account' }, { name => 'tos' }, + { name => 'meta' }, { name => 'directories' }, { name => 'plugins' }, { name => 'challenge-schema' }, @@ -329,11 +330,12 @@ __PACKAGE__->register_method ({ return $update_account->($param, 'deactivate', status => 'deactivated'); }}); +# TODO: deprecated, remove with pve 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 /cluster/acme/meta.", permissions => { user => 'all' }, parameters => { additionalProperties => 0, @@ -360,6 +362,58 @@ __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('pve-acme-directory-url', { + default => $acme_default_directory_url, + optional => 1, + }), + }, + }, + returns => { + type => 'object', + additionalProperties => 1, + properties => { + termsOfService => { + type => 'string', + optional => 1, + description => 'ACME TermsOfService URL.', + }, + externalAccountRequired => { + type => 'boolean', + optional => 1, + description => 'EAB Required' + }, + website => { + type => 'string', + optional => 1, + description => 'URL to more information about the ACME server.' + }, + caaIdentities => { + type => 'string', + optional => 1, + description => 'Hostnames referring to the ACME servers.' + }, + }, + }, + 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